Struct Fraction

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

A simplified fraction. This is used to get a percentile from any function in this module.

We use two methods of getting the index in a list. The first one can give a mean of two values it the Self::denominator usize::is_power_of_two. This enables 3/8 to give a correct result. If the above isn’t applicable, the fallback idx = ceil(len * fraction) - 1.

Please contribute if you need a more solid system.

Eq & Ord

These are implemented to follow the expected ordering.

Fields

numerator: u64

denominator: u64

Implementations

impl Fraction

pub const HALF: Self = _

pub const ONE_QUARTER: Self = _

pub const THREE_QUARTERS: Self = _

pub fn new(numerator: u64, denominator: u64) -> Self

Create a new fraction. This function also simplifies the fraction.

Panics

Panics if numerator > denominator.

Trait Implementations

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

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.

impl OrderedListIndex for Fraction

fn index(&self, len: usize) -> MeanValue<usize>

Returns the index this object is targeting. Could be either a single value or the mean of two.

impl PartialEq for Fraction

fn eq(&self, other: &Self) -> 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 PartialOrd for Fraction

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

impl Eq for Fraction