matrix_oxide/lib.rs
1//! Matrix Oxide
2//! ===
3//!
4//! A simple, lightweight, and from scratch linear algebra library for Rust. Currently still under active development with goals at becoming more of a deep learning library.
5//!
6//! Installation
7//! ---
8//! Use cargo CLI:
9//! ```
10//! cargo install matrix-oxide
11//! ```
12//!
13//! Or manually add it into your Cargo.toml:
14//! ```
15//! [dependencies]
16//! matrix-oxide = "0.1.2"
17//! ```
18//!
19//! Usage
20//! ---
21//!
22//! For more thorough information, read the [docs](https://docs.rs/matrix-oxide/latest/matrix-oxide/index.html).
23//!
24//!
25//! Example: Multiply 2 random 2x2 matrices.
26//! ```
27//! let matrix_a = Matrix::<i32>::new_random(2, 2);
28//! let matrix_b = Matrix::<i32>::new_random(2, 2);
29//!
30//! let matrix_ab = matrix_a.multiply(&matrix_b);
31//! ```
32
33pub mod activation;
34pub mod matrix;
35pub mod numbers;
36pub mod random;
37pub mod vector;
38
39// expose `Matrix` at the crates root level
40pub use matrix::Matrix;