edition: Rust-2018
Modular arithmetic is a system of arithmetic for integers, where numbers "wrap around" upon reaching a certain value - which is known as the modulus. A common example would be values on a clock, which wrap around the modulus 12 (for a 12-hour clock)
For further information on modular arithmetic, see the wikipedia article on the same.
This crate allows for the creation and usage of such numbers.
To use this crate, import it from crates.io or github.com and use it as shown below.
toml
[dependencies]
modulo = "~1"
```rust // Create a new modulo number from an integer, given a modulus let modnum = 76.tomodulo(7); let modnum2 = 45.tomodulo(16);
// This is equivalent to using the modulo! macro let modmac = modulo!(76, 7); let modmac2 = modulo!(78, 16);
// Check equality assert!(modnum == modmac); assert!(modnum2 != modmac2);
// Addition asserteq!(modnum + mod_mac, modulo!(5, 7));
// Subtraction asserteq!(modmac2 - mod_num2, modulo!(0, 16));
// Multipication asserteq!(modnum * mod_mac, modulo!(1, 7));
// Congruence assert!(76.is_congruent(41, 7)); ```
Further examples are given in the examples folder.
For development, you can fork this repo, or clone it directly from github/gitlab. The repo comes with examples of usage in the /examples directory.
bash
$> cd <work_dir>
$> git clone git@gitlab.com:rust-algorithms/modular.git
$> cd modulo
$> cargo build && cargo test
$> cargo run --example fib
MIT