- 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.Option
-
- All Implemented Interfaces:
Serializable,Product,RegressionBasisFunctionsProvider,TermStructureMonteCarloProduct,MonteCarloProduct
public class Option extends AbstractProductComponent implements RegressionBasisFunctionsProvider
An option. Implements the functionmax(underlying(t)-strike,0)for anyunderlyingobject implementing anAbstractLIBORMonteCarloProduct. The strike may be a fixed constant value or an object implementingAbstractLIBORMonteCarloProduct(resulting in a stochastic strike or exchange option). More precise, thegetVauemethod returns the value \[ \left\{ \begin{array}{ll} U(t)-S(t) & \text{if E(t) > 0} \\ U(t)-S(t) & \text{else.} \end{array} \right. \] where \( E \) is an estimator for the expectation of \( U(t)-S(t) \) and \( U \) is the value returned by the call togetValueof the underlying product, which may return a sum on discounted futures cash-flows / values (i.e. not yet performing the expectation) and \( S \) is the strike (which may be a fixed value or another underlying product).- Version:
- 1.2
- Author:
- Christian Fries
- See Also:
AbstractLIBORMonteCarloProduct, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Option(double exerciseDate, boolean isCall, TermStructureMonteCarloProduct strikeProduct, AbstractLIBORMonteCarloProduct underlying)Creates the function underlying(exerciseDate) ≥ strikeProduct ? underlying : strikeProductOption(double exerciseDate, boolean isCall, TermStructureMonteCarloProduct strikeProduct, AbstractLIBORMonteCarloProduct underlying, RegressionBasisFunctionsProvider regressionBasisFunctionsProvider)Creates the function underlying(exerciseDate) ≥ strikeProduct ? underlying : strikeProductOption(double exerciseDate, double strikePrice, boolean isCall, AbstractLIBORMonteCarloProduct underlying)Creates the function underlying(exerciseDate) ≥ strikePrice ? underlying : strikePriceOption(double exerciseDate, double strikePrice, boolean isCall, AbstractLIBORMonteCarloProduct underlying, RegressionBasisFunctionsProvider regressionBasisFunctionsProvider)Creates the function underlying(exerciseDate) ≥ strikePrice ? underlying : strikePriceOption(double exerciseDate, double strikePrice, AbstractLIBORMonteCarloProduct underlying)Creates the function underlying(exerciseDate) ≥ strikePrice ? underlying : strikePriceOption(double exerciseDate, AbstractLIBORMonteCarloProduct underlying)Creates the function underlying(exerciseDate) ≥ 0 ? underlying : 0
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RandomVariable[]getBasisFunctions(double exerciseDate, LIBORModelMonteCarloSimulationModel model)Return the regression basis functions.RandomVariable[]getBasisFunctions(double evaluationTime, MonteCarloSimulationModel model)Provides a set of \( \mathcal{F}_{t} \)-measurable random variables which can serve as regression basis functions.StringgetCurrency()Returns the currency string of this product.RandomVariablegetValue(double evaluationTime, LIBORModelMonteCarloSimulationModel model)This method returns the value random variable of the product within the specified model, evaluated at a given evalutationTime.Set<String>queryUnderlyings()Returns a set of underlying names referenced by this product component (i.e., required for valuation) or null if none.StringtoString()-
Methods inherited from class net.finmath.montecarlo.interestrate.products.components.AbstractProductComponent
getExecutor, getValues
-
Methods inherited from class net.finmath.montecarlo.interestrate.products.AbstractLIBORMonteCarloProduct
getFactorDrift, getValue, getValueForModifiedData
-
Methods inherited from class net.finmath.montecarlo.AbstractMonteCarloProduct
getValue, getValue, getValues, getValues, getValues, getValuesForModifiedData, getValuesForModifiedData, getValuesForModifiedData, getValuesForModifiedData
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.finmath.montecarlo.MonteCarloProduct
getValue, getValue, getValues, getValues, getValues, getValuesForModifiedData, getValuesForModifiedData, getValuesForModifiedData, getValuesForModifiedData
-
-
-
-
Constructor Detail
-
Option
public Option(double exerciseDate, double strikePrice, boolean isCall, AbstractLIBORMonteCarloProduct underlying, RegressionBasisFunctionsProvider regressionBasisFunctionsProvider)Creates the function underlying(exerciseDate) ≥ strikePrice ? underlying : strikePrice- Parameters:
exerciseDate- The exercise date of the option (given as a double).strikePrice- The strike price.isCall- If true, the function implements is underlying(exerciseDate) ≥ strikePrice ? underlying : strikePrice. Otherwise it is underlying(exerciseDate) < strikePrice ? underlying : strikePrice.underlying- The underlying.regressionBasisFunctionsProvider- Used to determine the regression basis functions for the conditional expectation operator.
-
Option
public Option(double exerciseDate, boolean isCall, TermStructureMonteCarloProduct strikeProduct, AbstractLIBORMonteCarloProduct underlying, RegressionBasisFunctionsProvider regressionBasisFunctionsProvider)Creates the function underlying(exerciseDate) ≥ strikeProduct ? underlying : strikeProduct- Parameters:
exerciseDate- The exercise date of the option (given as a double).isCall- If true, the function implements is underlying(exerciseDate) ≥ strikePrice ? underlying : strikePrice. Otherwise it is underlying(exerciseDate) < strikePrice ? underlying : strikePrice.strikeProduct- The strike (can be a general AbstractLIBORMonteCarloProduct).underlying- The underlying.regressionBasisFunctionsProvider- Used to determine the regression basis functions for the conditional expectation operator.
-
Option
public Option(double exerciseDate, boolean isCall, TermStructureMonteCarloProduct strikeProduct, AbstractLIBORMonteCarloProduct underlying)Creates the function underlying(exerciseDate) ≥ strikeProduct ? underlying : strikeProduct- Parameters:
exerciseDate- The exercise date of the option (given as a double).isCall- If true, the function implements is underlying(exerciseDate) ≥ strikePrice ? underlying : strikePrice. Otherwise it is underlying(exerciseDate) < strikePrice ? underlying : strikePrice.strikeProduct- The strike (can be a general AbstractLIBORMonteCarloProduct).underlying- The underlying.
-
Option
public Option(double exerciseDate, double strikePrice, boolean isCall, AbstractLIBORMonteCarloProduct underlying)Creates the function underlying(exerciseDate) ≥ strikePrice ? underlying : strikePrice- Parameters:
exerciseDate- The exercise date of the option (given as a double).strikePrice- The strike price.isCall- If true, the function implements is underlying(exerciseDate) ≥ strikePrice ? underlying : strikePrice. Otherwise it is underlying(exerciseDate) < strikePrice ? underlying : strikePrice.underlying- The underlying.
-
Option
public Option(double exerciseDate, double strikePrice, AbstractLIBORMonteCarloProduct underlying)Creates the function underlying(exerciseDate) ≥ strikePrice ? underlying : strikePrice- Parameters:
exerciseDate- The exercise date of the option (given as a double).strikePrice- The strike price.underlying- The underlying.
-
Option
public Option(double exerciseDate, AbstractLIBORMonteCarloProduct underlying)Creates the function underlying(exerciseDate) ≥ 0 ? underlying : 0- Parameters:
exerciseDate- The exercise date of the option (given as a double).underlying- The underlying.
-
-
Method Detail
-
getCurrency
public String getCurrency()
Description copied from interface:MonteCarloProductReturns the currency string of this product.- Specified by:
getCurrencyin interfaceMonteCarloProduct- Overrides:
getCurrencyin classAbstractMonteCarloProduct- Returns:
- the currency
-
queryUnderlyings
public Set<String> queryUnderlyings()
Description copied from class:AbstractProductComponentReturns a set of underlying names referenced by this product component (i.e., required for valuation) or null if none.- Specified by:
queryUnderlyingsin classAbstractProductComponent- Returns:
- A set of underlying names referenced by this product component (i.e., required for valuation) or null if none.
-
getValue
public RandomVariable getValue(double evaluationTime, LIBORModelMonteCarloSimulationModel model) throws CalculationException
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:
getValuein interfaceTermStructureMonteCarloProduct- Specified by:
getValuein classAbstractLIBORMonteCarloProduct- 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 thecause()method.
-
getBasisFunctions
public RandomVariable[] getBasisFunctions(double evaluationTime, MonteCarloSimulationModel model) throws CalculationException
Description copied from interface:RegressionBasisFunctionsProviderProvides a set of \( \mathcal{F}_{t} \)-measurable random variables which can serve as regression basis functions.- Specified by:
getBasisFunctionsin interfaceRegressionBasisFunctionsProvider- Parameters:
evaluationTime- The evaluation time \( t \) at which the basis function should be observed.model- The Monte-Carlo model used to derive the basis function.- Returns:
- An \( \mathcal{F}_{t} \)-measurable random variable.
- Throws:
CalculationException- Thrown if derivation of the basis function fails.
-
getBasisFunctions
public RandomVariable[] getBasisFunctions(double exerciseDate, LIBORModelMonteCarloSimulationModel model) throws CalculationException
Return the regression basis functions.- Parameters:
exerciseDate- The date w.r.t. which the basis functions should be measurable.model- The model.- Returns:
- Array of random variables.
- Throws:
CalculationException- Thrown if the valuation fails, specific cause may be available via thecause()method.
-
toString
public String toString()
- Overrides:
toStringin classAbstractMonteCarloProduct
-
-