Class to save tensor's shape and type. More...

#include <OperandInfo.h>

Public Member Functions
	OperandInfo ()=delete
	Construct a new OperandInfo object (deleted)

	OperandInfo (const Shape &shape, const TypeInfo &typeInfo, MemAllocType alloc_type, bool is_const=false, bool is_variable=false, OriginIndex origin=OriginIndex())
	Construct a new OperandInfo object.

	OperandInfo (const OperandInfo &origin)=default
	Construct a new OperandInfo object.

OperandInfo &	operator= (const OperandInfo &origin)=default
	Assign a new OperandInfo object.

const Shape &	shape () const
	Return tensor shape.

Shape &	shape ()
	Return mutable tensor shape.

void	shape (const ir::Shape &new_shape)
	set shape

const TypeInfo &	typeInfo () const
	Return tensor data type info.

void	typeInfo (const ir::TypeInfo &typeInfo)
	Set type information.

void	type (const DataType type)
	Set tensor data type.

size_t	total_size () const
	Return size of tensor (bytes)

MemAllocType	memAllocType () const

void	setAsConstant ()

void	setAsNonConst ()

bool	isConstant () const

void	setAsVariable ()

bool	isVariable () const

bool	isDynamic () const

void	setDynamic ()

OriginIndex	originIndex () const

void	setOriginIndex (OriginIndex origin)

Static Public Member Functions
static OperandInfo	createStaticInfo (const Shape &shape, const TypeInfo &typeInfo)
	Create a static OperandInfo object.

Detailed Description

Class to save tensor's shape and type.

Definition at line 53 of file OperandInfo.h.

Constructor & Destructor Documentation

◆ OperandInfo() [1/3]

onert::ir::OperandInfo::OperandInfo ( )

delete

Construct a new OperandInfo object (deleted)

Referenced by createStaticInfo().

◆ OperandInfo() [2/3]

onert::ir::OperandInfo::OperandInfo	(	const Shape &	shape,
		const TypeInfo &	typeInfo,
		MemAllocType	alloc_type,
		bool	is_const = `false`,
		bool	is_variable = `false`,
		OriginIndex	origin = `OriginIndex()`
	)

inline

Construct a new OperandInfo object.

Parameters

[in]	shape	Tensor shape
[in]	typeInfo	Tensor data type
[in]	alloc_type	When the thesor needs memory allocation

Definition at line 67 of file OperandInfo.h.

    : _shape(shape), _typeInfo(typeInfo), _alloc_type(alloc_type), _const(is_const),
      _variable(is_variable), _origin(origin)
  {
    // DO NOTHING
  }

◆ OperandInfo() [3/3]

onert::ir::OperandInfo::OperandInfo ( const OperandInfo & origin )

default

Construct a new OperandInfo object.

Parameters

[in] origin info for copy

Member Function Documentation

◆ createStaticInfo()

static OperandInfo onert::ir::OperandInfo::createStaticInfo	(	const Shape &	shape,
		const TypeInfo &	typeInfo
	)

inlinestatic

Create a static OperandInfo object.

Definition at line 89 of file OperandInfo.h.

  {
    return OperandInfo(shape, typeInfo, MemAllocType::STATIC);
  }

References OperandInfo(), shape(), onert::ir::STATIC, and typeInfo().

◆ isConstant()

bool onert::ir::OperandInfo::isConstant ( ) const

inline

Definition at line 132 of file OperandInfo.h.

  {
    // Impossible case: constant and dynamic operand
    assert(!(isDynamic() && _const));
    return _const;
  }

References isDynamic().

Referenced by onert::backend::basic::ExternalTensor::ExternalTensor(), onert::backend::IPortableTensor::is_constant(), and onert::ir::Operand::isConstant().

◆ isDynamic()

bool onert::ir::OperandInfo::isDynamic ( ) const

inline

Definition at line 146 of file OperandInfo.h.

146{ return _alloc_type == MemAllocType::DYNAMIC; }

onert::ir::MemAllocType::DYNAMIC

@ DYNAMIC

At kernel execution time, shape for a tensor is known, thus requried memory capacity can be calculate...

References onert::ir::DYNAMIC.

Referenced by onert::compiler::StaticShapeInferer::dump(), onert::backend::basic::ExternalTensor::ExternalTensor(), onert::backend::IPortableTensor::is_dynamic(), isConstant(), and setAsVariable().

◆ isVariable()

bool onert::ir::OperandInfo::isVariable ( ) const

inline

Definition at line 145 of file OperandInfo.h.

145{ return _variable; }

◆ memAllocType()

MemAllocType onert::ir::OperandInfo::memAllocType ( ) const

inline

Definition at line 129 of file OperandInfo.h.

129{ return _alloc_type; }

◆ operator=()

OperandInfo & onert::ir::OperandInfo::operator= ( const OperandInfo & origin )

default

Assign a new OperandInfo object.

Parameters

[in] origin info for copy

◆ originIndex()

OriginIndex onert::ir::OperandInfo::originIndex ( ) const

inline

Definition at line 148 of file OperandInfo.h.

148{ return _origin; }

Referenced by onert::ir::Operand::originIndex().

◆ setAsConstant()

void onert::ir::OperandInfo::setAsConstant ( )

inline

Definition at line 130 of file OperandInfo.h.

130{ _const = true; }

Referenced by onert::ir::Operand::data().

◆ setAsNonConst()

void onert::ir::OperandInfo::setAsNonConst ( )

inline

Definition at line 131 of file OperandInfo.h.

131{ _const = false; }

◆ setAsVariable()

void onert::ir::OperandInfo::setAsVariable ( )

inline

Definition at line 138 of file OperandInfo.h.

  {
    // Impossible case: constant or dynamic operand
    // The variable operand with buffer is not supported yet
    assert(!(isDynamic() || _const));
    _variable = true;
  }

