minmath 2.1.1

A lightweight math library
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

# minmath
[![GitHub stars](https://img.shields.io/github/stars/Jodus-Melodus/minmath)](https://github.com/Jodus-Melodus/minmath/stargazers)
[![GitHub license](https://img.shields.io/github/license/Jodus-Melodus/minmath)](https://github.com/Jodus-Melodus/minmath/blob/main/LICENSE.md)
[![Rust Tests](https://github.com/JodusMelodus/minmath/actions/workflows/tests.yml/badge.svg)](https://github.com/JodusMelodus/minmath/actions/workflows/tests.yml)

[![Crates.io](https://img.shields.io/crates/v/minmath.svg)](https://crates.io/crates/minmath)
[![Crates.io downloads](https://img.shields.io/crates/d/minmath.svg)](https://crates.io/crates/minmath)
[![Docs.rs](https://docs.rs/minmath/badge.svg)](https://docs.rs/minmath)

[![Rust Version](https://img.shields.io/badge/rust-1.70%2B-blue)](https://www.rust-lang.org/)

## Quick start example

### Matrix

```rust
fn main() {
    let mat1 = Matrix::new([[1.0, 2.0], [3.0, 4.0]]);
    let mat2 = Matrix::new([[5.0, 6.0], [7.0, 8.0]]);
    let mat3 = mat1 + mat2;
    println!("{}", mat3);
}
```

### Vector2/Vector3

```rust
fn main() {
    let vec2 = Vector2::new(4.0, 3.5);
    let vec3 = Vector3::new(5.5, 9.0, -8.0);
}
```

## Contributing

Contributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/Jodus-Melodus/minmath/issues).

## Adding `minmath` to dependencies

`minmath` currently has zero dependencies and I plan to keep it that way.
There are two ways to add the crate to your dependencies.

### Manual

Add the following to your `Cargo.toml` file.

```toml
[dependencies]
minmath = "*"
# Check https://crates.io/crates/minmath for the latest version
```

### Command Line

Run the following in your terminal.

```bash
cargo add minmath
```

## Structures and Features

- [Matrix](https://github.com/Jodus-Melodus/minmath/blob/master/docs/README_MATRIX.md)
- [Vector](https://github.com/Jodus-Melodus/minmath/blob/master/docs/README_VECTOR.md)

## License

This project is licensed under the MIT License. See [LICENSE](LICENSE.md) for details.

## Links

- [Crates.io](https://crates.io/crates/minmath)
- [Documentation (docs.rs)](https://docs.rs/minmath)
- [GitHub Repository](https://github.com/Jodus-Melodus/minmath)