Struct roqoqo::noise_models::ImperfectReadoutModel

pub struct ImperfectReadoutModel {
    prob_detect_0_as_1: HashMap<usize, f64>,
    prob_detect_1_as_0: HashMap<usize, f64>,
}

Noise model representing readout errors.

Readout errors are modeled by two probabilities in this simple model. One probability to detect a 1 instead of a 0 when the quantum measurement gives 0 and one probability to detect a 0 instead of a 1 when the quantum measurement gives 1.

Example

use roqoqo::noise_models::ImperfectReadoutModel;

let model = ImperfectReadoutModel::new_with_uniform_error(3, 0.5, 0.5).unwrap();
let model = model.set_error_probabilites(2, 0.3, 0.7).unwrap();
let uniform_prob = model.prob_detect_0_as_1(&0);
assert_eq!(uniform_prob, 0.5);
let lower_prob = model.prob_detect_0_as_1(&2);
assert_eq!(lower_prob, 0.3);
let higher_prob = model.prob_detect_1_as_0(&2);
assert_eq!(higher_prob, 0.7);

Fields

prob_detect_0_as_1: HashMap<usize, f64>

Decoherence rates for all qubits

prob_detect_1_as_0: HashMap<usize, f64>

Implementations

impl ImperfectReadoutModel

pub fn new() -> Self

Create a new empty ContinuousDecoherenceModel.

Returns

• ImperfectReadoutModel - The new model

pub fn new_with_uniform_error( number_qubits: usize, prob_detect_0_as_1: f64, prob_detect_1_as_0: f64, ) -> Result<Self, RoqoqoBackendError>

Convenience function to create uniform error probabilities

Arguments

• number_qubits - The number of qubits the uniform error probabilites should be initialized for.
• prob_detect_0_as_1 - The error probability to detect a 1 instead of a 0 when measuring 0
• prob_detect_1_as_0 - The error probability to detect a 0 instead of a 1 when measuring 1

Returns

• Ok(ImperfectReadoutModel) - The new error model
• Err(RoqoqoError) - Probabilities are not valid (< 0 or > 1)

pub fn set_error_probabilites( self, qubit: usize, prob_detect_0_as_1: f64, prob_detect_1_as_0: f64, ) -> Result<Self, RoqoqoBackendError>

Set and overwrite the measurement error probabilities

Arguments

• qubits - The qubits for which error rates are set.
• prob_detect_0_as_1 - The error probability to detect a 1 instead of a 0 when measuring 0
• prob_detect_1_as_0 - The error probability to detect a 0 instead of a 1 when measuring 1

Returns

• Ok(ImperfectReadoutModel) - The new error model
• Err(RoqoqoError) - Probabilities are not valid (< 0 or > 1)

pub fn prob_detect_0_as_1(&self, qubit: &usize) -> f64

Return probability to detect 0 as 1 for a qubit

Arguments

qubit - The qubit for which the probability is returned.

Returns

f64 - The probability to detect 0 as 1 for the qubit

pub fn prob_detect_1_as_0(&self, qubit: &usize) -> f64

Return probability to detect 1 as 0 for a qubit

Arguments

qubit - The qubit for which the probability is returned.

Returns

f64 - The probability to detect 1 as 0 for the qubit

Trait Implementations

impl Clone for ImperfectReadoutModel

fn clone(&self) -> ImperfectReadoutModel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImperfectReadoutModel

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

Formats the value using the given formatter.

impl Default for ImperfectReadoutModel

fn default() -> ImperfectReadoutModel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ImperfectReadoutModel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ImperfectReadoutModel> for NoiseModel

fn from(value: ImperfectReadoutModel) -> Self

Converts to this type from the input type.

impl PartialEq for ImperfectReadoutModel

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

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 ImperfectReadoutModel

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

Returns the minimum roqoqo version that supports the operation.

impl StructuralPartialEq for ImperfectReadoutModel