Module net.finmath.lib

Package net.finmath.montecarlo.assetderivativevaluation

Class MonteCarloAssetModel

java.lang.Object

net.finmath.montecarlo.assetderivativevaluation.MonteCarloAssetModel

All Implemented Interfaces:

Model, AssetModelMonteCarloSimulationModel, MonteCarloSimulationModel

Direct Known Subclasses:

MonteCarloBlackScholesModel

public class MonteCarloAssetModel
extends Object
implements AssetModelMonteCarloSimulationModel

This class glues together an AbstractProcessModel and a Monte-Carlo implementation of a MonteCarloProcessFromProcessModel and implements AssetModelMonteCarloSimulationModel. The model is specified via the object implementing ProcessModel.

Version:

1.0

Author:

Christian Fries

See Also:

The interface for numerical schemes., The interface for models provinding parameters to numerical schemes.

Constructor Summary

Constructors

Constructor	Description
MonteCarloAssetModel(ProcessModel model, IndependentIncrements stochasticDriver)	Convenient constructor being the same as this(new EulerSchemeFromProcessModel(model, stochasticDriver))
MonteCarloAssetModel(ProcessModel model, MonteCarloProcess process)	Deprecated. May be made private in future releases.
MonteCarloAssetModel(MonteCarloProcess process)	Create a Monte-Carlo simulation using given process discretization scheme.

Method Summary

Modifier and Type	Method	Description
RandomVariable	getAssetValue(double time, int assetIndex)	Returns the random variable representing the asset's value at a given time for a given asset.
RandomVariable	getAssetValue(int timeIndex, int assetIndex)	Returns the random variable representing the asset's value at a given time for a given asset.
MonteCarloAssetModel	getCloneWithModifiedData(Map<String,Object> dataModified)	Create a clone of this simulation modifying some of its properties (if any).
AssetModelMonteCarloSimulationModel	getCloneWithModifiedSeed(int seed)	Deprecated.
ProcessModel	getModel()	Returns the ProcessModel used for this Monte-Carlo simulation.
RandomVariable	getMonteCarloWeights(double time)	This method returns the weights of a weighted Monte Carlo method (the probability density).
RandomVariable	getMonteCarloWeights(int timeIndex)	This method returns the weights of a weighted Monte Carlo method (the probability density).
int	getNumberOfAssets()	Returns the number of asset price processes.
int	getNumberOfPaths()	Returns the numberOfPaths.
RandomVariable	getNumeraire(double time)	Returns the numeraire associated with the valuation measure used by this model.
RandomVariable	getNumeraire(int timeIndex)	Returns the numeraire associated with the valuation measure used by this model.
MonteCarloProcess	getProcess()	Returns the MonteCarloProcess used for this Monte-Carlo simulation.
RandomVariable	getRandomVariableForConstant(double value)	Returns a random variable which is initialized to a constant, but has exactly the same number of paths or discretization points as the ones used by this MonteCarloSimulationModel.
LocalDateTime	getReferenceDate()	Returns the model's date corresponding to the time discretization's \( t = 0 \).
double	getTime(int timeIndex)	Returns the time for a given time index.
TimeDiscretization	getTimeDiscretization()	Returns the timeDiscretizationFromArray.
int	getTimeIndex(double time)	Returns the time index for a given time.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MonteCarloAssetModel

public MonteCarloAssetModel(MonteCarloProcess process)

Create a Monte-Carlo simulation using given process discretization scheme.

Parameters:

process - The numerical scheme to be used.

MonteCarloAssetModel

public MonteCarloAssetModel(ProcessModel model,
                            IndependentIncrements stochasticDriver)

Convenient constructor being the same as this(new EulerSchemeFromProcessModel(model, stochasticDriver))

Parameters:

model - The model to use for the EulerSchemeFromProcessModel.

stochasticDriver - The stochatic driver to use.

MonteCarloAssetModel

@Deprecated
public MonteCarloAssetModel(ProcessModel model,
                            MonteCarloProcess process)

Deprecated.

May be made private in future releases.

Create a Monte-Carlo simulation using given process discretization scheme.

Parameters:

model - The model to be used.

process - The numerical scheme to be used.

Method Detail

getAssetValue

public RandomVariable getAssetValue(double time,
                                    int assetIndex)
                             throws CalculationException

Description copied from interface: AssetModelMonteCarloSimulationModel

Returns the random variable representing the asset's value at a given time for a given asset.

Specified by:

getAssetValue in interface AssetModelMonteCarloSimulationModel

Parameters:

time - Simulation time

assetIndex - Index of the asset (0 for a single asset model)

Returns:

The asset process as seen on simulation time

Throws:

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

getAssetValue

public RandomVariable getAssetValue(int timeIndex,
                                    int assetIndex)
                             throws CalculationException

Description copied from interface: AssetModelMonteCarloSimulationModel

Returns the random variable representing the asset's value at a given time for a given asset.

Specified by:

getAssetValue in interface AssetModelMonteCarloSimulationModel

Parameters:

timeIndex - Index of simulation time

assetIndex - Index of the asset (0 for a single asset model)

Returns:

The asset process as seen on simulation time

Throws:

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

getNumeraire

public RandomVariable getNumeraire(int timeIndex)
                            throws CalculationException

Description copied from interface: AssetModelMonteCarloSimulationModel

