Struct Flow 

pub struct Flow {
    pub start: PauliMap,
    pub end: PauliMap,
    pub measurements: FlowMeasurements,
    pub sign: bool,
    pub center: Option<IVec2>,
    pub marker: FlowMarker,
}

A stabilizer flow: a Pauli boundary condition start propagated through a chunk to end, together with the measurements it accumulates.

An empty start marks a flow created inside the chunk (nothing enters); an empty end marks one that terminates in the chunk (nothing leaves). FlowEngine fuses flows whose boundaries match across chunks into detector chains.

Fields

start: PauliMap

The Pauli boundary entering the chunk; empty if the flow originates fully from here.

end: PauliMap

The Pauli boundary leaving the chunk; empty if the flow terminates here.

measurements: FlowMeasurements

Measurement ids the flow accumulates as it crosses the chunk.

sign: bool

Whether the stabilizer relation has negative sign. Equivalently, this is the expected XOR of measurements when both boundaries have positive eigenvalue.

center: Option<IVec2>

Coordinate for the flow center, if any.

marker: FlowMarker

How the completed chain’s parity is consumed. See FlowMarker.

Implementations

impl Flow

pub fn new(start: PauliMap, end: PauliMap) -> Self

A flow from start to end with no measurements, no center, and a FlowMarker::Detector marker. Chain the with_* methods to set the rest, so adding a new field does not churn every construction site.

pub fn with_measurements( self, measurements: impl IntoIterator<Item = u32>, ) -> Self

Replaces the carried measurement parity.

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

Sets whether the stabilizer relation is negative.

pub fn with_center(self, center: impl Into<Option<IVec2>>) -> Self

Sets the optional flow center.

pub fn with_marker(self, marker: FlowMarker) -> Self

Sets how downstream compilation consumes this flow.

Trait Implementations

impl Clone for Flow

fn clone(&self) -> Flow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Flow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Flow

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

Formats the value using the given formatter.

impl Eq for Flow

impl PartialEq for Flow

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Flow

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Flow