Struct SymmetryReducer 

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

Finite generators and sector phases that extend to a one-dimensional character of the generated group.

Implementations

impl<State> SymmetryReducer<State>

pub fn new() -> Self

Create a reducer with no generators and an empty shared orbit cache.

pub fn with_map<M>(self, map: M, sector: i32) -> Self

where M: SymmetryMap<State> + 'static,

Add a finite symmetry generator and its one-dimensional character sector.

Adding a generator defines a different group action, so the returned reducer starts with a fresh cache. Clones made after construction share cached orbit traces.

pub fn generators(&self) -> usize

Return the number of configured finite generators.

pub fn cached_orbits(&self) -> usize

Return the number of canonical orbit traces currently cached.

This diagnostic is safe to call across cloned reducers. A poisoned cache reports zero rather than exposing lock internals.

pub fn clear_cache(&self)

Discard every cached orbit trace shared by clones of this reducer.

pub fn period_product(&self) -> Result<usize>

Product of declared generator periods.

This is not generally the order of a non-Abelian generated group. It is exposed because compatibility layers such as QuSpin define their historical normalization convention from this product.

impl<State> SymmetryReducer<State>

where State: Copy + Eq + Hash + Ord,

pub fn orbit_states(&self, state: State) -> Result<Vec<State>>

Enumerate the finite physical orbit of one state in canonical order.

This stays independent of any materialized basis. Deferred operator paths use it to test whether an output orbit intersects the seed constraint, including when the canonical representative itself lies outside that constraint.

pub fn orbit_with_states_and_ordering( &self, state: State, ordering: RepresentativeOrdering, ) -> Result<(SymmetryOrbit<State>, Vec<State>)>

Reduce a state and return its physical orbit from one group traversal.

Consumers that need both results should prefer this method over separate SymmetryReducer::orbit and SymmetryReducer::orbit_states calls.

pub fn orbit_with_states( &self, state: State, ) -> Result<(SymmetryOrbit<State>, Vec<State>)>

pub fn orbit(&self, state: State) -> Result<SymmetryOrbit<State>>

Reduce one state using only the finite group action.

This query does not enumerate a parent Hilbert space or construct the reduced basis. Incompatible character requests still return the canonical orbit representative, but have no reduced-vector phase.

pub fn orbit_with_ordering( &self, state: State, ordering: RepresentativeOrdering, ) -> Result<SymmetryOrbit<State>>

Reduce one state using an explicit representative convention.

Trait Implementations

impl<State: Clone> Clone for SymmetryReducer<State>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<State> Debug for SymmetryReducer<State>

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

Formats the value using the given formatter.

impl<State> Default for SymmetryReducer<State>

fn default() -> Self

Returns the “default value” for a type.