Enum Valuation 

pub enum Valuation<F>
where
    F: ValuationRing,
{
    PosInf,
    Finite(F),
}

Represents valuations of ultrametric numbers

In the digital representation, this is the number of digits between decimal point and first nonzero digit, possibly negative. This struct can also be used to represent certainty. E.g.

let z = ZAdic::new_approx(5, 6, vec![0, 0, 3, 1, 2, 4]);
assert_eq!(Valuation::Finite(2), z.valuation());
assert_eq!(Valuation::Finite(6), z.certainty());
assert_eq!(Valuation::Finite(0), ZAdic::empty(5).valuation());
assert_eq!(Valuation::Finite(0), ZAdic::empty(5).certainty());
assert_eq!(Valuation::PosInf, UAdic::new(5, vec![]).valuation());
assert_eq!(Valuation::PosInf, UAdic::new(5, vec![]).certainty());
assert_eq!(Valuation::Finite(0), QAdic::new(UAdic::new(5, vec![1, 2]), 0).valuation());
assert_eq!(Valuation::Finite(2), QAdic::new(UAdic::new(5, vec![1, 2]), 2).valuation());
assert_eq!(Valuation::Finite(-2), QAdic::new(UAdic::new(5, vec![1, 2]), -2).valuation());
assert_eq!(Valuation::Finite(-1), QAdic::new(UAdic::new(5, vec![0, 2]), -2).valuation());
assert_eq!(Valuation::PosInf, QAdic::new(UAdic::zero(5), -2).valuation());

Variants

PosInf

Positive infinity, e.g. for the size of zero

Finite(F)

Finite valuation

Implementations

impl<F> Valuation<F>

where F: ValuationRing,

pub fn finite(&self) -> Option<F>

Return finite value if Finite and None if PosInf

pub fn is_finite(&self) -> bool

Is the valuation finite

pub fn convert<G>(self) -> Result<Valuation<G>, G::Error>

where G: ValuationRing + TryFrom<F>,

Convert from one valuation to another

Errors

Error if the conversion attempt fails

Trait Implementations

impl<F> Add for Valuation<F>

where F: ValuationRing,

type Output = Valuation<F>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<F> Clone for Valuation<F>

where F: ValuationRing + Clone,

fn clone(&self) -> Valuation<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F> Copy for Valuation<F>

where F: ValuationRing + Copy,

impl<F> Debug for Valuation<F>

where F: ValuationRing + Debug,

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

Formats the value using the given formatter.

impl<F> Default for Valuation<F>

where F: ValuationRing + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<F> Display for Valuation<F>

where F: ValuationRing + Display,

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

Formats the value using the given formatter.

impl<F> Div for Valuation<F>

where F: ValuationRing + Div<Output = F>,

type Output = Option<Valuation<F>>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<F> Eq for Valuation<F>

where F: ValuationRing + Eq,

impl<F> From<F> for Valuation<F>

where F: ValuationRing,

fn from(value: F) -> Self

Converts to this type from the input type.

impl<F> Hash for Valuation<F>

where F: ValuationRing + Hash,

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<F> Mul for Valuation<F>

where F: ValuationRing,

type Output = Valuation<F>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<F> Neg for Valuation<F>

where F: ValuationRing + Neg<Output = F>,

type Output = Option<Valuation<F>>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<F> Ord for Valuation<F>

where F: ValuationRing,

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<F> PartialEq for Valuation<F>

where F: ValuationRing + PartialEq,

fn eq(&self, other: &Valuation<F>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<F> PartialOrd for Valuation<F>

where F: ValuationRing,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<F> StructuralPartialEq for Valuation<F>

where F: ValuationRing + PartialEq,

impl<F> Sub for Valuation<F>

where F: ValuationRing + Sub<Output = F>,

type Output = Option<Valuation<F>>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<F> Zero for Valuation<F>

where F: ValuationRing,

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.