tvm
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
tvm::BaseFuncNode Class Reference

Base node of all functions. More...

#include <function.h>

Inheritance diagram for tvm::BaseFuncNode:
Collaboration diagram for tvm::BaseFuncNode:

Public Member Functions

template<typename TObjectRef >
Optional< TObjectRef > GetAttr (const std::string &attr_key, Optional< TObjectRef > default_value=std::nullopt) const
 Get a function attribute. More...
 
template<typename TObjectRef >
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...
 
LinkageType GetLinkageType () const
 Get the type of the linkage. More...
 
 TVM_DECLARE_BASE_OBJECT_INFO (BaseFuncNode, RelaxExprNode)
 
- Public Member Functions inherited from tvm::RelaxExprNode
 TVM_DECLARE_BASE_OBJECT_INFO (RelaxExprNode, BaseExprNode)
 
- Public Member Functions inherited from tvm::BaseExprNode
 TVM_DECLARE_BASE_OBJECT_INFO (BaseExprNode, Object)
 

Static Public Member Functions

static void RegisterReflection ()
 
- Static Public Member Functions inherited from tvm::RelaxExprNode
static void RegisterReflection ()
 
- Static Public Member Functions inherited from tvm::BaseExprNode
static void RegisterReflection ()
 

Public Attributes

DictAttrs attrs
 Additional attributes storing the meta-data. More...
 
- Public Attributes inherited from tvm::RelaxExprNode
Optional< ObjectRef > struct_info_ = Optional<ObjectRef>()
 Stores the result of structure information of the expression that encapsulate both static shape and runtime information such as shape. More...
 
- Public Attributes inherited from tvm::BaseExprNode
Span span
 Span that points to the original source code. Reserved debug information. More...
 

Static Public Attributes

static constexpr const char * _type_key = "ir.BaseFunc"
 
static constexpr const uint32_t _type_child_slots = 2
 
- Static Public Attributes inherited from tvm::RelaxExprNode
static constexpr const char * _type_key = "ir.RelaxExpr"
 
static constexpr const uint32_t _type_child_slots = 22
 
- Static Public Attributes inherited from tvm::BaseExprNode
static constexpr const char * _type_key = "ir.BaseExpr"
 
static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode
 
static constexpr const uint32_t _type_child_slots = 64
 

Detailed Description

Base node of all functions.

We support several variants of functions throughout the stack. All of the functions share the same type system to support cross variant calls.

See also
BaseFunc

Member Function Documentation

◆ GetAttr() [1/2]

template<typename TObjectRef >
Optional<TObjectRef> tvm::BaseFuncNode::GetAttr ( const std::string &  attr_key,
Optional< TObjectRef >  default_value = std::nullopt 
) const
inline

Get a function attribute.

Parameters
attr_keyThe attribute key.
default_valueThe default value if the key does not exist, defaults to nullptr.
Returns
The result
Template Parameters
TOBjectRefthe expected object type.
Exceptions
Errorif the key exists but the value does not match TObjectRef
void GetAttrExample(const BaseFunc& f) {
auto value = f->GetAttr<Integer>("AttrKey", 0);
}

◆ GetAttr() [2/2]

template<typename TObjectRef >
Optional<TObjectRef> tvm::BaseFuncNode::GetAttr ( const std::string &  attr_key,
TObjectRef  default_value 
) const
inline

◆ GetLinkageType()

LinkageType tvm::BaseFuncNode::GetLinkageType ( ) const
inline

Get the type of the linkage.

Currently, we only consider external/internal linkage. This can be extended in the future when necessary.

Returns
Linkage type.
void Example(const BaseFunc& f) {
if (f->GetLinkageType() == tvm::LinkageType::kExternal) {
// Do not remove a function with external linkage
}
}
@ kExternal
External linkage.

◆ HasNonzeroAttr()

bool tvm::BaseFuncNode::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_keyThe key to the attribute.
Returns
The check result.
void HasNonzeroAttrExample(const BaseFunc& f) {
if (f->HasNonzeroAttr(attr::kInline)) {
// inline the function.
}
}

◆ RegisterReflection()

static void tvm::BaseFuncNode::RegisterReflection ( )
inlinestatic

◆ TVM_DECLARE_BASE_OBJECT_INFO()

tvm::BaseFuncNode::TVM_DECLARE_BASE_OBJECT_INFO ( BaseFuncNode  ,
RelaxExprNode   
)

Member Data Documentation

◆ _type_child_slots

constexpr const uint32_t tvm::BaseFuncNode::_type_child_slots = 2
staticconstexpr

◆ _type_key

constexpr const char* tvm::BaseFuncNode::_type_key = "ir.BaseFunc"
staticconstexpr

◆ attrs

DictAttrs tvm::BaseFuncNode::attrs

Additional attributes storing the meta-data.


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