diff --git a/src/linalg/mod.rs b/src/linalg/mod.rs index 42ed558..fe3e197 100644 --- a/src/linalg/mod.rs +++ b/src/linalg/mod.rs @@ -166,7 +166,7 @@ pub trait BaseVector: Clone + Debug { /// ``` fn unique(&self) -> Vec; - /// Compute the arithmetic mean. + /// Computes the arithmetic mean. fn mean(&self) -> T { let n = self.len(); let mut mean = T::zero(); @@ -176,7 +176,7 @@ pub trait BaseVector: Clone + Debug { } mean / T::from_usize(n).unwrap() } - /// Compute the standard deviation. + /// Computes the standard deviation. fn std(&self) -> T { let n = self.len(); diff --git a/src/linalg/stats.rs b/src/linalg/stats.rs index f5db1e9..ecb7ceb 100644 --- a/src/linalg/stats.rs +++ b/src/linalg/stats.rs @@ -1,13 +1,14 @@ //! # Various Statistical Methods //! -//! +//! This module provides reference implementations for various statistical functions. +//! Concrete implementations of the `BaseMatrix` trait are free to override these methods for better performance. use crate::linalg::BaseMatrix; use crate::math::num::RealNumber; /// Defines baseline implementations for various statistical functions pub trait MatrixStats: BaseMatrix { - /// Compute the arithmetic mean along the specified axis. + /// Computes the arithmetic mean along the specified axis. fn mean(&self, axis: u8) -> Vec { let (n, m) = match axis { 0 => { @@ -34,7 +35,7 @@ pub trait MatrixStats: BaseMatrix { x } - /// Compute the standard deviation along the specified axis. + /// Computes the standard deviation along the specified axis. fn std(&self, axis: u8) -> Vec { let (n, m) = match axis { 0 => {