The select module selects the specified column from a given input matrix. More...

Public Member Functions
	Select (const size_t index, const size_t elements=0)
	Create the Select 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 &	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...

InputDataType &	InputParameter () const
	Get the input parameter. More...

InputDataType &	InputParameter ()
	Modify the input parameter. More...

OutputDataType &	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...

size_t	elements
	Locally-stored number of elements selected. More...

size_t	index
	Locally-stored column index. More...

InputDataType	inputParameter
	Locally-stored input parameter object. More...

OutputDataType	outputParameter
	Locally-stored output parameter object. More...

Detailed Description

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

The select module selects the specified column from a given input 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 32 of file select.hpp.

Constructor & Destructor Documentation

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

mlpack::ann::Select< InputDataType, OutputDataType >::Select	(	const size_t	index,
		const size_t	elements = `0`
	)

Create the Select object.

Parameters

index	The column which should be extracted from the given input.
elements	The number of elements that should be used.

Member Function Documentation

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

template<typename eT >

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

inline

Get the delta.

Definition at line 78 of file select.hpp.

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

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

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

inline

Modify the delta.

Definition at line 80 of file select.hpp.

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

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

template<typename eT >

void mlpack::ann::Select< InputDataType, OutputDataType >::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.

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

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

inline

Get the input parameter.

Definition at line 68 of file select.hpp.

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

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

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

inline

Modify the input parameter.

Definition at line 70 of file select.hpp.

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

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

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

inline

Get the output parameter.

Definition at line 73 of file select.hpp.

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

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

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

inline

Modify the output parameter.

Definition at line 75 of file select.hpp.

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

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

template<typename Archive >

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

Serialize the layer.

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

Member Data Documentation

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

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

private

Locally-stored delta object.

Definition at line 96 of file select.hpp.

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

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

size_t mlpack::ann::Select< InputDataType, OutputDataType >::elements

private

Locally-stored number of elements selected.

Definition at line 93 of file select.hpp.

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

size_t mlpack::ann::Select< InputDataType, OutputDataType >::index

private

Locally-stored column index.

Definition at line 90 of file select.hpp.

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

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

private

Locally-stored input parameter object.

Definition at line 99 of file select.hpp.

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

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

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

private

Locally-stored output parameter object.

Definition at line 102 of file select.hpp.

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

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

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

Public Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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