Struct oxygen_quark::fraction::Fraction

pub struct Fraction {
    pub numerator: i64,
    pub denominator: i64,
}

Fields

numerator: i64

The numerator

denominator: i64

The denominator

Implementations

impl Fraction

pub fn new(numerator: i64, denominator: i64) -> Fraction

Generates a new Fraction

It returns a Fraction in its fully reduced form, after calculating the greatest common divisor.

Examples

let x = Fraction::new(3, 1);
let y = Fraction::new(4, 1);
 
// Prints out "3, 4"
println!("{}, {}", x, y);

Panics

Panics if denominator is zero (0).

pub fn new_from_decimal(decimal: f64) -> Fraction

Generates a new Fraction from an f64

It returns a Fraction in its fully reduced form, after calculating the greatest common divisor.

Useful for when calculating square-roots, sine, cosine, tangent functions and more.

Examples

let x = Fraction::new(3, 1);
let y = Fraction::new(4, 1);
 
// Prints out "3, 4"
println!("{}, {}", x, y);

Panics

Panics if the numerator is too large, ‘attempt to multiply with overflow’.

pub fn add(self, other: Fraction) -> Fraction

Adds two Fractions and returns their sum, another Fraction.

Examples

let f1 = Fraction::new(3, 1);
let f2 = Fraction::new(4, 1);
 
// Prints out "7"
println!("{}", f1.add(f2));
 
// It also works like this:
println!("{}", f1 + f2);

pub fn subtract(self, other: Fraction) -> Fraction

Subtracts two Fractions and returns their difference, another Fraction.

Examples

let f1 = Fraction::new(3, 1);
let f2 = Fraction::new(4, 1);
 
// Prints out "-1"
println!("{}", f1.subtract(f2));
 
// It also works like this:
println!("{}", f1 - f2);

pub fn multiply(self, other: Fraction) -> Fraction

Multiplies two Fractions and returns their product, another Fraction.

Examples

let f1 = Fraction::new(3, 1);
let f2 = Fraction::new(4, 1);
 
// Prints out "12"
println!("{}", f1.multiply(f2));
 
// It also works like this:
println!("{}", f1 * f2);

pub fn divide(self, other: Fraction) -> Fraction

Divides two Fractions and returns their quotient, another Fraction.

Examples

let f1 = Fraction::new(3, 1);
let f2 = Fraction::new(4, 1);
 
// Prints out "(3/4)"
println!("{}", f1.divide(f2));
 
// It also works like this:
println!("{}", f1 / f2);

pub fn greatest_common_divisor(numerator: i64, denominator: i64) -> i64

Returns the greatest common divisor, as an i64.

Examples

let n1 = 50;
let n2 = 20;
 
// Prints out "10"
println!("{}", Fraction::greatest_common_divisor(n1, n2));

pub fn reciprocal(self) -> Fraction

Returns the reciprocal of the Fraction it’s called on.

Just moves the denominator to the numerator position and vice versa.

Examples

let fraction = Fraction::new(3, 1);
 
// Prints out "(1/3)"
println!("{}", fraction.reciprocal());

Panics

Panics when being called on a Fraction with numerator 0.

pub fn zero() -> Fraction

Returns a Fraction with numerator 0 and denominator 1.

Examples

let fraction = Fraction::zero();
 
// Prints out "0"
println!("{}", fraction);

pub fn sqrt(&self) -> Fraction

Returns the square-root of a Fraction. Result is a Fraction

Examples

let fraction = Fraction::new(25, 36);
 
// Prints out "(5/6)"
println!("{}", fraction.sqrt());

pub fn cosine(self) -> Fraction

Returns an approximated Fraction of the cosine (cos) of the Fraction

Examples

let fraction = Fraction::new(1, 1);
 
// Prints out "(5403/10000)"
println!("{}", fraction.sqrt());

pub fn arc_cosine(self) -> Fraction

Returns an approximated Fraction of the arc cosine (cos^-1) of the Fraction

Examples

let fraction = Fraction::new(1, 1);
 
// Prints out "+0"
println!("{}", fraction.sqrt());

pub fn sine(self) -> Fraction

Returns an approximated Fraction of the sine (sin) of the Fraction

Examples

let fraction = Fraction::new(1, 1);
 
// Prints out "(84147/100000)"
println!("{}", fraction.sqrt());

pub fn arc_sine(self) -> Fraction

Returns an approximated Fraction of the arc sine (sin^-1) of the Fraction

Examples

let fraction = Fraction::new(1, 1);
 
// Prints out "(3927/2500)"
println!("{}", fraction.sqrt());

pub fn tangent(self) -> Fraction

Returns an approximated Fraction of the tangent (tan) of the Fraction

Examples

let fraction = Fraction::new(1, 1);
 
// Prints out "(155741/100000)"
println!("{}", fraction.sqrt());

pub fn arc_tangent(self) -> Fraction

Returns an approximated Fraction of the arc tangent (tan^-1) of the Fraction

Examples

let fraction = Fraction::new(1, 1);
 
// Prints out "(3927/5000)"
println!("{}", fraction.sqrt());

Trait Implementations

impl Add<Fraction> for Fraction

type Output = Fraction

The resulting type after applying the + operator.

fn add(self, other: Fraction) -> Fraction

Performs the + operation.

impl AddAssign<Fraction> for Fraction

fn add_assign(&mut self, other: Fraction)

Performs the += operation.

impl Clone for Fraction

fn clone(&self) -> Fraction

Returns a copy of the value.

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<Fraction> for Fraction

type Output = Fraction

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<Fraction> for Fraction

fn div_assign(&mut self, other: Fraction)

Performs the /= operation.

impl Mul<Fraction> for Fraction

type Output = Fraction

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Fraction> for Fraction

fn mul_assign(&mut self, other: Fraction)

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Fraction> for Fraction

fn eq(&self, other: &Fraction) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Fraction> for Fraction

fn partial_cmp(&self, other: &Fraction) -> 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 Sub<Fraction> for Fraction

type Output = Fraction

The resulting type after applying the - operator.

fn sub(self, other: Fraction) -> Fraction

Performs the - operation.

impl SubAssign<Fraction> for Fraction

fn sub_assign(&mut self, other: Fraction)

Performs the -= operation.

impl Copy for Fraction

impl Eq for Fraction