Public Member Functions | Data Fields
InferenceEngine::Data Class Reference

This class represents the main Data representation node. More...

#include <ie_data.h>

Collaboration diagram for InferenceEngine::Data:
Collaboration graph
[legend]

Public Member Functions

  Data (const std::string &name, Precision _precision, Layout layout=NCHW)
  An empty constructor (dimensionless) More...
 
  Data (const std::string &name, const SizeVector &a_dims, Precision _precision, Layout layout=NCHW)
  A full constructor (with dimensions) More...
 
  Data (const std::string &name, const TensorDesc &desc)
  A constructor with tensor descriptor. More...
 
bool  isInitialized () const
  Checks if the current node is resolved. More...
 
void  setDims (const SizeVector &a_dims)
  Sets the data dimensions. After the current node is marked as resolved. More...
 
void  setBatchSize (size_t batch_size)
  Sets the batch value in the data dimensions. Batch is defined as the last element in the dimensions vector. More...
 
void  setLayout (Layout layout)
  Sets the layout value for this Data instance. More...
 
Layout  getLayout () const
  Gets the layout value for this Data instance.
 
const TensorDesc getTensorDesc () const
  Gets Tensor descriptor reference. More...
 
const Precision getPrecision () const
  Gets a precision type of this Data instance. More...
 
void  setPrecision (const Precision &precision)
  Gets a precision type of this Data instance. More...
 
const SizeVector getDims () const
 
CNNLayerWeakPtr getCreatorLayer ()
 
const std::string &  getName () const
 
std::map< std::string, CNNLayerPtr > &  getInputTo ()
  returns child layers in di-graph
 
const UserValue getUserObject () const
 

Data Fields

Precision  precision
  A precision type of this Data instance. More...
 
Layout  layout
  A data layout of this Data instance. More...
 
SizeVector  dims
  A tensor dimension array (the order is opposite to the order in the IR: w,h,c,n) of this Data instance. More...
 
CNNLayerWeakPtr  creatorLayer
  A pointer to the layer that creates this data element, null for input data elements. More...
 
std::string  name
  A unique name that identifies this data node. More...
 
std::map< std::string, CNNLayerPtr inputTo
  A map of layers that use this node as input. It is useful for recursive NN graph traversal. More...
 
UserValue  userObject
  A user utility place holder. More...
 

Detailed Description

This class represents the main Data representation node.

The NN graphs are di-graphs consisting of data nodes and layer nodes.

Constructor & Destructor Documentation

§ Data() [1/3]

InferenceEngine::Data::Data ( const std::string &  name,
Precision  _precision,
Layout  layout = NCHW 
)

An empty constructor (dimensionless)

Parameters
name Name of the data node
_precision Precision of the data

§ Data() [2/3]

InferenceEngine::Data::Data ( const std::string &  name,
const SizeVector a_dims,
Precision  _precision,
Layout  layout = NCHW 
)

A full constructor (with dimensions)

Parameters
name Name of the data node
a_dims Data tensor dimensions
_precision Precision of the data

§ Data() [3/3]

InferenceEngine::Data::Data ( const std::string &  name,
const TensorDesc desc 
)

A constructor with tensor descriptor.

Parameters
name Name of the data node
desc Tensor descriptor

Member Function Documentation

§ getCreatorLayer()

CNNLayerWeakPtr& InferenceEngine::Data::getCreatorLayer ( )
Returns
owner of this data layer, parent layer in di-graph

§ getDims()

const SizeVector& InferenceEngine::Data::getDims ( ) const
Returns
data dimensions

§ getName()

const std::string& InferenceEngine::Data::getName ( ) const
Returns
name of the data object

§ getPrecision()

const Precision& InferenceEngine::Data::getPrecision ( ) const

Gets a precision type of this Data instance.

Returns
Precision type

§ getTensorDesc()

const TensorDesc& InferenceEngine::Data::getTensorDesc ( ) const

Gets Tensor descriptor reference.

Returns
reference to TensorDesc

§ getUserObject()

const UserValue& InferenceEngine::Data::getUserObject ( ) const
Returns
convenient arbitrary user data holder

§ isInitialized()

bool InferenceEngine::Data::isInitialized ( ) const

Checks if the current node is resolved.

Returns
true if resolved, false otherwise.

§ setBatchSize()

void InferenceEngine::Data::setBatchSize ( size_t  batch_size )

Sets the batch value in the data dimensions. Batch is defined as the last element in the dimensions vector.

Deprecated:
Parameters
batch_size Batch size to set

§ setDims()

void InferenceEngine::Data::setDims ( const SizeVector a_dims )

Sets the data dimensions. After the current node is marked as resolved.

Parameters
a_dims Tensor dimensions to set

§ setLayout()

void InferenceEngine::Data::setLayout ( Layout  layout )

Sets the layout value for this Data instance.

Parameters
layout Layout value to set

§ setPrecision()

void InferenceEngine::Data::setPrecision ( const Precision precision )

Gets a precision type of this Data instance.

Returns
Precision type

Field Documentation

§ creatorLayer

CNNLayerWeakPtr InferenceEngine::Data::creatorLayer

A pointer to the layer that creates this data element, null for input data elements.

Deprecated:
Deprecated. Please use getCreatorLayer()

§ dims

SizeVector InferenceEngine::Data::dims

A tensor dimension array (the order is opposite to the order in the IR: w,h,c,n) of this Data instance.

Deprecated:
Deprecated. Please use getDims()

§ inputTo

std::map<std::string, CNNLayerPtr> InferenceEngine::Data::inputTo

A map of layers that use this node as input. It is useful for recursive NN graph traversal.

Deprecated:
Deprecated. Please use getInputTo()

§ layout

Layout InferenceEngine::Data::layout

A data layout of this Data instance.

Deprecated:
Deprecated. Please use getFormat()

§ name

std::string InferenceEngine::Data::name

A unique name that identifies this data node.

Deprecated:
Deprecated. Please use getName()

§ precision

Precision InferenceEngine::Data::precision

A precision type of this Data instance.

Deprecated:
Deprecated. Please use getPrecision()

§ userObject

UserValue InferenceEngine::Data::userObject

A user utility place holder.

Deprecated:
Deprecated. Please use getUserObject()

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