Struct average::WeightedMean [−][src]
pub struct WeightedMean { /* fields omitted */ }
Expand description
Estimate the weighted and unweighted arithmetic mean of a sequence of numbers (“population”).
Example
use average::WeightedMean; let a: WeightedMean = (1..6).zip(1..6) .map(|(x, w)| (f64::from(x), f64::from(w))).collect(); println!("The weighted mean is {}.", a.mean());
Implementations
impl WeightedMean
[src]
impl WeightedMean
[src]pub fn new() -> WeightedMean
[src]
pub fn new() -> WeightedMean
[src]Create a new weighted and unweighted mean estimator.
pub fn is_empty(&self) -> bool
[src]
pub fn is_empty(&self) -> bool
[src]Determine whether the sample is empty.
Might be a false positive if the sum of weights is zero.
pub fn sum_weights(&self) -> f64
[src]
pub fn sum_weights(&self) -> f64
[src]Return the sum of the weights.
Returns 0 for an empty sample.
Trait Implementations
impl Clone for WeightedMean
[src]
impl Clone for WeightedMean
[src]fn clone(&self) -> WeightedMean
[src]
fn clone(&self) -> WeightedMean
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for WeightedMean
[src]
impl Debug for WeightedMean
[src]impl Default for WeightedMean
[src]
impl Default for WeightedMean
[src]fn default() -> WeightedMean
[src]
fn default() -> WeightedMean
[src]Returns the “default value” for a type. Read more
impl<'de> Deserialize<'de> for WeightedMean
[src]
impl<'de> Deserialize<'de> for WeightedMean
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl<'a> FromIterator<&'a (f64, f64)> for WeightedMean
[src]
impl<'a> FromIterator<&'a (f64, f64)> for WeightedMean
[src]fn from_iter<T>(iter: T) -> WeightedMean where
T: IntoIterator<Item = &'a (f64, f64)>,
[src]
fn from_iter<T>(iter: T) -> WeightedMean where
T: IntoIterator<Item = &'a (f64, f64)>,
[src]Creates a value from an iterator. Read more
impl FromIterator<(f64, f64)> for WeightedMean
[src]
impl FromIterator<(f64, f64)> for WeightedMean
[src]fn from_iter<T>(iter: T) -> WeightedMean where
T: IntoIterator<Item = (f64, f64)>,
[src]
fn from_iter<T>(iter: T) -> WeightedMean where
T: IntoIterator<Item = (f64, f64)>,
[src]Creates a value from an iterator. Read more
impl Merge for WeightedMean
[src]
impl Merge for WeightedMean
[src]fn merge(&mut self, other: &WeightedMean)
[src]
fn merge(&mut self, other: &WeightedMean)
[src]Merge another sample into this one.
Example
use average::{WeightedMean, Merge}; let weighted_sequence: &[(f64, f64)] = &[ (1., 0.1), (2., 0.2), (3., 0.3), (4., 0.4), (5., 0.5), (6., 0.6), (7., 0.7), (8., 0.8), (9., 0.9)]; let (left, right) = weighted_sequence.split_at(3); let avg_total: WeightedMean = weighted_sequence.iter().collect(); let mut avg_left: WeightedMean = left.iter().collect(); let avg_right: WeightedMean = right.iter().collect(); avg_left.merge(&avg_right); assert!((avg_total.mean() - avg_left.mean()).abs() < 1e-15);
impl Serialize for WeightedMean
[src]
impl Serialize for WeightedMean
[src]Auto Trait Implementations
impl RefUnwindSafe for WeightedMean
impl Send for WeightedMean
impl Sync for WeightedMean
impl Unpin for WeightedMean
impl UnwindSafe for WeightedMean
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<S, T> CastFloat<T> for S where
T: ConvFloat<S>,
[src]
impl<S, T> CastFloat<T> for S where
T: ConvFloat<S>,
[src]pub fn cast_trunc(self) -> T
[src]
pub fn cast_trunc(self) -> T
[src]Cast to integer, truncating Read more
pub fn cast_nearest(self) -> T
[src]
pub fn cast_nearest(self) -> T
[src]Cast to the nearest integer Read more
pub fn cast_floor(self) -> T
[src]
pub fn cast_floor(self) -> T
[src]Cast the floor to an integer Read more
pub fn try_cast_trunc(self) -> Result<T, Error>
[src]
pub fn try_cast_trunc(self) -> Result<T, Error>
[src]Try converting to integer with truncation Read more
pub fn try_cast_nearest(self) -> Result<T, Error>
[src]
pub fn try_cast_nearest(self) -> Result<T, Error>
[src]Try converting to the nearest integer Read more
pub fn try_cast_floor(self) -> Result<T, Error>
[src]
pub fn try_cast_floor(self) -> Result<T, Error>
[src]Try converting the floor to an integer Read more
pub fn try_cast_ceil(self) -> Result<T, Error>
[src]
pub fn try_cast_ceil(self) -> Result<T, Error>
[src]Try convert the ceiling to an integer Read more
impl<T> Pointable for T
impl<T> Pointable for T
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,