mlpack  3.1.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
LinearNoBias< InputDataType, OutputDataType, RegularizerType > 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, RegularizerType regularizer=RegularizerType())
 Create the LinearNoBias object using the specified number of units. More...
 
template<typename eT >
void Backward (const arma::Mat< eT > &, const 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, const 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...
 
size_t InputSize () const
 Get the input size. More...
 
OutputDataType const & OutputParameter () const
 Get the output parameter. More...
 
OutputDataType & OutputParameter ()
 Modify the output parameter. More...
 
size_t OutputSize () const
 Get the output size. 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...
 

Detailed Description

template<typename InputDataType, typename OutputDataType, typename RegularizerType>
class mlpack::ann::LinearNoBias< InputDataType, OutputDataType, RegularizerType >

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 82 of file layer_types.hpp.

Constructor & Destructor Documentation

Create the LinearNoBias object.

LinearNoBias ( const size_t  inSize,
const size_t  outSize,
RegularizerType  regularizer = RegularizerType() 
)

Create the LinearNoBias object using the specified number of units.

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

Member Function Documentation

void Backward ( const arma::Mat< eT > &  ,
const 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.
OutputDataType const& Delta ( ) const
inline

Get the delta.

Definition at line 110 of file linear_no_bias.hpp.

OutputDataType& Delta ( )
inline

Modify the delta.

Definition at line 112 of file linear_no_bias.hpp.

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.

Parameters
inputInput data used for evaluating the specified function.
outputResulting output activation.
void Gradient ( const arma::Mat< eT > &  input,
const arma::Mat< eT > &  error,
arma::Mat< eT > &  gradient 
)
OutputDataType const& Gradient ( ) const
inline

Get the gradient.

Definition at line 121 of file linear_no_bias.hpp.

OutputDataType& Gradient ( )
inline

Modify the gradient.

Definition at line 123 of file linear_no_bias.hpp.

InputDataType const& InputParameter ( ) const
inline

Get the input parameter.

Definition at line 100 of file linear_no_bias.hpp.

InputDataType& InputParameter ( )
inline

Modify the input parameter.

Definition at line 102 of file linear_no_bias.hpp.

size_t InputSize ( ) const
inline

Get the input size.

Definition at line 115 of file linear_no_bias.hpp.

OutputDataType const& OutputParameter ( ) const
inline

Get the output parameter.

Definition at line 105 of file linear_no_bias.hpp.

OutputDataType& OutputParameter ( )
inline

Modify the output parameter.

Definition at line 107 of file linear_no_bias.hpp.

size_t OutputSize ( ) const
inline

Get the output size.

Definition at line 118 of file linear_no_bias.hpp.

OutputDataType const& Parameters ( ) const
inline

Get the parameters.

Definition at line 95 of file linear_no_bias.hpp.

OutputDataType& Parameters ( )
inline

Modify the parameters.

Definition at line 97 of file linear_no_bias.hpp.

void Reset ( )
void serialize ( Archive &  ar,
const unsigned  int 
)

Serialize the layer.


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