Implementation of the Concat class. More...

Public Member Functions
	Concat (const bool model=true, const bool same=true)
	Create the Concat object using the specified parameters. More...

template<class LayerType , class... Args>
void	Add (Args...args)

void	Add (LayerTypes layer)

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, using 3rd-order tensors as input, calculating the function f(x) by propagating x backwards through f. More...

arma::mat const &	Delta () const
	Get the delta.e. More...

arma::mat &	Delta ()
	Modify the delta. More...

template<typename eT >
void	Forward (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 (arma::Mat< eT > &&, arma::Mat< eT > &&error, arma::Mat< eT > &&)

arma::mat const &	Gradient () const
	Get the gradient. More...

arma::mat &	Gradient ()
	Modify the gradient. More...

arma::mat const &	InputParameter () const

arma::mat &	InputParameter ()
	Modify the input parameter. More...

std::vector< LayerTypes > &	Model ()
	Return the model modules. More...

arma::mat const &	OutputParameter () const
	Get the output parameter. More...

arma::mat &	OutputParameter ()
	Modify the output parameter. More...

const arma::mat &	Parameters () const
	Return the initial point for the optimization. More...

arma::mat &	Parameters ()
	Modify the initial point for the optimization. More...

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

Private Attributes
DeleteVisitor	deleteVisitor
	Locally-stored delete visitor. More...

arma::mat	delta
	Locally-stored delta object. More...

DeltaVisitor	deltaVisitor
	Locally-stored delta visitor. More...

std::vector< LayerTypes >	empty
	Locally-stored empty list of modules. More...

arma::mat	gradient
	Locally-stored gradient object. More...

arma::mat	inputParameter
	Locally-stored input parameter object. More...

bool	model
	Parameter which indicates if the modules should be exposed. More...

std::vector< LayerTypes >	network
	Locally-stored network modules. More...

arma::mat	outputParameter
	Locally-stored output parameter object. More...

OutputParameterVisitor	outputParameterVisitor
	Locally-stored output parameter visitor. More...

arma::mat	parameters
	Locally-stored model parameters. More...

bool	same
	If true merge the error in the backward pass. More...

Detailed Description

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

Implementation of the Concat class.

The Concat class works as a feed-forward fully connected network container which plugs various layers together.

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 42 of file concat.hpp.

Constructor & Destructor Documentation

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

mlpack::ann::Concat< InputDataType, OutputDataType >::Concat	(	const bool	model = `true`,
		const bool	same = `true`
	)

Create the Concat object using the specified parameters.

Parameters

model	Expose all network modules.
same	Merge the error in the backward pass.

Member Function Documentation

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

template<class LayerType , class... Args>

void mlpack::ann::Concat< InputDataType, OutputDataType >::Add ( Args... args )

inline

Definition at line 95 of file concat.hpp.

References mlpack::ann::Concat< InputDataType, OutputDataType >::network.

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

void mlpack::ann::Concat< InputDataType, OutputDataType >::Add ( LayerTypes layer )

inline

Definition at line 102 of file concat.hpp.

References mlpack::ann::Concat< InputDataType, OutputDataType >::network.

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

template<typename eT >

void mlpack::ann::Concat< InputDataType, OutputDataType >::Backward	(	const arma::Mat< eT > &&	,
		arma::Mat< eT > &&	gy,
		arma::Mat< eT > &&	g
	)

Ordinary feed backward pass of a neural network, using 3rd-order tensors as input, calculating the function f(x) by propagating x backwards through 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>

arma::mat const& mlpack::ann::Concat< InputDataType, OutputDataType >::Delta ( ) const

inline

Get the delta.e.

Definition at line 130 of file concat.hpp.

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

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

arma::mat& mlpack::ann::Concat< InputDataType, OutputDataType >::Delta ( )

inline

Modify the delta.

Definition at line 132 of file concat.hpp.

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

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

template<typename eT >

void mlpack::ann::Concat< InputDataType, OutputDataType >::Forward	(	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::Concat< InputDataType, OutputDataType >::Gradient	(	arma::Mat< eT > &&	,
		arma::Mat< eT > &&	error,
		arma::Mat< eT > &&
	)

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

arma::mat const& mlpack::ann::Concat< InputDataType, OutputDataType >::Gradient ( ) const

inline

Get the gradient.

Definition at line 135 of file concat.hpp.

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

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

arma::mat& mlpack::ann::Concat< InputDataType, OutputDataType >::Gradient ( )

inline

Modify the gradient.

Definition at line 137 of file concat.hpp.

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

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

arma::mat const& mlpack::ann::Concat< InputDataType, OutputDataType >::InputParameter ( ) const

inline

Definition at line 120 of file concat.hpp.

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

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

arma::mat& mlpack::ann::Concat< InputDataType, OutputDataType >::InputParameter ( )

inline

Modify the input parameter.

Definition at line 122 of file concat.hpp.

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

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

std::vector<LayerTypes>& mlpack::ann::Concat< InputDataType, OutputDataType >::Model ( )

inline

Return the model modules.

Definition at line 105 of file concat.hpp.

References mlpack::ann::Concat< InputDataType, OutputDataType >::empty, mlpack::ann::Concat< InputDataType, OutputDataType >::model, and mlpack::ann::Concat< InputDataType, OutputDataType >::network.

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

arma::mat const& mlpack::ann::Concat< InputDataType, OutputDataType >::OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 125 of file concat.hpp.

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

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

arma::mat& mlpack::ann::Concat< InputDataType, OutputDataType >::OutputParameter ( )

inline

Modify the output parameter.

Definition at line 127 of file concat.hpp.

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

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

const arma::mat& mlpack::ann::Concat< InputDataType, OutputDataType >::Parameters ( ) const

inline

Return the initial point for the optimization.

Definition at line 116 of file concat.hpp.

References mlpack::ann::Concat< InputDataType, OutputDataType >::parameters.

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

arma::mat& mlpack::ann::Concat< InputDataType, OutputDataType >::Parameters ( )

inline

Modify the initial point for the optimization.

Definition at line 118 of file concat.hpp.

References mlpack::ann::Concat< InputDataType, OutputDataType >::parameters.

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

template<typename Archive >

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

Serialize the layer.

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

Member Data Documentation

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

DeleteVisitor mlpack::ann::Concat< InputDataType, OutputDataType >::deleteVisitor

private

Locally-stored delete visitor.

Definition at line 165 of file concat.hpp.

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

arma::mat mlpack::ann::Concat< InputDataType, OutputDataType >::delta

private

Locally-stored delta object.

Definition at line 171 of file concat.hpp.

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

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

DeltaVisitor mlpack::ann::Concat< InputDataType, OutputDataType >::deltaVisitor

private

Locally-stored delta visitor.

Definition at line 159 of file concat.hpp.

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

std::vector<LayerTypes> mlpack::ann::Concat< InputDataType, OutputDataType >::empty

private

Locally-stored empty list of modules.

Definition at line 168 of file concat.hpp.

Referenced by mlpack::ann::Concat< InputDataType, OutputDataType >::Model().

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

arma::mat mlpack::ann::Concat< InputDataType, OutputDataType >::gradient

private

Locally-stored gradient object.

Definition at line 180 of file concat.hpp.

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

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

arma::mat mlpack::ann::Concat< InputDataType, OutputDataType >::inputParameter

private

Locally-stored input parameter object.

Definition at line 174 of file concat.hpp.

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

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

bool mlpack::ann::Concat< InputDataType, OutputDataType >::model

private

Parameter which indicates if the modules should be exposed.

Definition at line 147 of file concat.hpp.

Referenced by mlpack::ann::Concat< InputDataType, OutputDataType >::Model().

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

std::vector<LayerTypes> mlpack::ann::Concat< InputDataType, OutputDataType >::network

private

Locally-stored network modules.

Definition at line 153 of file concat.hpp.

Referenced by mlpack::ann::Concat< InputDataType, OutputDataType >::Add(), and mlpack::ann::Concat< InputDataType, OutputDataType >::Model().

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

arma::mat mlpack::ann::Concat< InputDataType, OutputDataType >::outputParameter

private

Locally-stored output parameter object.

Definition at line 177 of file concat.hpp.

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

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

OutputParameterVisitor mlpack::ann::Concat< InputDataType, OutputDataType >::outputParameterVisitor

private

Locally-stored output parameter visitor.

Definition at line 162 of file concat.hpp.

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

arma::mat mlpack::ann::Concat< InputDataType, OutputDataType >::parameters

private

Locally-stored model parameters.

Definition at line 156 of file concat.hpp.

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

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

bool mlpack::ann::Concat< InputDataType, OutputDataType >::same

private

If true merge the error in the backward pass.

Definition at line 150 of file concat.hpp.

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

src/mlpack/methods/ann/layer/concat.hpp

Public Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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