Struct CommodityPrices

pub struct CommodityPrices(BTreeMap<(CommodityID, RegionID, TimeSliceID), MoneyPerFlow>);

A map relating commodity ID + region + time slice to current price (endogenous)

Tuple Fields

0: BTreeMap<(CommodityID, RegionID, TimeSliceID), MoneyPerFlow>

Implementations

impl CommodityPrices

fn with_scarcity_adjustment<'a, I>(self, activity_duals: I) -> Self

where I: Iterator<Item = (&'a AssetRef, &'a TimeSliceID, MoneyPerActivity)>,

Remove the impact of scarcity on prices.

Arguments

• activity_duals - Value of activity duals from solution

pub fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = ((CommodityID, RegionID, TimeSliceID), MoneyPerFlow)>,

Extend the prices map, possibly overwriting values

pub fn insert( &mut self, commodity_id: &CommodityID, region_id: &RegionID, time_slice: &TimeSliceID, price: MoneyPerFlow, )

Insert a price for the given commodity, region and time slice

pub fn iter( &self, ) -> impl Iterator<Item = (&CommodityID, &RegionID, &TimeSliceID, MoneyPerFlow)>

Iterate over the map.

Returns

An iterator of tuples containing commodity ID, region ID, time slice and price.

pub fn get( &self, commodity_id: &CommodityID, region_id: &RegionID, time_slice: &TimeSliceID, ) -> Option<MoneyPerFlow>

Get the price for the specified commodity for a given region and time slice

pub fn keys( &self, ) -> Keys<'_, (CommodityID, RegionID, TimeSliceID), MoneyPerFlow>

Iterate over the price map’s keys

pub fn remove( &mut self, commodity_id: &CommodityID, region_id: &RegionID, time_slice: &TimeSliceID, ) -> Option<MoneyPerFlow>

Remove the specified entry from the map

fn time_slice_weighted_averages( &self, time_slice_info: &TimeSliceInfo, ) -> HashMap<(CommodityID, RegionID), MoneyPerFlow>

Calculate time slice-weighted average prices for each commodity-region pair

This method aggregates prices across time slices by weighting each price by the duration of its time slice, providing a more representative annual average.

Note: this assumes that all time slices are present for each commodity-region pair, and that all time slice lengths sum to 1. This is not checked by this method.

pub fn within_tolerance_weighted( &self, other: &Self, tolerance: Dimensionless, time_slice_info: &TimeSliceInfo, ) -> bool

Check if time slice-weighted average prices are within relative tolerance of another price set.

This method calculates time slice-weighted average prices for each commodity-region pair and compares them. Both objects must have exactly the same set of commodity-region pairs, otherwise it will panic.

Additionally, this method assumes that all time slices are present for each commodity-region pair, and that all time slice lengths sum to 1. This is not checked by this method.

Trait Implementations

impl Clone for CommodityPrices

fn clone(&self) -> CommodityPrices

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CommodityPrices

fn default() -> CommodityPrices

Returns the “default value” for a type.

impl<'a> FromIterator<(&'a CommodityID, &'a RegionID, &'a TimeSliceID, MoneyPerFlow)> for CommodityPrices

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = (&'a CommodityID, &'a RegionID, &'a TimeSliceID, MoneyPerFlow)>,

Creates a value from an iterator.

impl IntoIterator for CommodityPrices

type Item = ((CommodityID, RegionID, TimeSliceID), MoneyPerFlow)

The type of the elements being iterated over.

type IntoIter = IntoIter<(CommodityID, RegionID, TimeSliceID), MoneyPerFlow>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.