Enum rug::float::Constant

pub enum Constant {
    Log2,
    Pi,
    Euler,
    Catalan,
    // some variants omitted
}

The available floating-point constants.

Examples

use rug::{float::Constant, Float};

let log2 = Float::with_val(53, Constant::Log2);
let pi = Float::with_val(53, Constant::Pi);
let euler = Float::with_val(53, Constant::Euler);
let catalan = Float::with_val(53, Constant::Catalan);

assert_eq!(log2.to_string_radix(10, Some(5)), "6.9315e-1");
assert_eq!(pi.to_string_radix(10, Some(5)), "3.1416");
assert_eq!(euler.to_string_radix(10, Some(5)), "5.7722e-1");
assert_eq!(catalan.to_string_radix(10, Some(5)), "9.1597e-1");

Variants

Log2

The logarithm of two, 0.693147…

Pi

The value of pi, π = 3.14159…

Euler

Euler’s constant, also known as the Euler-Mascheroni constant, γ = 0.577215…

Note that this is not Euler’s number e, which can be obtained using one of the exp functions.

Catalan

Catalan’s constant, 0.915965…

Trait Implementations

impl AssignRound<&'_ Constant> for Float

type Round = <Float as AssignRound<Constant>>::Round

The rounding method.

type Ordering = <Float as AssignRound<Constant>>::Ordering

The direction from rounding.

fn assign_round(&mut self, src: &Constant, round: Self::Round) -> Self::Ordering

Peforms the assignment.

impl AssignRound<Constant> for Float

type Round = Round

The rounding method.

type Ordering = Ordering

The direction from rounding.

fn assign_round(&mut self, src: Constant, round: Round) -> Ordering

Peforms the assignment.

impl Clone for Constant

fn clone(&self) -> Constant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Constant

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

Formats the value using the given formatter.

impl Hash for Constant

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 Ord for Constant

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Constant> for Constant

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

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

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

This method tests for !=.

impl PartialOrd<Constant> for Constant

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

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

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

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

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

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

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

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

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 Copy for Constant

impl Eq for Constant

impl StructuralEq for Constant

impl StructuralPartialEq for Constant