Add return value description to the doc comment of inverse
This commit is contained in:
parent
492fdc3b2b
commit
d9c3edbeee
1 changed files with 5 additions and 0 deletions
|
@ -80,6 +80,11 @@ pub trait Matrix<T,V>: Dimensional<V>, ToPtr<T>, Eq, Neg<self> {
|
|||
|
||||
/**
|
||||
* Returns the inverse of the matrix
|
||||
*
|
||||
* # Return value
|
||||
*
|
||||
* - `Some(m)` if the inversion was successful, where `m` is the inverted matrix
|
||||
* - `None` if the inversion was unsuccessful (because the matrix was not invertable)
|
||||
*/
|
||||
pure fn inverse(&self) -> Option<self>;
|
||||
|
||||
|
|
Loading…
Reference in a new issue