References isDynamic().

◆ setDynamic()

void onert::ir::OperandInfo::setDynamic ( )

inline

Definition at line 147 of file OperandInfo.h.

147{ _alloc_type = MemAllocType::DYNAMIC; }

References onert::ir::DYNAMIC.

Referenced by onert::backend::builtin::IOTensor::applyShape(), onert::backend::basic::Tensor::set_dynamic(), onert::backend::builtin::IOTensor::set_dynamic(), onert::backend::builtin::UserTensor::set_dynamic(), onert::exec::EdgeTensor::set_dynamic(), and onert::backend::builtin::IOTensor::setTensor().

◆ setOriginIndex()

void onert::ir::OperandInfo::setOriginIndex ( OriginIndex origin )

inline

Definition at line 149 of file OperandInfo.h.

149{ _origin = origin; }

Referenced by onert::ir::Operand::setOriginIndex().

◆ shape() [1/3]

Shape & onert::ir::OperandInfo::shape ( )

inline

Return mutable tensor shape.

Returns: Tensor shape

Definition at line 104 of file OperandInfo.h.

104{ return _shape; }

Referenced by RandomDataGenerator.RandomDataGenerator::_gen_float32(), RandomDataGenerator.RandomDataGenerator::_gen_int16(), and RandomDataGenerator.RandomDataGenerator::_gen_uint8().

◆ shape() [2/3]

const Shape & onert::ir::OperandInfo::shape ( ) const

inline

Return tensor shape.

Returns: Tensor shape

Definition at line 99 of file OperandInfo.h.

99{ return _shape; }

◆ shape() [3/3]

void onert::ir::OperandInfo::shape ( const ir::Shape & new_shape )

inline

set shape

Definition at line 108 of file OperandInfo.h.

108{ _shape = new_shape; }

Referenced by RandomDataGenerator.RandomDataGenerator::_gen_float32(), RandomDataGenerator.RandomDataGenerator::_gen_int16(), and RandomDataGenerator.RandomDataGenerator::_gen_uint8().

◆ total_size()

size_t onert::ir::OperandInfo::total_size ( ) const

Return size of tensor (bytes)

Returns: Tensor size

Definition at line 22 of file OperandInfo.cc.

{
  const auto data_type = _typeInfo.type();
  try
  {
    return _shape.num_elements() * sizeOfDataType(data_type);
  }
  catch (const std::runtime_error &e)
  {
    // Calculate total size for ggml block quantization type on exception handling
    // because it is rare case and we should care about performance on non-block case.
    if (data_type != DataType::QUANT_GGML_Q4_0 && data_type != DataType::QUANT_GGML_Q8_0)
      throw e;
 
    if (_shape.dim(_shape.rank() - 1) % 32 != 0)
      throw std::runtime_error{
        "Block quantization requires the last dimension to be a multiple of 32"};
 
    const auto num_blocks = _shape.num_elements() / 32;
    const auto block_size = data_type == DataType::QUANT_GGML_Q4_0
                              ? (sizeof(uint8_t) * 32 / 2 + sizeof(uint16_t))
                              : (sizeof(uint8_t) * 32 + sizeof(uint16_t));
    return num_blocks * block_size;
  }
}

References onert::ir::sizeOfDataType(), and onert::ir::TypeInfo::type().

Referenced by onert::exec::EdgeTensor::allocate_buffer(), onert::backend::basic::Tensor::applyShape(), onert::exec::EdgeTensor::applyShape(), and onert::backend::IPortableTensor::total_size().

◆ type()

void onert::ir::OperandInfo::type ( const DataType type )

inline

Set tensor data type.

Definition at line 122 of file OperandInfo.h.

122{ _typeInfo.type(type); }

onert::ir::OperandInfo::type

void type(const DataType type)

Set tensor data type.

Definition OperandInfo.h:122

References onert::ir::TypeInfo::type(), and type().

Referenced by onert::ir::Operand::type(), and type().

◆ typeInfo() [1/2]

const TypeInfo & onert::ir::OperandInfo::typeInfo ( ) const

inline

Return tensor data type info.

Returns: Tensor data type

Definition at line 113 of file OperandInfo.h.

113{ return _typeInfo; }

Referenced by createStaticInfo(), onert::backend::IPortableTensor::data_scale(), onert::backend::IPortableTensor::data_scales(), onert::backend::IPortableTensor::data_type(), onert::backend::IPortableTensor::data_zero_point(), onert::backend::IPortableTensor::data_zero_points(), onert::backend::IPortableTensor::sparsity(), and onert::ir::Operand::typeInfo().

◆ typeInfo() [2/2]

void onert::ir::OperandInfo::typeInfo ( const ir::TypeInfo & typeInfo )

inline

Set type information.

Parameters

[in] typeInfo Type information

Definition at line 118 of file OperandInfo.h.

118{ _typeInfo = typeInfo; }

References typeInfo().

Referenced by typeInfo().

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

runtime/onert/core/include/ir/OperandInfo.h
runtime/onert/core/src/ir/OperandInfo.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OperandInfo() [1/3]

◆ OperandInfo() [2/3]

◆ OperandInfo() [3/3]

Member Function Documentation

◆ createStaticInfo()

◆ isConstant()

◆ isDynamic()

◆ isVariable()

◆ memAllocType()

◆ operator=()

◆ originIndex()

◆ setAsConstant()

◆ setAsNonConst()

◆ setAsVariable()

◆ setDynamic()

◆ setOriginIndex()

◆ shape() [1/3]

◆ shape() [2/3]

◆ shape() [3/3]

◆ total_size()

◆ type()

◆ typeInfo() [1/2]

◆ typeInfo() [2/2]