Compute Library
 20.02.1
PadStrideInfo Class Reference

Padding and stride information class. More...

#include <Types.h>

Public Member Functions

 PadStrideInfo (unsigned int stride_x=1, unsigned int stride_y=1, unsigned int pad_x=0, unsigned int pad_y=0, DimensionRoundingType round=DimensionRoundingType::FLOOR)
 Constructor. More...
 
 PadStrideInfo (unsigned int stride_x, unsigned int stride_y, unsigned int pad_left, unsigned int pad_right, unsigned int pad_top, unsigned int pad_bottom, DimensionRoundingType round)
 Constructor. More...
 
std::pair< unsigned int, unsigned int > stride () const
 Get the stride. More...
 
bool padding_is_symmetric () const
 Check whether the padding is symmetric. More...
 
std::pair< unsigned int, unsigned int > pad () const
 Get the padding. More...
 
unsigned int pad_left () const
 Get the left padding. More...
 
unsigned int pad_right () const
 Get the right padding. More...
 
unsigned int pad_top () const
 Get the top padding. More...
 
unsigned int pad_bottom () const
 Get the bottom padding. More...
 
DimensionRoundingType round () const
 Get the rounding type. More...
 
bool has_padding () const
 Check whether this has any padding. More...
 

Detailed Description

Padding and stride information class.

Definition at line 686 of file Types.h.

Constructor & Destructor Documentation

◆ PadStrideInfo() [1/2]

PadStrideInfo ( unsigned int  stride_x = 1,
unsigned int  stride_y = 1,
unsigned int  pad_x = 0,
unsigned int  pad_y = 0,
DimensionRoundingType  round = DimensionRoundingType::FLOOR 
)
inline

Constructor.

Parameters
[in]stride_x(Optional) Stride, in elements, across x. Defaults to 1.
[in]stride_y(Optional) Stride, in elements, across y. Defaults to 1.
[in]pad_x(Optional) Padding, in elements, across x. Defaults to 0.
[in]pad_y(Optional) Padding, in elements, across y. Defaults to 0.
[in]round(Optional) Dimensions rounding. Defaults to FLOOR.

Definition at line 697 of file Types.h.

700  : _stride(std::make_pair(stride_x, stride_y)),
701  _pad_left(pad_x),
702  _pad_top(pad_y),
703  _pad_right(pad_x),
704  _pad_bottom(pad_y),
705  _round_type(round)
706  {
707  }
DimensionRoundingType round() const
Get the rounding type.
Definition: Types.h:781

◆ PadStrideInfo() [2/2]

PadStrideInfo ( unsigned int  stride_x,
unsigned int  stride_y,
unsigned int  pad_left,
unsigned int  pad_right,
unsigned int  pad_top,
unsigned int  pad_bottom,
DimensionRoundingType  round 
)
inline

Constructor.

Parameters
[in]stride_xStride, in elements, across x.
[in]stride_yStride, in elements, across y.
[in]pad_leftPadding across x on the left, in elements.
[in]pad_topPadding across y on the top, in elements.
[in]pad_rightPadding across x on the right, in elements.
[in]pad_bottomPadding across y on the bottom, in elements.
[in]roundDimensions rounding.

Definition at line 718 of file Types.h.

722  : _stride(std::make_pair(stride_x, stride_y)),
723  _pad_left(pad_left),
724  _pad_top(pad_top),
725  _pad_right(pad_right),
726  _pad_bottom(pad_bottom),
727  _round_type(round)
728  {
729  }
DimensionRoundingType round() const
Get the rounding type.
Definition: Types.h:781
unsigned int pad_top() const
Get the top padding.
Definition: Types.h:770
unsigned int pad_right() const
Get the right padding.
Definition: Types.h:765
unsigned int pad_bottom() const
Get the bottom padding.
Definition: Types.h:775
unsigned int pad_left() const
Get the left padding.
Definition: Types.h:760

Member Function Documentation

◆ has_padding()

bool has_padding ( ) const
inline

Check whether this has any padding.

Definition at line 787 of file Types.h.

788  {
789  return (_pad_left != 0 || _pad_top != 0 || _pad_right != 0 || _pad_bottom != 0);
790  }

◆ pad()

std::pair<unsigned int, unsigned int> pad ( ) const
inline

Get the padding.

Note
This should only be used when the padding is symmetric.
Returns
a pair: padding left/right, padding top/bottom

Definition at line 752 of file Types.h.

753  {
754  //this accessor should be used only when padding is symmetric
756  return std::make_pair(_pad_left, _pad_top);
757  }
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
bool padding_is_symmetric() const
Check whether the padding is symmetric.
Definition: Types.h:742

References ARM_COMPUTE_ERROR_ON, and PadStrideInfo::padding_is_symmetric().

Referenced by GCPoolingLayerKernel::configure(), and GCPoolingLayerKernel::run().

◆ pad_bottom()

◆ pad_left()

◆ pad_right()

◆ pad_top()

◆ padding_is_symmetric()

bool padding_is_symmetric ( ) const
inline

Check whether the padding is symmetric.

Returns
True if the padding is symmetric.

Definition at line 742 of file Types.h.

743  {
744  return (_pad_left == _pad_right) && (_pad_top == _pad_bottom);
745  }

Referenced by PadStrideInfo::pad().

◆ round()

DimensionRoundingType round ( ) const
inline

Get the rounding type.

Definition at line 781 of file Types.h.

782  {
783  return _round_type;
784  }

Referenced by arm_compute::scaled_dimensions().

◆ stride()


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