mlpack::ann::Join< InputDataType, OutputDataType > Class Template Reference

Implementation of the Join module class. More...

Public Member Functions
	Join ()
	Create the Join object. 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 InputType , typename OutputType >
void	Forward (const InputType &&input, 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...
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...

Private Attributes
OutputDataType	delta
	Locally-stored delta object. More...
InputDataType	inputParameter
	Locally-stored input parameter object. More...
size_t	inSizeCols
	Locally-stored number of input cols. More...
size_t	inSizeRows
	Locally-stored number of input rows. More...
OutputDataType	outputParameter
	Locally-stored output parameter object. More...

Detailed Description

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

Implementation of the Join module class.

The Join 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).

Definition at line 33 of file join.hpp.

Constructor & Destructor Documentation

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

mlpack::ann::Join< InputDataType, OutputDataType >::Join

(

)

Create the Join object.

Member Function Documentation

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

template<typename eT >

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

inline

Get the delta.

Definition at line 74 of file join.hpp.

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

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

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

inline

Modify the delta.

Definition at line 76 of file join.hpp.

References mlpack::ann::Join< InputDataType, OutputDataType >::delta, and mlpack::ann::Join< InputDataType, OutputDataType >::Serialize().

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

template<typename InputType , typename OutputType >

void mlpack::ann::Join< InputDataType, OutputDataType >::Forward	(	const InputType &&	input,
		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.

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

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

inline

Get the input parameter.

Definition at line 64 of file join.hpp.

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

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

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

inline

Modify the input parameter.

Definition at line 66 of file join.hpp.

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

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

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

inline

Get the output parameter.

Definition at line 69 of file join.hpp.

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

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

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

inline

Modify the output parameter.

Definition at line 71 of file join.hpp.

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

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

template<typename Archive >

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

Serialize the layer.

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

Member Data Documentation

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

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

private

Locally-stored delta object.

Definition at line 92 of file join.hpp.

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

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

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

private

Locally-stored input parameter object.

Definition at line 95 of file join.hpp.

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

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

size_t mlpack::ann::Join< InputDataType, OutputDataType >::inSizeCols

private

Locally-stored number of input cols.

Definition at line 89 of file join.hpp.

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

size_t mlpack::ann::Join< InputDataType, OutputDataType >::inSizeRows

private

Locally-stored number of input rows.

Definition at line 86 of file join.hpp.

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

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

private

Locally-stored output parameter object.

Definition at line 98 of file join.hpp.

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

---

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

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