Struct SpinfulFermionBasis1D 

pub struct SpinfulFermionBasis1D { /* private fields */ }

Two-flavor fermion basis with all up orbitals ordered before all down orbitals.

Rows follow the direct-product convention up ⊗ down: the up-basis row is the major index and the down-basis row is the minor index.

Implementations

impl SpinfulFermionBasis1D

pub fn builder(sites: usize) -> SpinfulFermionBasisBuilder

Start a two-species fermion basis builder.

pub const fn sites(&self) -> usize

Return the number of spatial sites per species.

pub const fn particles_up(&self) -> Option<usize>

Return the fixed up-species particle number, if unique.

pub const fn particles_down(&self) -> Option<usize>

Return the fixed down-species particle number, if unique.

pub fn particle_sectors(&self) -> Option<&[(usize, usize)]>

Return the selected union of (up, down) particle sectors.

pub const fn local_occupation_constraint( &self, ) -> Option<&LocalOccupationConstraint>

Return the site-local occupation filter, if configured.

Trait Implementations

impl Basis for SpinfulFermionBasis1D

type State = u128

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 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 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 Self: Sized, 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 is_empty(&self) -> bool

Return whether the basis contains no vectors.

impl Clone for SpinfulFermionBasis1D

fn clone(&self) -> SpinfulFermionBasis1D

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpinfulFermionBasis1D

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

Formats the value using the given formatter.

impl From<SpinfulFermionBasis1D> for PackedBasis

fn from(basis: SpinfulFermionBasis1D) -> Self

Converts to this type from the input type.