Skip to content

Commit 211e4c8

Browse files
committed
Update doc
1 parent b4fbce6 commit 211e4c8

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

src/lib.rs

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
1-
//! This crate serves matrix manipulation for [rust-ndarray](https://github.com/bluss/rust-ndarray)
1+
//! This crate serves matrix manipulation for
2+
//! [rust-ndarray](https://github.com/bluss/rust-ndarray).
3+
//!
24
//! They are implemented as traits,
3-
//! [Matrix](matrix/trait.Matrix.html), [SquareMatrix](square/trait.SquareMatrix.html), and
5+
//! [Matrix](matrix/trait.Matrix.html), [SquareMatrix](square/trait.SquareMatrix.html),
6+
//! [TriangularMatrix](triangular/trait.TriangularMatrix.html), and
47
//! [HermiteMatrix](hermite/trait.HermiteMatrix.html)
58
//!
69
//! Matrix
710
//! -------
811
//! - [singular-value decomposition](matrix/trait.Matrix.html#tymethod.svd)
12+
//! - [LU decomposition](matrix/trait.Matrix.html#tymethod.lu)
913
//! - [QR decomposition](matrix/trait.Matrix.html#tymethod.qr)
1014
//! - [operator norm for L1 norm](matrix/trait.Matrix.html#tymethod.norm_1)
1115
//! - [operator norm for L-inf norm](matrix/trait.Matrix.html#tymethod.norm_i)
1216
//! - [Frobeiuns norm](matrix/trait.Matrix.html#tymethod.norm_f)
13-
//! - [LU factorization](matrix/trait.Matrix.html#tymethod.lu)
1417
//!
1518
//! SquareMatrix
1619
//! -------------
1720
//! - [inverse of matrix](square/trait.SquareMatrix.html#tymethod.inv)
1821
//! - [trace of matrix](square/trait.SquareMatrix.html#tymethod.trace)
1922
//! - [WIP] eigenvalue
2023
//!
24+
//! TriangularMatrix
25+
//! ------------------
26+
//! - [solve linear problem with upper triangular matrix](triangular/trait.TriangularMatrix.html#tymethod.solve_upper)
27+
//! - [solve linear problem with lower triangular matrix](triangular/trait.TriangularMatrix.html#tymethod.solve_lower)
28+
//!
2129
//! HermiteMatrix
2230
//! --------------
2331
//! - [eigenvalue analysis](hermite/trait.HermiteMatrix.html#tymethod.eigh)

0 commit comments

Comments
 (0)