Struct Rational 

pub struct Rational { /* private fields */ }

A normalized exact rational number.

Implementations

impl Rational

pub const fn from_integer(value: i128) -> Self

Returns the exact integer value / 1.

pub const fn zero() -> Self

Returns 0 / 1.

pub const fn one() -> Self

Returns 1 / 1.

pub fn try_new( numerator: i128, denominator: i128, ) -> Result<Self, RationalError>

Creates a normalized rational number from a numerator and denominator.

Errors

Returns RationalError::ZeroDenominator when denominator == 0, and returns overflow-related errors when canonical sign normalization cannot be represented in the current integer type.

Examples

use use_rational::{Rational, RationalError};

let rational = Rational::try_new(2, 4)?;
assert_eq!(rational, Rational::try_new(1, 2)?);

assert!(matches!(
    Rational::try_new(1, 0),
    Err(RationalError::ZeroDenominator)
));

pub const fn numerator(&self) -> i128

Returns the normalized numerator.

pub const fn denominator(&self) -> i128

Returns the normalized positive denominator.

pub const fn is_integer(&self) -> bool

Returns true when the rational is an integer.

pub const fn to_integer(self) -> Option<i128>

Returns the exact integer value when the rational is integral.

pub fn reciprocal(self) -> Result<Self, RationalError>

Returns the reciprocal when the rational is non-zero.

Errors

Returns RationalError::DivisionByZero when self == 0.

pub fn checked_add(self, other: Self) -> Result<Self, RationalError>

Adds two rational numbers exactly.

Errors

Returns RationalError::ArithmeticOverflow when the intermediate or normalized result cannot be represented exactly.

pub fn checked_sub(self, other: Self) -> Result<Self, RationalError>

Subtracts two rational numbers exactly.

Errors

Returns RationalError::ArithmeticOverflow when the intermediate or normalized result cannot be represented exactly.

pub fn checked_mul(self, other: Self) -> Result<Self, RationalError>

Multiplies two rational numbers exactly.

Errors

Returns RationalError::ArithmeticOverflow when the intermediate or normalized result cannot be represented exactly.

pub fn checked_div(self, other: Self) -> Result<Self, RationalError>

Divides two rational numbers exactly.

Errors

Returns RationalError::DivisionByZero when other == 0, and returns RationalError::ArithmeticOverflow when the exact result cannot be represented.

pub fn as_f64(&self) -> f64

Returns the rational as an approximate f64.

Trait Implementations

impl Clone for Rational

fn clone(&self) -> Rational

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rational

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

Formats the value using the given formatter.

impl Display for Rational

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

Formats the value using the given formatter.

impl PartialEq for Rational

fn eq(&self, other: &Rational) -> 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 Copy for Rational

impl Eq for Rational

impl StructuralPartialEq for Rational