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 , 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 LiteralDoc None (const Optional< ObjectPath > &p)
 Create a LiteralDoc to represent None/null/empty value. More...
 
static LiteralDoc Int (int64_t v, const Optional< ObjectPath > &p)
 Create a LiteralDoc to represent integer. More...
 
static LiteralDoc Boolean (bool v, const Optional< ObjectPath > &p)
 Create a LiteralDoc to represent boolean. More...
 
static LiteralDoc Float (double v, const Optional< ObjectPath > &p)
 Create a LiteralDoc to represent float. More...
 
static LiteralDoc Str (const String &v, const Optional< ObjectPath > &p)
 Create a LiteralDoc to represent string. More...
 
static LiteralDoc DataType (const runtime::DataType &v, const Optional< ObjectPath > &p)
 Create a LiteralDoc to represent string. More...
 

Protected Member Functions

 LiteralDoc (ObjectRef value, const Optional< 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()

tvm::script::printer::LiteralDoc::LiteralDoc ( ObjectRef  value,
const Optional< ObjectPath > &  object_path 
)
explicitprotected

Member Function Documentation

◆ Boolean()

static LiteralDoc tvm::script::printer::LiteralDoc::Boolean ( bool  v,
const Optional< ObjectPath > &  p 
)
inlinestatic

Create a LiteralDoc to represent boolean.

Parameters
vThe boolean value.
pThe object path

◆ DataType()

static LiteralDoc tvm::script::printer::LiteralDoc::DataType ( const runtime::DataType v,
const Optional< ObjectPath > &  p 
)
inlinestatic

Create a LiteralDoc to represent string.

Parameters
vThe string value.
pThe object path

◆ Float()

static LiteralDoc tvm::script::printer::LiteralDoc::Float ( double  v,
const Optional< ObjectPath > &  p 
)
inlinestatic

Create a LiteralDoc to represent float.

Parameters
vThe float value.
pThe object path

◆ Int()

static LiteralDoc tvm::script::printer::LiteralDoc::Int ( int64_t  v,
const Optional< ObjectPath > &  p 
)
inlinestatic

Create a LiteralDoc to represent integer.

Parameters
vThe integer value.
pThe object path

◆ None()

static LiteralDoc tvm::script::printer::LiteralDoc::None ( const Optional< ObjectPath > &  p)
inlinestatic

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

Parameters
pThe object path

◆ Str()

static LiteralDoc tvm::script::printer::LiteralDoc::Str ( const String v,
const Optional< ObjectPath > &  p 
)
inlinestatic

Create a LiteralDoc to represent string.

Parameters
vThe string value.
pThe object path

◆ 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: