tvm::relax::FuncStructInfoNode Class Reference

Structure information about function. More...

#include <struct_info.h>

Inheritance diagram for tvm::relax::FuncStructInfoNode:

Collaboration diagram for tvm::relax::FuncStructInfoNode:

Public Member Functions
bool	IsOpaque () const
void	VisitAttrs (AttrVisitor *v)
bool	SEqualReduce (const FuncStructInfoNode *other, SEqualReducer equal) const
void	SHashReduce (SHashReducer hash_reduce) const
	TVM_DECLARE_FINAL_OBJECT_INFO (FuncStructInfoNode, StructInfoNode)
Public Member Functions inherited from tvm::relax::StructInfoNode
	TVM_DECLARE_BASE_OBJECT_INFO (StructInfoNode, Object)
Public Member Functions inherited from tvm::runtime::Object
uint32_t	type_index () const
std::string	GetTypeKey () const
size_t	GetTypeKeyHash () const
template<typename TargetType >
bool	IsInstance () const
bool	unique () const
	Object ()
	Object (const Object &other)
	Object (Object &&other)
Object &	operator= (const Object &other)
Object &	operator= (Object &&other)

Public Attributes
Optional< Array< StructInfo > >	params
	The parameter struct info of the function. More...
StructInfo	ret
	The struct info of the function's return value. More...
Optional< StructInfoDeriveFunc >	derive_func
	Derivation function of opaque functions that may take any number of parameters. More...
bool	purity
	Whether the function is pure. More...
Public Attributes inherited from tvm::relax::StructInfoNode
Span	span
	Span that points to the original source code. Reserved debug information. More...

Static Public Attributes
static constexpr const char *	_type_key = "relax.FuncStructInfo"
Static Public Attributes inherited from tvm::relax::StructInfoNode
static constexpr const char *	_type_key = "StructInfo"
static constexpr const bool	_type_has_method_sequal_reduce = true
static constexpr const bool	_type_has_method_shash_reduce = true
static constexpr const uint32_t	_type_child_slots = 7
Static Public Attributes inherited from tvm::runtime::Object
static constexpr const char *	_type_key = "runtime.Object"
static constexpr bool	_type_final = false
static constexpr uint32_t	_type_child_slots = 0
static constexpr bool	_type_child_slots_can_overflow = true
static constexpr bool	_type_has_method_visit_attrs = true
static constexpr bool	_type_has_method_sequal_reduce = false
static constexpr bool	_type_has_method_shash_reduce = false
static constexpr uint32_t	_type_index = TypeIndex::kDynamic

Additional Inherited Members
Public Types inherited from tvm::runtime::Object
typedef void(*	FDeleter) (Object *self)
	Object deleter. More...
using	RefCounterType = std::atomic< int32_t >
Static Public Member Functions inherited from tvm::runtime::Object
static std::string	TypeIndex2Key (uint32_t tindex)
	Get the type key of the corresponding index from runtime. More...
static size_t	TypeIndex2KeyHash (uint32_t tindex)
	Get the type key hash of the corresponding index from runtime. More...
static uint32_t	TypeKey2Index (const std::string &key)
	Get the type index of the corresponding key from runtime. More...
static uint32_t	_GetOrAllocRuntimeTypeIndex ()
static uint32_t	RuntimeTypeIndex ()
Protected Member Functions inherited from tvm::runtime::Object
void	IncRef ()
	developer function, increases reference counter. More...
void	DecRef ()
	developer function, decrease reference counter. More...
Static Protected Member Functions inherited from tvm::runtime::Object
static uint32_t	GetOrAllocRuntimeTypeIndex (const std::string &key, uint32_t static_tindex, uint32_t parent_tindex, uint32_t type_child_slots, bool type_child_slots_can_overflow)
	Get the type index using type key. More...
Protected Attributes inherited from tvm::runtime::Object
uint32_t	type_index_ {0}
	Type index(tag) that indicates the type of the object. More...
RefCounterType	ref_counter_ {0}
	The internal reference counter. More...
FDeleter	deleter_ = nullptr
	deleter of this object to enable customized allocation. If the deleter is nullptr, no deletion will be performed. The creator of the object must always set the deleter field properly. More...

Detailed Description

Structure information about function.

This data structure contains enough information for us to do best-effort structure information deduction.

Member Function Documentation

IsOpaque()

bool tvm::relax::FuncStructInfoNode::IsOpaque ( ) const

inline

Returns

Whether the func struct info is opaque.

Note

We define a function as opaque we have no constraints on params.

SEqualReduce()

bool tvm::relax::FuncStructInfoNode::SEqualReduce ( const FuncStructInfoNode *  other, SEqualReducer  equal  ) const

inline

SHashReduce()

void tvm::relax::FuncStructInfoNode::SHashReduce ( SHashReducer  hash_reduce ) const

inline

TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::relax::FuncStructInfoNode::TVM_DECLARE_FINAL_OBJECT_INFO	(	FuncStructInfoNode	,
		StructInfoNode
	)

VisitAttrs()

void tvm::relax::FuncStructInfoNode::VisitAttrs ( AttrVisitor *  v )

inline

Member Data Documentation

_type_key

constexpr const char* tvm::relax::FuncStructInfoNode::_type_key = "relax.FuncStructInfo"

staticconstexpr

derive_func

Optional<StructInfoDeriveFunc> tvm::relax::FuncStructInfoNode::derive_func

Derivation function of opaque functions that may take any number of parameters.

Note

When derive_func is not empty, then params should be NullOpt, ret should be ObjectStructInfo()

params

Optional<Array<StructInfo> > tvm::relax::FuncStructInfoNode::params

The parameter struct info of the function.

Note

When params is NullOpt means the function can take arbitrary number of arguments. We define such functions as Opaque function.

purity

bool tvm::relax::FuncStructInfoNode::purity

Whether the function is pure.

Note

This parameter should be set to true only if the function is pure on all inputs. If the function may have visible side effects, set it to false.

ret

StructInfo tvm::relax::FuncStructInfoNode::ret

The struct info of the function's return value.

---

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

• include/tvm/relax/struct_info.h