microsoft::quantum::StaticResourceComponentConfiguration

Public Types

	Name
using std::unordered_set< std::string >	Set
using DeferredValue::DeferredValuePtr	DeferredValuePtr

Public Functions

	Name
	StaticResourceComponentConfiguration() =default
void	setup(ConfigurationManager & config)
bool	shouldAnnotateQubitUse() const Whether or not to annotate every function with the number of qubits they use.
bool	shouldAnnotateResultUse() const Whether or not to annotate every function with the number of results they use.
bool	shouldAnnotateMaxQubitIndex() const Whether or not to annotate every function with the maximum qubit index accessed.
bool	shouldAnnotateMaxResultIndex() const Whether or not to annotate every function with the maximum result index accessed.
bool	shouldReplaceQubitsOnReset() const Whether or not qubits should be replaced upon resetting.
bool	shouldReindexQubits() const Whether or not qubit ids should be re-indexed sequentially starting from 0.
bool	shouldInlineAfterIdChange() const Whether or not this component should inline after changing qubit ids.
bool	isChangingIds() const Whether or not the configuration is set to changing qubit ids.
void	enableAnnotateQubitUse()
void	enableAnnotateResultUse()
void	enableAnnotateMaxQubitIndex()
void	enableAnnotateMaxResultIndex()
void	enableReplaceQubitOnReset()
void	enableReindexQubits()
void	enableInlineAfterIdChange()
String	requiredNumQubitsAttr() const
String	requiredNumResultsAttr() const
String	maxIndexQubitsAttr() const
String	maxIndexResultsAttr() const
StaticResourceComponentConfiguration	createDisabled() Creates a configuration where all features are disabled.

Public Types Documentation

using Set

using microsoft::quantum::StaticResourceComponentConfiguration::Set =  std::unordered_set<std::string>;

using DeferredValuePtr

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

Public Functions Documentation

function StaticResourceComponentConfiguration

StaticResourceComponentConfiguration() =default

function setup

void setup(
    ConfigurationManager & config
)

Setup function that adds the configuration flags to the ConfigurationManager. See the ConfigurationManager documentation for more details on how the setup process is implemented.

function shouldAnnotateQubitUse

bool shouldAnnotateQubitUse() const

Whether or not to annotate every function with the number of qubits they use.

function shouldAnnotateResultUse

bool shouldAnnotateResultUse() const

Whether or not to annotate every function with the number of results they use.

function shouldAnnotateMaxQubitIndex

bool shouldAnnotateMaxQubitIndex() const

Whether or not to annotate every function with the maximum qubit index accessed.

function shouldAnnotateMaxResultIndex

bool shouldAnnotateMaxResultIndex() const

Whether or not to annotate every function with the maximum result index accessed.

function shouldReplaceQubitsOnReset

bool shouldReplaceQubitsOnReset() const

Whether or not qubits should be replaced upon resetting.

function shouldReindexQubits

bool shouldReindexQubits() const

Whether or not qubit ids should be re-indexed sequentially starting from 0.

function shouldInlineAfterIdChange

bool shouldInlineAfterIdChange() const

Whether or not this component should inline after changing qubit ids.

function isChangingIds

bool isChangingIds() const

Whether or not the configuration is set to changing qubit ids.

function enableAnnotateQubitUse

void enableAnnotateQubitUse()

function enableAnnotateResultUse

void enableAnnotateResultUse()

function enableAnnotateMaxQubitIndex

void enableAnnotateMaxQubitIndex()

function enableAnnotateMaxResultIndex

void enableAnnotateMaxResultIndex()

function enableReplaceQubitOnReset

void enableReplaceQubitOnReset()

function enableReindexQubits

void enableReindexQubits()

function enableInlineAfterIdChange

void enableInlineAfterIdChange()

function requiredNumQubitsAttr

String requiredNumQubitsAttr() const

function requiredNumResultsAttr

String requiredNumResultsAttr() const

function maxIndexQubitsAttr

String maxIndexQubitsAttr() const

function maxIndexResultsAttr

String maxIndexResultsAttr() const

function createDisabled

static StaticResourceComponentConfiguration createDisabled()

Creates a configuration where all features are disabled.

---

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