Returns the numeraire associated with the valuation measure used by this model.

Specified by:

getNumeraire in interface AssetModelMonteCarloSimulationModel

Parameters:

timeIndex - The time index (associated with this models time discretization).

Returns:

The numeraire associated with the valuation measure used by this model.

Throws:

CalculationException - Thrown if calculation of numeraire fails.

getNumeraire

public RandomVariable getNumeraire(double time)
                            throws CalculationException

Description copied from interface: AssetModelMonteCarloSimulationModel

Returns the numeraire associated with the valuation measure used by this model.

Specified by:

getNumeraire in interface AssetModelMonteCarloSimulationModel

Parameters:

time - The time for which the numeraire is requested.

Returns:

The numeraire associated with the valuation measure used by this model.

Throws:

CalculationException - Thrown if calculation of numeraire fails.

getMonteCarloWeights

public RandomVariable getMonteCarloWeights(double time)
                                    throws CalculationException

Description copied from interface: MonteCarloSimulationModel

This method returns the weights of a weighted Monte Carlo method (the probability density).

Specified by:

getMonteCarloWeights in interface MonteCarloSimulationModel

Parameters:

time - Time at which the process should be observed

Returns:

A vector of positive weights which sums up to one

Throws:

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

getNumberOfAssets

public int getNumberOfAssets()

Description copied from interface: AssetModelMonteCarloSimulationModel

Returns the number of asset price processes.

Specified by:

getNumberOfAssets in interface AssetModelMonteCarloSimulationModel

Returns:

The number of asset price processes

getCloneWithModifiedData

public MonteCarloAssetModel getCloneWithModifiedData(Map<String,Object> dataModified)
                                              throws CalculationException

Description copied from interface: AssetModelMonteCarloSimulationModel

Create a clone of this simulation modifying some of its properties (if any).

Specified by:

getCloneWithModifiedData in interface AssetModelMonteCarloSimulationModel

Specified by:

getCloneWithModifiedData in interface MonteCarloSimulationModel

Parameters:

dataModified - The data which should be changed in the new model

Returns:

Returns a clone of this model, with some data modified (then it is no longer a clone :-)

Throws:

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

getCloneWithModifiedSeed

@Deprecated
public AssetModelMonteCarloSimulationModel getCloneWithModifiedSeed(int seed)

Deprecated.

The method is not implemented. Instead call getCloneWithModifiedData on the model an create a new process from it.

Specified by:

getCloneWithModifiedSeed in interface AssetModelMonteCarloSimulationModel

Parameters:

seed - The new seed.

Returns:

Returns a clone of this model except for a modified Monte-Carlo seed.

getNumberOfPaths

public int getNumberOfPaths()

Description copied from interface: MonteCarloSimulationModel

Returns the numberOfPaths.

Specified by:

getNumberOfPaths in interface MonteCarloSimulationModel

Returns:

Returns the numberOfPaths.

getReferenceDate

public LocalDateTime getReferenceDate()

Description copied from interface: MonteCarloSimulationModel

Returns the model's date corresponding to the time discretization's \( t = 0 \).

Specified by:

getReferenceDate in interface MonteCarloSimulationModel

Returns:

The model's date corresponding to the time discretization's \( t = 0 \).

getTimeDiscretization

public TimeDiscretization getTimeDiscretization()

Description copied from interface: MonteCarloSimulationModel

Returns the timeDiscretizationFromArray.

Specified by:

getTimeDiscretization in interface MonteCarloSimulationModel

Returns:

Returns the timeDiscretizationFromArray.

getTime

public double getTime(int timeIndex)

Description copied from interface: MonteCarloSimulationModel

Returns the time for a given time index.

Specified by:

getTime in interface MonteCarloSimulationModel

Parameters:

timeIndex - Time index

Returns:

Returns the time for a given time index.

getTimeIndex

public int getTimeIndex(double time)

Description copied from interface: MonteCarloSimulationModel

Returns the time index for a given time.

Specified by:

getTimeIndex in interface MonteCarloSimulationModel

Parameters:

time - The time.

Returns:

Returns the time index for a given time.

getRandomVariableForConstant

public RandomVariable getRandomVariableForConstant(double value)

Description copied from interface: MonteCarloSimulationModel

Returns a random variable which is initialized to a constant, but has exactly the same number of paths or discretization points as the ones used by this MonteCarloSimulationModel.

Specified by:

getRandomVariableForConstant in interface MonteCarloSimulationModel

Parameters:

value - The constant value to be used for initialized the random variable.

Returns:

A new random variable.

getMonteCarloWeights

public RandomVariable getMonteCarloWeights(int timeIndex)
                                    throws CalculationException

Description copied from interface: MonteCarloSimulationModel

This method returns the weights of a weighted Monte Carlo method (the probability density).

Specified by:

getMonteCarloWeights in interface MonteCarloSimulationModel

Parameters:

timeIndex - Time index at which the process should be observed

Returns:

A vector of positive weights which sums up to one

Throws:

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

getModel

public ProcessModel getModel()

Returns the ProcessModel used for this Monte-Carlo simulation.

Returns:

the model

getProcess

public MonteCarloProcess getProcess()

Returns the MonteCarloProcess used for this Monte-Carlo simulation.

Returns:

the process

toString

public String toString()

Overrides:

toString in class Object