Struct WeightSet 

pub struct WeightSet { /* private fields */ }

A deterministic set of asset weights keyed by asset identifier.

Implementations

impl WeightSet

pub const fn new() -> WeightSet

Creates an empty weight set.

pub fn from_asset_weights( weights: impl IntoIterator<Item = AssetWeight>, ) -> Result<WeightSet, PortfolioWeightError>

Creates a weight set from asset weights.

Errors

Returns [PortfolioWeightError::DuplicateAssetId] when an asset appears more than once.

pub fn insert( &mut self, asset_weight: AssetWeight, ) -> Result<(), PortfolioWeightError>

Inserts an asset weight.

Errors

Returns [PortfolioWeightError::DuplicateAssetId] when the asset already exists.

pub fn sum(&self) -> f64

Returns the sum of all weights.

pub fn is_approximately_fully_invested( &self, tolerance: f64, ) -> Result<bool, PortfolioWeightError>

Checks whether weights sum approximately to 1.0 within tolerance.

Errors

Returns [PortfolioWeightError::NonFiniteTolerance] or [PortfolioWeightError::NegativeTolerance] when tolerance is invalid.

pub fn iter(&self) -> Iter<'_, String, PortfolioWeight>

Iterates over weights in deterministic asset-id order.

Trait Implementations

impl Clone for WeightSet

fn clone(&self) -> WeightSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WeightSet

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

Formats the value using the given formatter.

impl Default for WeightSet

fn default() -> WeightSet

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a WeightSet

type Item = (&'a String, &'a PortfolioWeight)

The type of the elements being iterated over.

type IntoIter = Iter<'a, String, PortfolioWeight>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a WeightSet as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for WeightSet

fn eq(&self, other: &WeightSet) -> 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 StructuralPartialEq for WeightSet