Documentation for microsoft::quantum::TargetQisMappingPassConfiguration

Configuration class for the RuleTransformation pass.

microsoft::quantum::TargetQisMappingPassConfiguration

Configuration class for the RuleTransformation pass.

#include <Passes/TargetQisMappingPass/TargetQisMappingPassConfiguration.hpp>

Public Types

Name
using DeferredValue::DeferredValuePtr DeferredValuePtr

Public Functions

Name
void setup(ConfigurationManager & config)
Setup function that attached the configuration to the ConfigurationManager.
bool isDisabled() const
Tests whether all functionality is disabled for this component.
bool isDefault() const
Tests whether this is an instance of default configuration.
bool operator==(TargetQisMappingPassConfiguration const & ref) const
Testing equality of two configurations.
bool shouldDeleteDeadCode() const
Whether or not the component should delete dead code.
bool shouldCloneFunctions() const
bool assumeNoExceptions() const
Whether or not we assume that the code does not throw at runtime.
bool shouldTransformExecutionPathOnly() const
uint64_t maxRecursion() const
The maximum recursion acceptable when unrolling the execution path.
bool shouldReuseQubits() const
Whether or not to reuse qubits.
bool shouldAnnotateQubitUse() const
Whether or not to annotate entry point with the number of qubits they use.
bool shouldReuseResults() const
Whether or not to reuse result registers.
bool shouldAnnotateResultUse() const
Whether or not to annotate entry point with the number of results they use.
bool shouldGroupMeasurements() const
Whether or not the component should attempt to group measurements.
bool oneShotMeasurement() const
std::string entryPointAttr() const
Attribute which indicate that a function is the entry point.
bool disableReferenceCounting() const
bool disableAliasCounting() const
bool disableStringSupport() const
bool disableInitializeSupport() const
bool disableRecordOutputSupport() const
bool optimizeResultOne() const
bool optimizeResultZero() const
bool optimizeQuantumConstants() const
bool optimizeResultComparison() const
bool removeGetZeroOrOne() const
bool useStaticQubitArrayAllocation() const
bool useStaticQubitAllocation() const
bool useStaticResultAllocation() const
uint32_t defaultIntegerWidth() const
TargetQisMappingPassConfiguration createDisabled()
Creates a configuration where all functionality is disabled.
TargetQisMappingPassConfiguration createReuseQubitsOnly()
Creates a configuration where only reuse qubits is enabled.

Public Types Documentation

using DeferredValuePtr

using microsoft::quantum::TargetQisMappingPassConfiguration::DeferredValuePtr =  DeferredValue::DeferredValuePtr;

Public Functions Documentation

function setup

void setup(
    ConfigurationManager & config
)

Setup function that attached the configuration to the ConfigurationManager.

function isDisabled

bool isDisabled() const

Tests whether all functionality is disabled for this component.

function isDefault

bool isDefault() const

Tests whether this is an instance of default configuration.

function operator==

bool operator==(
    TargetQisMappingPassConfiguration const & ref
) const

Testing equality of two configurations.

function shouldDeleteDeadCode

bool shouldDeleteDeadCode() const

Whether or not the component should delete dead code.

function shouldCloneFunctions

bool shouldCloneFunctions() const

Whether or not the component should clone functions. This is relevant in relation to qubit allocation if execution paths are expanded.

function assumeNoExceptions

bool assumeNoExceptions() const

Whether or not we assume that the code does not throw at runtime.

function shouldTransformExecutionPathOnly

bool shouldTransformExecutionPathOnly() const

Whether or not the component should follow the execution path only or it should be applied to all parts of the code. For statically allocated qubits one generally wants to follow the execution path whereas it makes more sense to apply to all parts of the code for dynamic qubit allocation.

function maxRecursion

uint64_t maxRecursion() const

The maximum recursion acceptable when unrolling the execution path.

function shouldReuseQubits

bool shouldReuseQubits() const

Whether or not to reuse qubits.

function shouldAnnotateQubitUse

bool shouldAnnotateQubitUse() const

Whether or not to annotate entry point with the number of qubits they use.

function shouldReuseResults

bool shouldReuseResults() const

Whether or not to reuse result registers.

function shouldAnnotateResultUse

bool shouldAnnotateResultUse() const

Whether or not to annotate entry point with the number of results they use.

function shouldGroupMeasurements

bool shouldGroupMeasurements() const

Whether or not the component should attempt to group measurements.

function oneShotMeasurement

bool oneShotMeasurement() const

Whether or not the target supports measurement (and result interpretation) during the circuit execution.

function entryPointAttr

std::string entryPointAttr() const

Attribute which indicate that a function is the entry point.

function disableReferenceCounting

bool disableReferenceCounting() const

function disableAliasCounting

bool disableAliasCounting() const

function disableStringSupport

bool disableStringSupport() const

function disableInitializeSupport

bool disableInitializeSupport() const

function disableRecordOutputSupport

bool disableRecordOutputSupport() const

function optimizeResultOne

bool optimizeResultOne() const

function optimizeResultZero

bool optimizeResultZero() const

function optimizeQuantumConstants

bool optimizeQuantumConstants() const

function optimizeResultComparison

bool optimizeResultComparison() const

function removeGetZeroOrOne

bool removeGetZeroOrOne() const

function useStaticQubitArrayAllocation

bool useStaticQubitArrayAllocation() const

function useStaticQubitAllocation

bool useStaticQubitAllocation() const

function useStaticResultAllocation

bool useStaticResultAllocation() const

function defaultIntegerWidth

uint32_t defaultIntegerWidth() const

function createDisabled

static TargetQisMappingPassConfiguration createDisabled()

Creates a configuration where all functionality is disabled.

function createReuseQubitsOnly

static TargetQisMappingPassConfiguration createReuseQubitsOnly()

Creates a configuration where only reuse qubits is enabled.


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