mlpack  master
Public Member Functions | Private Attributes | List of all members
mlpack::ann::OrthogonalInitialization Class Reference

This class is used to initialize the weight matrix with the orthogonal matrix initialization. More...

Public Member Functions

 OrthogonalInitialization (const double gain=1.0)
 Initialize the orthogonal matrix initialization rule with the given gain. More...
 
template<typename eT >
void Initialize (arma::Mat< eT > &W, const size_t rows, const size_t cols)
 Initialize the elements of the specified weight matrix with the orthogonal matrix initialization method. More...
 
template<typename eT >
void Initialize (arma::Cube< eT > &W, const size_t rows, const size_t cols, const size_t slices)
 Initialize the elements of the specified weight 3rd order tensor with the orthogonal matrix initialization method. More...
 

Private Attributes

const double gain
 The number used as gain. More...
 

Detailed Description

This class is used to initialize the weight matrix with the orthogonal matrix initialization.

Definition at line 24 of file orthogonal_init.hpp.

Constructor & Destructor Documentation

mlpack::ann::OrthogonalInitialization::OrthogonalInitialization ( const double  gain = 1.0)
inline

Initialize the orthogonal matrix initialization rule with the given gain.

Parameters
gainThe gain value.

Definition at line 32 of file orthogonal_init.hpp.

Member Function Documentation

template<typename eT >
void mlpack::ann::OrthogonalInitialization::Initialize ( arma::Mat< eT > &  W,
const size_t  rows,
const size_t  cols 
)
inline

Initialize the elements of the specified weight matrix with the orthogonal matrix initialization method.

Parameters
WWeight matrix to initialize.
rowsNumber of rows.
colsNumber of columns.

Definition at line 43 of file orthogonal_init.hpp.

References gain.

Referenced by Initialize().

template<typename eT >
void mlpack::ann::OrthogonalInitialization::Initialize ( arma::Cube< eT > &  W,
const size_t  rows,
const size_t  cols,
const size_t  slices 
)
inline

Initialize the elements of the specified weight 3rd order tensor with the orthogonal matrix initialization method.

Parameters
WWeight matrix to initialize.
rowsNumber of rows.
colsNumber of columns.
slicesNumber of slices.

Definition at line 62 of file orthogonal_init.hpp.

References Initialize().

Member Data Documentation

const double mlpack::ann::OrthogonalInitialization::gain
private

The number used as gain.

Definition at line 75 of file orthogonal_init.hpp.

Referenced by Initialize().


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