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

Slightly change comment wording.

This commit is contained in:
Sébastien Crozet 2023-01-14 12:02:37 +01:00
parent 3d31f32251
commit 5ed215932c
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/linalg/inverse.rs
View File

@ -8,11 +8,11 @@ use crate::base::{DefaultAllocator, OMatrix, SquareMatrix};
use crate::linalg::lu; use crate::linalg::lu;
impl<T: ComplexField, D: Dim, S: Storage<T, D, D>> SquareMatrix<T, D, S> { impl<T: ComplexField, D: Dim, S: Storage<T, D, D>> SquareMatrix<T, D, S> {
/// Attempts to invert this matrix. /// Attempts to invert this square matrix.
/// ///
/// # Panics /// # Panics
/// ///
/// It's unable to invert a non-square matrix so it panics in such case. /// Panics if `self` isn’t a square matrix.
#[inline] #[inline]
#[must_use = "Did you mean to use try_inverse_mut()?"] #[must_use = "Did you mean to use try_inverse_mut()?"]
pub fn try_inverse(self) -> Option<OMatrix<T, D, D>> pub fn try_inverse(self) -> Option<OMatrix<T, D, D>>
@ -29,12 +29,12 @@ 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> { impl<T: ComplexField, D: Dim, S: StorageMut<T, D, D>> SquareMatrix<T, D, S> {
/// Attempts to invert this matrix in-place. Returns `false` and leaves `self` untouched if /// Attempts to invert this square matrix in-place. Returns `false` and leaves `self` untouched if
/// inversion fails. /// inversion fails.
/// ///
/// # Panics /// # Panics
/// ///
/// It's unable to invert a non-square matrix so it panics in such case. /// Panics if `self` isn’t a square matrix.
#[inline] #[inline]
pub fn try_inverse_mut(&mut self) -> bool pub fn try_inverse_mut(&mut self) -> bool
where where