libqasm
library for handling cQASM files
|
A subcircuit. More...
Public Member Functions | |
Subcircuit (const cqasm::v1::primitives::Str &name=cqasm::v1::primitives::initialize< cqasm::v1::primitives::Str >(), const cqasm::v1::primitives::Int &iterations=cqasm::v1::primitives::initialize< cqasm::v1::primitives::Int >(), const Any< Bundle > &bundles=Any< Bundle >(), const Any< AnnotationData > &annotations=Any< AnnotationData >(), const Maybe< Block > &body=Maybe< Block >()) | |
Constructor. More... | |
void | find_reachable (::tree::base::PointerMap &map) const override |
Registers all reachable nodes with the given PointerMap. More... | |
void | check_complete (const ::tree::base::PointerMap &map) const override |
Returns whether this Subcircuit is complete/fully defined. More... | |
NodeType | type () const override |
Returns the NodeType of this node. More... | |
Subcircuit * | as_subcircuit () override |
Interprets this node to a node of type Subcircuit. More... | |
const Subcircuit * | as_subcircuit () const override |
Interprets this node to a node of type Subcircuit. More... | |
One< Node > | copy () const override |
Returns a shallow copy of this node. More... | |
One< Node > | clone () const override |
Returns a deep copy of this node. More... | |
bool | equals (const Node &rhs) const override |
Value-based equality operator. More... | |
bool | operator== (const Node &rhs) const override |
Pointer-based equality operator. More... | |
void | serialize (::tree::cbor::MapWriter &map, const ::tree::base::PointerMap &ids) const override |
Serializes this node to the given map. More... | |
![]() | |
Annotated (const Any< AnnotationData > &annotations=Any< AnnotationData >()) | |
Constructor. More... | |
Annotated * | as_annotated () override |
Interprets this node to a node of type Annotated. More... | |
const Annotated * | as_annotated () const override |
Interprets this node to a node of type Annotated. More... | |
![]() | |
bool | operator!= (const Node &rhs) const |
Pointer-based inequality operator. More... | |
template<typename T > | |
T | visit (Visitor< T > &visitor) |
Visit this object. More... | |
void | dump (std::ostream &out=std::cout, int indent=0) |
Writes a debug dump of this node to the given stream. More... | |
void | dump_seq (std::ostream &out=std::cout, int indent=0) |
Alternate debug dump that represents links and node uniqueness via sequence number tags. More... | |
virtual AnnotationData * | as_annotation_data () |
Interprets this node to a node of type AnnotationData. More... | |
virtual const AnnotationData * | as_annotation_data () const |
Interprets this node to a node of type AnnotationData. More... | |
virtual Block * | as_block () |
Interprets this node to a node of type Block. More... | |
virtual const Block * | as_block () const |
Interprets this node to a node of type Block. More... | |
virtual BreakStatement * | as_break_statement () |
Interprets this node to a node of type BreakStatement. More... | |
virtual const BreakStatement * | as_break_statement () const |
Interprets this node to a node of type BreakStatement. More... | |
virtual Bundle * | as_bundle () |
Interprets this node to a node of type Bundle. More... | |
virtual const Bundle * | as_bundle () const |
Interprets this node to a node of type Bundle. More... | |
virtual BundleExt * | as_bundle_ext () |
Interprets this node to a node of type BundleExt. More... | |
virtual const BundleExt * | as_bundle_ext () const |
Interprets this node to a node of type BundleExt. More... | |
virtual ContinueStatement * | as_continue_statement () |
Interprets this node to a node of type ContinueStatement. More... | |
virtual const ContinueStatement * | as_continue_statement () const |
Interprets this node to a node of type ContinueStatement. More... | |
virtual ErrorModel * | as_error_model () |
Interprets this node to a node of type ErrorModel. More... | |
virtual const ErrorModel * | as_error_model () const |
Interprets this node to a node of type ErrorModel. More... | |
virtual ForLoop * | as_for_loop () |
Interprets this node to a node of type ForLoop. More... | |
virtual const ForLoop * | as_for_loop () const |
Interprets this node to a node of type ForLoop. More... | |
virtual ForeachLoop * | as_foreach_loop () |
Interprets this node to a node of type ForeachLoop. More... | |
virtual const ForeachLoop * | as_foreach_loop () const |
Interprets this node to a node of type ForeachLoop. More... | |
virtual GotoInstruction * | as_goto_instruction () |
Interprets this node to a node of type GotoInstruction. More... | |
virtual const GotoInstruction * | as_goto_instruction () const |
Interprets this node to a node of type GotoInstruction. More... | |
virtual IfElse * | as_if_else () |
Interprets this node to a node of type IfElse. More... | |
virtual const IfElse * | as_if_else () const |
Interprets this node to a node of type IfElse. More... | |
virtual IfElseBranch * | as_if_else_branch () |
Interprets this node to a node of type IfElseBranch. More... | |
virtual const IfElseBranch * | as_if_else_branch () const |
Interprets this node to a node of type IfElseBranch. More... | |
virtual Instruction * | as_instruction () |
Interprets this node to a node of type Instruction. More... | |
virtual const Instruction * | as_instruction () const |
Interprets this node to a node of type Instruction. More... | |
virtual InstructionBase * | as_instruction_base () |
Interprets this node to a node of type InstructionBase. More... | |
virtual const InstructionBase * | as_instruction_base () const |
Interprets this node to a node of type InstructionBase. More... | |
virtual Mapping * | as_mapping () |
Interprets this node to a node of type Mapping. More... | |
virtual const Mapping * | as_mapping () const |
Interprets this node to a node of type Mapping. More... | |
virtual Program * | as_program () |
Interprets this node to a node of type Program. More... | |
virtual const Program * | as_program () const |
Interprets this node to a node of type Program. More... | |
virtual RepeatUntilLoop * | as_repeat_until_loop () |
Interprets this node to a node of type RepeatUntilLoop. More... | |
virtual const RepeatUntilLoop * | as_repeat_until_loop () const |
Interprets this node to a node of type RepeatUntilLoop. More... | |
virtual SetInstruction * | as_set_instruction () |
Interprets this node to a node of type SetInstruction. More... | |
virtual const SetInstruction * | as_set_instruction () const |
Interprets this node to a node of type SetInstruction. More... | |
virtual Statement * | as_statement () |
Interprets this node to a node of type Statement. More... | |
virtual const Statement * | as_statement () const |
Interprets this node to a node of type Statement. More... | |
virtual Structured * | as_structured () |
Interprets this node to a node of type Structured. More... | |
virtual const Structured * | as_structured () const |
Interprets this node to a node of type Structured. More... | |
virtual Variable * | as_variable () |
Interprets this node to a node of type Variable. More... | |
virtual const Variable * | as_variable () const |
Interprets this node to a node of type Variable. More... | |
virtual Version * | as_version () |
Interprets this node to a node of type Version. More... | |
virtual const Version * | as_version () const |
Interprets this node to a node of type Version. More... | |
virtual WhileLoop * | as_while_loop () |
Interprets this node to a node of type WhileLoop. More... | |
virtual const WhileLoop * | as_while_loop () const |
Interprets this node to a node of type WhileLoop. More... | |
Static Public Member Functions | |
static std::shared_ptr< Subcircuit > | deserialize (const ::tree::cbor::MapReader &map, ::tree::base::IdentifierMap &ids) |
Deserializes the given node. More... | |
![]() | |
static std::shared_ptr< Annotated > | deserialize (const ::tree::cbor::MapReader &map, ::tree::base::IdentifierMap &ids) |
Deserializes the given node. More... | |
![]() | |
static std::shared_ptr< Node > | deserialize (const ::tree::cbor::MapReader &map, ::tree::base::IdentifierMap &ids) |
Deserializes the given node. More... | |
Public Attributes | |
cqasm::v1::primitives::Str | name |
The name of the subcircuit. More... | |
cqasm::v1::primitives::Int | iterations |
An optional integer expression representing the number of iterations for this subcircuit. More... | |
Any< Bundle > | bundles |
The instruction bundles contained by this subcircuit. More... | |
Maybe< Block > | body |
The statements contained by this subcircuit. More... | |
![]() | |
Any< AnnotationData > | annotations |
Zero or more annotations attached to this object. More... | |
Protected Member Functions | |
void | visit_internal (VisitorBase &visitor, void *retval) override |
Helper method for visiting nodes. More... | |
A subcircuit.
That is, a named collection of bundles, possibly repeated a number of times.
Definition at line 2332 of file cqasm-v1-semantic-gen.hpp.
#include <cqasm-v1-semantic-gen.hpp>
cqasm::v1::semantic::Subcircuit::Subcircuit | ( | const cqasm::v1::primitives::Str & | name = cqasm::v1::primitives::initialize<cqasm::v1::primitives::Str>() , |
const cqasm::v1::primitives::Int & | iterations = cqasm::v1::primitives::initialize<cqasm::v1::primitives::Int>() , |
||
const Any< Bundle > & | bundles = Any<Bundle>() , |
||
const Any< AnnotationData > & | annotations = Any<AnnotationData>() , |
||
const Maybe< Block > & | body = Maybe<Block>() |
||
) |
Constructor.
Definition at line 2969 of file cqasm-v1-semantic-gen.cpp.
|
override |
Registers all reachable nodes with the given PointerMap.
Definition at line 2976 of file cqasm-v1-semantic-gen.cpp.
|
override |
Returns whether this Subcircuit
is complete/fully defined.
Definition at line 2986 of file cqasm-v1-semantic-gen.cpp.
|
overridevirtual |
Returns the NodeType
of this node.
Implements cqasm::v1::semantic::Node.
Definition at line 2996 of file cqasm-v1-semantic-gen.cpp.
|
overrideprotectedvirtual |
Helper method for visiting nodes.
Implements cqasm::v1::semantic::Node.
Definition at line 3003 of file cqasm-v1-semantic-gen.cpp.
|
overridevirtual |
Interprets this node to a node of type Subcircuit.
Returns null if it has the wrong type.
Reimplemented from cqasm::v1::semantic::Node.
Definition at line 3011 of file cqasm-v1-semantic-gen.cpp.
|
overridevirtual |
Interprets this node to a node of type Subcircuit.
Returns null if it has the wrong type.
Reimplemented from cqasm::v1::semantic::Node.
Definition at line 3019 of file cqasm-v1-semantic-gen.cpp.
Returns a shallow copy of this node.
Implements cqasm::v1::semantic::Node.
Definition at line 3026 of file cqasm-v1-semantic-gen.cpp.
Returns a deep copy of this node.
Implements cqasm::v1::semantic::Node.
Definition at line 3033 of file cqasm-v1-semantic-gen.cpp.
|
overridevirtual |
Value-based equality operator.
Ignores annotations!
Implements cqasm::v1::semantic::Node.
Definition at line 3044 of file cqasm-v1-semantic-gen.cpp.
|
overridevirtual |
Pointer-based equality operator.
Implements cqasm::v1::semantic::Node.
Definition at line 3058 of file cqasm-v1-semantic-gen.cpp.
|
overridevirtual |
Serializes this node to the given map.
Implements cqasm::v1::semantic::Node.
Definition at line 3072 of file cqasm-v1-semantic-gen.cpp.
|
static |
Deserializes the given node.
Writes a debug dump of this node to the given stream.
Definition at line 3099 of file cqasm-v1-semantic-gen.cpp.
cqasm::v1::primitives::Str cqasm::v1::semantic::Subcircuit::name |
The name of the subcircuit.
If the file doesn't start with a subcircuit definition, this is empty for the first subcircuit.
Definition at line 2339 of file cqasm-v1-semantic-gen.hpp.
cqasm::v1::primitives::Int cqasm::v1::semantic::Subcircuit::iterations |
An optional integer expression representing the number of iterations for this subcircuit.
This is 1 when the iteration count is not specified.
Definition at line 2345 of file cqasm-v1-semantic-gen.hpp.
The instruction bundles contained by this subcircuit.
Only used for API level 1.0 and 1.1; use body for 1.2+.
Definition at line 2351 of file cqasm-v1-semantic-gen.hpp.
The statements contained by this subcircuit.
Only used for API level 1.2+; use bundles for 1.0 and 1.1.
Definition at line 2357 of file cqasm-v1-semantic-gen.hpp.