Struct qoqo::measurements::ClassicalRegisterWrapper

source · [−]

pub struct ClassicalRegisterWrapper {
    pub internal: ClassicalRegister,
}

Expand description

Collected information for executing a classical register.

Fields

internal: ClassicalRegister

Internal storage of [roqoqo::ClassicalRegister].

Implementations

source

impl ClassicalRegisterWrapper

source

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

Create an new ClassicalRegister measurement.

Args: constant_circuit (OptionalCircuit): The constant Circuit that is executed before each Circuit in circuits. circuits (listCircuit): The collection of quantum circuits executed for the measurement.

Returns: ClassicalRegister: The new register.

source

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

Return the collection of quantum circuits that make up the total measurement.

Returns: listCircuit: The quantum circuits.

source

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

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

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

source

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

Returns the type of the measurement in string form.

Returns: str: The type of the measurement.

source

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

Return copy of Measurement with symbolic parameters replaced.

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

Raises: RuntimeError: Error substituting symbolic parameters.

source

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.

source

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

Serialize the ClassicalRegister measurement to json form.

Returns: str: The serialized ClassicalRegister measurement.

Raises: PyRuntimeError: Unexpected error serializing ClassicalRegister.

source

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

Deserialize the ClassicalRegister measurement from json form.

Returns: ClassicalRegister: The deserialized ClassicalRegister Measurement.

Raises: PyRuntimeError: Cannot deserialize string to ClassicalRegister.

Trait Implementations

source

impl Clone for ClassicalRegisterWrapper

source

fn clone(&self) -> ClassicalRegisterWrapper

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for ClassicalRegisterWrapper

source

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

Formats the value using the given formatter. Read more

source

impl IntoPy<Py<PyAny>> for ClassicalRegisterWrapper

source

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

Performs the conversion.

source

impl PyClass for ClassicalRegisterWrapper

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. Read more

source

impl PyClassDescriptors<ClassicalRegisterWrapper> for PyClassImplCollector<ClassicalRegisterWrapper>

source

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

source

impl PyClassImpl for ClassicalRegisterWrapper

source

const DOC: &'static str

Class doc string

source

const IS_GC: bool

#[pyclass(gc)]

source

const IS_BASETYPE: bool

#[pyclass(subclass)]

source

const IS_SUBCLASS: bool

#[pyclass(extends=…)]

type Layout = PyCell<Self>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<ClassicalRegisterWrapper>

This handles following two situations: Read more

source

impl PyClassNewImpl<ClassicalRegisterWrapper> for PyClassImplCollector<ClassicalRegisterWrapper>

source

fn new_impl(self) -> Option<newfunc>

source

impl PyMethods<ClassicalRegisterWrapper> for PyClassImplCollector<ClassicalRegisterWrapper>

source

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

source

impl PyMethodsProtocolSlots<ClassicalRegisterWrapper> for PyClassImplCollector<ClassicalRegisterWrapper>

source

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

source

impl PyTypeInfo for ClassicalRegisterWrapper

type AsRefTarget = PyCell<Self>

Utility type to make Py::as_ref work.

source

const NAME: &'static str

Class name.

source

const MODULE: Option<&'static str>

Module name, if any.

source

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

PyTypeObject instance for this type.

source

fn is_type_of(object: &PyAny) -> bool

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

source

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

Auto Trait Implementations

impl RefUnwindSafe for ClassicalRegisterWrapper

impl Send for ClassicalRegisterWrapper

impl Sync for ClassicalRegisterWrapper

impl Unpin for ClassicalRegisterWrapper

impl UnwindSafe for ClassicalRegisterWrapper

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<'a, T> FromPyObject<'a> for T where
T: PyClass + Clone,

source

pub fn extract(obj: &'a PyAny) -> Result<T, PyErr>

Extracts Self from the source PyObject.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> PyErrArguments for T where
T: IntoPy<Py<PyAny>> + Send + Sync,

source

pub fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception

source

impl<T> PyTypeObject for T where
T: PyTypeInfo,

source

pub fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct qoqo::measurements::ClassicalRegisterWrapper

Fields

Implementations

impl ClassicalRegisterWrapper

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for ClassicalRegisterWrapper

fn clone(&self) -> ClassicalRegisterWrapper

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

impl Debug for ClassicalRegisterWrapper

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

impl IntoPy<Py<PyAny>> for ClassicalRegisterWrapper

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

impl PyClass for ClassicalRegisterWrapper

type Dict = PyClassDummySlot

type WeakRef = PyClassDummySlot

type BaseNativeType = PyAny

impl PyClassDescriptors<ClassicalRegisterWrapper> for PyClassImplCollector<ClassicalRegisterWrapper>

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

impl PyClassImpl for ClassicalRegisterWrapper

const DOC: &'static str

const IS_GC: bool

const IS_BASETYPE: bool

const IS_SUBCLASS: bool

type Layout = PyCell<Self>

type BaseType = PyAny

type ThreadChecker = ThreadCheckerStub<ClassicalRegisterWrapper>

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<ClassicalRegisterWrapper> for PyClassImplCollector<ClassicalRegisterWrapper>

fn new_impl(self) -> Option<newfunc>

impl PyMethods<ClassicalRegisterWrapper> for PyClassImplCollector<ClassicalRegisterWrapper>

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

impl PyMethodsProtocolSlots<ClassicalRegisterWrapper> for PyClassImplCollector<ClassicalRegisterWrapper>

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

impl PyTypeInfo for ClassicalRegisterWrapper

type AsRefTarget = PyCell<Self>

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_type_of(object: &PyAny) -> bool

fn is_exact_type_of(object: &PyAny) -> bool

Auto Trait Implementations

impl RefUnwindSafe for ClassicalRegisterWrapper

impl Send for ClassicalRegisterWrapper

impl Sync for ClassicalRegisterWrapper

impl Unpin for ClassicalRegisterWrapper

impl UnwindSafe for ClassicalRegisterWrapper

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<'a, T> FromPyObject<'a> for T where T: PyClass + Clone,

pub fn extract(obj: &'a PyAny) -> Result<T, PyErr>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> PyErrArguments for T where T: IntoPy<Py<PyAny>> + Send + Sync,

pub fn arguments(self, py: Python<'_>) -> Py<PyAny>

impl<T> PyTypeObject for T where T: PyTypeInfo,

pub fn type_object(py: Python<'_>) -> &PyType

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<'a, T> FromPyObject<'a> for T where
T: PyClass + Clone,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> PyErrArguments for T where
T: IntoPy<Py<PyAny>> + Send + Sync,

impl<T> PyTypeObject for T where
T: PyTypeInfo,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,