Struct Group

pub struct Group<T: Eq + Hash>(/* private fields */);

A sparse collection of weighted elements where zero-valued entries are excluded. Used for efficiently representing portfolios, groups, and other weighted collections.

Implementations

impl<T: Eq + Hash> Group<T>

pub fn into_iter(self) -> impl Iterator<Item = (T, f64)>

A consuming iterator for the key-value pairs Returns only non-zero weighted pairs.

pub fn iter(&self) -> impl Iterator<Item = (&T, &f64)>

A by-reference iterator for the key-value pairs Returns only non-zero weighted pairs.

pub fn keys(&self) -> impl Iterator<Item = &T>

Iterate over the keys with non-zero values

pub fn retain<F: Fn(&T, &f64) -> bool>(&mut self, f: F)

Remove keys based on some criteria This allows filtering the sparse vector with a custom function.

pub fn len(&self) -> usize

The number of key-value pairs. (After a call to .simplify(), equivalent to an L0 norm)

pub fn get<Q: ?Sized + Hash + Equivalent<T>>(&self, key: &Q) -> Option<f64>

Get the value associated to the key, or None if zero or missing

pub fn validate(&self) -> bool

Is this an economically valid portfolio? Checks that all weights are finite values.

Trait Implementations

impl<T: Debug + Eq + Hash> Debug for Group<T>

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

Formats the value using the given formatter.

impl<T: Eq + Hash> Default for Group<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Eq + Hash + Ord> FromIterator<(T, f64)> for Group<T>

fn from_iter<U: IntoIterator<Item = (T, f64)>>(iter: U) -> Self

Creates a value from an iterator.