Definition and Implementation of the Nearest Interpolation Layer. More...

Public Member Functions
	NearestInterpolation ()
	Create the NearestInterpolation object. More...

	NearestInterpolation (const size_t inRowSize, const size_t inColSize, const size_t outRowSize, const size_t outColSize, const size_t depth)
	The constructor for the NearestInterpolation. More...

template < typename eT >
void	Backward (const arma::Mat< eT > &, const arma::Mat< eT > &gradient, arma::Mat< eT > &output)
	Ordinary feed backward pass of a neural network, calculating the function f(x) by propagating x backwards through f. More...

OutputDataType const &	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)
	Forward pass through the layer. More...

size_t const &	InColSize () const
	Get the column size of the input. More...

size_t &	InColSize ()
	Modify the column size of the input. More...

size_t const &	InDepth () const
	Get the depth of the input. More...

size_t &	InDepth ()
	Modify the depth of the input. More...

size_t	InputShape () const
	Get the shape of the input. More...

size_t const &	InRowSize () const
	Get the row size of the input. More...

size_t &	InRowSize ()
	Modify the row size of the input. More...

size_t const &	OutColSize () const
	Get the column size of the output. More...

size_t &	OutColSize ()
	Modify the column size of the output. More...

OutputDataType const &	OutputParameter () const
	Get the output parameter. More...

OutputDataType &	OutputParameter ()
	Modify the output parameter. More...

size_t const &	OutRowSize () const
	Get the row size of the output. More...

size_t &	OutRowSize ()
	Modify the row size of the output. More...

template < typename Archive >
void	serialize (Archive &ar, const uint32_t)
	Serialize the layer. More...

Detailed Description

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

class mlpack::ann::NearestInterpolation< InputDataType, OutputDataType >

Definition and Implementation of the Nearest Interpolation Layer.

Nearest interpolation is an mathematical technique, primarily used for scaling purposes. The input should be a 2D matrix and it can have a number of channels/units.

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 34 of file nearest_interpolation.hpp.

Constructor & Destructor Documentation

◆ NearestInterpolation() [1/2]

NearestInterpolation ( )

Create the NearestInterpolation object.

◆ NearestInterpolation() [2/2]

NearestInterpolation	(	const size_t	inRowSize,
		const size_t	inColSize,
		const size_t	outRowSize,
		const size_t	outColSize,
		const size_t	depth
	)

The constructor for the NearestInterpolation.

Parameters

inRowSize	Number of input rows.
inColSize	Number of input columns.
outRowSize	Number of output rows.
outColSize	Number of output columns.
depth	Number of input slices.

Member Function Documentation

◆ Backward()

void Backward	(	const arma::Mat< eT > &	,
		const arma::Mat< eT > &	gradient,
		arma::Mat< eT > &	output
	)

Ordinary feed backward pass of a neural network, calculating the function f(x) by propagating x backwards through f.

Using the results from the feed forward pass. Since the layer does not have any learn-able parameters, we just have to down-sample the gradient to make its size compatible with the input size.

Parameters

*	(input) The input matrix.
gradient	The computed backward gradient.
output	The resulting down-sampled output.

◆ Delta() [1/2]

OutputDataType const& Delta ( ) const

inline

Get the delta.

Definition at line 87 of file nearest_interpolation.hpp.

◆ Delta() [2/2]

OutputDataType& Delta ( )

inline

Modify the delta.

Definition at line 89 of file nearest_interpolation.hpp.

◆ Forward()

void Forward	(	const arma::Mat< eT > &	input,
		arma::Mat< eT > &	output
	)

Forward pass through the layer.

The layer interpolates the matrix using the given Nearest Interpolation method.

Parameters

input	The input matrix.
output	The resulting interpolated output matrix.

◆ InColSize() [1/2]

size_t const& InColSize ( ) const

inline

Get the column size of the input.

Definition at line 97 of file nearest_interpolation.hpp.

◆ InColSize() [2/2]

size_t& InColSize ( )

inline

Modify the column size of the input.

Definition at line 99 of file nearest_interpolation.hpp.

◆ InDepth() [1/2]

size_t const& InDepth ( ) const

inline

Get the depth of the input.

Definition at line 112 of file nearest_interpolation.hpp.

◆ InDepth() [2/2]

size_t& InDepth ( )

inline

Modify the depth of the input.

Definition at line 114 of file nearest_interpolation.hpp.

◆ InputShape()

size_t InputShape ( ) const

inline

Get the shape of the input.

Definition at line 117 of file nearest_interpolation.hpp.

References NearestInterpolation< InputDataType, OutputDataType >::serialize().

◆ InRowSize() [1/2]

size_t const& InRowSize ( ) const

inline

Get the row size of the input.

Definition at line 92 of file nearest_interpolation.hpp.

◆ InRowSize() [2/2]

size_t& InRowSize ( )

inline

Modify the row size of the input.

Definition at line 94 of file nearest_interpolation.hpp.

◆ OutColSize() [1/2]

size_t const& OutColSize ( ) const

inline

Get the column size of the output.

Definition at line 107 of file nearest_interpolation.hpp.

◆ OutColSize() [2/2]

size_t& OutColSize ( )

inline

Modify the column size of the output.

Definition at line 109 of file nearest_interpolation.hpp.

◆ OutputParameter() [1/2]

OutputDataType const& OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 82 of file nearest_interpolation.hpp.

◆ OutputParameter() [2/2]

OutputDataType& OutputParameter ( )

inline

Modify the output parameter.

Definition at line 84 of file nearest_interpolation.hpp.

◆ OutRowSize() [1/2]

size_t const& OutRowSize ( ) const

inline

Get the row size of the output.

Definition at line 102 of file nearest_interpolation.hpp.

◆ OutRowSize() [2/2]

size_t& OutRowSize ( )

inline

Modify the row size of the output.

Definition at line 104 of file nearest_interpolation.hpp.

◆ serialize()

void serialize	(	Archive &	ar,
		const uint32_t
	)

Serialize the layer.

Referenced by NearestInterpolation< InputDataType, OutputDataType >::InputShape().

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

/home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/ann/layer/nearest_interpolation.hpp

Public Member Functions

Detailed Description

template<typenameInputDataType=arma::mat,typenameOutputDataType=arma::mat> class mlpack::ann::NearestInterpolation< InputDataType, OutputDataType >

Constructor & Destructor Documentation

◆ NearestInterpolation() [1/2]

◆ NearestInterpolation() [2/2]

Member Function Documentation

◆ Backward()

◆ Delta() [1/2]

◆ Delta() [2/2]

◆ Forward()

◆ InColSize() [1/2]

◆ InColSize() [2/2]

◆ InDepth() [1/2]

◆ InDepth() [2/2]

◆ InputShape()

◆ InRowSize() [1/2]

◆ InRowSize() [2/2]

◆ OutColSize() [1/2]

◆ OutColSize() [2/2]

◆ OutputParameter() [1/2]

◆ OutputParameter() [2/2]

◆ OutRowSize() [1/2]

◆ OutRowSize() [2/2]

◆ serialize()

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

class mlpack::ann::NearestInterpolation< InputDataType, OutputDataType >