Struct ExplainedError 

pub struct ExplainedError { /* private fields */ }

Describes a single error mechanism from a Stim circuit, pairing the detectors and observables it affects with the location(s) where it occurs in the circuit.

When you call methods like Circuit::shortest_graphlike_error, Stim returns a list of ExplainedError values. Each one represents one fault mechanism that was needed to produce the logical error, containing:

• dem_error_terms – the detectors and logical observables flipped by this error, each annotated with coordinate data (a list of DemTargetWithCoords).
• circuit_error_locations – the physical location(s) in the circuit where this error can occur, as CircuitErrorLocation values.

If circuit_error_locations is empty, it means there was a DEM error that was decomposed into parts where one of the parts is impossible to produce from a single circuit error on its own.

If the list contains a single entry, it may be because only a single representative circuit error was requested (as opposed to all possible errors that produce the same syndrome).

Examples

use stim::{
    CircuitErrorLocation, CircuitErrorLocationStackFrame,
    CircuitTargetsInsideInstruction, DemTargetWithCoords,
    ExplainedError, GateTarget, GateTargetWithCoords,
};

let explained = ExplainedError::new(
    vec![DemTargetWithCoords::new(
        stim::DemTarget::logical_observable_id(0).expect("valid id"),
        vec![],
    )],
    vec![CircuitErrorLocation::new(
        1,
        vec![GateTargetWithCoords::new(
            stim::GateTarget::y(0u32, false).expect("valid target"),
            vec![],
        )],
        None,
        CircuitTargetsInsideInstruction::new(
            "Y_ERROR", "", vec![0.125], 0, 1,
            vec![GateTargetWithCoords::new(GateTarget::from(0u32), vec![])],
        ),
        vec![CircuitErrorLocationStackFrame::new(2, 0, 0)],
        "",
    )],
);

assert_eq!(explained.dem_error_terms().len(), 1);
assert_eq!(explained.circuit_error_locations().len(), 1);

Implementations

impl ExplainedError

pub fn new( dem_error_terms: impl IntoIterator<Item = DemTargetWithCoords>, circuit_error_locations: impl IntoIterator<Item = CircuitErrorLocation>, ) -> Self

Creates a new ExplainedError from its constituent parts.

Arguments

• dem_error_terms – the detectors and logical observables flipped by this error mechanism, each paired with coordinate data.
• circuit_error_locations – the physical circuit location(s) where this error can occur. May be empty if the error was decomposed into parts that cannot individually be produced by a single circuit error.

pub fn dem_error_terms(&self) -> &[DemTargetWithCoords]

Returns the detectors and observables flipped by this error mechanism.

Each element is a DemTargetWithCoords pairing a detector (D5) or logical observable (L0) with its coordinate data from DETECTOR or other coordinate-assigning instructions.

pub fn circuit_error_locations(&self) -> &[CircuitErrorLocation]

Returns the locations of circuit errors that produce the symptoms described by dem_error_terms.

Each element is a CircuitErrorLocation that identifies a specific instruction, target range, and nesting position within the circuit.

If this slice is empty, it means the DEM error was decomposed into parts where one part is impossible to produce from a single circuit error on its own. If it contains a single entry, it may be because only a single representative was requested.

Trait Implementations

impl Clone for ExplainedError

fn clone(&self) -> ExplainedError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExplainedError

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

Formats the value using the given formatter.

impl Display for ExplainedError

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

Formats the value using the given formatter.

impl Hash for ExplainedError

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ExplainedError

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ExplainedError

fn eq(&self, other: &ExplainedError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ExplainedError

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ExplainedError

impl StructuralPartialEq for ExplainedError