tvm::DictAttrs Class Reference

Managed reference to DictAttrsNode. More...

#include <attrs.h>

Inheritance diagram for tvm::DictAttrs:

Collaboration diagram for tvm::DictAttrs:

Public Member Functions
	DictAttrs (ffi::UnsafeInit tag)
	constructor with UnsafeInit More...
	DictAttrs (ffi::Map< ffi::String, Any > dict={})
	Consruct a Attrs backed by DictAttrsNode. More...
template<typename TObjectRef >
ffi::Optional< TObjectRef >	GetAttr (const std::string &attr_key, ffi::Optional< TObjectRef > default_value=ffi::Optional< TObjectRef >(std::nullopt)) const
	Get a function attribute. More...
template<typename TObjectRef >
ffi::Optional< TObjectRef >	GetAttr (const std::string &attr_key, TObjectRef default_value) const
bool	HasNonzeroAttr (const std::string &attr_key) const
	Check whether the function has an non-zero integer attr. More...
	TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE_WITHOUT_DEFAULT_CONSTRUCTOR (DictAttrs, Attrs, DictAttrsNode)
	TVM_DEFINE_OBJECT_REF_COW_METHOD (DictAttrsNode)
Public Member Functions inherited from tvm::Attrs
	TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE (Attrs, ObjectRef, BaseAttrsNode)

Detailed Description

Managed reference to DictAttrsNode.

See also

DictAttrsNode.

Constructor & Destructor Documentation

DictAttrs() [1/2]

tvm::DictAttrs::DictAttrs ( ffi::UnsafeInit  tag )

inlineexplicit

constructor with UnsafeInit

DictAttrs() [2/2]

tvm::DictAttrs::DictAttrs ( ffi::Map< ffi::String, Any >  dict = {} )

explicit

Consruct a Attrs backed by DictAttrsNode.

Parameters

dict	The attributes.

Member Function Documentation

GetAttr() [1/2]

template<typename TObjectRef >

ffi::Optional<TObjectRef> tvm::DictAttrs::GetAttr ( const std::string &  attr_key, ffi::Optional< TObjectRef >  default_value = ffi::Optional<TObjectRef>(std::nullopt)  ) const

inline

Get a function attribute.

Parameters

attr_key	The attribute key.
default_value	The default value if the key does not exist, defaults to nullptr.

Returns

The result

Template Parameters

TOBjectRef

the expected object type.

Exceptions

Error

if the key exists but the value does not match TObjectRef

void GetAttrExample(const BaseFunc& f) {
  auto value = f->attrs.GetAttr<Integer>("AttrKey", 0);
}

GetAttr() [2/2]

template<typename TObjectRef >

ffi::Optional<TObjectRef> tvm::DictAttrs::GetAttr ( const std::string &  attr_key, TObjectRef  default_value  ) const

inline

HasNonzeroAttr()

bool tvm::DictAttrs::HasNonzeroAttr ( const std::string &  attr_key ) const

inline

Check whether the function has an non-zero integer attr.

This function can be used to check whether an optional attribute mark(e.g. inline) exists.

Parameters

attr_key

The key to the attribute.

Returns

The check result.

void HasNonzeroAttrExample(const BaseFunc& f) {
  if (f->HasNonzeroAttr(attr::kInline)) {
    // inline the function.
  }
}

TVM_DEFINE_OBJECT_REF_COW_METHOD()

tvm::DictAttrs::TVM_DEFINE_OBJECT_REF_COW_METHOD

(

DictAttrsNode

)

TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE_WITHOUT_DEFAULT_CONSTRUCTOR()

tvm::DictAttrs::TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE_WITHOUT_DEFAULT_CONSTRUCTOR	(	DictAttrs	,
		Attrs	,
		DictAttrsNode
	)

---

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

• include/tvm/ir/attrs.h