Struct PauliMap 

pub struct PauliMap { /* private fields */ }

A sparse, phaseless map from qubit coordinate to non-identity Pauli. Compose maps with ^; exact product phases are discarded.

Implementations

impl PauliMap

pub fn product_phase(&self, other: &Self) -> u8

Exact power of i contributed by a product; the maps themselves remain phaseless.

pub fn translated(&self, offset: IVec2) -> Self

Returns a copy with every coordinate shifted by offset.

Panics

Panics if any translated coordinate exceeds the signed 32-bit lattice. Use Self::try_translated for untrusted offsets.

pub fn try_translated( &self, offset: IVec2, ) -> Result<Self, CoordinateOverflowError>

Returns a copy with every coordinate shifted by offset.

Errors

Returns CoordinateOverflowError if any translated coordinate exceeds the signed 32-bit lattice.

pub fn from_unique_entries( entries: impl IntoIterator<Item = (IVec2, Pauli)>, ) -> Self

Build a map from entries with pairwise-distinct coordinates and non-identity Paulis.

Skips the per-entry binary search and shifting that FromIterator performs, sorting the collected entries once instead. The caller must guarantee the entries need no deduplication or identity filtering.

Panics

Panics if coordinates repeat or an entry is identity.

pub fn empty() -> Self

Creates an empty Pauli map.

pub fn len(&self) -> usize

Returns the number of non-identity entries.

pub fn is_empty(&self) -> bool

Returns whether the map contains no non-identity entries.

pub fn iter(&self) -> PauliMapIter<'_>

Iterates over the (coordinate, pauli) entries in sorted (x, y) order.

pub fn representative_coord(&self) -> Option<IVec2>

The product’s representative coordinate: its minimum data qubit by (x, y), used as the crate::Op::MPP measurement-record key. Entries are kept sorted, so this is the first one. Recovering it from the product alone lets the construct/clone/translate/merge stages agree without a shared registry. None for an empty product.

pub fn get(&self, coord: &IVec2) -> Option<&Pauli>

The Pauli at coord, or None if the coordinate carries identity.

pub fn insert(&mut self, coord: IVec2, pauli: Pauli) -> Option<Pauli>

Sets coord to pauli, returning the Pauli previously there.

Inserting Pauli::I removes the entry, so the no-identity invariant holds.

pub fn to_pauli_string( &self, layout: &FxHashMap<IVec2, u32>, num_qubits: usize, ) -> Result<String, CircuitError>

Renders the map as a dense Pauli string of length num_qubits, placing each entry at its layout index and filling gaps with _.

Errors

Returns CircuitError::QubitNotFoundInLayout if an entry’s coordinate is absent from layout, or CircuitError::QubitIndexOutOfRange if its index is at least num_qubits.

Trait Implementations

impl BitXor for &PauliMap

type Output = PauliMap

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl Clone for PauliMap

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PauliMap

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

Formats the value using the given formatter.

impl Default for PauliMap

fn default() -> PauliMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PauliMap

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for PauliMap

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

Formats the value using the given formatter.

impl Eq for PauliMap

impl FromIterator<(IVec2, Pauli)> for PauliMap

fn from_iter<T: IntoIterator<Item = (IVec2, Pauli)>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for PauliMap

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 IntoIterator for PauliMap

type Item = (IVec2, Pauli)

The type of the elements being iterated over.

type IntoIter = IntoIter<[(IVec2, Pauli); 4]>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a PauliMap

type Item = (&'a IVec2, &'a Pauli)

The type of the elements being iterated over.

type IntoIter = PauliMapIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for PauliMap

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PauliMap

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 PauliMap