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

Fix doc-tests for variance.

This commit is contained in:
sebcrozet 2019-02-03 11:06:06 +01:00
parent 381fdb642c
commit bafd74da70
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/base/statistics.rs
View File

@ -76,6 +76,9 @@ impl<N: Real, R: Dim, C: Dim, S: Storage<N, R, C>> Matrix<N, R, C, S> {
} }
/// The sum of all the rows of this matrix. /// The sum of all the rows of this matrix.
///
/// Use `.row_variance_tr` if you need the result in a column vector instead.
///
/// # Example /// # Example
/// ///
/// ``` /// ```
@ -138,11 +141,12 @@ impl<N: Real, R: Dim, C: Dim, S: Storage<N, R, C>> Matrix<N, R, C, S> {
/// # Example /// # Example
/// ///
/// ``` /// ```
/// # #[macro_use] extern crate approx;
/// # use nalgebra::Matrix2x3; /// # use nalgebra::Matrix2x3;
/// ///
/// let m = Matrix2x3::new(1.0, 2.0, 3.0, /// let m = Matrix2x3::new(1.0, 2.0, 3.0,
/// 4.0, 5.0, 6.0); /// 4.0, 5.0, 6.0);
/// assert_eq!(m.variance(), 3.5); /// assert_relative_eq!(m.variance(), 35.0 / 12.0, epsilon = 1.0e-8);
/// ``` /// ```
#[inline] #[inline]
pub fn variance(&self) -> N { pub fn variance(&self) -> N {
@ -156,6 +160,8 @@ impl<N: Real, R: Dim, C: Dim, S: Storage<N, R, C>> Matrix<N, R, C, S> {
} }
/// The variance of all the rows of this matrix. /// The variance of all the rows of this matrix.
///
/// Use `.row_variance_tr` if you need the result in a column vector instead.
/// # Example /// # Example
/// ///
/// ``` /// ```
@ -163,7 +169,7 @@ impl<N: Real, R: Dim, C: Dim, S: Storage<N, R, C>> Matrix<N, R, C, S> {
/// ///
/// let m = Matrix2x3::new(1.0, 2.0, 3.0, /// let m = Matrix2x3::new(1.0, 2.0, 3.0,
/// 4.0, 5.0, 6.0); /// 4.0, 5.0, 6.0);
/// assert_eq!(m.row_variance(), RowVector3::new(4.5, 4.5, 4.5)); /// assert_eq!(m.row_variance(), RowVector3::new(2.25, 2.25, 2.25));
/// ``` /// ```
#[inline] #[inline]
pub fn row_variance(&self) -> RowVectorN<N, C> pub fn row_variance(&self) -> RowVectorN<N, C>
@ -180,7 +186,7 @@ impl<N: Real, R: Dim, C: Dim, S: Storage<N, R, C>> Matrix<N, R, C, S> {
/// ///
/// let m = Matrix2x3::new(1.0, 2.0, 3.0, /// let m = Matrix2x3::new(1.0, 2.0, 3.0,
/// 4.0, 5.0, 6.0); /// 4.0, 5.0, 6.0);
/// assert_eq!(m.row_variance_tr(), Vector3::new(4.5, 4.5, 4.5)); /// assert_eq!(m.row_variance_tr(), Vector3::new(2.25, 2.25, 2.25));
/// ``` /// ```
#[inline] #[inline]
pub fn row_variance_tr(&self) -> VectorN<N, C> pub fn row_variance_tr(&self) -> VectorN<N, C>
@ -246,6 +252,8 @@ impl<N: Real, R: Dim, C: Dim, S: Storage<N, R, C>> Matrix<N, R, C, S> {
/// The mean of all the rows of this matrix. /// The mean of all the rows of this matrix.
/// ///
/// Use `.row_mean_tr` if you need the result in a column vector instead.
///
/// # Example /// # Example
/// ///
/// ``` /// ```