tvm
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
tvm::script::printer::LiteralDoc Class Reference

Reference type of LiteralDocNode. More...

#include <doc.h>

Inheritance diagram for tvm::script::printer::LiteralDoc:
Collaboration diagram for tvm::script::printer::LiteralDoc:

Public Member Functions

 TVM_DEFINE_NOTNULLABLE_OBJECT_REF_METHODS (LiteralDoc, ExprDoc, LiteralDocNode)
 
- Public Member Functions inherited from tvm::script::printer::ExprDoc
ExprDoc operator[] (Array< Doc > indices) const
 Create a doc representing index access on the current ExprDoc. More...
 
 TVM_DEFINE_NOTNULLABLE_OBJECT_REF_METHODS (ExprDoc, Doc, ExprDocNode)
 
- Public Member Functions inherited from tvm::script::printer::Doc
virtual ~Doc ()=default
 
 TVM_DEFINE_NOTNULLABLE_OBJECT_REF_METHODS (Doc, ObjectRef, DocNode)
 
- 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 >
const ObjectType * as () const
 Try to downcast the internal Object to a raw pointer of a corresponding type. More...
 

Static Public Member Functions

static LiteralDoc None ()
 Create a LiteralDoc to represent None/null/empty value. More...
 
static LiteralDoc None (ObjectPath object_path)
 Create a LiteralDoc to represent None/null/empty value. More...
 
static LiteralDoc Int (int v)
 Create a LiteralDoc to represent integer. More...
 
static LiteralDoc Int (const TracedObject< IntImm > &v)
 Create a LiteralDoc to represent integer. More...
 
static LiteralDoc Int (const TracedBasicValue< int > &v)
 Create a LiteralDoc to represent integer. More...
 
static LiteralDoc Boolean (bool v)
 Create a LiteralDoc to represent boolean. More...
 
static LiteralDoc Boolean (const TracedBasicValue< bool > &v)
 Create a LiteralDoc to represent boolean. More...
 
static LiteralDoc Float (double v)
 Create a LiteralDoc to represent float. More...
 
static LiteralDoc Float (const TracedObject< FloatImm > &v)
 Create a LiteralDoc to represent float. More...
 
static LiteralDoc Str (const String &v)
 Create a LiteralDoc to represent string. More...
 
static LiteralDoc Str (const TracedObject< String > &v)
 Create a LiteralDoc to represent string. More...
 

Protected Member Functions

 LiteralDoc (ObjectRef value)
 
 LiteralDoc (ObjectRef value, ObjectPath object_path)
 
- Protected Member Functions inherited from tvm::script::printer::ExprDoc
 ExprDoc ()=default
 
- Protected Member Functions inherited from tvm::script::printer::Doc
 Doc ()=default
 
- Protected Member Functions inherited from tvm::runtime::ObjectRef
Objectget_mutable () const
 

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

Detailed Description

Reference type of LiteralDocNode.

See also
LiteralDocNode

Constructor & Destructor Documentation

◆ LiteralDoc() [1/2]

tvm::script::printer::LiteralDoc::LiteralDoc ( ObjectRef  value)
explicitprotected

◆ LiteralDoc() [2/2]

tvm::script::printer::LiteralDoc::LiteralDoc ( ObjectRef  value,
ObjectPath  object_path 
)
protected

Member Function Documentation

◆ Boolean() [1/2]

static LiteralDoc tvm::script::printer::LiteralDoc::Boolean ( bool  v)
inlinestatic

Create a LiteralDoc to represent boolean.

Parameters
vThe boolean value.

◆ Boolean() [2/2]

static LiteralDoc tvm::script::printer::LiteralDoc::Boolean ( const TracedBasicValue< bool > &  v)
inlinestatic

Create a LiteralDoc to represent boolean.

Parameters
vThe boolean value.

The ObjectPath of v will be pushed to the source_path of the returned doc.

◆ Float() [1/2]

static LiteralDoc tvm::script::printer::LiteralDoc::Float ( double  v)
inlinestatic

Create a LiteralDoc to represent float.

Parameters
vThe float value.

◆ Float() [2/2]

static LiteralDoc tvm::script::printer::LiteralDoc::Float ( const TracedObject< FloatImm > &  v)
inlinestatic

Create a LiteralDoc to represent float.

Parameters
vThe float value.

The ObjectPath of v will be pushed to the source_path of the returned doc.

◆ Int() [1/3]

static LiteralDoc tvm::script::printer::LiteralDoc::Int ( int  v)
inlinestatic

Create a LiteralDoc to represent integer.

Parameters
vThe integer value.

◆ Int() [2/3]

static LiteralDoc tvm::script::printer::LiteralDoc::Int ( const TracedObject< IntImm > &  v)
inlinestatic

Create a LiteralDoc to represent integer.

Parameters
vThe integer value.

The ObjectPath of v will be pushed to the source_path of the returned doc.

◆ Int() [3/3]

static LiteralDoc tvm::script::printer::LiteralDoc::Int ( const TracedBasicValue< int > &  v)
inlinestatic

Create a LiteralDoc to represent integer.

Parameters
vThe integer value.

The ObjectPath of v will be pushed to the source_path of the returned doc.

◆ None() [1/2]

static LiteralDoc tvm::script::printer::LiteralDoc::None ( )
inlinestatic

Create a LiteralDoc to represent None/null/empty value.

◆ None() [2/2]

static LiteralDoc tvm::script::printer::LiteralDoc::None ( ObjectPath  object_path)
inlinestatic

Create a LiteralDoc to represent None/null/empty value.

Parameters
object_pathThe source path of the returned Doc.

◆ Str() [1/2]

static LiteralDoc tvm::script::printer::LiteralDoc::Str ( const String v)
inlinestatic

Create a LiteralDoc to represent string.

Parameters
vThe string value.

◆ Str() [2/2]

static LiteralDoc tvm::script::printer::LiteralDoc::Str ( const TracedObject< String > &  v)
inlinestatic

Create a LiteralDoc to represent string.

Parameters
vThe string value.

The ObjectPath of v will be pushed to the source_path of the returned doc.

◆ TVM_DEFINE_NOTNULLABLE_OBJECT_REF_METHODS()

tvm::script::printer::LiteralDoc::TVM_DEFINE_NOTNULLABLE_OBJECT_REF_METHODS ( LiteralDoc  ,
ExprDoc  ,
LiteralDocNode   
)

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