Data Structures | Typedefs | Enumerations | Functions
ie_common.h File Reference

This is a header file with common inference engine definitions. More...

#include <algorithm>
#include <cstdlib>
#include <memory>
#include <ostream>
#include <string>
#include <vector>
#include <map>

Go to the source code of this file.

Data Structures

union  InferenceEngine::UserValue
 The method holds the user values to enable binding of data per graph node. More...
 
struct  InferenceEngine::InferenceEngineProfileInfo
 Represents basic inference profiling information per layer. More...
 
struct  InferenceEngine::ResponseDesc
 Represents detailed information for an error. More...
 
struct  InferenceEngine::QueryNetworkResult
 Response structure encapsulating information about supported layer. More...
 
class  InferenceEngine::GeneralError
 This class represents StatusCode::GENERIC_ERROR exception. More...
 
class  InferenceEngine::NotImplemented
 This class represents StatusCode::NOT_IMPLEMENTED exception. More...
 
class  InferenceEngine::NetworkNotLoaded
 This class represents StatusCode::NETWORK_NOT_LOADED exception. More...
 
class  InferenceEngine::ParameterMismatch
 This class represents StatusCode::PARAMETER_MISMATCH exception. More...
 
class  InferenceEngine::NotFound
 This class represents StatusCode::NOT_FOUND exception. More...
 
class  InferenceEngine::OutOfBounds
 This class represents StatusCode::OUT_OF_BOUNDS exception. More...
 
class  InferenceEngine::Unexpected
 This class represents StatusCode::UNEXPECTED exception. More...
 
class  InferenceEngine::RequestBusy
 This class represents StatusCode::REQUEST_BUSY exception. More...
 
class  InferenceEngine::ResultNotReady
 This class represents StatusCode::RESULT_NOT_READY exception. More...
 
class  InferenceEngine::NotAllocated
 This class represents StatusCode::NOT_ALLOCATED exception. More...
 
class  InferenceEngine::InferNotStarted
 This class represents StatusCode::INFER_NOT_STARTED exception. More...
 
class  InferenceEngine::NetworkNotRead
 This class represents StatusCode::NETWORK_NOT_READ exception. More...
 

Typedefs

using InferenceEngine::SizeVector = std::vector< size_t >
 Represents tensor size. More...
 
using InferenceEngine::DataPtr = std::shared_ptr< Data >
 Smart pointer to Data.
 
using InferenceEngine::CDataPtr = std::shared_ptr< const Data >
 Smart pointer to constant Data.
 
using InferenceEngine::DataWeakPtr = std::weak_ptr< Data >
 Smart weak pointer to Data.
 

Enumerations

enum  InferenceEngine::Layout : uint8_t {
  InferenceEngine::ANY = 0, InferenceEngine::NCHW = 1, InferenceEngine::NHWC = 2, InferenceEngine::NCDHW = 3,
  InferenceEngine::NDHWC = 4, InferenceEngine::OIHW = 64, InferenceEngine::GOIHW = 65, InferenceEngine::OIDHW = 66,
  InferenceEngine::GOIDHW = 67, InferenceEngine::SCALAR = 95, InferenceEngine::C = 96, InferenceEngine::CHW = 128,
  InferenceEngine::HW = 192, InferenceEngine::NC = 193, InferenceEngine::CN = 194, InferenceEngine::BLOCKED = 200
}
 Layouts that the inference engine supports. More...
 
enum  InferenceEngine::ColorFormat : uint32_t {
  InferenceEngine::RAW = 0u, InferenceEngine::RGB, InferenceEngine::BGR, InferenceEngine::RGBX,
  InferenceEngine::BGRX, InferenceEngine::NV12, InferenceEngine::I420
}
 Extra information about input color format for preprocessing. More...
 
enum  InferenceEngine::StatusCode : int {
  OK = 0, GENERAL_ERROR = -1, NOT_IMPLEMENTED = -2, NETWORK_NOT_LOADED = -3,
  PARAMETER_MISMATCH = -4, NOT_FOUND = -5, OUT_OF_BOUNDS = -6, UNEXPECTED = -7,
  REQUEST_BUSY = -8, RESULT_NOT_READY = -9, NOT_ALLOCATED = -10, INFER_NOT_STARTED = -11,
  NETWORK_NOT_READ = -12
}
 This enum contains codes for all possible return values of the interface functions.
 

Functions

std::ostream & InferenceEngine::operator<< (std::ostream &out, const Layout &p)
 Prints a string representation of InferenceEngine::Layout to a stream. More...
 
std::ostream & InferenceEngine::operator<< (std::ostream &out, const ColorFormat &fmt)
 Prints a string representation of InferenceEngine::ColorFormat to a stream. More...
 

Detailed Description

This is a header file with common inference engine definitions.

Typedef Documentation

◆ SizeVector

using InferenceEngine::SizeVector = typedef std::vector<size_t>

Represents tensor size.

The order is opposite to the order in Caffe*: (w,h,n,b) where the most frequently changing element in memory is first.

Enumeration Type Documentation

◆ ColorFormat

Extra information about input color format for preprocessing.

Enumerator
RAW 

Plain blob (default), no extra color processing required.

RGB 

RGB color format.

BGR 

BGR color format, default in DLDT.

RGBX 

RGBX color format with X ignored during inference.

BGRX 

BGRX color format with X ignored during inference.

NV12 

NV12 color format represented as compound Y+UV blob.

I420 

I420 color format represented as compound Y+U+V blob.

◆ Layout

enum InferenceEngine::Layout : uint8_t

Layouts that the inference engine supports.

Enumerator
ANY 

"any" layout

NCHW 

NCHW layout for input / output blobs.

NHWC 

NHWC layout for input / output blobs.

NCDHW 

NCDHW layout for input / output blobs.

NDHWC 

NDHWC layout for input / output blobs.

OIHW 

NDHWC layout for operation weights.

GOIHW 

NDHWC layout for operation weights.

OIDHW 

NDHWC layout for operation weights.

GOIDHW 

NDHWC layout for operation weights.

SCALAR 

A scalar layout.

A bias layout for operation.

CHW 

A single image layout (e.g. for mean image)

HW 

HW 2D layout.

NC 

HC 2D layout.

CN 

CN 2D layout.

BLOCKED 

A blocked layout.

Function Documentation

◆ operator<<() [1/2]

std::ostream& InferenceEngine::operator<< ( std::ostream &  out,
const ColorFormat fmt 
)
inline

Prints a string representation of InferenceEngine::ColorFormat to a stream.

Parameters
outAn output stream to send to
fmtA color format value to print to a stream
Returns
A reference to the out stream

◆ operator<<() [2/2]

std::ostream& InferenceEngine::operator<< ( std::ostream &  out,
const Layout p 
)
inline

Prints a string representation of InferenceEngine::Layout to a stream.

Parameters
outAn output stream to send to
pA layout value to print to a stream
Returns
A reference to the out stream