Skip to main content

DetectorErrorModel

Struct DetectorErrorModel 

Source
pub struct DetectorErrorModel {
    pub num_detectors: usize,
    pub num_observables: usize,
    pub errors: Vec<DEMError>,
    pub coordinate_shifts: Vec<Vec<f64>>,
    pub detector_coords: HashMap<usize, Vec<f64>>,
}
Expand description

Detector Error Model representation

Fields§

§num_detectors: usize

Number of detectors in the circuit

§num_observables: usize

Number of logical observables

§errors: Vec<DEMError>

List of error mechanisms

§coordinate_shifts: Vec<Vec<f64>>

Coordinate system shifts (for visualization)

§detector_coords: HashMap<usize, Vec<f64>>

Detector coordinates

Implementations§

Source§

impl DetectorErrorModel

Source

pub fn new(num_detectors: usize, num_observables: usize) -> Self

Create a new empty DEM

Source

pub fn from_circuit(circuit: &StimCircuit) -> Result<Self>

Generate a DEM from a Stim circuit

This performs error analysis by:

  1. Identifying all error mechanisms in the circuit
  2. Propagating each error through to detectors/observables
  3. Recording which detectors/observables are affected
Source

pub fn to_dem_string(&self) -> String

Convert DEM to Stim DEM format string

Source

pub fn from_dem_string(s: &str) -> Result<Self>

Parse a DEM from string

Source

pub fn sample(&self) -> (Vec<bool>, Vec<bool>)

Sample errors according to the DEM

Returns (detector_outcomes, observable_flips) for a single sample

Source

pub fn sample_batch(&self, num_shots: usize) -> Vec<(Vec<bool>, Vec<bool>)>

Sample multiple shots

Source

pub fn total_error_probability(&self) -> f64

Get the total error probability

Source

pub fn num_error_mechanisms(&self) -> usize

Get number of error mechanisms

Source

pub fn force_error(&mut self, qubit: usize, error_type: ErrorType) -> usize

Force a specific error on a qubit with probability 1.0.

This inserts a deterministic error mechanism into the DEM for debugging and testing. The error targets no detectors or observables by default (they must be wired by the caller via the returned index, or by re-analysing the circuit); however, it records the qubit, error type, and probability so that downstream samplers see it as a certain event.

§Arguments
  • qubit — Index of the qubit to apply the error to.
  • error_type — The Pauli or measurement error to force.
§Returns

The index of the newly added error mechanism in self.errors.

Source

pub fn force_error_with_targets( &mut self, qubit: usize, error_type: ErrorType, detector_targets: Vec<usize>, observable_targets: Vec<usize>, ) -> usize

Force a specific error and associate it with given detector and observable targets.

Unlike force_error, this variant lets the caller specify exactly which detectors and observables flip when the error occurs, enabling accurate decoding tests.

Trait Implementations§

Source§

impl Clone for DetectorErrorModel

Source§

fn clone(&self) -> DetectorErrorModel

Returns a duplicate 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 DetectorErrorModel

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

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,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V