Struct Avg 

pub struct Avg<T, R> { /* private fields */ }

Representation of a partially computed average aggregate as a (sum, count) tuple.

This struct represents the result of the linear part of the average aggregate as a (sum, count) tuple (see Stream::dyn_average). The actual average value can be obtained by dividing sum by count. Avg forms a commutative monoid with point-wise plus operation (sum1, count1) + (sum2, count2) = (sum1 + sum2, count1 + count2).

Implementations

impl<T, R> Avg<T, R>

pub const fn new(sum: T, count: R) -> Self

Create a new Avg object with the given sum and count.

pub fn sum(&self) -> T

where T: Clone,

Returns the sum component of the (sum, count) tuple.

pub fn count(&self) -> R

where R: Clone,

Returns the count component of the (sum, count) tuple.

pub fn compute_avg(&self) -> Option<T>

where R: Clone + HasZero, T: From<R> + Div<Output = T> + Clone,

Returns sum / count or None if count is zero.

Trait Implementations

impl<T, R> AddAssignByRef for Avg<T, R>

where T: AddAssignByRef, R: AddAssignByRef,

fn add_assign_by_ref(&mut self, rhs: &Self)

impl<T, R> AddByRef for Avg<T, R>

where T: AddByRef, R: AddByRef,

fn add_by_ref(&self, other: &Self) -> Self

impl<T, R> Archive for Avg<T, R>

where <T as Archive>::Archived: Ord, <R as Archive>::Archived: Ord, T: Archive, R: Archive,

type Archived = ArchivedAvg<T, R>

The archived representation of this type.

type Resolver = AvgResolver<T, R>

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

unsafe fn resolve( &self, pos: usize, resolver: Self::Resolver, out: *mut Self::Archived, )

Creates the archived version of this value at the given position and writes it to the given output.

impl<T: Clone, R: Clone> Clone for Avg<T, R>

fn clone(&self) -> Avg<T, R>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, R: Debug> Debug for Avg<T, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Default, R: Default> Default for Avg<T, R>

fn default() -> Avg<T, R>

Returns the “default value” for a type.

impl<__D: Fallible + ?Sized, T, R> Deserialize<Avg<T, R>, __D> for Archived<Avg<T, R>>

where <T as Archive>::Archived: Ord, <R as Archive>::Archived: Ord, T: Archive, Archived<T>: Deserialize<T, __D>, R: Archive, Archived<R>: Deserialize<R, __D>,

fn deserialize(&self, deserializer: &mut __D) -> Result<Avg<T, R>, __D::Error>

Deserializes using the given deserializer

impl<T: Eq, R: Eq> Eq for Avg<T, R>

impl<T, R> HasZero for Avg<T, R>

where T: HasZero, R: HasZero,

fn is_zero(&self) -> bool

fn zero() -> Self

impl<T: Hash, R: Hash> Hash for Avg<T, R>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, R> IsNone for Avg<T, R>

type Inner = Avg<T, R>

fn is_none(&self) -> bool

fn unwrap_or_self(&self) -> &Self::Inner

fn from_inner(inner: Self::Inner) -> Self

fn result_to_field<E>(r: Result<Self, E>) -> Result<Self, E>

where Self: Sized,

If Self is Option<T> an Err is converted as Ok(None). For all other types the error is propagated unchanged.

impl<T, R> MulByRef<R> for Avg<T, R>

where T: MulByRef<Output = T> + From<R>, R: MulByRef<Output = R> + Clone,

type Output = Avg<T, R>

fn mul_by_ref(&self, rhs: &R) -> Avg<T, R>

impl<T, R> Neg for Avg<T, R>

where T: Neg<Output = T>, R: Neg<Output = R>,

type Output = Avg<T, R>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T, R> NegByRef for Avg<T, R>

where T: NegByRef, R: NegByRef,

fn neg_by_ref(&self) -> Self

impl<T: Ord, R: Ord> Ord for Avg<T, R>

fn cmp(&self, other: &Avg<T, R>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, R: PartialEq> PartialEq for Avg<T, R>

fn eq(&self, other: &Avg<T, R>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd, R: PartialOrd> PartialOrd for Avg<T, R>

fn partial_cmp(&self, other: &Avg<T, R>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<__S: Fallible + ?Sized, T, R> Serialize<__S> for Avg<T, R>

where <T as Archive>::Archived: Ord, <R as Archive>::Archived: Ord, T: Serialize<__S>, R: Serialize<__S>,

fn serialize(&self, serializer: &mut __S) -> Result<Self::Resolver, __S::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl<T, R> SizeOf for Avg<T, R>

where T: SizeOf, R: SizeOf,

fn size_of_children(&self, context: &mut Context)

Gets the size of all “children” owned by this value, not including the size of the value itself.

fn size_of(&self) -> TotalSize

Gets the total size of the current value

fn size_of_with_context(&self, context: &mut Context)

Adds the size of the current value to the given Context, including both the size of the value itself and all of its children

impl<T, R> StructuralPartialEq for Avg<T, R>

impl<T, R> SupportsRoaring for Avg<T, R>

fn supports_roaring32(&self) -> bool

Returns true if this key type can be represented in a 32-bit roaring bitmap.

fn roaring_u32_offset(&self, _min: &Self) -> Option<u32>

where Self: Sized,

Computes the u32 offset of self relative to min.

fn roaring_u32_offset_dyn(&self, _min: &DynData) -> Option<u32>

Like roaring_u32_offset, but accepts min as a type-erased DynData reference.

fn roaring_u32_offset_dyn_checked(&self, min: &DynData) -> u32

Like roaring_u32_offset_dyn, but panics when the offset cannot be computed.