AddMerge< InputDataType, OutputDataType, CustomLayers > Class Template Reference

Implementation of the AddMerge module class. More...

Public Member Functions
	AddMerge (const bool model=false, const bool run=true)
	Create the AddMerge object using the specified parameters. More...
	~AddMerge ()
	Destructor to release allocated memory. More...
template<class LayerType , class... Args>
void	Add (Args...args)
void	Add (LayerTypes< CustomLayers...> 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, calculating the function f(x) by propagating x backwards trough f. More...
template<typename eT >
void	Backward (const arma::Mat< eT > &&, arma::Mat< eT > &&gy, arma::Mat< eT > &&g, const size_t index)
	This is the overload of Backward() that runs only a specific layer with the given input. More...
OutputDataType const &	Delta () const
	Get the delta. More...
OutputDataType &	Delta ()
	Modify the delta. More...
template<typename InputType , typename OutputType >
void	Forward (InputType &&, OutputType &&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 > &&input, arma::Mat< eT > &&error, arma::Mat< eT > &&gradient)
template<typename eT >
void	Gradient (arma::Mat< eT > &&input, arma::Mat< eT > &&error, arma::Mat< eT > &&gradient, const size_t index)
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...
OutputDataType const &	Parameters () const
	Get the parameters. More...
OutputDataType &	Parameters ()
	Modify the parameters. More...
bool	Run () const
	Get the value of run parameter. More...
bool &	Run ()
	Modify the value of run 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	(	const bool	model = false,
		const bool	run = true
	)

Create the AddMerge object using the specified parameters.

Parameters

model	Expose all the network modules.
run	Call the Forward/Backward method before the output is merged.

~AddMerge

(

)

Destructor to release allocated memory.

Member Function Documentation

void Add ( Args...  args )

inline

Definition at line 128 of file add_merge.hpp.

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

inline

Definition at line 135 of file add_merge.hpp.

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.

void Backward	(	const arma::Mat< eT > &&	,
		arma::Mat< eT > &&	gy,
		arma::Mat< eT > &&	g,
		const size_t	index
	)

This is the overload of Backward() that runs only a specific layer with the given input.

Parameters

input	The propagated input activation.
gy	The backpropagated error.
g	The calculated gradient.
The	index of the layer to run.

OutputDataType const& Delta ( ) const

inline

Get the delta.

Definition at line 148 of file add_merge.hpp.

OutputDataType& Delta ( )

inline

Modify the delta.

Definition at line 150 of file add_merge.hpp.

void Forward	(	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.

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

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

InputDataType const& InputParameter ( ) const

inline

Get the input parameter.

Definition at line 138 of file add_merge.hpp.

InputDataType& InputParameter ( )

inline

Modify the input parameter.

Definition at line 140 of file add_merge.hpp.

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

inline

Return the model modules.

Definition at line 153 of file add_merge.hpp.

OutputDataType const& OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 143 of file add_merge.hpp.

OutputDataType& OutputParameter ( )

inline

Modify the output parameter.

Definition at line 145 of file add_merge.hpp.

OutputDataType const& Parameters ( ) const

inline

Get the parameters.

Definition at line 164 of file add_merge.hpp.

OutputDataType& Parameters ( )

inline

Modify the parameters.

Definition at line 166 of file add_merge.hpp.

bool Run ( ) const

inline

Get the value of run parameter.

Definition at line 169 of file add_merge.hpp.

bool& Run ( )

inline

Modify the value of run parameter.

Definition at line 171 of file add_merge.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/add_merge.hpp