Public Types | Public Member Functions
InferenceEngine::BatchedBlob Class Reference

This class represents a blob that contains other blobs - one per batch. More...

#include <ie_compound_blob.h>

Inheritance diagram for InferenceEngine::BatchedBlob:
Inheritance graph
[legend]
Collaboration diagram for InferenceEngine::BatchedBlob:
Collaboration graph
[legend]

Public Types

using Ptr = std::shared_ptr< BatchedBlob >
 A smart pointer to the BatchedBlob object.
 
using CPtr = std::shared_ptr< const BatchedBlob >
 A smart pointer to the const BatchedBlob object.
 
- Public Types inherited from InferenceEngine::CompoundBlob
using Ptr = std::shared_ptr< CompoundBlob >
 A smart pointer to the CompoundBlob object.
 
using CPtr = std::shared_ptr< const CompoundBlob >
 A smart pointer to the const CompoundBlob object.
 
- Public Types inherited from InferenceEngine::Blob
using Ptr = std::shared_ptr< Blob >
 A smart pointer containing Blob object.
 
using CPtr = std::shared_ptr< const Blob >
 A smart pointer to the const Blob object.
 

Public Member Functions

 BatchedBlob (const std::vector< Blob::Ptr > &blobs)
 Constructs a batched blob from a vector of blobs. More...
 
 BatchedBlob (std::vector< Blob::Ptr > &&blobs)
 Constructs a batched blob from a vector of blobs. More...
 
- Public Member Functions inherited from InferenceEngine::CompoundBlob
 CompoundBlob (const std::vector< Blob::Ptr > &blobs)
 Constructs a compound blob from a vector of blobs. More...
 
 CompoundBlob (std::vector< Blob::Ptr > &&blobs)
 Constructs a compound blob from a vector of blobs. More...
 
size_t byteSize () const noexcept override
 Always returns 0 More...
 
size_t element_size () const noexcept override
 Always returns 0 More...
 
void allocate () noexcept override
 No operation is performed. Compound blob does not allocate/deallocate any data.
 
bool deallocate () noexcept override
 No operation is performed. Compound blob does not allocate/deallocate any data. More...
 
LockedMemory< void > buffer () noexcept override
 Always returns an empty LockedMemory object.
 
LockedMemory< const void > cbuffer () const noexcept override
 Always returns an empty LockedMemory object.
 
size_t size () const noexcept override
 Returns the number of underlying blobs in the compound blob.
 
virtual Blob::Ptr getBlob (size_t i) const noexcept
 Returns an underlying blob at index i. More...
 
Blob::Ptr createROI (const ROI &roi) const override
 Creates a blob describing given ROI object based on the current blob with memory sharing. More...
 
- Public Member Functions inherited from InferenceEngine::Blob
virtual ~Blob ()
 Blob virtual destructor.
 
template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&!std::is_reference< T >::value, int >::type = 0, typename std::enable_if< std::is_base_of< Blob, T >::value, int >::type = 0>
bool is () noexcept
 Checks if the Blob object can be cast to the type T*. More...
 
template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&!std::is_reference< T >::value, int >::type = 0, typename std::enable_if< std::is_base_of< Blob, T >::value, int >::type = 0>
bool is () const noexcept
 Checks if the Blob object can be cast to the type const T*. More...
 
template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&!std::is_reference< T >::value, int >::type = 0, typename std::enable_if< std::is_base_of< Blob, T >::value, int >::type = 0>
T * as () noexcept
 Casts this Blob object to the type T*. More...
 
template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&!std::is_reference< T >::value, int >::type = 0, typename std::enable_if< std::is_base_of< Blob, T >::value, int >::type = 0>
const T * as () const noexcept
 Casts this Blob object to the type const T*. More...
 
 Blob (const TensorDesc &tensorDesc)
 Constructor. Creates an empty Blob object with the specified precision. More...
 
virtual const TensorDescgetTensorDesc () const noexcept
 Returns the tensor description. More...
 
virtual TensorDescgetTensorDesc () noexcept
 Returns the tensor description. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from InferenceEngine::Blob
static Ptr CreateFromData (const DataPtr &data)
 Creates a TBlob<> object from a Data node. More...
 
- Protected Member Functions inherited from InferenceEngine::CompoundBlob
 CompoundBlob (const TensorDesc &tensorDesc)
 Constructs a compound blob with specified descriptor. More...
 
const std::shared_ptr< IAllocator > & getAllocator () const noexcept override
 Returns nullptr as CompoundBlob is not allocator-based.
 
void * getHandle () const noexcept override
 Returns nullptr as CompoundBlob is not allocator-based.
 
- Static Protected Member Functions inherited from InferenceEngine::Blob
static size_t product (const SizeVector &dims) noexcept
 Multiplies the dimension vector values. More...
 
- Protected Attributes inherited from InferenceEngine::CompoundBlob
std::vector< Blob::Ptr_blobs
 Compound blob container for underlying blobs.
 
- Protected Attributes inherited from InferenceEngine::Blob
TensorDesc tensorDesc
 The tensor descriptor of the given blob.
 

Detailed Description

This class represents a blob that contains other blobs - one per batch.

Plugin which supports BatchedBlob input should report BATCHED_BLOB in the OPTIMIZATION_CAPABILITIES metric.

Constructor & Destructor Documentation

◆ BatchedBlob() [1/2]

InferenceEngine::BatchedBlob::BatchedBlob ( const std::vector< Blob::Ptr > &  blobs)
explicit

Constructs a batched blob from a vector of blobs.

All passed blobs should meet following requirements:

  • all blobs have equal tensor descriptors,
  • blobs layouts should be one of: NCHW, NHWC, NCDHW, NDHWC, NC, CN, C, CHW, HWC
  • batch dimensions should be equal to 1 or not defined (C, CHW, HWC). Resulting blob's tensor descriptor is constructed using tensor descriptors of passed blobs by setting batch dimension to blobs.size()
Parameters
blobsA vector of blobs that is copied to this object

◆ BatchedBlob() [2/2]

InferenceEngine::BatchedBlob::BatchedBlob ( std::vector< Blob::Ptr > &&  blobs)
explicit

Constructs a batched blob from a vector of blobs.

All passed blobs should meet following requirements:

  • all blobs have equal tensor descriptors,
  • blobs layouts should be one of: NCHW, NHWC, NCDHW, NDHWC, NC, CN, C, CHW, HWC
  • batch dimensions should be equal to 1 or not defined (C, CHW, HWC). Resulting blob's tensor descriptor is constructed using tensor descriptors of passed blobs by setting batch dimension to blobs.size()
Parameters
blobsA vector of blobs that is moved to this object

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