Skip to content

Commit 776ed20

Browse files
committed
Add doc for SVD
1 parent 4ccd223 commit 776ed20

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/svd.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
//! singular-value decomposition
2+
//!
3+
//! https://en.wikipedia.org/wiki/Singular_value_decomposition
24
35
use ndarray::*;
46

@@ -7,20 +9,23 @@ use super::error::*;
79
use super::layout::*;
810
use super::types::*;
911

12+
/// singular-value decomposition of matrix reference
1013
pub trait SVD {
1114
type U;
1215
type VT;
1316
type Sigma;
1417
fn svd(&self, calc_u: bool, calc_vt: bool) -> Result<(Option<Self::U>, Self::Sigma, Option<Self::VT>)>;
1518
}
1619

20+
/// singular-value decomposition
1721
pub trait SVDInto {
1822
type U;
1923
type VT;
2024
type Sigma;
2125
fn svd_into(self, calc_u: bool, calc_vt: bool) -> Result<(Option<Self::U>, Self::Sigma, Option<Self::VT>)>;
2226
}
2327

28+
/// singular-value decomposition for mutable reference of matrix
2429
pub trait SVDMut {
2530
type U;
2631
type VT;

0 commit comments

Comments
 (0)