Struct Ratio 

pub struct Ratio { /* private fields */ }

Implementations

impl Ratio

pub const OVERFLOW: i64 = i64::MAX

pub const UNDERFLOW: i64 = i64::MIN

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

pub fn numerator(&self) -> u32

pub fn denominator(&self) -> u32

pub fn invertible(&self) -> bool

pub fn inverse(&self) -> Self

pub fn reduce_u32(numerator: &mut u32, denominator: &mut u32)

Reduces the ratio of numerator/denominator in-place (32-bit).

pub fn reduce_u64(numerator: &mut u64, denominator: &mut u64)

Reduces the ratio of numerator/denominator in-place (64-bit).

pub fn reduce(&mut self)

Reduces the ratio instance in-place.

pub fn product_raw( a_numerator: u32, a_denominator: u32, b_numerator: u32, b_denominator: u32, exact: Exact, ) -> (u32, u32)

Produces the product of two ratios.

If exact is Exact::Yes, this panics on loss of precision. If exact is Exact::No, it attempts to find the best 32-bit approximation.

pub fn product(a: Ratio, b: Ratio, exact: Exact) -> Ratio

pub fn scale_with_round<const ROUND: u8>( value: i64, numerator: u32, denominator: u32, ) -> i64

Scales an i64 value by the ratio of numerator/denominator.

Returns a saturated value (OVERFLOW or UNDERFLOW) on overflow/underflow. The rounding behavior is determined by the ROUND const generic.

pub fn scale<const ROUND: u8>(&self, value: i64) -> i64

Scales an i64 value by this ratio.

Returns a saturated value (OVERFLOW or UNDERFLOW) on overflow/underflow. The rounding behavior is determined by the ROUND const generic.

Trait Implementations

impl Clone for Ratio

fn clone(&self) -> Ratio

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Ratio

impl Debug for Ratio

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

Formats the value using the given formatter.

impl Default for Ratio

fn default() -> Self

Returns the “default value” for a type.

impl Div for Ratio

type Output = Ratio

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl Div<Ratio> for i64

type Output = i64

The resulting type after applying the / operator.

fn div(self, rhs: Ratio) -> Self::Output

Performs the / operation.

impl Eq for Ratio

impl FromBytes for Ratio

where u32: FromBytes,

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for Ratio

where u32: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl Immutable for Ratio

where u32: Immutable,

impl IntoBytes for Ratio

where u32: IntoBytes, (): PaddingFree<Self, { _ }>,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl Mul for Ratio

type Output = Ratio

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Mul<Ratio> for i64

type Output = i64

The resulting type after applying the * operator.

fn mul(self, rhs: Ratio) -> Self::Output

Performs the * operation.

impl Mul<i64> for Ratio

type Output = i64

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> Self::Output

Performs the * operation.

impl PartialEq for Ratio

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Ratio

impl TryFromBytes for Ratio

where u32: TryFromBytes,

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<!, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<!, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<!, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.