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//! ```sh
10//! cargo install matrix-oxide
11//! ```
12//!
13//! Or manually add it into your Cargo.toml:
14//! ```toml
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/).
23//!
24//!
25//! Example: Multiply 2 random 2x2 matrices.
26//! ```
27//! use matrix_oxide::Matrix;
28//!
29//! let matrix_a = Matrix::<i32>::new_random(2, 2);
30//! let matrix_b = Matrix::<i32>::new_random(2, 2);
31//!
32//! let matrix_ab = matrix_a.multiply(&matrix_b);
33//! ```
34
35pub mod activation;
36pub mod matrix;
37pub mod numbers;
38pub mod random;
39pub mod vector;
40
41// expose `Matrix` at the crates root level
42pub use matrix::Matrix;
matrix_oxide/lib.rs

matrix_oxide/
lib.rs
