Skip to content

Commit 7710322

Browse files
committed
Update documents
1 parent 047ddf7 commit 7710322

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

src/lib.rs

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
//! This crate serves matrix manipulation for
2-
//! [rust-ndarray](https://github.com/bluss/rust-ndarray).
1+
//! This crate implements matrix manipulation for
2+
//! [rust-ndarray](https://github.com/bluss/rust-ndarray) using LAPACK.
33
//!
4-
//! They are implemented as traits,
4+
//! Basic manipulations are implemented as matrix traits,
55
//! [Matrix](matrix/trait.Matrix.html), [SquareMatrix](square/trait.SquareMatrix.html),
6-
//! [SolveTriangular](triangular/trait.SolveTriangular.html), and
7-
//! [HermiteMatrix](hermite/trait.HermiteMatrix.html)
6+
//! and [HermiteMatrix](hermite/trait.HermiteMatrix.html).
87
//!
98
//! Matrix
109
//! -------
@@ -21,16 +20,16 @@
2120
//! - [trace of matrix](square/trait.SquareMatrix.html#tymethod.trace)
2221
//! - [WIP] eigenvalue
2322
//!
24-
//! SolveTriangular
25-
//! ------------------
26-
//! - [solve linear problem with upper triangular matrix](triangular/trait.SolveTriangular.html#tymethod.solve_upper)
27-
//! - [solve linear problem with lower triangular matrix](triangular/trait.SolveTriangular.html#tymethod.solve_lower)
28-
//!
2923
//! HermiteMatrix
3024
//! --------------
3125
//! - [eigenvalue analysis](hermite/trait.HermiteMatrix.html#tymethod.eigh)
3226
//! - [symmetric square root](hermite/trait.HermiteMatrix.html#tymethod.ssqrt)
3327
//! - [Cholesky factorization](hermite/trait.HermiteMatrix.html#tymethod.cholesky)
28+
//!
29+
//! Others
30+
//! -------
31+
//! - [solve triangular](triangular/trait.SolveTriangular.html)
32+
//! - [misc utilities](util/index.html)
3433
3534
extern crate blas;
3635
extern crate lapack;

src/square.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ pub trait SquareMatrix: Matrix {
1818
fn inv(self) -> Result<Self, LinalgError>;
1919
/// trace of matrix
2020
fn trace(&self) -> Result<Self::Scalar, LinalgError>;
21-
/// test matrix is square
21+
#[doc(hidden)]
2222
fn check_square(&self) -> Result<(), NotSquareError> {
2323
let (rows, cols) = self.size();
2424
if rows == cols {

0 commit comments

Comments
 (0)