MultiplyConstant< InputDataType, OutputDataType > Class Template Reference

Implementation of the multiply constant layer. More...

Public Member Functions

 MultiplyConstant (const double scalar=1.0)
 Create the MultiplyConstant object. More...

 
template
<
typename
DataType
>
void Backward (const DataType &&, DataType &&gy, DataType &&g)
 Ordinary feed backward pass of a neural network. More...

 
OutputDataType & Delta () const
 Get the delta. More...

 
OutputDataType & Delta ()
 Modify the delta. More...

 
template
<
typename
InputType
,
typename
OutputType
>
void Forward (const InputType &&input, OutputType &&output)
 Ordinary feed forward pass of a neural network. More...

 
OutputDataType & OutputParameter () const
 Get the output parameter. More...

 
OutputDataType & OutputParameter ()
 Modify the output parameter. More...

 
template
<
typename
Archive
>
void serialize (Archive &ar, const unsigned int)
 Serialize the layer. More...

 

Detailed Description


template
<
typename
InputDataType
=
arma::mat
,
typename
OutputDataType
=
arma::mat
>

class mlpack::ann::MultiplyConstant< InputDataType, OutputDataType >

Implementation of the multiply constant layer.

The multiply constant layer multiplies the input by a (non-learnable) constant.

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 34 of file multiply_constant.hpp.

Constructor & Destructor Documentation

◆ MultiplyConstant()

MultiplyConstant ( const double  scalar = 1.0)

Create the MultiplyConstant object.

Member Function Documentation

◆ Backward()

void Backward ( const DataType &&  ,
DataType &&  gy,
DataType &&  g 
)

Ordinary feed backward pass of a neural network.

The backward pass multiplies the error with the specified constant scalar value.

Parameters
inputThe propagated input activation.
gyThe backpropagated error.
gThe calculated gradient.

◆ Delta() [1/2]

OutputDataType& Delta ( ) const
inline

Get the delta.

Definition at line 69 of file multiply_constant.hpp.

◆ Delta() [2/2]

OutputDataType& Delta ( )
inline

Modify the delta.

Definition at line 71 of file multiply_constant.hpp.

References MultiplyConstant< InputDataType, OutputDataType >::serialize().

◆ Forward()

void Forward ( const InputType &&  input,
OutputType &&  output 
)

Ordinary feed forward pass of a neural network.

Multiply the input with the specified constant scalar value.

Parameters
inputInput data used for evaluating the specified function.
outputResulting output activation.

◆ OutputParameter() [1/2]

OutputDataType& OutputParameter ( ) const
inline

Get the output parameter.

Definition at line 64 of file multiply_constant.hpp.

◆ OutputParameter() [2/2]

OutputDataType& OutputParameter ( )
inline

Modify the output parameter.

Definition at line 66 of file multiply_constant.hpp.

◆ serialize()

void serialize ( Archive &  ar,
const unsigned  int 
)

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