Struct GeneralBasis 

pub struct GeneralBasis<Parent>
where
    Parent: Basis,
    Parent::State: Hash + Ord,
{ /* private fields */ }

Implementations

impl<Parent> GeneralBasis<Parent>

where Parent: Basis, Parent::State: Hash + Ord,

pub fn new( parent: Parent, sector: SymmetryReducer<Parent::State>, ) -> Result<Self>

pub fn from_reducer( parent: Parent, reducer: SymmetryReducer<Parent::State>, ) -> Result<Self>

Materialize a reduced basis from an independently reusable reducer.

pub fn from_reducer_with_ordering( parent: Parent, reducer: SymmetryReducer<Parent::State>, ordering: RepresentativeOrdering, ) -> Result<Self>

Materialize a reduced basis with an explicit canonical representative convention. The native default is the minimum state; compatibility frontends with descending basis order may select the maximum state without changing the physical symmetry subspace.

pub fn from_orbit_seeds( parent: Parent, reducer: SymmetryReducer<Parent::State>, ) -> Result<Self>

Materialize symmetry vectors whose seed states come from parent.

Unlike GeneralBasis::from_reducer, the finite symmetry orbit may contain states outside the parent’s enumerated constraint. The parent still supplies the local operator algebra, while its state list selects which physical orbits enter the reduced space. This is the natural construction for particle-hole or species-exchange symmetries acting on a fixed additive sector: one seed sector selects an orbit, and the normalized reduced vector contains the complete symmetry orbit.

The parent’s local action must therefore be defined for every state generated by the reducer. Built-in packed bases and callback bases satisfy this contract because local actions operate on the encoded state rather than its row index.

pub fn from_orbit_seeds_with_ordering( parent: Parent, reducer: SymmetryReducer<Parent::State>, ordering: RepresentativeOrdering, ) -> Result<Self>

pub fn parent(&self) -> &Parent

pub const fn reducer(&self) -> &SymmetryReducer<Parent::State>

pub fn representative(&self, state: Parent::State) -> Result<Parent::State>

pub fn orbit_size(&self, state: Parent::State) -> Result<usize>

pub fn symmetry_amplitude(&self, state: Parent::State) -> Result<Complex64>

Normalized coefficient of a parent state in its reduced representative.

Trait Implementations

impl<Parent> Basis for GeneralBasis<Parent>

where Parent: Basis, Parent::State: Hash + Ord + 'static,

type State = <Parent as Basis>::State

Integer-like state representation used by this basis.

fn len(&self) -> usize

Return the number of vectors in the basis.

fn state(&self, index: usize) -> Result<Self::State>

Return the encoded state at a basis index.

fn index(&self, state: Self::State) -> Result<usize>

Locate an encoded state in the basis.

fn apply_local( &self, state: Self::State, operator: &str, sites: &[usize], ) -> Result<Option<(Self::State, Complex64)>>

Apply one local operator string to one encoded state.

fn apply_local_transitions( &self, state: Self::State, operator: &str, sites: &[usize], ) -> Result<LocalTransitions<Self::State>>

Applies a local operator and returns every nonzero destination.

fn apply_local_unreduced_transitions( &self, state: Self::State, operator: &str, sites: &[usize], ) -> Result<LocalTransitions<Self::State>>

Local action before symmetry-sector reduction. Cross-sector builders use this path and let the target basis perform the reduction.

fn visit_local_unreduced_transitions<F>( &self, state: Self::State, operator: &str, sites: &[usize], visit: F, ) -> Result<()>

where F: FnMut(Self::State, Complex64) -> Result<()>,

Streams unreduced destinations directly to a consumer.

fn transition_orbit_size(&self, state: Self::State) -> Result<usize>

Orbit size of a canonical source state used in projector normalization.

fn reduction_image( &self, state: Self::State, ) -> Result<Option<ReductionImage<Self::State>>>

Return the canonical reduction metadata for a physical state.

fn reduce_transition( &self, state: Self::State, source_orbit_size: usize, ) -> Result<Option<(Self::State, Complex64)>>

Map an unreduced physical target state into this basis.

fn index_transition( &self, state: Self::State, source_orbit_size: usize, ) -> Result<Option<(usize, Complex64)>>

Reduces a physical target and locates its row in one operation.

fn operator_preserves_particle_sector(&self, operator: &str) -> Result<bool>

Whether a local operator string preserves the particle-sector constraints represented by this basis. Unconstrained and custom bases accept every syntactically valid string by default.

fn operator_preserves_particle_sector_on_sites( &self, operator: &str, sites: &[usize], ) -> Result<bool>

Site-aware particle-sector check for bases whose local labels encode species as well as position.

fn is_empty(&self) -> bool

Return whether the basis contains no vectors.

impl<Parent> Clone for GeneralBasis<Parent>

where Parent: Basis + Clone, Parent::State: Hash + Ord + Clone,

fn clone(&self) -> GeneralBasis<Parent>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Parent> Debug for GeneralBasis<Parent>

where Parent: Basis + Debug, Parent::State: Hash + Ord + Debug,

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

Formats the value using the given formatter.

impl From<GeneralBasis<BosonBasis1D>> for PackedBasis

fn from(basis: BosonBasisGeneral) -> Self

Converts to this type from the input type.

impl From<GeneralBasis<SpinBasis1D>> for PackedBasis

fn from(basis: SpinBasisGeneral) -> Self

Converts to this type from the input type.

impl From<GeneralBasis<SpinfulFermionBasis1D>> for PackedBasis

fn from(basis: SpinfulFermionBasisGeneral) -> Self

Converts to this type from the input type.

impl From<GeneralBasis<SpinlessFermionBasis1D>> for PackedBasis

fn from(basis: SpinlessFermionBasisGeneral) -> Self

Converts to this type from the input type.

impl From<GeneralBasis<UserBasis<u128>>> for PackedBasis

fn from(basis: UserBasisGeneral) -> Self

Converts to this type from the input type.

impl From<GeneralBasis<WideSpinBasis<16>>> for WidePackedBasis

fn from(basis: WideSpinBasisGeneral1024) -> Self

Converts to this type from the input type.

impl From<GeneralBasis<WideSpinBasis<256>>> for WidePackedBasis

fn from(basis: WideSpinBasisGeneral16384) -> Self

Converts to this type from the input type.

impl From<GeneralBasis<WideSpinBasis<4>>> for WidePackedBasis

fn from(basis: WideSpinBasisGeneral256) -> Self

Converts to this type from the input type.

impl From<GeneralBasis<WideSpinBasis<64>>> for WidePackedBasis

fn from(basis: WideSpinBasisGeneral4096) -> Self

Converts to this type from the input type.