Struct DetectorParity 

pub struct DetectorParity<M = u32> { /* private fields */ }

A mod-2 sum of DetectorTerms and a constant sign bit — the parity a detector or observable checks.

Terms are held in a canonical form: sorted, with pairs that cancel removed, so equal parities compare and hash equally regardless of construction order.

Implementations

impl<M: Copy + Ord> DetectorParity<M>

pub fn from_measurements(measurements: impl IntoIterator<Item = M>) -> Self

Builds a parity from measurement ids, canonicalizing the result.

pub fn from_terms(terms: impl IntoIterator<Item = DetectorTerm<M>>) -> Self

Builds a parity from arbitrary terms, canonicalizing the result.

pub fn from_term_buf(terms: SmallVec<[DetectorTerm<M>; 2]>) -> Self

Like Self::from_terms, but takes the term buffer by value so callers that already hold one (e.g. a completed flow’s measurements) avoid rebuilding it element by element.

pub fn with_sign(self, sign: bool) -> Self

Sets the constant XOR term. true represents a negative stabilizer sign, so a noiseless detector with odd raw measurement parity evaluates to zero.

pub fn sign(&self) -> bool

The constant XOR term (true for a negative stabilizer sign).

pub fn terms(&self) -> &[DetectorTerm<M>]

The canonicalized terms.

pub fn measurements(&self) -> impl Iterator<Item = M> + '_

Measurement terms only, dropping loop-carried detector state.

pub fn is_empty(&self) -> bool

Returns true for the zero parity: no terms and no constant sign.

pub fn xor_assign(&mut self, other: &Self)

XORs other’s terms into self (mod-2 addition) and recanonicalizes.

pub fn map_measurements(self, f: impl FnMut(M) -> M) -> Self

Maps measurement terms in the existing buffer and recanonicalizes it.

pub fn try_map_measurements<N: Copy + Ord, E>( &self, f: impl FnMut(M) -> Result<N, E>, ) -> Result<DetectorParity<N>, E>

Maps each measurement term through f, leaving loop-state terms intact, and canonicalizes the result. Loop-state terms pass through unchanged.

Errors

Returns the first error f produces.

Trait Implementations

impl<M: Clone> Clone for DetectorParity<M>

fn clone(&self) -> DetectorParity<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for DetectorParity<M>

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

Formats the value using the given formatter.

impl<M> Default for DetectorParity<M>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, M> Deserialize<'de> for DetectorParity<M>

where M: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<M: Display> Display for DetectorParity<M>

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

Formats the value using the given formatter.

impl<M: Eq> Eq for DetectorParity<M>

impl<M: Hash> Hash for DetectorParity<M>

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<M: PartialEq> PartialEq for DetectorParity<M>

fn eq(&self, other: &DetectorParity<M>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<M> Serialize for DetectorParity<M>

where M: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<M: PartialEq> StructuralPartialEq for DetectorParity<M>