Public Types | Public Member Functions
InferenceEngine::Builder::PoolingLayer Class Reference

The class represents a builder for Pooling layer. More...

#include <ie_pooling_layer.hpp>

Inheritance diagram for InferenceEngine::Builder::PoolingLayer:
Inheritance graph
[legend]
Collaboration diagram for InferenceEngine::Builder::PoolingLayer:
Collaboration graph
[legend]

Public Types

enum  PoolingType { MAX = 1, AVG = 2 }
 The enum defines available pooling types.
 
enum  RoundingType { CEIL = 1, FLOOR = 2 }
 The enum defines available rounding types.
 

Public Member Functions

 PoolingLayer (const std::string &name="")
 The constructor creates a builder with the name. More...
 
 PoolingLayer (const Layer::Ptr &layer)
 The constructor creates a builder from generic builder. More...
 
 PoolingLayer (const Layer::CPtr &layer)
 The constructor creates a builder from generic builder. More...
 
 operator Layer () const override
 Operator creates generic layer builder. More...
 
PoolingLayersetName (const std::string &name)
 Sets the name for the layer. More...
 
const PortgetInputPort () const
 Returns input port. More...
 
PoolingLayersetInputPort (const Port &port)
 Sets input port. More...
 
const PortgetOutputPort () const
 Returns output port. More...
 
PoolingLayersetOutputPort (const Port &port)
 Sets output port. More...
 
const std::vector< size_t > getKernel () const
 Returns kernel size. More...
 
PoolingLayersetKernel (const std::vector< size_t > &kernel)
 Sets kernel size. More...
 
const std::vector< size_t > getStrides () const
 Returns vector of strides. More...
 
PoolingLayersetStrides (const std::vector< size_t > &strides)
 Sets strides. More...
 
const std::vector< size_t > getPaddingsBegin () const
 Returns begin paddings. More...
 
PoolingLayersetPaddingsBegin (const std::vector< size_t > &paddings)
 Sets begin paddings. More...
 
const std::vector< size_t > getPaddingsEnd () const
 Return end paddings. More...
 
PoolingLayersetPaddingsEnd (const std::vector< size_t > &paddings)
 Sets end paddings. More...
 
PoolingType getPoolingType () const
 Returns pooling type. More...
 
PoolingLayersetPoolingType (PoolingType type)
 Sets pooling type. More...
 
RoundingType getRoundingType () const
 Returns rounding type. More...
 
PoolingLayersetRoundingType (RoundingType type)
 Sets rounding types. More...
 
bool getExcludePad () const
 Returns a type of pooling strategy. More...
 
PoolingLayersetExcludePad (bool exclude)
 Sets a type of pooling strategy. More...
 
- Public Member Functions inherited from InferenceEngine::Builder::LayerDecorator
 LayerDecorator (const std::string &type, const std::string &name)
 The constructor creates layer builders with layer type and layer name. More...
 
 LayerDecorator (const Layer::Ptr &layer)
 The constructor creates layer builders from reference to generic layer builder. More...
 
 LayerDecorator (const Layer::CPtr &layer)
 The constructor creates layer builders from reference to generic layer builder. More...
 
 LayerDecorator (const LayerDecorator &rval)
 The copy constructor. More...
 
LayerDecoratoroperator= (const LayerDecorator &rval)
 Copy operator for LayerDecorator. More...
 
virtual ~LayerDecorator ()=default
 Virtual destructor.
 
virtual operator Layer::Ptr ()
 The operator creates generic builder. More...
 
virtual operator Layer::CPtr () const
 The operator creates generic builder. More...
 
const std::string & getType () const
 Returns layer type. More...
 
const std::string & getName () const
 Returns layer name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from InferenceEngine::Builder::LayerDecorator
Layer::PtrgetLayer ()
 
const Layer::CPtr getLayer () const
 
void checkType (const std::string &type) const
 
- Protected Attributes inherited from InferenceEngine::Builder::LayerDecorator
Layer::CPtr cLayer
 

Detailed Description

The class represents a builder for Pooling layer.

Deprecated:
Use ngraph API instead.

Constructor & Destructor Documentation

§ PoolingLayer() [1/3]

InferenceEngine::Builder::PoolingLayer::PoolingLayer ( const std::string &  name = "")
explicit

The constructor creates a builder with the name.

Parameters
nameLayer name

§ PoolingLayer() [2/3]

InferenceEngine::Builder::PoolingLayer::PoolingLayer ( const Layer::Ptr layer)
explicit

