tvm::NameSupplyNode Class Reference

NameSupply can be used to generate unique names. More...

#include <name_supply.h>

Inheritance diagram for tvm::NameSupplyNode:

Collaboration diagram for tvm::NameSupplyNode:

Public Member Functions
	NameSupplyNode ()=default
	Empty constructor. Needed by the TVM_REGISTER_NODE_TYPE macro. More...
	NameSupplyNode (const String &prefix, std::unordered_map< std::string, int > name_map)
	Constructor. More...
String	FreshName (const String &name, bool add_prefix=true, bool add_underscore=true)
	Generates a unique name from this NameSupply. More...
String	ReserveName (const String &name, bool add_prefix=true)
	Reserves an existing name with this NameSupply. More...
bool	ContainsName (const String &name, bool add_prefix=true)
	Checks if this NameSupply already generated a name. More...
void	VisitAttrs (AttrVisitor *v)
	TVM_DECLARE_FINAL_OBJECT_INFO (NameSupplyNode, 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
std::string	prefix_

Static Public Attributes
static constexpr const char *	_type_key = "NameSupply"
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

NameSupply can be used to generate unique names.

Constructor & Destructor Documentation

NameSupplyNode() [1/2]

tvm::NameSupplyNode::NameSupplyNode ( )

default

Empty constructor. Needed by the TVM_REGISTER_NODE_TYPE macro.

NameSupplyNode() [2/2]

tvm::NameSupplyNode::NameSupplyNode ( const String &  prefix, std::unordered_map< std::string, int >  name_map  )

inline

Constructor.

Parameters

prefix	The prefix to be used with this NameSupply.
name_map	The map used to guarantee uniqueness.

Member Function Documentation

ContainsName()

bool tvm::NameSupplyNode::ContainsName	(	const String &	name,
		bool	add_prefix = true
	)

Checks if this NameSupply already generated a name.

Parameters

name	The name to check.
add_prefix	If set to true, then the prefix of this NameSupply will be prepended to the name before checking for it.

Returns

True if the name has already been generated. False otherwise.

FreshName()

String tvm::NameSupplyNode::FreshName	(	const String &	name,
		bool	add_prefix = true,
		bool	add_underscore = true
	)

Generates a unique name from this NameSupply.

Parameters

name	The name from which the generated name is derived.
add_prefix	If set to true, then the prefix of this NameSupply will be prepended to the name.
add_underscore	If set to true, add '_' between prefix and a digit.

Returns

A unique name.

ReserveName()

String tvm::NameSupplyNode::ReserveName	(	const String &	name,
		bool	add_prefix = true
	)

Reserves an existing name with this NameSupply.

Parameters

name	The name to be reserved.
add_prefix	If set to true, then the prefix of this NameSupply will be prepended to the name before reserving it.

Returns

The name that was reserved with the NameSupply. It can be different if a prefix is added.

TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::NameSupplyNode::TVM_DECLARE_FINAL_OBJECT_INFO	(	NameSupplyNode	,
		Object
	)

VisitAttrs()

void tvm::NameSupplyNode::VisitAttrs ( AttrVisitor *  v )

inline

Member Data Documentation

_type_has_method_sequal_reduce

constexpr const bool tvm::NameSupplyNode::_type_has_method_sequal_reduce = false

staticconstexpr

_type_has_method_shash_reduce

constexpr const bool tvm::NameSupplyNode::_type_has_method_shash_reduce = false

staticconstexpr

_type_key

constexpr const char* tvm::NameSupplyNode::_type_key = "NameSupply"

staticconstexpr

prefix_

std::string tvm::NameSupplyNode::prefix_

---

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

• include/tvm/ir/name_supply.h