mathio 0.2.4

A lightweight, simple and straight-forward opinionated library for math used in other projects
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

# Mathio 🚀️ 

[![License](https://img.shields.io/badge/License-MIT%20or%20Apache%202-blue.svg?label=license)](./LICENSE-MIT)
[![crates.io](https://img.shields.io/crates/v/mathio.svg)](https://crates.io/crates/mathio)
[![Released API docs](https://docs.rs/mathio/badge.svg)](https://docs.rs/mathio)

A ***lightweight***, ***simple*** and ***straight-forward*** opinionated library for **math** used in other projects.

Current features are:

* Fractions
* Tweening
* Periods


### === Examples ===

**Fractions**

Great for expressing lossless floats
``` rust
use mathio::Fraction;

let frac_1 = Fraction::new(2, 3);
let frac_2 = Fraction::new(3, 6);
 
assert_eq!(frac_1 + frac_2, Fraction::new(7, 6));
assert_eq!(frac_1 - frac_2, Fraction::new(1, 6));
assert_eq!(frac_1 * frac_2, Fraction::new(1, 3));
assert_eq!(frac_1 / frac_2, Fraction::new(4, 3));
assert_eq!(frac_1 >= frac_2, true);
```

**Periods**

Good for clamping repeating values (angles, sin/cosine, etc.)
``` rust
let period = 360.0;
assert_eq!(315.0, periodical(period, -45.0));
assert_eq!(45.0, periodical(period, 45.0));
assert_eq!(0.0, periodical(period, 360.0));
assert_eq!(90.0, periodical(period, 450.0));
```

### === Licensing ===
Released under both [APACHE](./LICENSE-APACHE) and [MIT](./LICENSE-MIT) licenses. Pick one that suits you the most!