Concatenate< InputDataType, OutputDataType > Class Template Reference

Implementation of the Concatenate module class. More...

Public Member Functions
	Concatenate ()
	Create the Concatenate object using the specified number of output units. More...
	Concatenate (const Concatenate &layer)
	Copy constructor. More...
	Concatenate (Concatenate &&layer)
	Move constructor. 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 &	Concat () const
	Get the concat matrix. More...
OutputDataType &	Concat ()
	Modify the concat. 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...
Concatenate &	operator= (const Concatenate &layer)
	Operator= copy constructor. More...
Concatenate &	operator= (Concatenate &&layer)
	Operator= move constructor. 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 &, const uint32_t)
	Serialize the layer. More...

Detailed Description

template

<

typename

InputDataType

=

arma::mat

,

typename

OutputDataType

=

arma::mat

>

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

Implementation of the Concatenate module class.

The Concatenate module concatenates a constant given matrix to the incoming data. Note: Users need to use the Concat() function to provide the concat matrix.

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 36 of file concatenate.hpp.

Constructor & Destructor Documentation

Concatenate() [1/3]

Concatenate

(

)

Create the Concatenate object using the specified number of output units.

Concatenate() [2/3]

Concatenate

(

const Concatenate< InputDataType, OutputDataType > &

layer

)

Copy constructor.

Concatenate() [3/3]

Concatenate

(

Concatenate< InputDataType, OutputDataType > &&

layer

)

Move constructor.

Member Function Documentation

Backward()

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.

Concat() [1/2]

OutputDataType const& Concat ( ) const

inline

Get the concat matrix.

Definition at line 96 of file concatenate.hpp.

Concat() [2/2]

OutputDataType& Concat ( )

inline

Modify the concat.

Definition at line 98 of file concatenate.hpp.

Delta() [1/2]

OutputDataType const& Delta ( ) const

inline

Get the delta.

Definition at line 91 of file concatenate.hpp.

Delta() [2/2]

OutputDataType& Delta ( )

inline

Modify the delta.

Definition at line 93 of file concatenate.hpp.

Forward()

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.

operator=() [1/2]

Concatenate& operator=

(

const Concatenate< InputDataType, OutputDataType > &

layer

)

Operator= copy constructor.

operator=() [2/2]

Concatenate& operator=

(

Concatenate< InputDataType, OutputDataType > &&

layer

)

Operator= move constructor.

OutputParameter() [1/2]

OutputDataType const& OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 86 of file concatenate.hpp.

OutputParameter() [2/2]

OutputDataType& OutputParameter ( )

inline

Modify the output parameter.

Definition at line 88 of file concatenate.hpp.

Parameters() [1/2]

OutputDataType const& Parameters ( ) const

inline

Get the parameters.

Definition at line 81 of file concatenate.hpp.

Parameters() [2/2]

OutputDataType& Parameters ( )

inline

Modify the parameters.

Definition at line 83 of file concatenate.hpp.

serialize()

void serialize ( Archive &  , const uint32_t    )

inline

Serialize the layer.

Definition at line 104 of file concatenate.hpp.

---

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

• /home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/ann/layer/concatenate.hpp