Subview< InputDataType, OutputDataType > Class Template Reference

Implementation of the subview layer. More...

Public Member Functions

 Subview (const size_t inSize=1, const size_t beginRow=0, const size_t endRow=0, const size_t beginCol=0, const size_t endCol=0)
 Create the Subview layer object using the specified range of input to accept. More...

 
template
<
typename
eT
>
void Backward (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 const & Delta () const
 Get the delta. More...

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

 
template
<
typename
InputType
,
typename
OutputType
>
void Forward (InputType &&input, OutputType &&output)
 Ordinary feed forward pass of a neural network, evaluating the function f(x) by propagating the activity forward through f. More...

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

 

Detailed Description


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

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

Implementation of the subview layer.

The subview layer modifies the input to a submatrix of required size.

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

Constructor & Destructor Documentation

◆ Subview()

Subview ( const size_t  inSize = 1,
const size_t  beginRow = 0,
const size_t  endRow = 0,
const size_t  beginCol = 0,
const size_t  endCol = 0 
)
inline

Create the Subview layer object using the specified range of input to accept.

Parameters
inSizeWidth of sample.
beginRowStarting row index.
endRowEnding row index.
beginColStarting column index.
endColEnding column index.

Definition at line 47 of file subview.hpp.

Member Function Documentation

◆ Backward()

void Backward ( arma::Mat< eT > &&  ,
arma::Mat< eT > &&  gy,
arma::Mat< eT > &&  g 
)
inline

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
inputThe propagated input activation.
gyThe backpropagated error.
gThe calculated gradient.

Definition at line 115 of file subview.hpp.

◆ Delta() [1/2]

OutputDataType const& Delta ( ) const
inline

Get the delta.

Definition at line 128 of file subview.hpp.

◆ Delta() [2/2]

OutputDataType& Delta ( )
inline

Modify the delta.

Definition at line 130 of file subview.hpp.

◆ Forward()

void Forward ( InputType &&  input,
OutputType &&  output 
)
inline

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.

Definition at line 69 of file subview.hpp.

◆ OutputParameter() [1/2]

OutputDataType const& OutputParameter ( ) const
inline

Get the output parameter.

Definition at line 123 of file subview.hpp.

◆ OutputParameter() [2/2]

OutputDataType& OutputParameter ( )
inline

Modify the output parameter.

Definition at line 125 of file subview.hpp.

◆ serialize()

void serialize ( Archive &  ar,
const unsigned  int 
)
inline

Serialize the layer.

Definition at line 136 of file subview.hpp.


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