HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
onnxruntime::OptionalTypeBase Class Reference

Common base-class for all optional types. More...

#include <data_types.h>

+ Inheritance diagram for onnxruntime::OptionalTypeBase:

Public Member Functions

bool IsCompatible (const ONNX_NAMESPACE::TypeProto &type_proto) const override
 this API will be used to check type compatibility at runtime More...
 
DeleteFunc GetDeleteFunc () const override
 
const ONNX_NAMESPACE::TypeProto * GetTypeProto () const override
 Retrieves an instance of TypeProto for a given MLDataType. More...
 
virtual MLDataType GetElementType () const
 
 OptionalTypeBase (const OptionalTypeBase &)=delete
 
OptionalTypeBase & operator= (const OptionalTypeBase &)=delete
 
- Public Member Functions inherited from onnxruntime::DataTypeImpl
virtual ~DataTypeImpl ()=default
 
size_t Size () const
 
bool IsTensorType () const
 
bool IsTensorSequenceType () const
 
bool IsSparseTensorType () const
 
bool IsOptionalType () const
 
bool IsNonTensorType () const
 
bool IsPrimitiveDataType () const
 
const TensorTypeBase * AsTensorType () const
 
const SequenceTensorTypeBase * AsSequenceTensorType () const
 
const SparseTensorTypeBase * AsSparseTensorType () const
 
const OptionalTypeBase * AsOptionalType () const
 
const NonTensorTypeBase * AsNonTensorType () const
 
const PrimitiveDataTypeBase * AsPrimitiveDataType () const
 

Static Public Member Functions

static MLDataType Type ()
 
- Static Public Member Functions inherited from onnxruntime::DataTypeImpl
template<typename T >
static MLDataType GetType ()
 
template<typename elemT >
static MLDataType GetTensorType ()
 
template<typename elemT >
static MLDataType GetSequenceTensorType ()
 
template<typename elemT >
static MLDataType GetSparseTensorType ()
 
template<typename T , typename elemT >
static MLDataType GetOptionalType ()
 
static MLDataType TypeFromProto (const ONNX_NAMESPACE::TypeProto &proto)
 
static const TensorTypeBase * TensorTypeFromONNXEnum (int type)
 
static const
SequenceTensorTypeBase * 
SequenceTensorTypeFromONNXEnum (int type)
 
static const SparseTensorTypeBase * SparseTensorTypeFromONNXEnum (int type)
 
static const char * ToString (MLDataType type)
 
static std::vector< std::string > ToString (const std::vector< MLDataType > &types)
 
static void RegisterDataType (MLDataType)
 
static MLDataType GetDataType (const std::string &)
 
static const std::vector
< MLDataType > & 
AllTensorTypes ()
 
static const std::vector
< MLDataType > & 
AllTensorTypesIRv4 ()
 
static const std::vector
< MLDataType > & 
AllTensorTypesIRv9 ()
 
static const std::vector
< MLDataType > & 
AllFixedSizeTensorTypes ()
 
static const std::vector
< MLDataType > & 
AllFixedSizeTensorTypesIRv4 ()
 
static const std::vector
< MLDataType > & 
AllFixedSizeTensorTypesIRv9 ()
 
static const std::vector
< MLDataType > & 
AllSequenceTensorTypes ()
 
static const std::vector
< MLDataType > & 
AllSequenceTensorTypesIRv4 ()
 
static const std::vector
< MLDataType > & 
AllSequenceTensorTypesIRv9 ()
 
static const std::vector
< MLDataType > & 
AllFixedSizeSequenceTensorTypes ()
 
static const std::vector
< MLDataType > & 
AllFixedSizeSequenceTensorTypesIRv4 ()
 
static const std::vector
< MLDataType > & 
AllFixedSizeSequenceTensorTypesIRv9 ()
 
static const std::vector
< MLDataType > & 
AllNumericTensorTypes ()
 
static const std::vector
< MLDataType > & 
AllNumericTensorTypesIRv4 ()
 
static const std::vector
< MLDataType > & 
AllNumericTensorTypesIRv9 ()
 
static const std::vector
< MLDataType > & 
AllIEEEFloatTensorTypes ()
 
static const std::vector
< MLDataType > & 
AllTensorAndSequenceTensorTypes ()
 
static const std::vector
< MLDataType > & 
AllTensorAndSequenceTensorTypesIRv4 ()
 
