tvm
Classes | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
tvm::runtime::PackedFuncObj Class Reference

Object container class that backs PackedFunc. More...

#include <packed_func.h>

Inheritance diagram for tvm::runtime::PackedFuncObj:
Collaboration diagram for tvm::runtime::PackedFuncObj:

Classes

struct  Extractor
 Internal struct for extracting the callable method from callable type. More...
 

Public Member Functions

TVM_ALWAYS_INLINE void CallPacked (TVMArgs args, TVMRetValue *rv) const
 Call the function in packed format. More...
 
 TVM_DECLARE_FINAL_OBJECT_INFO (PackedFuncObj, 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)
 
Objectoperator= (const Object &other)
 
Objectoperator= (Object &&other)
 

Static Public Attributes

static constexpr const uint32_t _type_index = TypeIndex::kRuntimePackedFunc
 
static constexpr const char * _type_key = "runtime.PackedFunc"
 
- 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
 

Protected Types

using FCallPacked = void(const PackedFuncObj *, TVMArgs, TVMRetValue *)
 The internal callable function type. More...
 

Protected Member Functions

 PackedFuncObj (FCallPacked *f_call_pack)
 Constructing a packed function object from a function pointer. More...
 
 PackedFuncObj ()=delete
 Delete the default constructor explicitly. More...
 
- Protected Member Functions inherited from tvm::runtime::Object
void IncRef ()
 developer function, increases reference counter. More...
 
void DecRef ()
 developer function, decrease reference counter. More...
 

Protected Attributes

FCallPackedf_call_packed_
 Internal callable function pointer used to call the packed function. 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...
 

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 ()
 
- 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...
 

Detailed Description

Object container class that backs PackedFunc.

Note
Do not use this function directly, use PackedFunc.

Member Typedef Documentation

◆ FCallPacked

The internal callable function type.

Constructor & Destructor Documentation

◆ PackedFuncObj() [1/2]

tvm::runtime::PackedFuncObj::PackedFuncObj ( FCallPacked f_call_pack)
inlineexplicitprotected

Constructing a packed function object from a function pointer.

Parameters
f_call_packThe function pointer used to call the packed function.

◆ PackedFuncObj() [2/2]

tvm::runtime::PackedFuncObj::PackedFuncObj ( )
protecteddelete

Delete the default constructor explicitly.

Member Function Documentation

◆ CallPacked()

TVM_ALWAYS_INLINE void tvm::runtime::PackedFuncObj::CallPacked ( TVMArgs  args,
TVMRetValue rv 
) const

Call the function in packed format.

Parameters
argsThe arguments
rvThe return value.

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::runtime::PackedFuncObj::TVM_DECLARE_FINAL_OBJECT_INFO ( PackedFuncObj  ,
Object   
)

Member Data Documentation

◆ _type_index

constexpr const uint32_t tvm::runtime::PackedFuncObj::_type_index = TypeIndex::kRuntimePackedFunc
staticconstexpr

◆ _type_key

constexpr const char* tvm::runtime::PackedFuncObj::_type_key = "runtime.PackedFunc"
staticconstexpr

◆ f_call_packed_

FCallPacked* tvm::runtime::PackedFuncObj::f_call_packed_
protected

Internal callable function pointer used to call the packed function.


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