Struct ReductionImage 

pub struct ReductionImage<State> { /* private fields */ }

Canonical image of one physical state under a basis reduction.

phase / sqrt(orbit_size) is the coefficient of state in the normalized reduced vector labelled by representative. Keeping this convention at the basis boundary lets projectors, cross-sector operators, and language bindings share one source of truth.

Implementations

impl<State> ReductionImage<State>

pub fn new( representative: State, phase: Complex64, orbit_size: usize, ) -> Result<Self>

Validate and store the canonical representative, unit phase, and orbit size.

The phase must be finite with unit magnitude and orbit_size must be positive. These invariants make ReductionImage::amplitude safe to use in projectors and cross-sector assembly.

pub const fn representative(&self) -> &State

Return the canonical state labelling the reduced-basis vector.

pub const fn phase(&self) -> Complex64

Return the unit-modulus physical-to-canonical phase.

pub const fn orbit_size(&self) -> usize

Return the number of physical states in the symmetry orbit.

pub fn amplitude(&self) -> Complex64

Normalized coefficient of the physical state in its reduced vector.

Trait Implementations

impl<State: Clone> Clone for ReductionImage<State>

fn clone(&self) -> ReductionImage<State>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<State: Debug> Debug for ReductionImage<State>

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

Formats the value using the given formatter.

impl<State: PartialEq> PartialEq for ReductionImage<State>

fn eq(&self, other: &ReductionImage<State>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<State: Copy> Copy for ReductionImage<State>

impl<State> StructuralPartialEq for ReductionImage<State>