Skip to main content

Spin

Struct Spin 

Source
pub struct Spin { /* private fields */ }
Expand description

Spin quantum number j (half-integer)

§Mathematical Definition

j ∈ {0, 1/2, 1, 3/2, 2, …}

Internally represented as 2j (integer) to avoid floating point.

§Physical Meaning

  • j = 0: Scalar (spin-0)
  • j = 1/2: Spinor (spin-1/2, fermions)
  • j = 1: Vector (spin-1, bosons)
  • j = n/2: General half-integer spin

Implementations§

Source§

impl Spin

Source

pub const ZERO: Spin

Spin-0 (scalar, trivial representation)

Source

pub const HALF: Spin

Spin-1/2 (spinor, fundamental representation)

Source

pub const ONE: Spin

Spin-1 (vector, adjoint representation)

Source

pub fn two_j(&self) -> u32

Get the internal 2j representation (useful for pattern matching).

Source

pub fn from_half_integer(two_j: u32) -> Self

Create from half-integer: j = n/2

§Examples
  • Spin::from_half_integer(0) → j = 0
  • Spin::from_half_integer(1) → j = 1/2
  • Spin::from_half_integer(2) → j = 1
Source

pub fn from_integer(j: u32) -> Self

Create from integer spin (convenience)

Source

pub fn value(&self) -> f64

Get the spin value as f64: j

Source

pub fn dimension(&self) -> usize

Get dimension of this representation: 2j + 1

Source

pub fn is_integer(&self) -> bool

Check if this is integer spin (boson)

Source

pub fn is_half_integer(&self) -> bool

Check if this is half-integer spin (fermion)

Trait Implementations§

Source§

impl Clone for Spin

Source§

fn clone(&self) -> Spin

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Spin

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for Spin

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Spin

Source§

fn cmp(&self, other: &Spin) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Spin

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for Spin

Source§

fn partial_cmp(&self, other: &Spin) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for Spin

Source§

impl Eq for Spin

Source§

impl StructuralPartialEq for Spin

Auto Trait Implementations§

§

impl Freeze for Spin

§

impl RefUnwindSafe for Spin

§

impl Send for Spin

§

impl Sync for Spin

§

impl Unpin for Spin

§

impl UnsafeUnpin for Spin

§

impl UnwindSafe for Spin

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,