NeuralEngine
A Game Engine with embeded Machine Learning algorithms based on Gaussian Processes.
NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar > Class Template Referenceabstract


Abstract class for back-constraints, a kind of prior knowledge to force topological positions of uncertain latent inputs. All types of back-constraints will be derived from this class.
More...

#include <FgIBackconstraint.h>

Inheritance diagram for NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >:
Collaboration diagram for NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >:

Public Member Functions

 IBackconstraint (BackConstType type)
 Constructor. More...
 
virtual ~IBackconstraint ()
 Destructor. More...
 
virtual void Init (const af::array &Y, const af::array &X, const af::array &segments)=0
 Initializes this object. More...
 
virtual int GetNumParameters ()=0
 Gets number of to be optimized parameters. More...
 
virtual void SetParameters (const af::array &param)=0
 Sets the parameters. More...
 
virtual af::array GetParameters ()=0
 Gets the parameters. More...
 
virtual af::array GetConstraintX ()=0
 Gets constraint x coordinates. More...
 
virtual af::array BackconstraintGradient (const af::array &gX)=0
 Back-constraint gradient. More...
 
BackConstType GetType ()
 Gets the back-constraint type. More...
 

Protected Attributes

int iN
 dataset length More...
 
int iq
 latent dimension More...
 
af::dtype m_dType
 floating point precision flag for af::array More...
 

Private Member Functions

template<class Archive >
void serialize (Archive &ar, unsigned int version)
 

Private Attributes

BackConstType backType
 

Friends

class boost::serialization::access
 

Detailed Description

template<typename Scalar>
class NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >


Abstract class for back-constraints, a kind of prior knowledge to force topological positions of uncertain latent inputs. All types of back-constraints will be derived from this class.

HmetalT, 26.10.2017.

Definition at line 41 of file FgIBackconstraint.h.

Constructor & Destructor Documentation

◆ IBackconstraint()

template<typename Scalar >
NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::IBackconstraint ( BackConstType  type)

Constructor.

Hmetal T, 17/09/2020.

Parameters
typeThe type.

◆ ~IBackconstraint()

Destructor.

Hmetal T, 17/09/2020.

Member Function Documentation

◆ Init()

template<typename Scalar >
virtual void NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::Init ( const af::array &  Y,
const af::array &  X,
const af::array &  segments 
)
pure virtual

Initializes this object.

Hmetal T, 17/09/2020.

Parameters
YAn af::array to process.
XAn af::array to process.

Implemented in NeuralEngine::MachineLearning::GPModels::KBR< Scalar >, and NeuralEngine::MachineLearning::GPModels::PTC< Scalar >.

◆ GetNumParameters()

template<typename Scalar >
virtual int NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::GetNumParameters ( )
pure virtual

Gets number of to be optimized parameters.

Hmetal T, 17/09/2020.

Returns
The number parameters.

Implemented in NeuralEngine::MachineLearning::GPModels::KBR< Scalar >, and NeuralEngine::MachineLearning::GPModels::PTC< Scalar >.

◆ SetParameters()

template<typename Scalar >
virtual void NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::SetParameters ( const af::array &  param)
pure virtual

Sets the parameters.

Hmetal T, 17/09/2020.

Parameters
paramThe parameter.

Implemented in NeuralEngine::MachineLearning::GPModels::KBR< Scalar >, and NeuralEngine::MachineLearning::GPModels::PTC< Scalar >.

◆ GetParameters()

template<typename Scalar >
virtual af::array NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::GetParameters ( )
pure virtual

Gets the parameters.

Hmetal T, 17/09/2020.

Returns
The parameters.

Implemented in NeuralEngine::MachineLearning::GPModels::KBR< Scalar >, and NeuralEngine::MachineLearning::GPModels::PTC< Scalar >.

◆ GetConstraintX()

template<typename Scalar >
virtual af::array NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::GetConstraintX ( )
pure virtual

Gets constraint x coordinates.

Hmetal T, 17/09/2020.

Returns
The constraint x coordinate.

Implemented in NeuralEngine::MachineLearning::GPModels::KBR< Scalar >, and NeuralEngine::MachineLearning::GPModels::PTC< Scalar >.

◆ BackconstraintGradient()

template<typename Scalar >
virtual af::array NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::BackconstraintGradient ( const af::array &  gX)
pure virtual

Back-constraint gradient.

Hmetal T, 17/09/2020.

Parameters
gXThe gradient of \(\mathbf{X}\).
Returns
The gradient of the back-constraint.

Implemented in NeuralEngine::MachineLearning::GPModels::KBR< Scalar >, and NeuralEngine::MachineLearning::GPModels::PTC< Scalar >.

◆ GetType()

template<typename Scalar >
BackConstType NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::GetType ( )

Gets the back-constraint type.

Hmetal T, 15/09/2020.

Returns
The type.

◆ serialize()

template<typename Scalar >
template<class Archive >
void NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::serialize ( Archive &  ar,
unsigned int  version 
)
inlineprivate

Definition at line 139 of file FgIBackconstraint.h.

Friends And Related Function Documentation

◆ boost::serialization::access

template<typename Scalar >
friend class boost::serialization::access
friend

Definition at line 136 of file FgIBackconstraint.h.

Member Data Documentation

◆ iN

dataset length

Definition at line 128 of file FgIBackconstraint.h.

◆ iq

latent dimension

Definition at line 129 of file FgIBackconstraint.h.

◆ m_dType

template<typename Scalar >
af::dtype NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::m_dType
protected

floating point precision flag for af::array

Definition at line 131 of file FgIBackconstraint.h.

◆ backType

template<typename Scalar >
BackConstType NeuralEngine::MachineLearning::GPModels::IBackconstraint< Scalar >::backType
private

Definition at line 134 of file FgIBackconstraint.h.


The documentation for this class was generated from the following file: