Documentation for microsoft::quantum::CallPattern

microsoft::quantum::CallPattern

Inherits from microsoft::quantum::IOperandPrototype

Public Types

Name
using std::string String

Public Functions

Name
CallPattern(String const & name)
Construction by name.
CallPattern(CallPattern const & other)
Copy construction prohibited.
CallPattern(CallPattern && other) =default
Move construction allowed.
~CallPattern() override
Destructor implementation.
virtual bool match(Value * instr, Captures & captures) const override
Matches the callee by name.
virtual Child copy() const override
Creates a copy of itself.

Additional inherited members

Public Types inherited from microsoft::quantum::IOperandPrototype

Name
using llvm::Instruction Instruction
using llvm::Value Value
using std::shared_ptr< IOperandPrototype > Child
using std::vector< Child > Children
using std::unordered_map< std::string, Value * > Captures

Public Functions inherited from microsoft::quantum::IOperandPrototype

Name
IOperandPrototype() =default
virtual ~IOperandPrototype()
void addChild(Child const & child)
void captureAs(std::string capture_name)

Protected Functions inherited from microsoft::quantum::IOperandPrototype

Name
bool fail(Value * value, Captures & captures) const
Function which should be called whenever a match fails.
bool success(Value * value, Captures & captures) const
Function which should be called whenever a match is successful.
bool matchChildren(Value * value, Captures & captures) const
Subroutine to match all children.
void copyPropertiesFrom(IOperandPrototype const & other)

Public Types Documentation

using String

using microsoft::quantum::CallPattern::String =  std::string;

Public Functions Documentation

function CallPattern

explicit CallPattern(
    String const & name
)

Construction by name.

function CallPattern

CallPattern(
    CallPattern const & other
)

Copy construction prohibited.

function CallPattern

CallPattern(
    CallPattern && other
) =default

Move construction allowed.

function ~CallPattern

~CallPattern() override

Destructor implementation.

function match

virtual bool match(
    Value * instr,
    Captures & captures
) const override

Matches the callee by name.

Reimplements: microsoft::quantum::IOperandPrototype::match

function copy

virtual Child copy() const override

Creates a copy of itself.

Reimplements: microsoft::quantum::IOperandPrototype::copy


Updated on 1 August 2023 at 16:25:10 UTC