Struct Integer

pub struct Integer {
    pub sign: bool,
    /* private fields */
}

Integer type with no size limit.

Fields

sign: bool

Sign of the number.

Implementations

impl Integer

pub fn of(sign: bool, digits: &[u8]) -> Option<Self>

Construct an integer by passing the sign and each digit.

Example

use rmatrix_ks::number::instances::integer::Integer;

let digits = vec![1, 2, 3];
// Integer(123)
let Some(_) = Integer::of(true, &digits) else {
    unreachable!();
};

Warning

Each digit should be between [0, 9], which means it is a single decimal digit.

use rmatrix_ks::number::instances::integer::Integer;

let digits = vec![1, 2, 10];
assert_eq!(Integer::of(true, &digits), None);

pub fn of_str(integer_number: &str) -> Option<Self>

Construct integer numbers from string.

Examples

use rmatrix_ks::number::instances::integer::Integer;

let i1 = Integer::of_str("-123456");
let i2 = Integer::of(false, &[1, 2, 3, 4, 5, 6]);
assert_eq!(i1, i2);

pub fn digits(&self) -> Vec<u8>

Return the digit at each position.

Examples

use rmatrix_ks::number::instances::integer::Integer;

let digits = Integer::of_str("-123456").map(|e| e.digits());
assert_eq!(digits, Some(vec![1, 2, 3, 4, 5, 6]));

Trait Implementations

impl Add for Integer

Implement the addition operation for the integer number.

type Output = Integer

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Integer

fn clone(&self) -> Integer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Integer

Implement Debug for Integer.

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

Formats the value using the given formatter.

impl Default for Integer

Implement Default for the integer number.

fn default() -> Self

Returns the “default value” for a type.

impl Display for Integer

Implement Display for Integer.

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

Formats the value using the given formatter.

impl FromStr for Integer

Implement FromStr for Integer.

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Integral for Integer

Implement the concept of Integral for Integer.

fn quot_rem(self, rhs: Self) -> (Self, Self)

Calculating the quotient and remainder of two integers, where the quotient is rounded towards zero.

fn div_mod(self, rhs: Self) -> (Self, Self)

Calculating the division and modulus of two integers, where the division result is rounded towards negative infinity.

fn to_integer(self) -> Integer

Convert the integral number to an integer.

fn quotient(self, rhs: Self) -> Self

Calculating the quotient of two integers, rounding the result towards zero.

fn remainder(self, rhs: Self) -> Self

Calculating the remainder corresponding to the quotient rounded towards zero.

fn division(self, rhs: Self) -> Self

Calculating the quotient of two integers, rounding the result towards negative infinity.

fn modulus(self, rhs: Self) -> Self

Calculating the modulus of two integers.

fn is_even(&self) -> bool

Validate whether an integral number is even.

fn is_odd(&self) -> bool

Validate whether an integral number is odd.

impl Mul for Integer

Implement the multiplication operation for the integer number.

type Output = Integer

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Integer

Implement the negation operation for the integer number.

type Output = Integer

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Number for Integer

Implement the concept of NUMBER for the integer number.

fn absolute_value(&self) -> Self

Calculate the absolute value of a number.

fn sign_number(&self) -> Self

Calculate the sign of a number.

fn from_integer(integer_number: Integer) -> Self

Convert an integer to another numeric type.

impl One for Integer

fn is_one(&self) -> bool

Validate whether an integer is one.

Examples

use rmatrix_ks::number::{instances::integer::Integer, traits::one::One};

let a = Integer::one();
assert!(a.is_one());
let b = Integer::of(true, &[1, 6]);
assert!(b.is_some_and(|e| !e.is_one()));

fn one() -> Self

Return the ONE number.

impl Ord for Integer

Implement Ord for the integer number.

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 PartialEq for Integer

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

Implement PartialOrd for the integer number.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Compare two integers.

Examples

use rmatrix_ks::number::instances::integer::Integer;

// 512
let a = Integer::of(true, &[5, 1, 2]).unwrap();
// 512
let another_a = Integer::of(true, &[5, 1, 2]).unwrap();
// -128
let b = Integer::of(false, &[1, 2, 8]).unwrap();
// 1024
let c = Integer::of(true, &[1, 0, 2, 4]).unwrap();
assert_eq!(a.partial_cmp(&another_a), Some(std::cmp::Ordering::Equal));
assert_eq!(a.partial_cmp(&b), Some(std::cmp::Ordering::Greater));
assert_eq!(a.partial_cmp(&c), Some(std::cmp::Ordering::Less));

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 Real for Integer

Implement the concept of Real for Integer.

fn to_rational(self) -> Rational

Convert a real number to a rational number.

impl Sub for Integer

Implement the subtraction operation for the integer number.

type Output = Integer

The resulting type after applying the - operator.

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

Performs the - operation.

impl Zero for Integer

Implement the concept of ZERO for the integer number.

fn zero() -> Self

Retrieve zeros in integers.

Examples

use rmatrix_ks::number::{instances::integer::Integer, traits::zero::Zero};

let a = Integer::zero();
let Some(zero) = Integer::of_str("0") else {
    unreachable!();
};
assert_eq!(a, zero);

fn is_zero(&self) -> bool

Validate whether an integer is zero.

Examples

use rmatrix_ks::number::{instances::integer::Integer, traits::zero::Zero};

let a = Integer::zero();
assert!(a.is_zero());
let Some(b) = Integer::of(true, &[1, 6]) else {
    unreachable!();
};
assert!(!b.is_zero());

impl Eq for Integer

impl StructuralPartialEq for Integer