Struct reckoner::Integer

source · [−]

#[repr(transparent)]
pub struct Integer { /* private fields */ }

Expand description

Multiple precision integer value.

Implementations

source

source

pub fn new() -> Self

Construct a new integer with a default value of zero.

pub unsafe fn from_raw(raw: *mut mpz_t) -> Self

Construct an Integer from a raw non-null pointer to creachadair_imath_sys::mpz_t.

This function must only every be called once for a given pointer, and the pointer must point to an initialized creachadair_imath_sys::mpz_t struct. The recommendation is to only use raw pointers from the Integer::into_raw function.

In ths context, initialized means that the creachadair_imath_sys::mpz_t has been the argument of a call to creachadair_imath_sys::mp_int_init.

Example

use creachadair_imath_sys::{mp_int_zero, MP_OK};
use reckoner::Integer;

let a = Integer::from(300);

assert_eq!(a, 300);

let a_raw = Integer::into_raw(a);

unsafe { mp_int_zero(a_raw) };

let a = unsafe { Integer::from_raw(a_raw) };

assert_eq!(a, 0);

source

pub fn into_raw(integer: Integer) -> *mut mpz_t

Consumes the Integer, returning a wrapped raw pointer.

Example

use creachadair_imath_sys::{mp_int_add, MP_OK};
use reckoner::Integer;

let a = Integer::from(200);
let b = Integer::from(300);
let c = Integer::new();

let a_raw = Integer::into_raw(a);
let b_raw = Integer::into_raw(b);
let c_raw = Integer::into_raw(c);

let op_res = unsafe { mp_int_add(a_raw, b_raw, c_raw) };

if op_res != unsafe { MP_OK } {
    panic!("Operation failed.")
}

let a = unsafe { Integer::from_raw(a_raw) };
let b = unsafe { Integer::from_raw(b_raw) };
let c = unsafe { Integer::from_raw(c_raw) };

assert_eq!(a, 200);
assert_eq!(b, 300);
assert_eq!(c, 500);

source

pub fn from_string(s: impl AsRef<str>, radix: u8) -> Result<Self, Error>

Parse an Integer from the given string, with the specified radix.

Example

use reckoner::Integer;

let a = Integer::from_string("8", 10);
let b = Integer::from_string("1000", 2);

assert_eq!(a, b);

source

pub fn copy_to(&self, other: &mut Self)

Replaces the value of other with a copy of the value of self. No new memory is allocated unless self has more significant digits than other has allocated.

Example

use reckoner::Integer;

let a = Integer::from(20);
let mut b = Integer::new();

assert_eq!(a, 20);
assert_eq!(b, 0);

a.copy_to(&mut b);

assert_eq!(a, 20);
assert_eq!(b, 20, "Failed to copy");

source

pub fn zero(&mut self)

Set value of integer to zero

Example

use reckoner::Integer;

let mut a = Integer::from(21837419283648u128);

assert_eq!(a, 21837419283648u128);
a.zero();
assert_eq!(a, 0);

source

pub fn compare(&self, rhs: &Self) -> Ordering

Compare two integers

Example

use reckoner::Integer;
use core::cmp::Ordering;

let a = Integer::from(123);
let b = Integer::from(456);

assert_eq!(a.compare(&b), Ordering::Less);
assert_eq!(b.compare(&a), Ordering::Greater);
assert_eq!(b.compare(&b), Ordering::Equal);

source

pub fn compare_magnitude(&self, rhs: &Self) -> Ordering

Compare the magnitude of two integers, not taking sign into account.

Example

use core::cmp::Ordering;
use reckoner::Integer;

let a = Integer::from(-234);
let b = Integer::from(123);

assert_eq!(a.compare_magnitude(&b), Ordering::Greater);
assert_eq!(a.compare(&b), Ordering::Less);

source

pub fn compare_zero(&self) -> Ordering

Compare an integer to zero.

Example

use core::cmp::Ordering;
use reckoner::Integer;

let a = Integer::from(-234);
let b = Integer::from(123);

assert_eq!(a.compare_zero(), Ordering::Less);
assert_eq!(b.compare_zero(), Ordering::Greater);

impl Debug for Integer

source

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

Formats the value using the given formatter. Read more

source

impl Default for Integer

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

The resulting type after applying the / operator.

The resulting type after applying the * operator.

source

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

Performs the * operation. Read more

source

impl Mul<u8> for Integer

type Output = Integer

The resulting type after applying the * operator.

type Output = Integer

The resulting type after applying the - operator.

source

fn neg(self) -> Self::Output

Performs the unary - operation. Read more

source

impl Neg for Integer

type Output = Integer

The resulting type after applying the - operator.

source

fn neg(self) -> Self::Output

Performs the unary - operation. Read more

source

impl Ord for Integer

source

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

const fn max(self, other: Self) -> Selfwhere
Self: Sized,

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

The resulting type after applying the - operator.

The type returned in the event of a conversion error.

source

fn try_from(src: Rational) -> Result<Self, Self::Error>

Performs the conversion.

source

impl Eq for Integer

source

impl Send for Integer

Auto Trait Implementations

impl RefUnwindSafe for Integer

impl !Sync for Integer

impl Unpin for Integer

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for Twhere
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.