Struct qoqo::devices::GenericDeviceWrapper

pub struct GenericDeviceWrapper {
    pub internal: GenericDevice,
}

A generic device assuming all-to-all connectivity between all involved qubits.

Args: number_qubits (int): The number of qubits in the device

Note: GenericDevice uses nested HashMaps to represent the most general device connectivity. The memory usage will be inefficient for devices with large qubit numbers.

Fields

internal: GenericDevice

Internal storage of roqoqo::devices::SquareLatticeDevice

Implementations

impl GenericDeviceWrapper

pub fn new(number_qubits: usize) -> PyResult<Self>

Create new generic device

pub fn number_qubits(&self) -> usize

Return number of qubits in device.

Returns: int: The number of qubits.

pub fn two_qubit_edges(&self) -> Vec<(usize, usize)>

Return the list of pairs of qubits linked by a native two-qubit-gate in the device.

A pair of qubits is considered linked by a native two-qubit-gate if the device can implement a two-qubit-gate between the two qubits without decomposing it into a sequence of gates that involves a third qubit of the device. The two-qubit-gate also has to form a universal set together with the available single qubit gates.

The returned vectors is a simple, graph-library independent, representation of the undirected connectivity graph of the device. It can be used to construct the connectivity graph in a graph library of the user’s choice from a list of edges and can be used for applications like routing in quantum algorithms.

Returns: Sequence[(int, int)]: List of two qubit edges in the undirected connectivity graph

pub fn single_qubit_gate_time(&self, hqslang: &str, qubit: usize) -> Option<f64>

Returns the gate time of a single qubit operation if the single qubit operation is available on device.

Args: hqslangstr: The hqslang name of a single qubit gate. qubit[int]: The qubit the gate acts on

Returns: Option[float]: None if gate is not available

Raises: PyValueError: Qubit is not in device

pub fn two_qubit_gate_time( &self, hqslang: &str, control: usize, target: usize ) -> Option<f64>

Returns the gate time of a two qubit operation if the two qubit operation is available on device.

Args: hqslangstr: The hqslang name of a single qubit gate. control[int]: The control qubit the gate acts on. target[int]: The target qubit the gate acts on.

Returns: Option[float]: None if gate is not available

Raises: PyValueError: Qubit is not in device

pub fn three_qubit_gate_time( &self, hqslang: &str, control_0: usize, control_1: usize, target: usize ) -> Option<f64>

Returns the gate time of a three qubit operation if the three qubit operation is available on device.

Args: hqslangstr: The hqslang name of a single qubit gate. control_0[int]: The control_0 qubit the gate acts on. control_1[int]: The control_1 qubit the gate acts on. target[int]: The target qubit the gate acts on.

Returns: Option[float]: None if gate is not available

Raises: PyValueError: Qubit is not in device

pub fn multi_qubit_gate_time( &self, hqslang: &str, qubits: Vec<usize> ) -> Option<f64>

Returns the gate time of a multi qubit operation if the multi qubit operation is available on device.

Args: hqslangstr: The hqslang name of a multi qubit gate. qubits[List[int]]: The qubits the gate acts on.

Returns: Option[float]: None if gate is not available

Raises: PyValueError: Qubit is not in device

pub fn set_single_qubit_gate_time( &mut self, gate: &str, qubit: usize, gate_time: f64 ) -> PyResult<()>

Set the gate time of a single qubit gate.

Args: gate (str): hqslang name of the single-qubit-gate. qubit (int): The qubit for which the gate time is set gate_time (float): The gate time for the given gate.

Raises: PyValueError: Qubit is not in device

pub fn set_two_qubit_gate_time( &mut self, gate: &str, control: usize, target: usize, gate_time: f64 ) -> PyResult<()>

Set the gate time of a two qubit gate.

Args: gate (str): hqslang name of the single-qubit-gate. control (int): The control qubit for which the gate time is set target (int): The control qubit for which the gate time is set gate_time (float): The gate time for the given gate.

Raises: PyValueError: Qubit is not in device

pub fn set_three_qubit_gate_time( &mut self, gate: &str, control_0: usize, control_1: usize, target: usize, gate_time: f64 ) -> PyResult<()>

Set the gate time of a three qubit gate.

Args: gate (str): hqslang name of the single-qubit-gate. control_0 (int): The control_0 qubit for which the gate time is set control_1 (int): The control_1 qubit for which the gate time is set target (int): The control qubit for which the gate time is set gate_time (float): The gate time for the given gate.

Raises: PyValueError: Qubit is not in device

