Struct qoqo::measurements::BasisRotationWrapper

pub struct BasisRotationWrapper {
    pub internal: BasisRotation,
}

Collected information for executing a basis rotation measurement.

Fields

internal: BasisRotation

Internal storage of [roqoqo::BasisRotation].

Implementations

impl BasisRotationWrapper

pub fn new(
    constant_circuit: Option<CircuitWrapper>,
    circuits: Vec<CircuitWrapper>,
    input: BasisRotationInputWrapper
) -> Self

Create a new BasisRotation measurement.

Args: constant_circuit (OptionalCircuit): The constant Circuit that is executed before each Circuit in circuits. circuits (listCircuit): The collection of quantum circuits for the separate basis rotations. input (BasisRotationInput): The additional input information required for measurement.

Returns: BasisRotation: The BasisRotation containing the new basis rotation measurement.

pub fn evaluate(
    &mut self,
    input_bit_registers: Py<PyAny>,
    float_registers: HashMap<String, FloatOutputRegister>,
    complex_registers: HashMap<String, ComplexOutputRegister>
) -> PyResult<Option<HashMap<String, f64>>>

Execute the basis rotation measurement.

Args: input_bit_registers (dict[str, Union[list[list[int]], list[listbool]]]): The classical bit registers with the register name as key float_registers (dict[str, list[list[float]]): The classical float registers as a dictionary with the register name as key complex_registers (dict[str, list[list[complex]]): The classical complex registers as a dictionary with the register name as key

Returns: Optional[dict[str, float]]: The evaluated measurement.

Raises: RuntimeError: Unexpected repetition of key in bit_register. RuntimeError: Error evaluating basis rotation measurement.

pub fn circuits(&self) -> Vec<CircuitWrapper>

Return the collection of quantum circuits for the separate basis rotations.

Returns: listCircuit: The quantum circuits.

pub fn constant_circuit(&self) -> Option<CircuitWrapper>

Return constant circuit that is executed before any Circuit in circuits.

Returns: OptionalCircuit: The constant Circuit (None if not defined).

pub fn input(&self) -> BasisRotationInputWrapper

Returns the measurement input data defining how to construct expectation values from measurements.

Returns: BasisRotationInput: The measurment input of BasisRotation.

pub fn measurement_type(&self) -> &'static str

Returns the type of the measurement in string form.

Returns: str: The type of the measurement.

pub fn substitute_parameters(
    &self,
    substituted_parameters: HashMap<String, f64>
) -> PyResult<Self>

Return clone of Measurement with symbolic parameters replaced.

Args: substituted_parameters (dict[str, float]): The dictionary containing the substitutions to use in the Circuit.

pub fn _internal_to_bincode(&self) -> PyResult<(&'static str, Py<PyByteArray>)>

Return the name of the measurement and the bincode representation of the Measurement using the bincode crate.

Returns: (str, ByteArray): Name and serialized measurement (in bincode form).

Raises: ValueError: Cannot serialize Measurement to bytes.

pub fn to_json(&self) -> PyResult<String>

Serialize the BasisRotation to json form using the serde_json crate.

Returns: str: The serialized BasisRotation.

Raises: RuntimeError: Unexpected error serializing BasisRotation.

pub fn from_json(cls: &PyType, json_string: &str) -> PyResult<Self>

Deserialize the BasisRotation from json form using the serde_json crate.

Returns: BasisRotation: The deserialized BasisRotation.

Raises: RuntimeError: Cannot deserialize string to BasisRotation.

Trait Implementations

impl Clone for BasisRotationWrapper

fn clone(&self) -> BasisRotationWrapper

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasisRotationWrapper

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

Formats the value using the given formatter.

impl IntoPy<Py<PyAny>> for BasisRotationWrapper

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for BasisRotationWrapper

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

impl PyClassDescriptors<BasisRotationWrapper> for PyClassImplCollector<BasisRotationWrapper>

fn py_class_descriptors(self) -> &'static [PyMethodDefType]

impl PyClassImpl for BasisRotationWrapper

const DOC: &'static str

Class doc string

const IS_GC: bool

#[pyclass(gc)]

const IS_BASETYPE: bool

#[pyclass(subclass)]

const IS_SUBCLASS: bool

#[pyclass(extends=…)]

type Layout = PyCell<Self>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<BasisRotationWrapper>

This handles following two situations:

fn for_each_method_def(visitor: &mut dyn FnMut(&[PyMethodDefType]))

fn get_new() -> Option<newfunc>

fn get_alloc() -> Option<allocfunc>

fn get_free() -> Option<freefunc>

fn for_each_proto_slot(visitor: &mut dyn FnMut(&[PyType_Slot]))

fn get_buffer() -> Option<&'static PyBufferProcs>

impl PyClassNewImpl<BasisRotationWrapper> for PyClassImplCollector<BasisRotationWrapper>

fn new_impl(self) -> Option<newfunc>

impl PyMethods<BasisRotationWrapper> for PyClassImplCollector<BasisRotationWrapper>

fn py_methods(self) -> &'static [PyMethodDefType]

impl PyMethodsProtocolSlots<BasisRotationWrapper> for PyClassImplCollector<BasisRotationWrapper>

fn methods_protocol_slots(self) -> &'static [PyType_Slot]

impl PyTypeInfo for BasisRotationWrapper

type AsRefTarget = PyCell<Self>

Utility type to make Py::as_ref work.

const NAME: &'static str

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

PyTypeObject instance for this type.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.