Struct Fraction

pub struct Fraction {
    pub sign: bool,
    pub num: u128,
    pub denom: u128,
}

A fraction that can be factorized.

Fields

sign: bool

The sign, where false is positive and true is negative. Fractions with a numerator of 0 ignore the sign when checking equality.

num: u128

The numerator.

denom: u128

The denominator.

Implementations

impl Fraction

pub const ONE: Self

The multiplicative base fraction, 1/1.

pub const ZERO: Self

The additive base fraction, 0/1.

pub const NEG_ONE: Self

The negative multiplicative base fraction, -1/1.

pub const ONE_OVER_ZERO: Self

The fraction that represents positive infinity, 1/0.

pub const ZERO_OVER_ZERO: Self

The fraction that represents an undefined value, 0/0.

pub const NEG_ONE_OVER_ZERO: Self

The fraction that represents negative infinity, -1/0.

pub fn new(num: impl Into<Fraction>, denom: impl Into<Fraction>) -> Self

Creates a new fraciton from a numerator and denominator.

Examples:

Basic usage:

let frac = Fraction::new(2, -5);

assert_eq!(frac.sign, true);
assert_eq!(frac.num, 2);
assert_eq!(frac.denom, 5);

pub fn whole(num: impl Into<Fraction>) -> Self

Creates a new fraction from a numerator.

Examples:

Basic usage:

let frac = Fraction::whole(36);

assert_eq!(frac.sign, false);
assert_eq!(frac.num, 36);
assert_eq!(frac.denom, 1);

pub const fn recip(&self) -> Self

The multiplicative reciprocal of this fraction, created by swapping the numerator and the denominator.

pub fn factorize(&self) -> impl Iterator<Item = Factor>

Breaks this fraction down into it’s prime factors. The factors are always yielded in order from lowest to highest, and no two factors with the same base will appear.

Examples

Basic usage:

let frac = Fraction::new(-120, 130);
let factors: Vec<Factor> = frac.factorize().collect();

assert_eq!(factors, [
    Factor::NegativeOne,
    Factor::Prime(2, 2),
    Factor::Prime(3, 1),
    Factor::Prime(13, -1),
]);

Trait Implementations

impl Clone for Fraction

fn clone(&self) -> Fraction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Fraction

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

Formats the value using the given formatter.

impl Display for Fraction

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

Formats the value using the given formatter.

impl Div for &Fraction

type Output = Fraction

The resulting type after applying the / operator.

fn div(self, other: Self) -> Fraction

Performs the / operation.

impl Div for Fraction

type Output = Fraction

The resulting type after applying the / operator.

fn div(self, other: Self) -> Fraction

Performs the / operation.

impl DivAssign<&Fraction> for Fraction

fn div_assign(&mut self, other: &Self)

Performs the /= operation.

impl DivAssign for Fraction

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl From<Factor> for Fraction

fn from(fac: Factor) -> Self

Converts to this type from the input type.

impl From<i128> for Fraction

fn from(num: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Fraction

fn from(num: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Fraction

fn from(num: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Fraction

fn from(num: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Fraction

fn from(num: i8) -> Self

Converts to this type from the input type.

impl From<u128> for Fraction

fn from(num: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Fraction

fn from(num: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Fraction

fn from(num: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Fraction

fn from(num: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Fraction

fn from(num: u8) -> Self

Converts to this type from the input type.

impl Mul for &Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&Fraction> for Fraction

fn mul_assign(&mut self, other: &Self)

Performs the *= operation.

impl MulAssign for Fraction

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl Neg for &Fraction

type Output = Fraction

The resulting type after applying the - operator.

fn neg(self) -> Fraction

Performs the unary - operation.

impl Neg for Fraction

type Output = Fraction

The resulting type after applying the - operator.

fn neg(self) -> Fraction

Performs the unary - operation.

impl PartialEq for Fraction

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

Tests for self and other values to be equal, and is used by ==.

const 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 Product<Factor> for Fraction

fn product<I: Iterator<Item = Factor>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl Product for Fraction

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl Copy for Fraction

impl Eq for Fraction