InvestmentSet

Enum InvestmentSet 

Source
pub enum InvestmentSet {
    Single((CommodityID, RegionID)),
    Cycle(Vec<(CommodityID, RegionID)>),
    Layer(Vec<InvestmentSet>),
}
Expand description

Represents a set of markets which are invested in together.

Variants§

§

Single((CommodityID, RegionID))

Assets are selected for a single market using select_assets_for_single_market

§

Cycle(Vec<(CommodityID, RegionID)>)

Assets are selected for a group of markets which forms a cycle. Experimental: handled by select_assets_for_cycle and guarded by the broken options parameter.

§

Layer(Vec<InvestmentSet>)

Assets are selected for a layer of independent InvestmentSets

Implementations§

Source§

impl InvestmentSet

Source

pub fn iter_markets<'a>( &'a self, ) -> Box<dyn Iterator<Item = &'a (CommodityID, RegionID)> + 'a>

Recursively iterate over all markets contained in this InvestmentSet.

Source

fn select_assets( &self, model: &Model, year: u32, demand: &IndexMap<(CommodityID, RegionID, TimeSliceID), Flow>, existing_assets: &[AssetRef], prices: &CommodityPrices, seen_markets: &[(CommodityID, RegionID)], previously_selected_assets: &[AssetRef], writer: &mut DataWriter, ) -> Result<Vec<AssetRef>>

Selects assets for this investment set variant and passes through the shared context needed by single-market, cycle, or layered selection.

§Arguments
  • model – Simulation model supplying parameters, processes, and dispatch.
  • year – Planning year being solved.
  • demand – Net demand profiles available to all markets before selection.
  • existing_assets – Assets already commissioned in the system.
  • prices – Commodity price assumptions to use when valuing investments.
  • seen_markets – Markets for which investments have already been settled.
  • previously_selected_assets – Assets chosen in earlier investment sets.
  • writer – Data sink used to log optimisation artefacts.

Trait Implementations§

Source§

impl Clone for InvestmentSet

Source§

fn clone(&self) -> InvestmentSet

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InvestmentSet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for InvestmentSet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for InvestmentSet

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for InvestmentSet

Source§

fn eq(&self, other: &InvestmentSet) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for InvestmentSet

Source§

impl StructuralPartialEq for InvestmentSet

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.