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

GlobalVarSupply can be used to generate unique GlobalVars. More...

#include <global_var_supply.h>

Inheritance diagram for tvm::GlobalVarSupplyNode:
Collaboration diagram for tvm::GlobalVarSupplyNode:

Public Member Functions

 GlobalVarSupplyNode ()
 Empty constructor. Will use an empty NameSupply. More...
 
 GlobalVarSupplyNode (NameSupply name_supply, std::unordered_map< std::string, GlobalVar > name_to_var_map={})
 Constructor. More...
 
GlobalVar FreshGlobal (String name, bool add_prefix=true)
 Generates a unique GlobalVar from this supply. More...
 
GlobalVar UniqueGlobalFor (const String &name, bool add_prefix=true)
 Looks up for a GlobalVar with the given name in this supply. If no entry is found, creates one, places it in the cache and returns it. More...
 
void ReserveGlobalVar (const GlobalVar &var, bool allow_conflict=false)
 Reserves an existing GlobalVar with this supply. More...
 
void VisitAttrs (AttrVisitor *v)
 
 TVM_DECLARE_FINAL_OBJECT_INFO (GlobalVarSupplyNode, 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)
 

Public Attributes

NameSupply name_supply_
 The NameSupply used to generate unique name hints to GlobalVars. More...
 

Static Public Attributes

static constexpr const char * _type_key = "GlobalVarSupply"
 
static constexpr const bool _type_has_method_sequal_reduce = false
 
static constexpr const bool _type_has_method_shash_reduce = false
 
- 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

GlobalVarSupply can be used to generate unique GlobalVars.

Constructor & Destructor Documentation

◆ GlobalVarSupplyNode() [1/2]

tvm::GlobalVarSupplyNode::GlobalVarSupplyNode ( )
inline

Empty constructor. Will use an empty NameSupply.

◆ GlobalVarSupplyNode() [2/2]

tvm::GlobalVarSupplyNode::GlobalVarSupplyNode ( NameSupply  name_supply,
std::unordered_map< std::string, GlobalVar name_to_var_map = {} 
)
explicit

Constructor.

Parameters
name_supplyThe NameSupply to use for generating the names of fresh GlobalVars.
name_to_var_mapAn optional map.

Member Function Documentation

◆ FreshGlobal()

GlobalVar tvm::GlobalVarSupplyNode::FreshGlobal ( String  name,
bool  add_prefix = true 
)

Generates a unique GlobalVar from this supply.

Parameters
nameThe name from which the name of the GlobalVar is derived.
add_prefixIf set to true, then the prefix of the contained NameSupply will be prepended to the name.
Returns
A unique GlobalVar.

◆ ReserveGlobalVar()

void tvm::GlobalVarSupplyNode::ReserveGlobalVar ( const GlobalVar var,
bool  allow_conflict = false 
)

Reserves an existing GlobalVar with this supply.

Parameters
varThe GlobalVar to be registered.
allow_conflictAllow conflict with other GlobalVars that have the same name.

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::GlobalVarSupplyNode::TVM_DECLARE_FINAL_OBJECT_INFO ( GlobalVarSupplyNode  ,
Object   
)

◆ UniqueGlobalFor()

GlobalVar tvm::GlobalVarSupplyNode::UniqueGlobalFor ( const String name,
bool  add_prefix = true 
)

Looks up for a GlobalVar with the given name in this supply. If no entry is found, creates one, places it in the cache and returns it.

Parameters
nameThe name of the GlobalVar to search for.
add_prefixIf set to true, the prefix of the contained NameSupply will be prepended to the name before performing the search.
Returns
A cached GlobalVar.

◆ VisitAttrs()

void tvm::GlobalVarSupplyNode::VisitAttrs ( AttrVisitor v)
inline

Member Data Documentation

◆ _type_has_method_sequal_reduce

constexpr const bool tvm::GlobalVarSupplyNode::_type_has_method_sequal_reduce = false
staticconstexpr

◆ _type_has_method_shash_reduce

constexpr const bool tvm::GlobalVarSupplyNode::_type_has_method_shash_reduce = false
staticconstexpr

◆ _type_key

constexpr const char* tvm::GlobalVarSupplyNode::_type_key = "GlobalVarSupply"
staticconstexpr

◆ name_supply_

NameSupply tvm::GlobalVarSupplyNode::name_supply_

The NameSupply used to generate unique name hints to GlobalVars.


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