Struct SpinState 

pub struct SpinState { /* private fields */ }

A validated spin state with spin and projection stored as doubled quantum numbers.

Implementations

impl SpinState

pub fn new(spin: AngularMomentum, projection: Projection) -> LadduResult<Self>

Construct a spin state after validating projection bounds and parity.

pub const fn spin(self) -> AngularMomentum

Return the spin quantum number.

pub const fn projection(self) -> Projection

Return the spin projection quantum number.

pub fn allowed_projections(spin: AngularMomentum) -> Vec<Self>

Enumerate all allowed projections for spin.

Trait Implementations

impl Clone for SpinState

fn clone(&self) -> SpinState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpinState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpinState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SpinState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SpinState

fn eq(&self, other: &SpinState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SpinState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SpinState

impl Eq for SpinState

impl StructuralPartialEq for SpinState