Public Member Functions | Protected Member Functions
InferenceEngine::BlockingDesc Class Reference

This class describes blocking layouts. More...

#include <ie_layouts.h>

Public Member Functions

  BlockingDesc ()
  The default constructor which creates empty blocking descriptor.
 
  BlockingDesc (const SizeVector &dims, Layout layout)
  The constructor which allows to create blocking descriptors for standard layouts. More...
 
  BlockingDesc (const SizeVector &blocked_dims, const SizeVector &order)
  The constructor allows to create blocking descriptors for blocked memory. More...
 
  BlockingDesc (const SizeVector &blocked_dims, const SizeVector &order, size_t offset)
  The constructor allows to create blocking descriptors for blocked memory. More...
 
  BlockingDesc (const SizeVector &blocked_dims, const SizeVector &order, size_t offset, SizeVector dimOffsets)
  The constructor allows to create blocking descriptors for blocked memory. More...
 
  BlockingDesc (const SizeVector &blocked_dims, const SizeVector &order, size_t offset, SizeVector dimOffsets, SizeVector strides)
  The constructor allows to create blocking descriptors for blocked memory. More...
 
virtual  ~BlockingDesc ()=default
  Destructor.
 
const SizeVector getBlockDims () const
  Returns the blocked dimensions vector. More...
 
const SizeVector getOrder () const
  Returns the vector of order. More...
 
const SizeVector getOffsetPaddingToData () const
  Returns the per-dimension offset vector. More...
 
size_t  getOffsetPadding () const
  Returns the offset to the current memory block. More...
 
const SizeVector getStrides () const
  Returns strides for each dimension. More...
 
bool  operator== (const BlockingDesc &rhs) const
  The comparison operator for the BlockingDesc. More...
 
bool  operator!= (const BlockingDesc &rhs) const
  The comparison operator for the BlockingDesc. More...
 

Protected Member Functions

void  fillDesc (const SizeVector &blocked_dims, const SizeVector &order)
 

Detailed Description

This class describes blocking layouts.

Constructor & Destructor Documentation

§ BlockingDesc() [1/5]

InferenceEngine::BlockingDesc::BlockingDesc ( const SizeVector dims,
Layout  layout 
)

The constructor which allows to create blocking descriptors for standard layouts.

Parameters
dims real dimensions
layout memory layout

§ BlockingDesc() [2/5]

InferenceEngine::BlockingDesc::BlockingDesc ( const SizeVector blocked_dims,
const SizeVector order 
)

The constructor allows to create blocking descriptors for blocked memory.

Parameters
blocked_dims blocked dimensions
order the order of dimensions

§ BlockingDesc() [3/5]

InferenceEngine::BlockingDesc::BlockingDesc ( const SizeVector blocked_dims,
const SizeVector order,
size_t  offset 
)

The constructor allows to create blocking descriptors for blocked memory.

Parameters
blocked_dims blocked dimensions
order the order of dimensions
offset offset to the current memory block

§ BlockingDesc() [4/5]

InferenceEngine::BlockingDesc::BlockingDesc ( const SizeVector blocked_dims,
const SizeVector order,
size_t  offset,
SizeVector  dimOffsets 
)

The constructor allows to create blocking descriptors for blocked memory.

Parameters
blocked_dims blocked dimensions
order the order of dimensions
offset offset to the current memory block
dimOffsets per-dimension offset from the padding to actual data,

§ BlockingDesc() [5/5]

InferenceEngine::BlockingDesc::BlockingDesc ( const SizeVector blocked_dims,
const SizeVector order,
size_t  offset,
SizeVector  dimOffsets,
SizeVector  strides 
)

The constructor allows to create blocking descriptors for blocked memory.

Parameters
blocked_dims blocked dimensions
order the order of dimensions
offset offset to the current memory block
dimOffsets per-dimension offset from the padding to actual data,
strides strides for each dimension

Member Function Documentation

§ getBlockDims()

const SizeVector& InferenceEngine::BlockingDesc::getBlockDims ( ) const
inline

Returns the blocked dimensions vector.

Returns
blocked dimensions

§ getOffsetPadding()

size_t InferenceEngine::BlockingDesc::getOffsetPadding ( ) const
inline

Returns the offset to the current memory block.

Returns
offset

§ getOffsetPaddingToData()

const SizeVector& InferenceEngine::BlockingDesc::getOffsetPaddingToData ( ) const
inline

Returns the per-dimension offset vector.

Returns
offsets

§ getOrder()

const SizeVector& InferenceEngine::BlockingDesc::getOrder ( ) const
inline

Returns the vector of order.

Returns
order

§ getStrides()

const SizeVector& InferenceEngine::BlockingDesc::getStrides ( ) const
inline

Returns strides for each dimension.

Returns
strides

§ operator!=()

bool InferenceEngine::BlockingDesc::operator!= ( const BlockingDesc rhs ) const

The comparison operator for the BlockingDesc.

Parameters
rhs object to compare
Returns
true if objects aren't equal

§ operator==()

bool InferenceEngine::BlockingDesc::operator== ( const BlockingDesc rhs ) const

The comparison operator for the BlockingDesc.

Parameters
rhs object to compare
Returns
true if objects are equal

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