Struct SpinBasis1D 

pub struct SpinBasis1D { /* private fields */ }

Spin-chain basis for the full or fixed-magnetization spin space.

Implementations

impl SpinBasis1D

pub fn builder(sites: usize) -> SpinBasisBuilder

Start a spin-basis builder for sites lattice positions.

The default is an unrestricted spin-half basis with angular-momentum normalization and no spatial symmetry reduction.

pub const fn sites(&self) -> usize

Return the number of lattice sites.

pub const fn spin_twice(&self) -> u16

Return twice the local spin quantum number.

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

Return the selected additive spin-occupation sector, if unique.

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

Allowed additive spin-occupation sectors when the basis is a union.

pub const fn pauli(&self) -> bool

Report whether a Pauli-scaled spin-half convention is active.

pub const fn normalization(&self) -> SpinNormalization

Return the exact local spin-operator normalization.

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

Return the canonical translation-momentum sector, if selected.

pub const fn parity(&self) -> Option<i8>

Return the reflection eigenvalue, if selected.

Trait Implementations

impl Basis for SpinBasis1D

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 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 Clone for SpinBasis1D

fn clone(&self) -> SpinBasis1D

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpinBasis1D

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

Formats the value using the given formatter.

impl From<SpinBasis1D> for PackedBasis

fn from(basis: SpinBasis1D) -> Self

Converts to this type from the input type.