Struct UnionFindDecoder 

pub struct UnionFindDecoder { /* private fields */ }

Union-find decoder compiled from a graphlike detector error model.

Detectors are vertices. A two-detector mechanism becomes an internal edge and a one-detector mechanism a boundary edge, each weighted ln((1-p)/p) clamped at zero. Mechanisms flipping no detector cannot enter the graph; their probability mass bounds the logical error rate any decoder over the model can reach. Mechanisms sharing one detector set collapse to the most probable of them. Decoding uses no randomness: growth, fusion, and peeling break every tie by ascending edge index in mechanism order, so equal inputs give equal outputs on any thread count.

Implementations

impl UnionFindDecoder

pub fn from_model(model: &DetectorErrorModel) -> Result<Self>

Compile a decoder from a graphlike detector error model.

Errors

A mechanism flipping more than two detectors is rejected with a pointer to DetectorErrorModel::decompose_graphlike. Mechanism probabilities must lie in [0, 1); a zero-probability mechanism is skipped rather than rejected.

pub fn num_detectors(&self) -> usize

pub fn num_observables(&self) -> usize

pub fn decode_packed(&self, detectors: &PackedShots) -> Result<PackedShots>

Decode packed detector samples into predicted observable flips.

Accepts either layout with one bit per detector per shot, detector d at bit index d. Returns shot-major records with one bit per observable per shot, observable o at bit index o.

Errors

The input measurement count must equal the model’s detector count, and every shot must be explainable: a detector component with odd defect parity and no boundary edge rejects the batch, naming the first such shot.

Trait Implementations

impl Clone for UnionFindDecoder

fn clone(&self) -> UnionFindDecoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnionFindDecoder

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

Formats the value using the given formatter.