docs: write more documentation
This commit is contained in:
parent
baf4264ea1
commit
8483c145d9
3 changed files with 81 additions and 17 deletions
20
src/lib.rs
20
src/lib.rs
|
|
@ -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)]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue