AppraisalOutput

muse2::simulation::investment::appraisal

Struct AppraisalOutput 

Source 
pub struct AppraisalOutput {
    pub asset: AssetRef,
    pub capacity: AssetCapacity,
    pub activity: IndexMap<TimeSliceID, Activity>,
    pub unmet_demand: IndexMap<TimeSliceID, Flow>,
    pub metric: Box<dyn MetricTrait>,
    pub coefficients: ObjectiveCoefficients,
    pub demand: IndexMap<TimeSliceID, Flow>,
}
Expand description

The output of investment appraisal required to compare potential investment decisions

Fields§

§asset: AssetRef

The asset being appraised

§capacity: AssetCapacity

The hypothetical capacity to install

§activity: IndexMap<TimeSliceID, Activity>

Time slice level activity of the asset

§unmet_demand: IndexMap<TimeSliceID, Flow>

The hypothetical unmet demand following investment in this asset

§metric: Box<dyn MetricTrait>

The comparison metric to compare investment decisions

§coefficients: ObjectiveCoefficients

Capacity and activity coefficients used in the appraisal

§demand: IndexMap<TimeSliceID, Flow>

Demand profile used in the appraisal

Implementations§

Source§

impl AppraisalOutput

Source

pub fn compare_metric(&self, other: &Self) -> Ordering

Compare this appraisal to another on the basis of the comparison metric.

Note that if the metrics are approximately equal (as determined by the [approx_eq!] macro) then Ordering::Equal is returned. The reason for this is because different CPU architectures may lead to subtly different values for the comparison metrics and if the value is very similar to another, then it can lead to different decisions being made, depending on the user’s platform (e.g. macOS ARM vs. Windows). We want to avoid this, if possible, which is why we use a more approximate comparison.

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> 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, 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.