diff options
Diffstat (limited to 'src/lib.rs')
-rw-r--r-- | src/lib.rs | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -1,3 +1,23 @@ +//! Abstraction and APIs for matrix operations +//! +//! Includes handy utilities such as: +//! - Transpose of matrix +//! - Determinant of any N-by-N matrix +//! - Matrix mathematics +//! - TODO:: Inverse matrix +//! - TODO:: Transformation of vectors using matrices +//! +//! Examples: +//! ``` +//! ... +//! use matrix::Matrix; +//! let m = Matrix::from_str("1,2,3\n4,5,6\n7,8,9"); +//! println!("Matrix string formatting:\n{}", m); +//! println!("Evaluate determinant of matrix: {}", m.determinant()); +//! println!("Transpose of matrix m:\n{}", m.transpose()); +//! ... +//! ``` + pub mod types; #[cfg(test)] |