Struct VariableMap

pub struct VariableMap {
    asset_vars: IndexMap<(AssetRef, TimeSliceID), Col>,
    existing_asset_var_idx: Range<usize>,
    unmet_demand_vars: IndexMap<(CommodityID, RegionID, TimeSliceID), Col>,
    unmet_demand_var_idx: Range<usize>,
}

A map for easy lookup of variables in the problem.

The entries are ordered (see [IndexMap]).

We use this data structure for two things:

1. In order define constraints for the optimisation
2. To keep track of the combination of parameters that each variable corresponds to, for when we are reading the results of the optimisation.

Fields

asset_vars: IndexMap<(AssetRef, TimeSliceID), Col>

existing_asset_var_idx: Range<usize>

unmet_demand_vars: IndexMap<(CommodityID, RegionID, TimeSliceID), Col>

unmet_demand_var_idx: Range<usize>

Implementations

impl VariableMap

fn new_with_asset_vars( problem: &mut Problem, model: &Model, input_prices: Option<&CommodityPrices>, existing_assets: &[AssetRef], candidate_assets: &[AssetRef], year: u32, ) -> Self

Create a new VariableMap and add variables to the problem

Arguments

• problem - The optimisation problem
• model - The model
• input_prices - Optional explicit prices for input commodities
• existing_assets - The asset pool
• candidate_assets - Candidate assets for inclusion in active pool
• year - Current milestone year

fn add_unmet_demand_variables( &mut self, problem: &mut Problem, model: &Model, commodities: &[CommodityID], )

Add unmet demand variables to the map and the problem

Arguments

• problem - The optimisation problem
• model - The model
• commodities - The subset of commodities the problem is being run for

fn get_asset_var(&self, asset: &AssetRef, time_slice: &TimeSliceID) -> Col

Get the asset Variable corresponding to the given parameters.

fn get_unmet_demand_var( &self, commodity_id: &CommodityID, region_id: &RegionID, time_slice: &TimeSliceID, ) -> Col

Get the unmet demand Variable corresponding to the given parameters.

fn iter_asset_vars( &self, ) -> impl Iterator<Item = (&AssetRef, &TimeSliceID, Col)>

Iterate over the asset variables

fn asset_var_keys(&self) -> Keys<'_, (AssetRef, TimeSliceID), Col>

Iterate over the keys for asset variables