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_levies(self, model: &Model, year: u32) -> Self

Add prices based on levies/incentives.

If a commodity already has a price based on the previous dual-based calculation, we choose the higher of the two.

Arguments

• model - The model
• year - The milestone year of interest

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 within_tolerance(&self, other: &Self, tolerance: Dimensionless) -> bool

Check if prices are within relative tolerance of another price set

Both objects must have exactly the same set of keys, otherwise it will panic.

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.