Enum roqoqo::QuantumProgram

#[non_exhaustive]
pub enum QuantumProgram {
    PauliZProduct {
        measurement: PauliZProduct,
        input_parameter_names: Vec<String>,
    },
    CheatedPauliZProduct {
        measurement: CheatedPauliZProduct,
        input_parameter_names: Vec<String>,
    },
    Cheated {
        measurement: Cheated,
        input_parameter_names: Vec<String>,
    },
    ClassicalRegister {
        measurement: ClassicalRegister,
        input_parameter_names: Vec<String>,
    },
}

Represents a quantum program evaluating measurements based on a one or more free float parameters.

The main use of QuantumProgram is to contain a Measurements implementing crate::measurements::Measure that measures expectation values or output registers of crate::Circuit quantum circuits that contain symbolic parameters. Circuit with symbolic parameters can not be simulated or executed on real hardware. The symbolic parameters need to be replaced with real floating point numbers first. A QuantumProgram contains a list of the free parameters (input_parameter_names) and can automatically replace the parameters with its run methods and return the result.

The QuantumProgram should correspond as closely as possible to a normal multi-parameter function in classical computing that can be called with a set of parameters and returns a result. It is the intended way to interface between normal program code and roqoqo based quantum programs.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PauliZProduct

Variant for basis rotation measurement based quantum programs

Fields

measurement: PauliZProduct

The measurement that is performed

input_parameter_names: Vec<String>

List of free input parameters that can be set when the QuantumProgram is executed

CheatedPauliZProduct

Variant for cheated basis rotation measurement based quantum programs

Fields

measurement: CheatedPauliZProduct

The measurement that is performed

input_parameter_names: Vec<String>

List of free input parameters that can be set when the QuantumProgram is executed

Cheated

Variant for statevector/density matrix based measurements

Fields

measurement: Cheated

The measurement that is performed

input_parameter_names: Vec<String>

List of free input parameters that can be set when the QuantumProgram is executed

ClassicalRegister

Variant quantum programs returning full classical registers

Fields

measurement: ClassicalRegister

The measurement that is performed

input_parameter_names: Vec<String>

List of free input parameters that can be set when the QuantumProgram is executed

Implementations

impl QuantumProgram

pub fn run<T>( &self, backend: T, parameters: &[f64] ) -> Result<Option<HashMap<String, f64>>, RoqoqoBackendError>

where T: EvaluatingBackend,

Runs the QuantumProgram and returns expectation values.

Runs the quantum programm for a given set of parameters passed in the same order as the parameters listed in input_parameter_names and returns expectation values.

Arguments:

• backend - The backend the program is executed on.
• parameters - List of float (f64) parameters of the function call in order of input_parameter_names

pub fn run_registers<T>(&self, backend: T, parameters: &[f64]) -> RegisterResult

where T: EvaluatingBackend,

Runs the QuantumProgram and returns the classical registers of the quantum program.

Runs the quantum programm for a given set of parameters passed in the same order as the parameters listed in input_parameter_names and returns the classical register output.
The classical registers usually contain a record of measurement values for the repeated execution of a crate::Circuit quantum circuit for real quantum hardware or the readout of the statevector or the density matrix for simulators.

Arguments:

• backend - The backend the program is executed on.
• parameters - List of float (f64) parameters of the function call in order of input_parameter_names

Trait Implementations

impl Clone for QuantumProgram

fn clone(&self) -> QuantumProgram

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QuantumProgram

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QuantumProgram

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for QuantumProgram

Implements the Display trait for QuantumProgram.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for QuantumProgram

fn eq(&self, other: &QuantumProgram) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for QuantumProgram

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SupportedVersion for QuantumProgram

fn minimum_supported_roqoqo_version(&self) -> (u32, u32, u32)

Returns the minimum roqoqo version that supports the operation.

impl StructuralPartialEq for QuantumProgram