LpPooling< InputDataType, OutputDataType > Class Template Reference

Implementation of the LPPooling. More...

Public Member Functions

 LpPooling ()
 Create the LpPooling object. More...

 
 LpPooling (const size_t normType, const size_t kernelWidth, const size_t kernelHeight, const size_t strideWidth=1, const size_t strideHeight=1, const bool floor=true)
 Create the LpPooling object using the specified number of 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, using 3rd-order tensors as input, 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...

 
bool const & Floor () const
 Get the value of the rounding operation. More...

 
bool & Floor ()
 Modify the value of the rounding operation. 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 const & InputHeight () const
 Get the input height. More...

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

 
size_t InputSize () const
 Get the input size. More...

 
size_t const & InputWidth () const
 Get the intput width. More...

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

 
size_t KernelHeight () const
 Get the kernel height. More...

 
size_t & KernelHeight ()
 Modify the kernel height. More...

 
size_t KernelWidth () const
 Get the kernel width. More...

 
size_t & KernelWidth ()
 Modify the kernel width. More...

 
size_t NormType () const
 Get the normType. More...

 
size_t & NormType ()
 Modify the normType. More...

 
size_t const & 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 OutputSize () const
 Get the output size. More...

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

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

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

 
size_t StrideHeight () const
 Get the stride height. More...

 
size_t & StrideHeight ()
 Modify the stride height. More...

 
size_t StrideWidth () const
 Get the stride width. More...

 
size_t & StrideWidth ()
 Modify the stride width. More...

 
size_t WeightSize () const
 Get the size of the weights. More...

 

Detailed Description


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

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

Implementation of the LPPooling.

Template Parameters
InputDataTypeType of the input data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).
OutputDataTypeType of the output data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).

Definition at line 32 of file lp_pooling.hpp.

Constructor & Destructor Documentation

◆ LpPooling() [1/2]

LpPooling ( )

Create the LpPooling object.

◆ LpPooling() [2/2]

LpPooling ( const size_t  normType,
const size_t  kernelWidth,
const size_t  kernelHeight,
const size_t  strideWidth = 1,
const size_t  strideHeight = 1,
const bool  floor = true 
)

Create the LpPooling object using the specified number of units.

Parameters
normTypeParameter for type of norm.
kernelWidthWidth of the pooling window.
kernelHeightHeight of the pooling window.
strideWidthWidth of the stride operation.
strideHeightWidth of the stride operation.
floorSet to true to use floor method.

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, using 3rd-order tensors as input, calculating the function f(x) by propagating x backwards through f.

Using the results from the feed forward pass.

Parameters
*(input) The propagated input activation.
gyThe backpropagated error.
gThe calculated gradient.

◆ Delta() [1/2]

OutputDataType const& Delta ( ) const
inline

Get the delta.

Definition at line 85 of file lp_pooling.hpp.

◆ Delta() [2/2]

OutputDataType& Delta ( )
inline

Modify the delta.

Definition at line 87 of file lp_pooling.hpp.

◆ Floor() [1/2]

bool const& Floor ( ) const
inline

Get the value of the rounding operation.

Definition at line 141 of file lp_pooling.hpp.

◆ Floor() [2/2]

bool& Floor ( )
inline

Modify the value of the rounding operation.

Definition at line 143 of file lp_pooling.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
inputInput data used for evaluating the specified function.
outputResulting output activation.

◆ InputHeight() [1/2]

size_t const& InputHeight ( ) const
inline

Get the input height.

Definition at line 95 of file lp_pooling.hpp.

◆ InputHeight() [2/2]

size_t& InputHeight ( )
inline

Modify the input height.

Definition at line 97 of file lp_pooling.hpp.

◆ InputSize()

size_t InputSize ( ) const
inline

Get the input size.

Definition at line 110 of file lp_pooling.hpp.

◆ InputWidth() [1/2]

size_t const& InputWidth ( ) const
inline

Get the intput width.

Definition at line 90 of file lp_pooling.hpp.

◆ InputWidth() [2/2]

size_t& InputWidth ( )
inline

Modify the input width.

Definition at line 92 of file lp_pooling.hpp.

◆ KernelHeight() [1/2]

size_t KernelHeight ( ) const
inline

Get the kernel height.

Definition at line 126 of file lp_pooling.hpp.

◆ KernelHeight() [2/2]

size_t& KernelHeight ( )
inline

Modify the kernel height.

Definition at line 128 of file lp_pooling.hpp.

◆ KernelWidth() [1/2]

size_t KernelWidth ( ) const
inline

Get the kernel width.

Definition at line 121 of file lp_pooling.hpp.

◆ KernelWidth() [2/2]

size_t& KernelWidth ( )
inline

Modify the kernel width.

Definition at line 123 of file lp_pooling.hpp.

◆ NormType() [1/2]

size_t NormType ( ) const
inline

Get the normType.

Definition at line 116 of file lp_pooling.hpp.

◆ NormType() [2/2]

size_t& NormType ( )
inline

Modify the normType.

Definition at line 118 of file lp_pooling.hpp.

◆ OutputHeight() [1/2]

size_t const& OutputHeight ( ) const
inline

Get the output height.

Definition at line 105 of file lp_pooling.hpp.

◆ OutputHeight() [2/2]

size_t& OutputHeight ( )
inline

Modify the output height.

Definition at line 107 of file lp_pooling.hpp.

◆ OutputParameter() [1/2]

OutputDataType const& OutputParameter ( ) const
inline

Get the output parameter.

Definition at line 80 of file lp_pooling.hpp.

◆ OutputParameter() [2/2]

OutputDataType& OutputParameter ( )
inline

Modify the output parameter.

Definition at line 82 of file lp_pooling.hpp.

◆ OutputSize()

size_t OutputSize ( ) const
inline

Get the output size.

Definition at line 113 of file lp_pooling.hpp.

◆ OutputWidth() [1/2]

size_t const& OutputWidth ( ) const
inline

Get the output width.

Definition at line 100 of file lp_pooling.hpp.

◆ OutputWidth() [2/2]

size_t& OutputWidth ( )
inline

Modify the output width.

Definition at line 102 of file lp_pooling.hpp.

◆ serialize()

void serialize ( Archive &  ar,
const uint32_t   
)

Serialize the layer.

Referenced by LpPooling< InputDataType, OutputDataType >::WeightSize().

◆ StrideHeight() [1/2]

size_t StrideHeight ( ) const
inline

Get the stride height.

Definition at line 136 of file lp_pooling.hpp.

◆ StrideHeight() [2/2]

size_t& StrideHeight ( )
inline

Modify the stride height.

Definition at line 138 of file lp_pooling.hpp.

◆ StrideWidth() [1/2]

size_t StrideWidth ( ) const
inline

Get the stride width.

Definition at line 131 of file lp_pooling.hpp.

◆ StrideWidth() [2/2]

size_t& StrideWidth ( )
inline

Modify the stride width.

Definition at line 133 of file lp_pooling.hpp.

◆ WeightSize()

size_t WeightSize ( ) const
inline

Get the size of the weights.

Definition at line 146 of file lp_pooling.hpp.

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


The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-git/src/mlpack/methods/ann/layer/lp_pooling.hpp