Class TimeDiscreteEndOfMonthIndex

All Implemented Interfaces:
Serializable, Product, TermStructureMonteCarloProduct, MonteCarloProduct

public class TimeDiscreteEndOfMonthIndex extends AbstractIndex
An index which maps is evaluation point to a fixed discrete point, the end of the month, then takes the value of a given base index at this point.
Christian Fries
See Also:
  • Constructor Details

    • TimeDiscreteEndOfMonthIndex

      public TimeDiscreteEndOfMonthIndex(String name, AbstractIndex baseIndex, int fixingOffsetMonths)
      Creates a time discrete index.
      name - The name of this index. Used to map an index on a curve.
      baseIndex - The base index (will be referenced at end of month points).
      fixingOffsetMonths - A given fixing offset in month.
  • Method Details

    • getValue

      public RandomVariable getValue(double evaluationTime, TermStructureMonteCarloSimulationModel model) throws CalculationException
      Description copied from interface: TermStructureMonteCarloProduct
      This method returns the value random variable of the product within the specified model, evaluated at a given evalutationTime. Note: For a lattice this is often the value conditional to evalutationTime, for a Monte-Carlo simulation this is the (sum of) value discounted to evaluation time. Cashflows prior evaluationTime are not considered.
      Specified by:
      getValue in interface TermStructureMonteCarloProduct
      Specified by:
      getValue in class AbstractIndex
      evaluationTime - The time on which this products value should be observed.
      model - The model used to price the product.
      The random variable representing the value of the product discounted to evaluation time
      CalculationException - Thrown if the valuation fails, specific cause may be available via the cause() method.
    • queryUnderlyings

      public Set<String> queryUnderlyings()
      Description copied from class: AbstractProductComponent
      Returns a set of underlying names referenced by this product component (i.e., required for valuation) or null if none.
      Specified by:
      queryUnderlyings in class AbstractProductComponent
      A set of underlying names referenced by this product component (i.e., required for valuation) or null if none.
    • toString

      public String toString()
      toString in class AbstractMonteCarloProduct