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
void	Backward (const DataType &, const 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
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...
double	Scalar () const
	Get the scalar multiplier. More...
double &	Scalar ()
	Modify the scalar multiplier. More...
template
void	serialize (Archive &ar, const unsigned int)
	Serialize the layer. More...

Detailed Description

template
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

InputDataType	Type of the input data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).
OutputDataType	Type 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 &	,
		const 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

*	(input) The propagated input activation.
gy	The backpropagated error.
g	The 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.

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

input	Input data used for evaluating the specified function.
output	Resulting 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.

Scalar() [1/2]

double Scalar ( ) const

inline

Get the scalar multiplier.

Definition at line 74 of file multiply_constant.hpp.

Scalar() [2/2]

double& Scalar ( )

inline

Modify the scalar multiplier.

Definition at line 76 of file multiply_constant.hpp.

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

serialize()

void serialize	(	Archive &	ar,
		const unsigned	int
	)

Serialize the layer.

Referenced by MultiplyConstant< InputDataType, OutputDataType >::Scalar().

---

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

• /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.4.2/src/mlpack/methods/ann/layer/multiply_constant.hpp