RelativeCostLogit_calcUnnormalizedShare: RelativeCostLogit_calcUnnormalizedShare

In JGCRI/gcamland: GCAM Land Allocation Module

Description

RelativeCostLogit_calcUnnormalizedShare

Usage

RelativeCostLogit_calcUnnormalizedShare(
  aChoiceFnAbove,
  aShareWeight,
  aProfit,
  aPeriod
)

Arguments

aChoiceFnAbove	Choice function (logit type and exponent from node above)
aShareWeight	share weight for the choice for which the share is being calculated.
aProfit	Profit for the choice for which the share is being calculated.
aPeriod	model time period for the calculation.

Details

Calculate the numerator of the discrete choice (i.e., the unnormalized version) function being used to calculate child shares in this node. The normalization factor will be calculated later. Note: Negative costs can not be used in this logit formulation. Instead, the profit is capped at RelativeCostLogit::getMinCostThreshold. This implies no behavior once profits have crossed this threshold. Note: this is modified to match the equations in GCAM4.3 (i.e., no log) but uses structure from versions of GCAM with the absolute cost logit.

Value

log of the unnormalized share.

Author(s)

KVC September 2017

JGCRI/gcamland documentation built on Oct. 6, 2020, 5:30 p.m.