Trait tea_agg::AggValidExt

source · 
pub trait AggValidExt<T: IsNone>: IntoIterator<Item = T> + Sized {
    // Provided methods
    fn n_vsum_filter<U, I>(self, mask: I) -> (usize, T::Inner)
       where I: IntoIterator<Item = U>,
             U: IsNone,
             U::Inner: Cast<bool>,
             T::Inner: Number { ... }
    fn n_sum_filter<U, I>(self, mask: I) -> Option<T::Inner>
       where I: IntoIterator<Item = U>,
             U: IsNone,
             U::Inner: Cast<bool>,
             T::Inner: Number { ... }
    fn vmean_filter<U, I>(self, mask: I, min_periods: usize) -> f64
       where I: IntoIterator<Item = U>,
             U: IsNone,
             U::Inner: Cast<bool>,
             T::Inner: Number { ... }
    fn vkurt(self, min_periods: usize) -> f64
       where T::Inner: Number { ... }
}
Expand description

Extension trait providing additional aggregation methods for iterables with potentially invalid (None) values.

Provided Methods§

source

fn n_vsum_filter<U, I>(self, mask: I) -> (usize, T::Inner)
where I: IntoIterator<Item = U>, U: IsNone, U::Inner: Cast<bool>, T::Inner: Number,

Computes the sum of valid values filtered by a mask, along with the count of valid elements.

§Arguments
  • mask - An iterable of boolean-like values used to filter the input.
§Returns

A tuple containing the count of valid elements and their sum.

source

fn n_sum_filter<U, I>(self, mask: I) -> Option<T::Inner>
where I: IntoIterator<Item = U>, U: IsNone, U::Inner: Cast<bool>, T::Inner: Number,

Computes the sum of valid values filtered by a mask.

§Arguments
  • mask - An iterable of boolean-like values used to filter the input.
§Returns

The sum of valid elements, or None if no valid elements are found.

source

fn vmean_filter<U, I>(self, mask: I, min_periods: usize) -> f64
where I: IntoIterator<Item = U>, U: IsNone, U::Inner: Cast<bool>, T::Inner: Number,

Computes the mean of valid values filtered by a mask.

§Arguments
  • mask - An iterable of boolean-like values used to filter the input.
  • min_periods - The minimum number of valid elements required to compute the mean.
§Returns

The mean of valid elements, or NaN if the number of valid elements is less than min_periods.

source

fn vkurt(self, min_periods: usize) -> f64
where T::Inner: Number,

Computes the kurtosis of the data.

§Arguments
  • min_periods - The minimum number of valid elements required to compute the kurtosis.
§Returns

The kurtosis of the data, or NaN if the number of valid elements is less than min_periods.

Object Safety§

This trait is not object safe.

Implementors§

source§

impl<I: IntoIterator<Item = T>, T: IsNone> AggValidExt<T> for I