Struct Integer 

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

Arbitrary-precision integer backed by num-bigint.

Example

use ocas_domain::Integer;

let a = Integer::from(42);
let b = Integer::new(100);
assert_eq!(a.to_string(), "42");
assert_eq!(b.to_string(), "100");

Implementations

impl Integer

pub fn new<T: Into<BigInt>>(value: T) -> Self

Create an integer from a machine integer.

pub fn inner(&self) -> &BigInt

Access the underlying BigInt.

pub fn to_bigint(&self) -> BigInt

Convert to a BigInt regardless of the backend.

pub fn to_i64(&self) -> Option<i64>

Try to extract the value as i64. Returns None if it doesn’t fit.

pub fn pow_u32(&self, exp: u32) -> Self

Raise to a u32 power.

impl Integer

pub fn modpow(&self, exp: &Integer, modulus: &Integer) -> Integer

Modular exponentiation: self^exp mod modulus.

pub fn mod_floor(&self, modulus: &Integer) -> Integer

Floor modulo: result r satisfies 0 ≤ r < |modulus|.

pub fn div_rem(&self, other: &Integer) -> (Integer, Integer)

Division with remainder: (quotient, remainder).

pub fn is_even(&self) -> bool

Returns true if the value is even.

pub fn is_negative(&self) -> bool

Returns true if the value is negative.

pub fn is_zero(&self) -> bool

Returns true if the value is zero.

pub fn is_one(&self) -> bool

Returns true if the value is one.

pub fn abs(&self) -> Integer

Absolute value.

pub fn sqrt(&self) -> Integer

Integer square root (floor).

Trait Implementations

impl Add for Integer

type Output = Integer

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Integer> for Integer

type Output = Integer

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Integer> for &Integer

type Output = Integer

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Integer> for &Integer

type Output = Integer

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&Integer> for Integer

Available on non-crate feature gmp only.

fn add_assign(&mut self, rhs: &Integer)

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

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

Formats the value using the given formatter.

impl Display for Integer

Available on non-crate feature gmp only.

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

Formats the value using the given formatter.

impl Div for Integer

type Output = Integer

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Integer> for Integer

type Output = Integer

The resulting type after applying the / operator.

fn div(self, rhs: &Integer) -> Integer

Performs the / operation.

impl Div<&Integer> for &Integer

type Output = Integer

The resulting type after applying the / operator.

fn div(self, rhs: &Integer) -> Integer

Performs the / operation.

impl Div<Integer> for &Integer

type Output = Integer

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<&Integer> for Integer

Available on non-crate feature gmp only.

fn div_assign(&mut self, rhs: &Integer)

Performs the /= operation.

impl Eq for Integer

impl From<BigInt> for Integer

Available on non-crate feature gmp only.

fn from(value: BigInt) -> Self

Converts to this type from the input type.

impl From<i64> for Integer

Available on non-crate feature gmp only.

fn from(value: i64) -> Self

Converts to this type from the input type.

impl Hash for Integer

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul for Integer

type Output = Integer

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Integer> for Integer

type Output = Integer

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Integer> for &Integer

type Output = Integer

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Integer> for &Integer

type Output = Integer

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&Integer> for Integer

Available on non-crate feature gmp only.

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

Performs the *= operation.

impl Neg for Integer

Available on non-crate feature gmp only.

type Output = Integer

The resulting type after applying the - operator.

fn neg(self) -> Integer

Performs the unary - operation.

impl Neg for &Integer

Available on non-crate feature gmp only.

type Output = Integer

The resulting type after applying the - operator.

fn neg(self) -> Integer

Performs the unary - operation.

impl Ord for Integer

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Integer

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

type Output = Integer

The resulting type after applying the % operator.

fn rem(self, rhs: Integer) -> Integer

Performs the % operation.

impl Rem<&Integer> for Integer

type Output = Integer

The resulting type after applying the % operator.

fn rem(self, rhs: &Integer) -> Integer

Performs the % operation.

impl Rem<&Integer> for &Integer

type Output = Integer

The resulting type after applying the % operator.

fn rem(self, rhs: &Integer) -> Integer

Performs the % operation.

impl Rem<Integer> for &Integer

type Output = Integer

The resulting type after applying the % operator.

fn rem(self, rhs: Integer) -> Integer

Performs the % operation.

impl Shr<u32> for Integer

Available on non-crate feature gmp only.

type Output = Integer

The resulting type after applying the >> operator.

fn shr(self, shift: u32) -> Integer

Performs the >> operation.

impl Shr<u32> for &Integer

Available on non-crate feature gmp only.

type Output = Integer

The resulting type after applying the >> operator.

fn shr(self, shift: u32) -> Integer

Performs the >> operation.

impl ShrAssign<u32> for Integer

Available on non-crate feature gmp only.

fn shr_assign(&mut self, shift: u32)

Performs the >>= operation.

impl StructuralPartialEq for Integer

impl Sub for Integer

type Output = Integer

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Integer> for Integer

type Output = Integer

The resulting type after applying the - operator.

fn sub(self, rhs: &Integer) -> Integer

Performs the - operation.

impl Sub<&Integer> for &Integer

type Output = Integer

The resulting type after applying the - operator.

fn sub(self, rhs: &Integer) -> Integer

Performs the - operation.

impl Sub<Integer> for &Integer

type Output = Integer

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&Integer> for Integer

Available on non-crate feature gmp only.

fn sub_assign(&mut self, rhs: &Integer)

Performs the -= operation.