Skip to content

Commit 5dce6b6

Browse files
committed
Add document
1 parent 94725b2 commit 5dce6b6

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/krylov/householder.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,17 @@ use num_traits::Zero;
55
/// Iterative orthogonalizer using Householder reflection
66
#[derive(Debug, Clone)]
77
pub struct Householder<A: Scalar> {
8+
/// Dimension of orthogonalizer
89
dim: usize,
10+
11+
/// Store Householder reflector.
12+
///
13+
/// The coefficient is copied into another array, and this does not contain
914
v: Vec<Array1<A>>,
1015
}
1116

1217
impl<A: Scalar> Householder<A> {
18+
/// Create a new orthogonalizer
1319
pub fn new(dim: usize) -> Self {
1420
Householder { dim, v: Vec::new() }
1521
}

0 commit comments

Comments
 (0)