Struct PlanStimOptions 

pub struct PlanStimOptions<'a> { /* private fields */ }

How emit_plan_stim should render a plan.

Implementations

impl<'a> PlanStimOptions<'a>

pub fn new(qubit_map: &'a FxHashMap<IVec2, u32>) -> Self

Render against qubit_map, in the default StimDialect and with no tag.

qubit_map addresses the emitted circuit: every qubit coordinate the plan touches must appear in it, and the index it maps to is the qubit number written out. Passing the caller’s own global layout is what lets several plans be emitted into one shared index space. Sparse indices in 0..=16_777_215 are supported without allocating entries for missing indices. Both dialects share Stim’s 24-bit qubit targets.

pub fn with_dialect(self, dialect: StimDialect) -> Self

Choose how non-Clifford T gates are spelled.

pub fn with_tag(self, tag: &'a str) -> Self

Tag every emitted instruction with tag, so the caller can find this plan’s slice of a larger circuit structurally instead of by position.

The HONEST_T tag wins on the gates it marks: it is load-bearing for the StimDialect round trip, whereas this tag is the caller’s own bookkeeping.

Trait Implementations

impl<'a> Clone for PlanStimOptions<'a>

fn clone(&self) -> PlanStimOptions<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for PlanStimOptions<'a>

impl<'a> Debug for PlanStimOptions<'a>

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

Formats the value using the given formatter.