Struct icu::experimental::units::ratio::IcuRatio

pub struct IcuRatio(/* private fields */);

A ratio type that uses BigInt as the underlying type.

Implementations

impl IcuRatio

pub fn from_big_ints(numerator: BigInt, denominator: BigInt) -> IcuRatio

Creates a new IcuRatio from the given numerator and denominator.

pub fn get_ratio(self) -> Ratio<BigInt>

Returns the current IcuRatio as a Ratio of BigInt.

pub fn abs(&self) -> IcuRatio

Returns the absolute value of the ratio.

pub fn two() -> IcuRatio

Returns a Ratio with value of 2.

pub fn ten() -> IcuRatio

Returns a Ratio with value of 10.

pub fn is_negative(&self) -> bool

Returns true if the ratio is negative.

Trait Implementations

impl Add<&IcuRatio> for &IcuRatio

type Output = IcuRatio

The resulting type after applying the + operator.

fn add(self, rhs: &IcuRatio) -> IcuRatio

Performs the + operation.

impl Add for IcuRatio

type Output = IcuRatio

The resulting type after applying the + operator.

fn add(self, rhs: IcuRatio) -> IcuRatio

Performs the + operation.

impl AddAssign for IcuRatio

fn add_assign(&mut self, rhs: IcuRatio)

Performs the += operation.

impl Clone for IcuRatio

fn clone(&self) -> IcuRatio

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IcuRatio

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

Formats the value using the given formatter.

impl Div for IcuRatio

type Output = IcuRatio

The resulting type after applying the / operator.

fn div(self, rhs: IcuRatio) -> IcuRatio

Performs the / operation.

impl DivAssign for IcuRatio

fn div_assign(&mut self, rhs: IcuRatio)

Performs the /= operation.

impl From<Ratio<BigInt>> for IcuRatio

fn from(ratio: Ratio<BigInt>) -> IcuRatio

Converts to this type from the input type.

impl From<u32> for IcuRatio

fn from(value: u32) -> IcuRatio

Converts to this type from the input type.

impl FromStr for IcuRatio

fn from_str(number_str: &str) -> Result<IcuRatio, <IcuRatio as FromStr>::Err>

Converts a string representation of a ratio into an IcuRatio. Supported string formats include:

use core::str::FromStr;
use icu::experimental::units::ratio::IcuRatio;
use num_bigint::BigInt;
use num_rational::Ratio;
use num_traits::identities::Zero;

// Fractional notation
let ratio = IcuRatio::from_str("1/2").unwrap();
assert_eq!(
    ratio,
    IcuRatio::from(Ratio::new(BigInt::from(1), BigInt::from(2)))
);

// Decimal notation
let ratio = IcuRatio::from_str("1.5").unwrap();
assert_eq!(
    ratio,
    IcuRatio::from(Ratio::new(BigInt::from(3), BigInt::from(2)))
);

// Scientific notation
let ratio = IcuRatio::from_str("1.5E6").unwrap();
assert_eq!(
    ratio,
    IcuRatio::from(Ratio::from_integer(BigInt::from(1500000)))
);

// Scientific notation with negative exponent
let ratio = IcuRatio::from_str("1.5E-6").unwrap();
assert_eq!(
    ratio,
    IcuRatio::from(Ratio::new(BigInt::from(15), BigInt::from(10000000)))
);

// Scientific notation with commas
let ratio = IcuRatio::from_str("1,500E6").unwrap();
assert_eq!(
    ratio,
    IcuRatio::from(Ratio::from_integer(BigInt::from(1500000000)))
);

// Integer notation
let ratio = IcuRatio::from_str("1").unwrap();
assert_eq!(ratio, IcuRatio::from(Ratio::from_integer(BigInt::from(1))));

// Fractional notation with exponent
let ratio = IcuRatio::from_str("1/2E5").unwrap();
assert_eq!(
    ratio,
    IcuRatio::from(Ratio::from_integer(BigInt::from(50000)))
);

