MaxPooling< InputDataType, OutputDataType > Class Template Reference

Implementation of the MaxPooling layer. More...

Public Member Functions

 MaxPooling ()
 Create the MaxPooling object. More...

 
 MaxPooling (const size_t kernelWidth, const size_t kernelHeight, const size_t strideWidth=1, const size_t strideHeight=1, const bool floor=true)
 Create the MaxPooling 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...

 
const OutputDataType & Delta () const
 Get the delta. More...

 
OutputDataType & Delta ()
 Modify the delta. More...

 
bool Deterministic () const
 Get the value of the deterministic parameter. More...

 
bool & Deterministic ()
 Modify the value of the deterministic parameter. More...

 
bool 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 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 InputWidth () const
 Get the input 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 OutputHeight () const
 Get the output height. More...

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

 
const OutputDataType & 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 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::MaxPooling< InputDataType, OutputDataType >

Implementation of the MaxPooling layer.

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 52 of file max_pooling.hpp.

Constructor & Destructor Documentation

◆ MaxPooling() [1/2]

Create the MaxPooling object.

◆ MaxPooling() [2/2]

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

Create the MaxPooling object using the specified number of units.

Parameters
kernelWidthWidth of the pooling window.
kernelHeightHeight of the pooling window.
strideWidthWidth of the stride operation.
strideHeightWidth of the stride operation.
floorRounding operator (floor or ceil).

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]

const OutputDataType& Delta ( ) const
inline

Get the delta.

Definition at line 103 of file max_pooling.hpp.

◆ Delta() [2/2]

OutputDataType& Delta ( )
inline

Modify the delta.

Definition at line 105 of file max_pooling.hpp.

◆ Deterministic() [1/2]

bool Deterministic ( ) const
inline

Get the value of the deterministic parameter.

Definition at line 159 of file max_pooling.hpp.

◆ Deterministic() [2/2]

bool& Deterministic ( )
inline

Modify the value of the deterministic parameter.

Definition at line 161 of file max_pooling.hpp.

◆ Floor() [1/2]

bool Floor ( ) const
inline

Get the value of the rounding operation.

Definition at line 154 of file max_pooling.hpp.

◆ Floor() [2/2]

bool& Floor ( )
inline

Modify the value of the rounding operation.

Definition at line 156 of file max_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 InputHeight ( ) const
inline

Get the input height.

Definition at line 113 of file max_pooling.hpp.

◆ InputHeight() [2/2]

size_t& InputHeight ( )
inline

Modify the input height.

Definition at line 115 of file max_pooling.hpp.

◆ InputSize()

size_t InputSize ( ) const
inline

Get the input size.

Definition at line 128 of file max_pooling.hpp.

◆ InputWidth() [1/2]

size_t InputWidth ( ) const
inline

Get the input width.

Definition at line 108 of file max_pooling.hpp.

◆ InputWidth() [2/2]

size_t& InputWidth ( )
inline

Modify the input width.

Definition at line 110 of file max_pooling.hpp.

◆ KernelHeight() [1/2]

size_t KernelHeight ( ) const
inline

Get the kernel height.

Definition at line 139 of file max_pooling.hpp.

◆ KernelHeight() [2/2]

size_t& KernelHeight ( )
inline

Modify the kernel height.

Definition at line 141 of file max_pooling.hpp.

◆ KernelWidth() [1/2]

size_t KernelWidth ( ) const
inline

Get the kernel width.

Definition at line 134 of file max_pooling.hpp.

◆ KernelWidth() [2/2]

size_t& KernelWidth ( )
inline

Modify the kernel width.

Definition at line 136 of file max_pooling.hpp.

◆ OutputHeight() [1/2]

size_t OutputHeight ( ) const
inline

Get the output height.

Definition at line 123 of file max_pooling.hpp.

◆ OutputHeight() [2/2]

size_t& OutputHeight ( )
inline

Modify the output height.

Definition at line 125 of file max_pooling.hpp.

◆ OutputParameter() [1/2]

const OutputDataType& OutputParameter ( ) const
inline

Get the output parameter.

Definition at line 98 of file max_pooling.hpp.

◆ OutputParameter() [2/2]

OutputDataType& OutputParameter ( )
inline

Modify the output parameter.

Definition at line 100 of file max_pooling.hpp.

◆ OutputSize()

size_t OutputSize ( ) const
inline

Get the output size.

Definition at line 131 of file max_pooling.hpp.

◆ OutputWidth() [1/2]

size_t OutputWidth ( ) const
inline

Get the output width.

Definition at line 118 of file max_pooling.hpp.

◆ OutputWidth() [2/2]

size_t& OutputWidth ( )
inline

Modify the output width.

Definition at line 120 of file max_pooling.hpp.

◆ serialize()

void serialize ( Archive &  ar,
const uint32_t   
)

Serialize the layer.

◆ StrideHeight() [1/2]

size_t StrideHeight ( ) const
inline

Get the stride height.

Definition at line 149 of file max_pooling.hpp.

◆ StrideHeight() [2/2]

size_t& StrideHeight ( )
inline

Modify the stride height.

Definition at line 151 of file max_pooling.hpp.

◆ StrideWidth() [1/2]

size_t StrideWidth ( ) const
inline

Get the stride width.

Definition at line 144 of file max_pooling.hpp.

◆ StrideWidth() [2/2]

size_t& StrideWidth ( )
inline

Modify the stride width.

Definition at line 146 of file max_pooling.hpp.

◆ WeightSize()

size_t WeightSize ( ) const
inline

Get the size of the weights.

Definition at line 164 of file max_pooling.hpp.


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