tvm
Public Member Functions | Static Public Member Functions | List of all members
tvm::relay::Var Class Reference

#include <expr.h>

Inheritance diagram for tvm::relay::Var:
Collaboration diagram for tvm::relay::Var:

Public Member Functions

 Var (String name_hint, Type type_annotation, Span span=Span())
 The constructor. More...
 
 Var (Id vid, Type type_annotation, Span span=Span())
 The constructor. More...
 
 TVM_DEFINE_OBJECT_REF_METHODS (Var, RelayExpr, VarNode)
 
 TVM_DEFINE_OBJECT_REF_COW_METHOD (VarNode)
 
- Public Member Functions inherited from tvm::RelayExpr
 TVM_DEFINE_OBJECT_REF_METHODS (RelayExpr, BaseExpr, RelayExprNode)
 
- Public Member Functions inherited from tvm::BaseExpr
 TVM_DEFINE_OBJECT_REF_METHODS (BaseExpr, ObjectRef, BaseExprNode)
 
- Public Member Functions inherited from tvm::runtime::ObjectRef
 ObjectRef ()=default
 default constructor More...
 
 ObjectRef (ObjectPtr< Object > data)
 Constructor from existing object ptr. More...
 
bool same_as (const ObjectRef &other) const
 Comparator. More...
 
bool operator== (const ObjectRef &other) const
 Comparator. More...
 
bool operator!= (const ObjectRef &other) const
 Comparator. More...
 
bool operator< (const ObjectRef &other) const
 Comparator. More...
 
bool defined () const
 
const Objectget () const
 
const Objectoperator-> () const
 
bool unique () const
 
int use_count () const
 
template<typename ObjectType , typename = std::enable_if_t<std::is_base_of_v<Object, ObjectType>>>
const ObjectType * as () const
 Try to downcast the internal Object to a raw pointer of a corresponding type. More...
 
template<typename ObjectRefType , typename = std::enable_if_t<std::is_base_of_v<ObjectRef, ObjectRefType>>>
Optional< ObjectRefType > as () const
 Try to downcast the ObjectRef to a Optional<T> of the requested type. More...
 

Static Public Member Functions

static Var GenSym (Type type_annotation={}, Span span={})
 Return a globally fresh name. Helps with debugging to follow the same variable between passes and sub-expressions. More...
 

Additional Inherited Members

- Public Types inherited from tvm::runtime::ObjectRef
using ContainerType = Object
 type indicate the container type. More...
 
- Static Public Attributes inherited from tvm::runtime::ObjectRef
static constexpr bool _type_is_nullable = true
 
- Protected Member Functions inherited from tvm::runtime::ObjectRef
Objectget_mutable () const
 
- Static Protected Member Functions inherited from tvm::runtime::ObjectRef
template<typename T >
static T DowncastNoCheck (ObjectRef ref)
 Internal helper function downcast a ref without check. More...
 
static void FFIClearAfterMove (ObjectRef *ref)
 Clear the object ref data field without DecRef after we successfully moved the field. More...
 
template<typename ObjectType >
static ObjectPtr< ObjectType > GetDataPtr (const ObjectRef &ref)
 Internal helper function get data_ as ObjectPtr of ObjectType. More...
 
- Protected Attributes inherited from tvm::runtime::ObjectRef
ObjectPtr< Objectdata_
 Internal pointer that backs the reference. More...
 

Constructor & Destructor Documentation

◆ Var() [1/2]

tvm::relay::Var::Var ( String  name_hint,
Type  type_annotation,
Span  span = Span() 
)
inline

The constructor.

Parameters
name_hintThe name hint of a variable.
type_annotationThe type annotation of a variable.
spanThe source span of the expression.

◆ Var() [2/2]

tvm::relay::Var::Var ( Id  vid,
Type  type_annotation,
Span  span = Span() 
)

The constructor.

Parameters
vidThe unique id of a variable.
type_annotationThe type annotation of a variable.
spanThe source span of the expression.

Member Function Documentation

◆ GenSym()

static Var tvm::relay::Var::GenSym ( Type  type_annotation = {},
Span  span = {} 
)
static

Return a globally fresh name. Helps with debugging to follow the same variable between passes and sub-expressions.

TODO(mbs): Replace with name creation w.r.t. scopes once available as part of name gen overhaul.

◆ TVM_DEFINE_OBJECT_REF_COW_METHOD()

tvm::relay::Var::TVM_DEFINE_OBJECT_REF_COW_METHOD ( VarNode  )

◆ TVM_DEFINE_OBJECT_REF_METHODS()

tvm::relay::Var::TVM_DEFINE_OBJECT_REF_METHODS ( Var  ,
RelayExpr  ,
VarNode   
)

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