Struct SpinBasisBuilder 

pub struct SpinBasisBuilder { /* private fields */ }

Builder for full, conserved, or symmetry-reduced spin-chain bases.

Implementations

impl SpinBasisBuilder

pub const fn spin_twice(self, spin_twice: u16) -> Self

Select the local spin as twice its quantum number.

For example, 1 selects spin one half and 2 selects spin one.

pub fn up(self, up: usize) -> Self

Restrict the basis to one additive spin-occupation sector.

pub fn magnetization(self, up: usize) -> Self

Alias for SpinBasisBuilder::up.

pub fn particle_sectors(self, sectors: impl IntoIterator<Item = usize>) -> Self

Select a union of additive spin-occupation sectors.

pub const fn momentum(self, momentum: i32) -> Self

Select a translation-momentum sector.

Negative values are canonicalized modulo the lattice length when the basis is built.

pub const fn parity(self, parity: i8) -> Self

Select a reflection sector with eigenvalue -1 or 1.

pub const fn pauli(self, pauli: bool) -> Self

Select Cartesian Pauli normalization for a spin-half basis.

pub const fn normalization(self, normalization: SpinNormalization) -> Self

Select an explicit local spin normalization.

pub fn build(self) -> Result<SpinBasis1D>

Validate the requested sectors and enumerate the resulting basis.

Fixed additive sectors are generated combinatorially. Translation and parity filters are then applied to physical orbits.

Trait Implementations

impl Clone for SpinBasisBuilder

fn clone(&self) -> SpinBasisBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpinBasisBuilder

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

Formats the value using the given formatter.