docs: write more documentation

This commit is contained in:
Zhongheng Liu 2025-01-23 00:22:12 +02:00
commit 8483c145d9
Signed by: steven
GPG key ID: 805A28B071DAD84B
3 changed files with 81 additions and 17 deletions

View file

@ -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)]