pub fn set_qubit_decoherence_rates( &mut self, qubit: usize, rates: PyReadonlyArray2<'_, f64> ) -> PyResult<()>

Set the gate time of a single qubit gate.

Args: gate (str): hqslang name of the single-qubit-gate. qubits (int): The qubit for which the gate time is set gate_time (float): The gate time for the given gate.

Raises: PyValueError: Qubit is not in device

pub fn set_multi_qubit_gate_time( &self, gate: &str, qubits: Vec<usize>, gate_time: f64 ) -> PyResult<()>

Set the gate time of a single qubit gate.

Args: gate (str): hqslang name of the single-qubit-gate. qubits (List[int]): The qubits for which the gate time is set gate_time (float): The gate time for the given gate.

Raises: PyValueError: Qubits not in device

pub fn add_damping(&mut self, qubit: usize, damping: f64) -> PyResult<()>

Adds single qubit damping to noise rates.

Args: qubit (int): The qubit for which the decoherence is added damping (float): The damping rates.

Raises: PyValueError: Qubit is not in device

pub fn add_dephasing(&mut self, qubit: usize, dephasing: f64) -> PyResult<()>

Adds single qubit dephasing to noise rates.

Args: qubit (int): The qubit for which the decoherence is added dephasing (float): The dephasing rates.

Raises: PyValueError: Qubit is not in device

pub fn add_depolarising( &mut self, qubit: usize, depolarising: f64 ) -> PyResult<()>

Adds single qubit depolarising to noise rates.

Args: qubit (int): The qubit for which the decoherence is added depolarising (float): The depolarising rates.

Raises: PyValueError: Qubit is not in device

pub fn single_qubit_gate_names(&self) -> Vec<String>

Returns the names of a single qubit operations available on the device.

Returns: List[strt]: The list of gate names.

pub fn two_qubit_gate_names(&self) -> Vec<String>

Returns the names of a two qubit operations available on the device.

Returns: List[strt]: The list of gate names.

pub fn multi_qubit_gate_names(&self) -> Vec<String>

Returns the names of a mutli qubit operations available on the device.

The list of names also includes the three qubit gate operations.

Returns: List[strt]: The list of gate names.

pub fn __copy__(&self) -> Self

Returns a copy of the device (copy here produces a deepcopy).

Returns: A deep copy of self.

pub fn __deepcopy__(&self, _memodict: &Bound<'_, PyAny>) -> Self

Creates deep copy of Device.

Returns: A deep copy of self.

pub fn to_bincode(&self) -> PyResult<Py<PyByteArray>>

Return the bincode representation of the Device using the bincode crate.

Returns: ByteArray: The serialized Device (in bincode form).

Raises: ValueError: Cannot serialize Device to bytes.

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

Return the json representation of the Device.

Returns: str: The serialized form of Device.

Raises: ValueError: Cannot serialize Device to json.

pub fn from_bincode(input: &Bound<'_, PyAny>) -> PyResult<GenericDeviceWrapper>

Convert the bincode representation of the qoqo device to a device using the bincode crate.

Args: input (ByteArray): The serialized Device (in bincode form).

Returns: The deserialized Device.

Raises: TypeError: Input cannot be converted to byte array. ValueError: Input cannot be deserialized to selected Device.

pub fn from_json(input: &str) -> PyResult<GenericDeviceWrapper>

Convert the json representation of a device to a qoqo device.

Args: input (str): The serialized device in json form.

Returns: The deserialized device.

Raises: ValueError: Input cannot be deserialized to selected Device.

impl GenericDeviceWrapper

pub fn from_pyany(input: &Bound<'_, PyAny>) -> PyResult<GenericDevice>

Fallible conversion of generic python object.

Trait Implementations

impl Clone for GenericDeviceWrapper

fn clone(&self) -> GenericDeviceWrapper

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenericDeviceWrapper

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

Formats the value using the given formatter.

impl HasPyGilRef for GenericDeviceWrapper

type AsRefTarget = PyCell<GenericDeviceWrapper>

Utility type to make Py::as_ref work.

impl IntoPy<Py<PyAny>> for GenericDeviceWrapper

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

Performs the conversion.

impl PartialEq for GenericDeviceWrapper

fn eq(&self, other: &GenericDeviceWrapper) -> 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 PyClass for GenericDeviceWrapper

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for GenericDeviceWrapper

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<GenericDeviceWrapper>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForGenericDeviceWrapper

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

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.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<GenericDeviceWrapper> for PyClassImplCollector<GenericDeviceWrapper>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a GenericDeviceWrapper

type Holder = Option<PyRef<'py, GenericDeviceWrapper>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut GenericDeviceWrapper

type Holder = Option<PyRefMut<'py, GenericDeviceWrapper>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder ) -> PyResult<Self>

impl PyTypeInfo for GenericDeviceWrapper

const NAME: &'static str = "GenericDevice"

Class name.

const MODULE: Option<&'static str> = _

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

👎Deprecated since 0.21.0: PyTypeInfo::type_object will be replaced by PyTypeInfo::type_object_bound in a future PyO3 version

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_type_of will be replaced by PyTypeInfo::is_type_of_bound in a future PyO3 version

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

fn is_type_of_bound(object: &Bound<'_, 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

👎Deprecated since 0.21.0: PyTypeInfo::is_exact_type_of will be replaced by PyTypeInfo::is_exact_type_of_bound in a future PyO3 version

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for GenericDeviceWrapper

impl StructuralPartialEq for GenericDeviceWrapper