Fix doc typos

This commit is contained in:
metric-space 2021-12-26 21:05:42 -05:00
parent ac94fbe831
commit dbaefed8d1
2 changed files with 2 additions and 2 deletions

View File

@ -188,7 +188,7 @@ impl<T: ComplexField, R: Dim, C: Dim, S: Storage<T, R, C>> Matrix<T, R, C, S> {
SVD::try_new_unordered(self.into_owned(), compute_u, compute_v, eps, max_niter)
}
/// Attempts to compute the Polar Decomposition of a `matrix
/// Attempts to compute the Polar Decomposition of a `matrix` (indirectly uses SVD)
///
/// # Arguments
///

View File

@ -643,7 +643,7 @@ where
}
/// converts SVD results to Polar decomposition form of the original Matrix
/// A = P'U
/// A = P' * U
/// The polar decomposition used here is Left Polar Decomposition (or Reverse Polar Decomposition)
/// Returns None if the SVD hasn't been calculated
pub fn to_polar(&self) -> Option<(OMatrix<T, R, R>, OMatrix<T, R, C>)>