AddMerge< InputDataType, OutputDataType, CustomLayers > Class Template Reference

Implementation of the AddMerge module class. More...

Public Member Functions
	AddMerge (const bool model=false)
	Create the AddMerge object using the specified parameters. More...
	~AddMerge ()
	Destructor to release allocated memory. More...
void	Add (LayerTypes< CustomLayers... > layer)
template < typename LayerType >
void	Add (const LayerType &layer)
template<class LayerType , class... Args>
void	Add (Args... args)
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 InputType , typename OutputType >
void	Forward (const InputType &&, OutputType &&output)
	Ordinary feed forward pass of a neural network, evaluating the function f(x) by propagating the activity forward through f. More...
InputDataType const &	InputParameter () const
	Get the input parameter. More...
InputDataType &	InputParameter ()
	Modify the input parameter. More...
std::vector< LayerTypes< CustomLayers... > > &	Model ()
	Return the model modules. More...
OutputDataType const &	OutputParameter () const
	Get the output parameter. More...
OutputDataType &	OutputParameter ()
	Modify the output parameter. 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, typename... CustomLayers>
class mlpack::ann::AddMerge< InputDataType, OutputDataType, CustomLayers >

Implementation of the AddMerge module class.

The AddMerge class accumulates the output of various modules.

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).
CustomLayers	Additional custom layers that can be added.

Definition at line 42 of file add_merge.hpp.

Constructor & Destructor Documentation

AddMerge()

AddMerge

(

const bool

model = false

)

Create the AddMerge object using the specified parameters.

Parameters

model

Expose the all network modules.

~AddMerge()

~AddMerge

(

)

Destructor to release allocated memory.

Member Function Documentation

Add() [1/3]

void Add ( LayerTypes< CustomLayers... >  layer )

inline

Definition at line 84 of file add_merge.hpp.

Add() [2/3]

void Add ( const LayerType &  layer )

inline

Definition at line 92 of file add_merge.hpp.

Add() [3/3]

void Add ( Args...  args )

inline

Definition at line 100 of file add_merge.hpp.

Backward()

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.

Using the results from the feed forward pass.

Parameters

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

Delta() [1/2]

OutputDataType const& Delta ( ) const

inline

Get the delta.

Definition at line 113 of file add_merge.hpp.

Delta() [2/2]

OutputDataType& Delta ( )

inline

Modify the delta.

Definition at line 115 of file add_merge.hpp.

Forward()

void Forward	(	const InputType &&	,
		OutputType &&	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.

InputParameter() [1/2]

InputDataType const& InputParameter ( ) const

inline

Get the input parameter.

Definition at line 103 of file add_merge.hpp.

InputParameter() [2/2]

InputDataType& InputParameter ( )

inline

Modify the input parameter.

Definition at line 105 of file add_merge.hpp.

Model()

std::vector<LayerTypes<CustomLayers...> >& Model ( )

inline

Return the model modules.

Definition at line 118 of file add_merge.hpp.

References AddMerge< InputDataType, OutputDataType, CustomLayers >::serialize().

OutputParameter() [1/2]

OutputDataType const& OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 108 of file add_merge.hpp.

OutputParameter() [2/2]

OutputDataType& OutputParameter ( )

inline

Modify the output parameter.

Definition at line 110 of file add_merge.hpp.

serialize()

void serialize	(	Archive &	ar,
		const unsigned	int
	)

Serialize the layer.

Referenced by AddMerge< InputDataType, OutputDataType, CustomLayers >::Model().

---

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

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