Lookup< InputDataType, OutputDataType > Class Template Reference

Implementation of the Lookup class. More...

Public Member Functions
	Lookup (const size_t inSize=0, const size_t outSize=0)
	Create the Lookup object using the specified number of input and output 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, 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...
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::Lookup< InputDataType, OutputDataType >

Implementation of the Lookup class.

The Lookup class is a particular convolution, where the width of the convolution is 1.

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 35 of file lookup.hpp.

Constructor & Destructor Documentation

Lookup	(	const size_t	inSize = 0,
		const size_t	outSize = 0
	)

Create the Lookup object using the specified number of input and output units.

Parameters

inSize	The number of input units.
outSize	The 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

input	The propagated input activation.
gy	The backpropagated error.
g	The calculated gradient.

OutputDataType const& Delta ( ) const

inline

Get the delta.

Definition at line 99 of file lookup.hpp.

OutputDataType& Delta ( )

inline

Modify the delta.

Definition at line 101 of file lookup.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

input	Input data used for evaluating the specified function.
output	Resulting output activation.

void Gradient	(	const arma::Mat< eT > &&	input,
		arma::Mat< eT > &&	error,
		arma::Mat< eT > &&	gradient
	)

OutputDataType const& Gradient ( ) const

inline

Get the gradient.

Definition at line 104 of file lookup.hpp.

OutputDataType& Gradient ( )

inline

Modify the gradient.

Definition at line 106 of file lookup.hpp.

InputDataType const& InputParameter ( ) const

inline

Get the input parameter.

Definition at line 89 of file lookup.hpp.

InputDataType& InputParameter ( )

inline

Modify the input parameter.

Definition at line 91 of file lookup.hpp.

OutputDataType const& OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 94 of file lookup.hpp.

OutputDataType& OutputParameter ( )

inline

Modify the output parameter.

Definition at line 96 of file lookup.hpp.

OutputDataType const& Parameters ( ) const

inline

Get the parameters.

Definition at line 84 of file lookup.hpp.

OutputDataType& Parameters ( )

inline

Modify the parameters.

Definition at line 86 of file lookup.hpp.

void serialize	(	Archive &	ar,
		const unsigned	int
	)

Serialize the layer.

---

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

• src/mlpack/methods/ann/layer/lookup.hpp