static const std::vector
< MLDataType > & 
AllTensorAndSequenceTensorTypesIRv9 ()
 
static const std::vector
< MLDataType > & 
AllOptionalAndTensorAndSequenceTensorTypes ()
 
static const std::vector
< MLDataType > & 
AllOptionalAndTensorAndSequenceTensorTypesIRv4 ()
 
static const std::vector
< MLDataType > & 
AllOptionalAndTensorAndSequenceTensorTypesIRv9 ()
 
static const std::vector
< MLDataType > & 
AllFixedSizeTensorAndSequenceTensorTypes ()
 
static const std::vector
< MLDataType > & 
AllFixedSizeTensorAndSequenceTensorTypesIRv4 ()
 
static const std::vector
< MLDataType > & 
AllFixedSizeTensorAndSequenceTensorTypesIRv9 ()
 
static const std::vector
< MLDataType > & 
AllOptionalTypes ()
 
static const std::vector
< MLDataType > & 
AllOptionalTypesIRv4 ()
 
static const std::vector
< MLDataType > & 
AllOptionalTypesIRv9 ()
 
static const std::vector
< MLDataType > & 
AllTensorAndSequenceTensorAndOptionalTypes ()
 
static const std::vector
< MLDataType > & 
AllTensorAndSequenceTensorAndOptionalTypesIRv4 ()
 
static const std::vector
< MLDataType > & 
AllTensorAndSequenceTensorAndOptionalTypesIRv9 ()
 

Protected Member Functions

ONNX_NAMESPACE::TypeProto & MutableTypeProto ()
 
 OptionalTypeBase ()
 
 ~OptionalTypeBase () override
 
- Protected Member Functions inherited from onnxruntime::DataTypeImpl
 DataTypeImpl (GeneralType type, size_t size)
 

Additional Inherited Members

- Public Types inherited from onnxruntime::DataTypeImpl
enum  GeneralType {
  GeneralType::kInvalid = 0, GeneralType::kNonTensor = 1, GeneralType::kTensor = 2, GeneralType::kTensorSequence = 3,
  GeneralType::kSparseTensor = 4, GeneralType::kOptional = 5, GeneralType::kPrimitive = 6
}
 
- Public Attributes inherited from onnxruntime::DataTypeImpl
const GeneralType type_
 
const size_t size_
 

Detailed Description

Common base-class for all optional types.

Definition at line 592 of file data_types.h.

Constructor & Destructor Documentation

onnxruntime::OptionalTypeBase::OptionalTypeBase ( const OptionalTypeBase &  )
delete
onnxruntime::OptionalTypeBase::OptionalTypeBase ( )
protected
onnxruntime::OptionalTypeBase::~OptionalTypeBase ( )
overrideprotected

Member Function Documentation

DeleteFunc onnxruntime::OptionalTypeBase::GetDeleteFunc ( ) const
inlineoverridevirtual

Implements onnxruntime::DataTypeImpl.

Definition at line 598 of file data_types.h.

virtual MLDataType onnxruntime::OptionalTypeBase::GetElementType ( ) const
inlinevirtual

Reimplemented in onnxruntime::OptionalType< T, elemT >.

Definition at line 605 of file data_types.h.

const ONNX_NAMESPACE::TypeProto* onnxruntime::OptionalTypeBase::GetTypeProto ( ) const
overridevirtual

Retrieves an instance of TypeProto for a given MLDataType.

Returns
optional TypeProto. Only ONNX types has type proto, non-ONNX types will return nullptr.

Implements onnxruntime::DataTypeImpl.

bool onnxruntime::OptionalTypeBase::IsCompatible ( const ONNX_NAMESPACE::TypeProto &  type_proto) const
overridevirtual

this API will be used to check type compatibility at runtime

Parameters
type_protoa TypeProto instance that is constructed for a specific type will be checked against a TypeProto instance contained within a corresponding MLDataType instance.

Implements onnxruntime::DataTypeImpl.

ONNX_NAMESPACE::TypeProto& onnxruntime::OptionalTypeBase::MutableTypeProto ( )
protected
OptionalTypeBase& onnxruntime::OptionalTypeBase::operator= ( const OptionalTypeBase &  )
delete
static MLDataType onnxruntime::OptionalTypeBase::Type ( )
static

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