hodasemi/cgmath
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add return value description to the doc comment of inverse

Browse source
This commit is contained in:
Brendan Zabarauskas 2012-12-04 11:56:10 +10:00
parent 492fdc3b2b
commit d9c3edbeee
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/mat.rs
View file

@ -80,6 +80,11 @@ pub trait Matrix<T,V>: Dimensional<V>, ToPtr<T>, Eq, Neg<self> {
/** /**
* Returns the inverse of the matrix * 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>; pure fn inverse(&self) -> Option<self>;