Struct wigner_symbols::SignedSqrt

pub struct SignedSqrt(pub Rational);

Signed square root of a rational number

This represents a mathematical expression of the form s √(n / d) where

• s is a sign (-1, 0, or +1),
• n is a nonnegative numerator, and
• d is a positive denominator.

Internally, it is represented by the rational number s × n / d.

This can be converted to a floating-point number via f64::from(…).

Defaults to zero.

Implementations

impl SignedSqrt

pub fn new(c: Integer, r: Rational) -> Self

Construct a SignedSqrt equal to c √r.

pub fn sign(&self) -> Ordering

Equivalent to self.cmp(&Self::from(0)).

pub fn sq(self) -> Rational

Returns the square of the expression.

pub fn signed_sq(self) -> Rational

Returns the square of the expression, but with the sign adjusted to match the sign of the original expression.

Trait Implementations

impl Clone for SignedSqrt

fn clone(&self) -> SignedSqrt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignedSqrt

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

Formats the value using the given formatter.

impl Default for SignedSqrt

fn default() -> SignedSqrt

Returns the “default value” for a type.

impl From<i32> for SignedSqrt

fn from(s: i32) -> Self

Performs the conversion.

impl From<i64> for SignedSqrt

fn from(s: i64) -> Self

Performs the conversion.

impl Hash for SignedSqrt

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, 

Feeds a slice of this type into the given Hasher.

impl Mul<SignedSqrt> for SignedSqrt

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl Mul<i32> for SignedSqrt

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: i32) -> Self::Output

Performs the * operation.

impl Ord for SignedSqrt

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<SignedSqrt> for SignedSqrt

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<SignedSqrt> for SignedSqrt

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

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SignedSqrt

impl StructuralEq for SignedSqrt

impl StructuralPartialEq for SignedSqrt