opis 0.8.0

Opis is an arithmetic library for rational numbers written in Rust.
Documentation

Opis Rust

Opis is an arithmetic library for rational numbers written in Rust.

Usage

In Cargo.toml


[dependencies]
opis = "0.8.0"

In your rust file


use opis::Int;

Features

  • Representation of integers of any length.
  • Integer bits are stored in big endian order.
  • There are three groups of functions: conversion, arithmetic & comparison
  • Conversion functions support radix 2, 10 & 16.
  • Arithmetic functions are addition, subtration, multiplication, division, remainder, modulo, exponentiation & modular inverse.
  • Comparision function checks between integers a and b if a is greater, lesser or equal to b.

API

Conversion Functions

From Str


let integer: Int = Int::from_str("6747", 10)?;

To Str


let binary_str: String = integer.to_str(2);

Arithmetic Functions

Addition(add)


let s = int_a.add(&int2_b);

Subtraction(sub)


let d = int_a.sub(&int_b).unwrap();

Multiplication(mul)


let p = int_a.mul(&int_b);

Division(div)


let q = int_a.div(&int_b).unwrap();

Remainder(rem)


let r = int_a.rem(&int_b).unwrap();

Modulo(modulo)


let m = int_a.modulo(&int_b).unwrap();

Exponentiation(pow)


let p = int_a.pow(&int_e);

Modular Inverse(mod_inv)


let mi = int_a.mod_inv(&int_m);

Comparison Function


match &int1.cmp(&int2)[..] {
    "greater" => Println!("a is greater than b!"),
    "less" => Println!("a is less than b!"),
    "equal" => Println!("a is equal to b!"),
    _ => Println!("no match!"),
}

Performance

Future

  • Full Base2, Base10 & Base16 conversion support

Contribution

Pull requests, bug reports and any kind of suggestion are welcome.

2021-11-2