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

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

#include <ie_norm_layer.hpp>

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

Public Types

enum  NormType { WITHIN_CHANNEL = 0, ACROSS_CHANNELS = 1 }
 The enum defines all Norm types.
 

Public Member Functions

 NormLayer (const std::string &name="")
 The constructor creates a builder with the name. More...
 
 NormLayer (const Layer::Ptr &layer)
 The constructor creates a builder from generic builder. More...
 
 NormLayer (const Layer::CPtr &layer)
 The constructor creates a builder from generic builder. More...
 
NormLayersetName (const std::string &name)
 Sets the name for the layer. More...
 
const PortgetPort () const
 Returns port with shapes for the layer. More...
 
NormLayersetPort (const Port &port)
 Sets port shapes for the layer. More...
 
size_t getSize () const
 Returns side length of the region. More...
 
NormLayersetSize (size_t size)
 Sets side length of the region. More...
 
float getAlpha () const
 Returns scaling parameter for the normalizing sum. More...
 
NormLayersetAlpha (float alpha)
 Sets scaling parameter for the normalizing sum. More...
 
float getBeta () const
 Returns exponent for the normalizing sum. More...
 
NormLayersetBeta (float beta)
 Sets exponent for the normalizing sum. More...
 
bool getAcrossMaps () const
 Returns region type. More...
 
NormLayersetAcrossMaps (bool acrossMap)
 Sets region type. More...
 
NormType getRegion () const
 Returns region type. More...
 
NormLayersetRegion (NormType type)
 Sets region type. 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 () const
 The operator creates generic builder. More...
 
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 Norm layer.

Deprecated:
Use ngraph API instead.

Constructor & Destructor Documentation

§ NormLayer() [1/3]

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

The constructor creates a builder with the name.

Parameters
nameLayer name

§ NormLayer() [2/3]

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

The constructor creates a builder from generic builder.

Parameters
layerpointer to generic builder

§ NormLayer() [3/3]

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

The constructor creates a builder from generic builder.

Parameters
layerconstant pointer to generic builder

Member Function Documentation

§ getAcrossMaps()

bool InferenceEngine::Builder::NormLayer::getAcrossMaps ( ) const

Returns region type.

Returns
true if normalizing sum is performed over adjacent channels

§ getAlpha()

float InferenceEngine::Builder::NormLayer::getAlpha ( ) const

Returns scaling parameter for the normalizing sum.

Returns
Scaling parameter

§ getBeta()

float InferenceEngine::Builder::NormLayer::getBeta ( ) const

Returns exponent for the normalizing sum.

Returns
Exponent

§ getPort()

const Port& InferenceEngine::Builder::NormLayer::getPort ( ) const

Returns port with shapes for the layer.

Returns
Port with shapes

§ getRegion()

NormType InferenceEngine::Builder::NormLayer::getRegion ( ) const

Returns region type.

Returns
Norm type

§ getSize()

size_t InferenceEngine::Builder::NormLayer::getSize ( ) const

Returns side length of the region.

Returns
Size

§ setAcrossMaps()

NormLayer& InferenceEngine::Builder::NormLayer::setAcrossMaps ( bool  acrossMap)

Sets region type.

Parameters
acrossMaptrue if normalizing sum is performed over adjacent channels
Returns
reference to layer builder

§ setAlpha()

NormLayer& InferenceEngine::Builder::NormLayer::setAlpha ( float  alpha)

Sets scaling parameter for the normalizing sum.

Parameters
alphaScaling parameter
Returns
reference to layer builder

§ setBeta()

NormLayer& InferenceEngine::Builder::NormLayer::setBeta ( float  beta)

Sets exponent for the normalizing sum.

Parameters
betaExponent
Returns
reference to layer builder

§ setName()

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

Sets the name for the layer.

Parameters
nameLayer name
Returns
reference to layer builder

§ setPort()

NormLayer& InferenceEngine::Builder::NormLayer::setPort ( const Port port)

Sets port shapes for the layer.

Parameters
portPort with shapes
Returns
reference to layer builder

§ setRegion()

NormLayer& InferenceEngine::Builder::NormLayer::setRegion ( NormType  type)

Sets region type.

Parameters
typeregion type
Returns
reference to layer builder

§ setSize()

NormLayer& InferenceEngine::Builder::NormLayer::setSize ( size_t  size)

Sets side length of the region.

Parameters
sizeSize
Returns
reference to layer builder

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