// Negative numbers in fractional notation
let ratio = IcuRatio::from_str("-1/2").unwrap();
assert_eq!(
    ratio,
    IcuRatio::from(Ratio::new(BigInt::from(-1), BigInt::from(2)))
);

// Negative numbers in decimal notation
let ratio = IcuRatio::from_str("-1.5").unwrap();
assert_eq!(
    ratio,
    IcuRatio::from(Ratio::new(BigInt::from(-3), BigInt::from(2)))
);

// Negative numbers in scientific notation
let ratio = IcuRatio::from_str("-1.5E6").unwrap();
assert_eq!(
    ratio,
    IcuRatio::from(Ratio::from_integer(BigInt::from(-1500000)))
);

// Negative numbers in scientific notation with commas
let ratio = IcuRatio::from_str("-1,500E6").unwrap();
assert_eq!(
    ratio,
    IcuRatio::from(Ratio::from_integer(BigInt::from(-1500000000)))
);

// Corner cases

// Empty string
let ratio = IcuRatio::from_str("").unwrap();
assert_eq!(ratio, IcuRatio::zero());

// Single dot
let ratio = IcuRatio::from_str(".").unwrap();
assert_eq!(ratio, IcuRatio::zero());

// Single minus
let ratio = IcuRatio::from_str("-").unwrap();
assert_eq!(ratio, IcuRatio::zero());

// Single plus
let ratio = IcuRatio::from_str("+").unwrap();
assert_eq!(ratio, IcuRatio::zero());

// Only zeros after dot
let ratio = IcuRatio::from_str(".000").unwrap();
assert_eq!(ratio, IcuRatio::zero());

// Error cases
// Division by zero
assert!(IcuRatio::from_str("1/0").is_err());

// Multiple slashes
assert!(IcuRatio::from_str("1/2/3").is_err());

// Non-numeric characters in fractions
assert!(IcuRatio::from_str("1/2A").is_err());

// Multiple scientific notations
assert!(IcuRatio::from_str("1.5E6E6").is_err());

// Multiple decimal points
assert!(IcuRatio::from_str("1.5.6").is_err());

// Exponent part is not an integer
assert!(IcuRatio::from_str("1.5E6.5").is_err());

NOTE: You can add as many commas as you want in the string, they will be disregarded.

type Err = RatioFromStrError

The associated error which can be returned from parsing.

impl Mul<&IcuRatio> for &IcuRatio

type Output = IcuRatio

The resulting type after applying the * operator.

fn mul(self, rhs: &IcuRatio) -> IcuRatio

Performs the * operation.

impl Mul for IcuRatio

type Output = IcuRatio

The resulting type after applying the * operator.

fn mul(self, rhs: IcuRatio) -> IcuRatio

Performs the * operation.

impl MulAssign<&SiPrefix> for IcuRatio

fn mul_assign(&mut self, rhs: &SiPrefix)

Performs the *= operation.

impl MulAssign for IcuRatio

fn mul_assign(&mut self, rhs: IcuRatio)

Performs the *= operation.

impl One for IcuRatio

fn one() -> IcuRatio

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl Ord for IcuRatio

fn cmp(&self, other: &IcuRatio) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for IcuRatio

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

fn partial_cmp(&self, other: &IcuRatio) -> 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 Pow<i32> for IcuRatio

type Output = IcuRatio

The result after applying the operator.

fn pow(self, exp: i32) -> IcuRatio

Returns self to the power rhs.

impl Sub for IcuRatio

type Output = IcuRatio

The resulting type after applying the - operator.

fn sub(self, rhs: IcuRatio) -> IcuRatio

Performs the - operation.

impl SubAssign for IcuRatio

fn sub_assign(&mut self, rhs: IcuRatio)

Performs the -= operation.

impl Zero for IcuRatio

fn zero() -> IcuRatio

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Eq for IcuRatio

impl StructuralPartialEq for IcuRatio