Doc that represents function definition. More...

#include <doc.h>

Inheritance diagram for tvm::script::printer::FunctionDocNode:

Collaboration diagram for tvm::script::printer::FunctionDocNode:

Public Member Functions
	TVM_FFI_DECLARE_OBJECT_INFO_FINAL ("script.printer.FunctionDoc", FunctionDocNode, StmtDocNode)

Public Member Functions inherited from tvm::script::printer::StmtDocNode
	TVM_FFI_DECLARE_OBJECT_INFO ("script.printer.StmtDoc", StmtDocNode, DocNode)

Public Member Functions inherited from tvm::script::printer::DocNode
	TVM_FFI_DECLARE_OBJECT_INFO ("script.printer.Doc", DocNode, ffi::Object)

virtual	~DocNode ()=default

Static Public Member Functions
static void	RegisterReflection ()

Static Public Member Functions inherited from tvm::script::printer::StmtDocNode
static void	RegisterReflection ()

Static Public Member Functions inherited from tvm::script::printer::DocNode
static void	RegisterReflection ()

Public Attributes
IdDoc	name {ffi::UnsafeInit{}}
	The name of function.

ffi::Array< AssignDoc >	args
	The arguments of function.

ffi::Array< ExprDoc >	decorators
	Decorators of function.

ffi::Optional< ExprDoc >	return_type {std::nullopt}
	The return type of function.

ffi::Array< StmtDoc >	body
	The body of function.

ffi::Array< Doc >	type_params
	The PEP 695 type parameters of the function.

Public Attributes inherited from tvm::script::printer::StmtDocNode
ffi::Optional< ffi::String >	comment {std::nullopt}
	The comment of this doc.

Public Attributes inherited from tvm::script::printer::DocNode
ffi::Array< AccessPath >	source_paths
	The list of object paths of the source IR node.

Additional Inherited Members
Static Public Attributes inherited from tvm::script::printer::DocNode
static constexpr bool	_type_mutable = true

Detailed Description

Doc that represents function definition.

See also: FunctionDoc

Member Function Documentation

◆ RegisterReflection()

static void tvm::script::printer::FunctionDocNode::RegisterReflection ( )

inlinestatic

◆ TVM_FFI_DECLARE_OBJECT_INFO_FINAL()

tvm::script::printer::FunctionDocNode::TVM_FFI_DECLARE_OBJECT_INFO_FINAL	(	"script.printer.FunctionDoc"	,
		FunctionDocNode	,
		StmtDocNode
	)

Member Data Documentation

◆ args

ffi::Array<AssignDoc> tvm::script::printer::FunctionDocNode::args

The arguments of function.

The lhs means argument name, annotation means argument type, and rhs means default value.

◆ body

ffi::Array<StmtDoc> tvm::script::printer::FunctionDocNode::body

The body of function.

◆ decorators

ffi::Array<ExprDoc> tvm::script::printer::FunctionDocNode::decorators

Decorators of function.

◆ name

IdDoc tvm::script::printer::FunctionDocNode::name {ffi::UnsafeInit{}}

The name of function.

◆ return_type

ffi::Optional<ExprDoc> tvm::script::printer::FunctionDocNode::return_type {std::nullopt}

The return type of function.

◆ type_params

ffi::Array<Doc> tvm::script::printer::FunctionDocNode::type_params

The PEP 695 type parameters of the function.

Possible actual types:

ExprDoc (a bare parameter like T)
AssignDoc (an annotated parameter like T: int)

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

include/tvm/script/printer/doc.h

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members