Struct ReducedCosts

pub struct ReducedCosts(IndexMap<(AssetRef, TimeSliceID), MoneyPerActivity>);

A map of reduced costs for different assets in different time slices

This is the system cost associated with one unit of activity (MoneyPerActivity) for each asset in each time slice.

For candidate assets this is calculated directly from the activity variable duals.

For existing assets this is calculated from the operating cost and the revenue from flows.

These may be used in the investment algorithm, depending on the appraisal method, to compare the cost effectiveness of different potential investment decisions.

Tuple Fields

0: IndexMap<(AssetRef, TimeSliceID), MoneyPerActivity>

Implementations

impl ReducedCosts

pub fn get( &self, asset: &AssetRef, time_slice: &TimeSliceID, ) -> MoneyPerActivity

Get the reduced cost for the specified asset and time slice

If no reduced cost is found for the asset, the reduced cost is returned for the relevant candidate asset. This can occur the first year an asset is commissioned, or if an asset was not selected in an earlier iteration of the ironing out loop.

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

where T: IntoIterator<Item = ((AssetRef, TimeSliceID), MoneyPerActivity)>,

Extend the reduced costs map

pub fn iter( &self, ) -> impl Iterator<Item = (&(AssetRef, TimeSliceID), &MoneyPerActivity)>

Iterate over the map

pub fn iter_mut( &mut self, ) -> impl Iterator<Item = (&(AssetRef, TimeSliceID), &mut MoneyPerActivity)>

Iterate mutably over the map

Trait Implementations

impl Clone for ReducedCosts

fn clone(&self) -> ReducedCosts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ReducedCosts

fn default() -> ReducedCosts

Returns the “default value” for a type.

impl From<IndexMap<(AssetRef, TimeSliceID), MoneyPerActivity>> for ReducedCosts

fn from(map: IndexMap<(AssetRef, TimeSliceID), MoneyPerActivity>) -> Self

Converts to this type from the input type.

impl FromIterator<((AssetRef, TimeSliceID), MoneyPerActivity)> for ReducedCosts

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

where T: IntoIterator<Item = ((AssetRef, TimeSliceID), MoneyPerActivity)>,

Creates a value from an iterator.

impl IntoIterator for ReducedCosts

type Item = ((AssetRef, TimeSliceID), MoneyPerActivity)

The type of the elements being iterated over.

type IntoIter = IntoIter<(AssetRef, TimeSliceID), MoneyPerActivity>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.