mlpack  master
Public Member Functions | Private Attributes | List of all members
mlpack::ann::LinearNoBias< InputDataType, OutputDataType > Class Template Reference

Implementation of the LinearNoBias class. More...

Public Member Functions

 LinearNoBias ()
 Create the LinearNoBias object. More...
 
 LinearNoBias (const size_t inSize, const size_t outSize)
 Create the LinearNoBias object using the specified number of units. More...
 
template<typename eT >
void Backward (const arma::Mat< eT > &&, arma::Mat< eT > &&gy, arma::Mat< eT > &&g)
 Ordinary feed backward pass of a neural network, calculating the function f(x) by propagating x backwards trough f. More...
 
OutputDataType const & Delta () const
 Get the delta. More...
 
OutputDataType & Delta ()
 Modify the delta. More...
 
template<typename eT >
void Forward (const arma::Mat< eT > &&input, arma::Mat< eT > &&output)
 Ordinary feed forward pass of a neural network, evaluating the function f(x) by propagating the activity forward through f. More...
 
template<typename eT >
void Gradient (const arma::Mat< eT > &&input, arma::Mat< eT > &&error, arma::Mat< eT > &&gradient)
 
OutputDataType const & Gradient () const
 Get the gradient. More...
 
OutputDataType & Gradient ()
 Modify the gradient. More...
 
InputDataType const & InputParameter () const
 Get the input parameter. More...
 
InputDataType & InputParameter ()
 Modify the input parameter. More...
 
OutputDataType const & OutputParameter () const
 Get the output parameter. More...
 
OutputDataType & OutputParameter ()
 Modify the output parameter. More...
 
OutputDataType const & Parameters () const
 Get the parameters. More...
 
OutputDataType & Parameters ()
 Modify the parameters. More...
 
void Reset ()
 
template<typename Archive >
void Serialize (Archive &ar, const unsigned int)
 Serialize the layer. More...
 

Private Attributes

OutputDataType delta
 Locally-stored delta object. More...
 
OutputDataType gradient
 Locally-stored gradient object. More...
 
InputDataType inputParameter
 Locally-stored input parameter object. More...
 
size_t inSize
 Locally-stored number of input units. More...
 
OutputDataType outputParameter
 Locally-stored output parameter object. More...
 
size_t outSize
 Locally-stored number of output units. More...
 
OutputDataType weight
 Locally-stored weight parameter. More...
 
OutputDataType weights
 Locally-stored weight object. More...
 

Detailed Description

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
class mlpack::ann::LinearNoBias< InputDataType, OutputDataType >

Implementation of the LinearNoBias class.

The LinearNoBias class represents a single layer of a neural network.

Template Parameters
InputDataTypeType of the input data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).
OutputDataTypeType of the output data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).

Definition at line 50 of file layer_types.hpp.

Constructor & Destructor Documentation

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::LinearNoBias ( )

Create the LinearNoBias object.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::LinearNoBias ( const size_t  inSize,
const size_t  outSize 
)

Create the LinearNoBias object using the specified number of units.

Parameters
inSizeThe number of input units.
outSizeThe number of output units.

Member Function Documentation

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
template<typename eT >
void mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Backward ( const arma::Mat< eT > &&  ,
arma::Mat< eT > &&  gy,
arma::Mat< eT > &&  g 
)

Ordinary feed backward pass of a neural network, calculating the function f(x) by propagating x backwards trough f.

Using the results from the feed forward pass.

Parameters
inputThe propagated input activation.
gyThe backpropagated error.
gThe calculated gradient.
template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType const& mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Delta ( ) const
inline

Get the delta.

Definition at line 106 of file linear_no_bias.hpp.

References mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::delta.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType& mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Delta ( )
inline

Modify the delta.

Definition at line 108 of file linear_no_bias.hpp.

References mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::delta.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
template<typename eT >
void mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Forward ( const arma::Mat< eT > &&  input,
arma::Mat< eT > &&  output 
)

Ordinary feed forward pass of a neural network, evaluating the function f(x) by propagating the activity forward through f.

Parameters
inputInput data used for evaluating the specified function.
outputResulting output activation.
template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
template<typename eT >
void mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Gradient ( const arma::Mat< eT > &&  input,
arma::Mat< eT > &&  error,
arma::Mat< eT > &&  gradient 
)
template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType const& mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Gradient ( ) const
inline

Get the gradient.

Definition at line 111 of file linear_no_bias.hpp.

References mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::gradient.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType& mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Gradient ( )
inline
template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
InputDataType const& mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::InputParameter ( ) const
inline

Get the input parameter.

Definition at line 96 of file linear_no_bias.hpp.

References mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::inputParameter.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
InputDataType& mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::InputParameter ( )
inline

Modify the input parameter.

Definition at line 98 of file linear_no_bias.hpp.

References mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::inputParameter.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType const& mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::OutputParameter ( ) const
inline

Get the output parameter.

Definition at line 101 of file linear_no_bias.hpp.

References mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::outputParameter.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType& mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::OutputParameter ( )
inline

Modify the output parameter.

Definition at line 103 of file linear_no_bias.hpp.

References mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::outputParameter.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType const& mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Parameters ( ) const
inline

Get the parameters.

Definition at line 91 of file linear_no_bias.hpp.

References mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::weights.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType& mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Parameters ( )
inline

Modify the parameters.

Definition at line 93 of file linear_no_bias.hpp.

References mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::weights.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
void mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Reset ( )
template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
template<typename Archive >
void mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Serialize ( Archive &  ar,
const unsigned  int 
)

Member Data Documentation

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::delta
private

Locally-stored delta object.

Definition at line 136 of file linear_no_bias.hpp.

Referenced by mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Delta().

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::gradient
private

Locally-stored gradient object.

Definition at line 139 of file linear_no_bias.hpp.

Referenced by mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Gradient().

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
InputDataType mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::inputParameter
private

Locally-stored input parameter object.

Definition at line 142 of file linear_no_bias.hpp.

Referenced by mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::InputParameter().

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
size_t mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::inSize
private

Locally-stored number of input units.

Definition at line 124 of file linear_no_bias.hpp.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::outputParameter
private

Locally-stored output parameter object.

Definition at line 145 of file linear_no_bias.hpp.

Referenced by mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::OutputParameter().

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
size_t mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::outSize
private

Locally-stored number of output units.

Definition at line 127 of file linear_no_bias.hpp.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::weight
private

Locally-stored weight parameter.

Definition at line 133 of file linear_no_bias.hpp.

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
OutputDataType mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::weights
private

Locally-stored weight object.

Definition at line 130 of file linear_no_bias.hpp.

Referenced by mlpack::ann::LinearNoBias< InputDataType, OutputDataType >::Parameters().


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