Implementation of the Linear layer class. More...

Public Member Functions
	Linear ()
	Create the Linear object. More...

	Linear (const size_t inSize, const size_t outSize)
	Create the Linear layer 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	bias
	Locally-stored bias term parameters. More...

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 paramters. More...

OutputDataType	weights
	Locally-stored weight object. More...

Detailed Description

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

Implementation of the Linear layer class.

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

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

Constructor & Destructor Documentation

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

mlpack::ann::Linear< InputDataType, OutputDataType >::Linear ( )

Create the Linear object.

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

mlpack::ann::Linear< InputDataType, OutputDataType >::Linear	(	const size_t	inSize,
		const size_t	outSize
	)

Create the Linear layer object using the specified number of units.

Parameters

inSize	The number of input units.
outSize	The number of output units.

Member Function Documentation

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

template<typename eT >

void mlpack::ann::Linear< 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

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

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

OutputDataType const& mlpack::ann::Linear< InputDataType, OutputDataType >::Delta ( ) const

inline

Get the delta.

Definition at line 107 of file linear.hpp.

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

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

OutputDataType& mlpack::ann::Linear< InputDataType, OutputDataType >::Delta ( )

inline

Modify the delta.

Definition at line 109 of file linear.hpp.

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

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

template<typename eT >

void mlpack::ann::Linear< 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

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

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

template<typename eT >

void mlpack::ann::Linear< 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::Linear< InputDataType, OutputDataType >::Gradient ( ) const

inline

Get the gradient.

Definition at line 112 of file linear.hpp.

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

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

OutputDataType& mlpack::ann::Linear< InputDataType, OutputDataType >::Gradient ( )

inline

Modify the gradient.

Definition at line 114 of file linear.hpp.

References mlpack::ann::Linear< InputDataType, OutputDataType >::gradient, and mlpack::ann::Linear< InputDataType, OutputDataType >::Serialize().

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

InputDataType const& mlpack::ann::Linear< InputDataType, OutputDataType >::InputParameter ( ) const

inline

Get the input parameter.

Definition at line 97 of file linear.hpp.

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

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

InputDataType& mlpack::ann::Linear< InputDataType, OutputDataType >::InputParameter ( )

inline

Modify the input parameter.

Definition at line 99 of file linear.hpp.

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

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

OutputDataType const& mlpack::ann::Linear< InputDataType, OutputDataType >::OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 102 of file linear.hpp.

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

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

OutputDataType& mlpack::ann::Linear< InputDataType, OutputDataType >::OutputParameter ( )

inline

Modify the output parameter.

Definition at line 104 of file linear.hpp.

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

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

OutputDataType const& mlpack::ann::Linear< InputDataType, OutputDataType >::Parameters ( ) const

inline

Get the parameters.

Definition at line 92 of file linear.hpp.

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

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

OutputDataType& mlpack::ann::Linear< InputDataType, OutputDataType >::Parameters ( )

inline

Modify the parameters.

Definition at line 94 of file linear.hpp.

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

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

void mlpack::ann::Linear< InputDataType, OutputDataType >::Reset ( )

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

template<typename Archive >

void mlpack::ann::Linear< InputDataType, OutputDataType >::Serialize	(	Archive &	ar,
		const unsigned	int
	)

Serialize the layer.

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

Member Data Documentation

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

OutputDataType mlpack::ann::Linear< InputDataType, OutputDataType >::bias

private

Locally-stored bias term parameters.

Definition at line 136 of file linear.hpp.

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

OutputDataType mlpack::ann::Linear< InputDataType, OutputDataType >::delta

private

Locally-stored delta object.

Definition at line 139 of file linear.hpp.

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

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

OutputDataType mlpack::ann::Linear< InputDataType, OutputDataType >::gradient

private

Locally-stored gradient object.

Definition at line 142 of file linear.hpp.

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

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

InputDataType mlpack::ann::Linear< InputDataType, OutputDataType >::inputParameter

private

Locally-stored input parameter object.

Definition at line 145 of file linear.hpp.

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

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

size_t mlpack::ann::Linear< InputDataType, OutputDataType >::inSize

private

Locally-stored number of input units.

Definition at line 124 of file linear.hpp.

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

OutputDataType mlpack::ann::Linear< InputDataType, OutputDataType >::outputParameter

private

Locally-stored output parameter object.

Definition at line 148 of file linear.hpp.

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

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

size_t mlpack::ann::Linear< InputDataType, OutputDataType >::outSize

private

Locally-stored number of output units.

Definition at line 127 of file linear.hpp.

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

OutputDataType mlpack::ann::Linear< InputDataType, OutputDataType >::weight

private

Locally-stored weight paramters.

Definition at line 133 of file linear.hpp.

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

OutputDataType mlpack::ann::Linear< InputDataType, OutputDataType >::weights

private

Locally-stored weight object.

Definition at line 130 of file linear.hpp.

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

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

src/mlpack/methods/ann/layer/layer_types.hpp
src/mlpack/methods/ann/layer/linear.hpp

Public Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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