Implementation of the Padding module class. More...

Public Member Functions
	Padding (const size_t padWLeft=0, const size_t padWRight=0, const size_t padHTop=0, const size_t padHBottom=0, const size_t inputWidth=0, const size_t inputHeight=0)
	Create the Padding object using the specified number of output units. More...

template < typename eT >
void	Backward (const arma::Mat< eT > &, const 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 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...

size_t	InputHeight () const
	Get the input height. More...

size_t &	InputHeight ()
	Modify the input height. More...

size_t	InputWidth () const
	Get the input width. More...

size_t &	InputWidth ()
	Modify the input width. More...

size_t	OutputHeight () const
	Get the output height. More...

size_t &	OutputHeight ()
	Modify the output height. More...

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

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

size_t	OutputWidth () const
	Get the output width. More...

size_t &	OutputWidth ()
	Modify the output width. More...

size_t	PadHBottom () const
	Get the bottom padding width. More...

size_t &	PadHBottom ()
	Modify the bottom padding width. More...

size_t	PadHTop () const
	Get the top padding width. More...

size_t &	PadHTop ()
	Modify the top padding width. More...

size_t	PadWLeft () const
	Get the left padding width. More...

size_t &	PadWLeft ()
	Modify the left padding width. More...

size_t	PadWRight () const
	Get the right padding width. More...

size_t &	PadWRight ()
	Modify the right padding width. 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::Padding< InputDataType, OutputDataType >

Implementation of the Padding module class.

The Padding module applies a bias term to the incoming data.

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 89 of file layer_types.hpp.

Constructor & Destructor Documentation

◆ Padding()

Padding	(	const size_t	padWLeft = `0`,
		const size_t	padWRight = `0`,
		const size_t	padHTop = `0`,
		const size_t	padHBottom = `0`,
		const size_t	inputWidth = `0`,
		const size_t	inputHeight = `0`
	)

Create the Padding object using the specified number of output units.

Parameters

padWLeft	Left padding width of the input.
padWRight	Right padding width of the input.
padHTop	Top padding height of the input.
padHBottom	Bottom padding height of the input.
inputWidth	Width of the input.
inputHeight	Height of the input.

Member Function Documentation

◆ Backward()

void Backward	(	const arma::Mat< eT > &	,
		const 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 84 of file padding.hpp.

◆ Delta() [2/2]

OutputDataType& Delta ( )

inline

Modify the delta.

Definition at line 86 of file padding.hpp.

◆ Forward()

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.

Parameters

input	Input data used for evaluating the specified function.
output	Resulting output activation.

◆ InputHeight() [1/2]

size_t InputHeight ( ) const

inline

Get the input height.

Definition at line 114 of file padding.hpp.

◆ InputHeight() [2/2]

size_t& InputHeight ( )

inline

Modify the input height.

Definition at line 116 of file padding.hpp.

◆ InputWidth() [1/2]

size_t InputWidth ( ) const

inline

Get the input width.

Definition at line 109 of file padding.hpp.

◆ InputWidth() [2/2]

size_t& InputWidth ( )

inline

Modify the input width.

Definition at line 111 of file padding.hpp.

◆ OutputHeight() [1/2]

size_t OutputHeight ( ) const

inline

Get the output height.

Definition at line 124 of file padding.hpp.

◆ OutputHeight() [2/2]

size_t& OutputHeight ( )

inline

Modify the output height.

Definition at line 126 of file padding.hpp.

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

◆ OutputParameter() [1/2]

OutputDataType const& OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 79 of file padding.hpp.

◆ OutputParameter() [2/2]

OutputDataType& OutputParameter ( )

inline

Modify the output parameter.

Definition at line 81 of file padding.hpp.

◆ OutputWidth() [1/2]

size_t OutputWidth ( ) const

inline

Get the output width.

Definition at line 119 of file padding.hpp.

◆ OutputWidth() [2/2]

size_t& OutputWidth ( )

inline

Modify the output width.

Definition at line 121 of file padding.hpp.

◆ PadHBottom() [1/2]

size_t PadHBottom ( ) const

inline

Get the bottom padding width.

Definition at line 104 of file padding.hpp.

◆ PadHBottom() [2/2]

size_t& PadHBottom ( )

inline

Modify the bottom padding width.

Definition at line 106 of file padding.hpp.

◆ PadHTop() [1/2]

size_t PadHTop ( ) const

inline

Get the top padding width.

Definition at line 99 of file padding.hpp.

◆ PadHTop() [2/2]

size_t& PadHTop ( )

inline

Modify the top padding width.

Definition at line 101 of file padding.hpp.

◆ PadWLeft() [1/2]

size_t PadWLeft ( ) const

inline

Get the left padding width.

Definition at line 89 of file padding.hpp.

◆ PadWLeft() [2/2]

size_t& PadWLeft ( )

inline

Modify the left padding width.

Definition at line 91 of file padding.hpp.

◆ PadWRight() [1/2]

size_t PadWRight ( ) const

inline

Get the right padding width.

Definition at line 94 of file padding.hpp.

◆ PadWRight() [2/2]

size_t& PadWRight ( )

inline

Modify the right padding width.

Definition at line 96 of file padding.hpp.

◆ serialize()

void serialize	(	Archive &	ar,
		const uint32_t
	)

Serialize the layer.

Referenced by Padding< InputDataType, OutputDataType >::OutputHeight().

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

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

Public Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ Padding()

Member Function Documentation

◆ Backward()

◆ Delta() [1/2]

◆ Delta() [2/2]

◆ Forward()

◆ InputHeight() [1/2]

◆ InputHeight() [2/2]

◆ InputWidth() [1/2]

◆ InputWidth() [2/2]

◆ OutputHeight() [1/2]

◆ OutputHeight() [2/2]

◆ OutputParameter() [1/2]

◆ OutputParameter() [2/2]

◆ OutputWidth() [1/2]

◆ OutputWidth() [2/2]

◆ PadHBottom() [1/2]

◆ PadHBottom() [2/2]

◆ PadHTop() [1/2]

◆ PadHTop() [2/2]

◆ PadWLeft() [1/2]

◆ PadWLeft() [2/2]

◆ PadWRight() [1/2]

◆ PadWRight() [2/2]

◆ serialize()

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

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