onnxruntime::PrimitiveDataTypeBase Class Reference

PrimitiveDataTypeBase Base class for primitive Tensor contained types. More...

#include <data_types.h>

Inheritance diagram for onnxruntime::PrimitiveDataTypeBase:

Public Member Functions
bool	IsCompatible (const ONNX_NAMESPACE::TypeProto &) const override
	this API will be used to check type compatibility at runtime More...
const ONNX_NAMESPACE::TypeProto *	GetTypeProto () const final
	Retrieves an instance of TypeProto for a given MLDataType. More...
int32_t	GetDataType () const
int32_t	GetNumSubElems () const
bool	HasSubElems () const
Public Member Functions inherited from onnxruntime::DataTypeImpl
virtual	~DataTypeImpl ()=default
size_t	Size () const
virtual DeleteFunc	GetDeleteFunc () const =0
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

Protected Member Functions
	PrimitiveDataTypeBase (size_t size, int32_t data_type, int32_t num_sub_elems)
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 }
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 ()
Public Attributes inherited from onnxruntime::DataTypeImpl
const GeneralType	type_
const size_t	size_

Detailed Description

PrimitiveDataTypeBase Base class for primitive Tensor contained types.

This class contains an integer constant that can be used for input data type dispatching. This class also stores the number of subelements per size units. Example: For int4, the size unit is 1 byte and the number of subelements is 2.

Definition at line 926 of file data_types.h.

Constructor & Destructor Documentation

onnxruntime::PrimitiveDataTypeBase::PrimitiveDataTypeBase ( size_t  size, int32_t  data_type, int32_t  num_sub_elems  )

inlineprotected

Definition at line 949 of file data_types.h.

Member Function Documentation

int32_t onnxruntime::PrimitiveDataTypeBase::GetDataType ( ) const

inline

Definition at line 936 of file data_types.h.

int32_t onnxruntime::PrimitiveDataTypeBase::GetNumSubElems ( ) const

inline

Definition at line 940 of file data_types.h.

const ONNX_NAMESPACE::TypeProto* onnxruntime::PrimitiveDataTypeBase::GetTypeProto ( ) const

inlinefinalvirtual

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.

Definition at line 932 of file data_types.h.

bool onnxruntime::PrimitiveDataTypeBase::HasSubElems ( ) const

inline

Definition at line 944 of file data_types.h.

bool onnxruntime::PrimitiveDataTypeBase::IsCompatible ( const ONNX_NAMESPACE::TypeProto &  type_proto ) const

inlineoverridevirtual

this API will be used to check type compatibility at runtime

Parameters

type_proto

a 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.

Definition at line 928 of file data_types.h.

---

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

• onnxruntime/core/framework/data_types.h