Struct PauliPattern 

pub struct PauliPattern(/* private fields */);

A Pauli pattern representing a set of matching Pauli words.

Example

[XY]2Z3 represents X2Z3 or Y2Z3. Z? represents any Pauli word with I or Z.

Implementations

impl PauliPattern

pub fn enumerate_matches<A>( &self, n_qubits: usize, ) -> EnumMatchesPauliPattern<'_, A>

where A: PauliStorage,

Iterate over every PauliWord over n_qubits qubits that matches this pattern. Star patterns are not supported and will panic.

impl PauliPattern

pub fn parse(input: impl AsRef<str>) -> Result<PauliPattern, Error>

Parse a pattern from its textual form.

The grammar supports literal Paulis (X, Y, Z), the don’t-care symbol _, alternation in brackets ([XY]), optional-identity suffix (X?), star repetition (X*), counted repetition (X{3}), and absolute-position anchoring (X3 matches an X at qubit 3).

Examples

use ppvm_pauli_word::pattern::{Contains, PauliPattern};
use ppvm_pauli_word::word::PauliWord;

let pat = PauliPattern::parse("X0Y1Z2").unwrap();
let w: PauliWord<u64> = "XYZ".into();
assert!(pat.contains(&w));

let alt = PauliPattern::parse("[XY]0Y1Z2").unwrap();
let w2: PauliWord<u64> = "YYZ".into();
assert!(alt.contains(&w2));

Trait Implementations

impl Clone for PauliPattern

fn clone(&self) -> PauliPattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W> Contains<W> for PauliPattern

where W: PauliIter,

fn contains(&self, item: &W) -> bool

true if item matches this pattern.

impl Debug for PauliPattern

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

Formats the value using the given formatter.

impl Display for PauliPattern

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

Formats the value using the given formatter.

impl<S> From<S> for PauliPattern

where S: AsRef<str>,

fn from(s: S) -> PauliPattern

Converts to this type from the input type.

impl PartialEq for PauliPattern

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PauliPattern

impl<'a, A, H> Trace<'a, PauliPattern> for PauliWord<A, H>

where A: PauliStorage + 'a, H: Default + BuildHasher + Clone + HashFinalize + 'a,

type Output = bool

Numeric output of the trace.

fn trace( &'a self, value: &'a PauliPattern, ) -> <PauliWord<A, H> as Trace<'a, PauliPattern>>::Output

Compute tr(self · value).

impl<'a, A, H> Trace<'a, PauliPattern> for LossyPauliWord<A, H>

where A: PauliStorage + 'a, H: Default + BuildHasher + Clone + HashFinalize + 'a,

type Output = bool

Numeric output of the trace.

fn trace( &'a self, value: &'a PauliPattern, ) -> <LossyPauliWord<A, H> as Trace<'a, PauliPattern>>::Output

Compute tr(self · value).

impl<'a, W> Trace<'a, W> for PauliPattern

where W: PauliWordTrait + 'a,

type Output = bool

Numeric output of the trace.

fn trace(&'a self, value: &'a W) -> <PauliPattern as Trace<'a, W>>::Output

Compute tr(self · value).