M-Labs/nalgebra
3
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update inverse.rs - improved code doc try_inverse_mut

Browse Source 
The "and leaves `self` untouched" part of the code doc was wrong. Self may be modified before early false return.
This commit is contained in:
Pavel Kučera 2024-05-23 09:50:21 +02:00 committed by GitHub
parent afc03cc403
commit 201ec1dd7f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/linalg/inverse.rs
View File

@ -29,8 +29,8 @@ impl<T: ComplexField, D: Dim, S: Storage<T, D, D>> SquareMatrix<T, D, S> {
}
impl<T: ComplexField, D: Dim, S: StorageMut<T, D, D>> SquareMatrix<T, D, S> {
/// Attempts to invert this square matrix in-place. Returns `false` and leaves `self` untouched if
/// inversion fails.
/// Attempts to invert this square matrix in-place. Returns `false` if the
/// inversion fails. Note that `self` may be modified even if the inversion fails.
///
/// # Panics
///