The constructor creates a builder from generic builder.

Parameters
layerpointer to generic builder

§ PoolingLayer() [3/3]

InferenceEngine::Builder::PoolingLayer::PoolingLayer ( const Layer::CPtr layer)
explicit

The constructor creates a builder from generic builder.

Parameters
layerconstant pointer to generic builder

Member Function Documentation

§ getExcludePad()

bool InferenceEngine::Builder::PoolingLayer::getExcludePad ( ) const

Returns a type of pooling strategy.

Returns
true if zero-values in the padding are not used

§ getInputPort()

const Port& InferenceEngine::Builder::PoolingLayer::getInputPort ( ) const

Returns input port.

Returns
Input port

§ getKernel()

const std::vector<size_t> InferenceEngine::Builder::PoolingLayer::getKernel ( ) const

Returns kernel size.

Returns
Kernel size

§ getOutputPort()

const Port& InferenceEngine::Builder::PoolingLayer::getOutputPort ( ) const

Returns output port.

Returns
Output port

§ getPaddingsBegin()

const std::vector<size_t> InferenceEngine::Builder::PoolingLayer::getPaddingsBegin ( ) const

Returns begin paddings.

Returns
vector of paddings

§ getPaddingsEnd()

const std::vector<size_t> InferenceEngine::Builder::PoolingLayer::getPaddingsEnd ( ) const

Return end paddings.

Returns
Vector of paddings

§ getPoolingType()

PoolingType InferenceEngine::Builder::PoolingLayer::getPoolingType ( ) const

Returns pooling type.

Returns
Pooling type

§ getRoundingType()

RoundingType InferenceEngine::Builder::PoolingLayer::getRoundingType ( ) const

Returns rounding type.

Returns
Rounding type

§ getStrides()

const std::vector<size_t> InferenceEngine::Builder::PoolingLayer::getStrides ( ) const

Returns vector of strides.

Returns
vector of strides

§ operator Layer()

InferenceEngine::Builder::PoolingLayer::operator Layer ( ) const
overridevirtual

Operator creates generic layer builder.

Returns
Generic layer builder

Reimplemented from InferenceEngine::Builder::LayerDecorator.

§ setExcludePad()

PoolingLayer& InferenceEngine::Builder::PoolingLayer::setExcludePad ( bool  exclude)

Sets a type of pooling strategy.

Parameters
excludezero-values in the padding are not used if true
Returns
reference to layer builder

§ setInputPort()

PoolingLayer& InferenceEngine::Builder::PoolingLayer::setInputPort ( const Port port)

Sets input port.

Parameters
portInput port
Returns
reference to layer builder

§ setKernel()

PoolingLayer& InferenceEngine::Builder::PoolingLayer::setKernel ( const std::vector< size_t > &  kernel)

Sets kernel size.

Parameters
kernelKernel size
Returns
reference to layer builder

§ setName()

PoolingLayer& InferenceEngine::Builder::PoolingLayer::setName ( const std::string &  name)

Sets the name for the layer.

Parameters
nameLayer name
Returns
reference to layer builder

§ setOutputPort()

PoolingLayer& InferenceEngine::Builder::PoolingLayer::setOutputPort ( const Port port)

Sets output port.

Parameters
portOutput port
Returns
reference to layer builder

§ setPaddingsBegin()

PoolingLayer& InferenceEngine::Builder::PoolingLayer::setPaddingsBegin ( const std::vector< size_t > &  paddings)

Sets begin paddings.

Parameters
paddingsVector of paddings
Returns
reference to layer builder

§ setPaddingsEnd()

PoolingLayer& InferenceEngine::Builder::PoolingLayer::setPaddingsEnd ( const std::vector< size_t > &  paddings)

Sets end paddings.

Parameters
paddingsVector of paddings
Returns
reference to layer builder

§ setPoolingType()

PoolingLayer& InferenceEngine::Builder::PoolingLayer::setPoolingType ( PoolingType  type)

Sets pooling type.

Parameters
typePooling type
Returns
reference to layer builder

§ setRoundingType()

PoolingLayer& InferenceEngine::Builder::PoolingLayer::setRoundingType ( RoundingType  type)

Sets rounding types.

Parameters
typeRounding type
Returns
reference to layer builder

§ setStrides()

PoolingLayer& InferenceEngine::Builder::PoolingLayer::setStrides ( const std::vector< size_t > &  strides)

Sets strides.

Parameters
stridesvector of strides
Returns
reference to layer builder

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