net.finmath.montecarlo.interestrate.products.components

Class AccrualAccount

java.lang.Object

net.finmath.montecarlo.AbstractMonteCarloProduct

net.finmath.montecarlo.interestrate.products.AbstractLIBORMonteCarloProduct

net.finmath.montecarlo.interestrate.products.components.AbstractProductComponent

net.finmath.montecarlo.interestrate.products.components.AccrualAccount

All Implemented Interfaces:

java.io.Serializable, ProductInterface

public class AccrualAccount
extends AbstractProductComponent

Implementation of a general accrual account. This class is an improved version of the MoneyMarketAccount except that it allow the use of a general index for accrual and also supports past fixings.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AccrualAccount(java.lang.String currency, AnalyticModelIndex pastFixings, AbstractIndex accrualIndex, double accrualPeriod) Create an accrual account.

Method Summary

Modifier and Type	Method and Description
RandomVariableInterface	getValue(double evaluationTime, LIBORModelMonteCarloSimulationInterface model) This method returns the value random variable of the product within the specified model, evaluated at a given evalutationTime.
java.util.Set<java.lang.String>	queryUnderlyings() Returns a set of underlying names referenced by this product component (i.e., required for valuation) or null if none.

Methods inherited from class net.finmath.montecarlo.interestrate.products.components.AbstractProductComponent

getValues

Methods inherited from class net.finmath.montecarlo.interestrate.products.AbstractLIBORMonteCarloProduct

getFactorDrift, getValue, getValueForModifiedData

Methods inherited from class net.finmath.montecarlo.AbstractMonteCarloProduct

getCurrency, getValue, getValue, getValues, getValues, getValuesForModifiedData, getValuesForModifiedData, getValuesForModifiedData, getValuesForModifiedData, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AccrualAccount

public AccrualAccount(java.lang.String currency,
                      AnalyticModelIndex pastFixings,
                      AbstractIndex accrualIndex,
                      double accrualPeriod)

Create an accrual account.

Parameters:

currency - The currency of this account.

pastFixings - An analytic model index which is used for past fixings, i.e., all calls to getValue with evaluationTime < 0 are delegated to this index.

accrualIndex - The accrual index.

accrualPeriod - The accrual period.

Method Detail

queryUnderlyings

public java.util.Set<java.lang.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

Returns:

A set of underlying names referenced by this product component (i.e., required for valuation) or null if none.

getValue

public RandomVariableInterface getValue(double evaluationTime,
                                        LIBORModelMonteCarloSimulationInterface model)
                                 throws CalculationException

Description copied from class: AbstractLIBORMonteCarloProduct

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 class AbstractLIBORMonteCarloProduct

Parameters:

evaluationTime - The time on which this products value should be observed.

model - The model used to price the product.

Returns:

The random variable representing the value of the product discounted to evaluation time

Throws:

CalculationException - Thrown if the valuation fails, specific cause may be available via the cause() method.