public interface ProcessModel
getInitialState()
.
getDrift(int, net.finmath.stochastic.RandomVariable[], net.finmath.stochastic.RandomVariable[])
.
getFactorLoading(int, int, net.finmath.stochastic.RandomVariable[])
.
applyStateSpaceTransform(int, net.finmath.stochastic.RandomVariable)
.
Modifier and Type | Method and Description |
---|---|
RandomVariable |
applyStateSpaceTransform(int componentIndex,
RandomVariable randomVariable)
Applies the state space transform fi to the given state random variable
such that Yi → fi(Yi) =: Xi.
|
default RandomVariable |
applyStateSpaceTransformInverse(int componentIndex,
RandomVariable randomVariable) |
ProcessModel |
getCloneWithModifiedData(Map<String,Object> dataModified)
Returns a clone of this model where the specified properties have been modified.
|
RandomVariable[] |
getDrift(int timeIndex,
RandomVariable[] realizationAtTimeIndex,
RandomVariable[] realizationPredictor)
This method has to be implemented to return the drift, i.e.
|
RandomVariable[] |
getFactorLoading(int timeIndex,
int componentIndex,
RandomVariable[] realizationAtTimeIndex)
This method has to be implemented to return the factor loadings, i.e.
|
RandomVariable[] |
getInitialState()
Returns the initial value of the state variable of the process Y, not to be
confused with the initial value of the model X (which is the state space transform
applied to this state value.
|
int |
getNumberOfComponents()
Returns the number of components
|
int |
getNumberOfFactors()
Returns the number of factors m, i.e., the number of independent Brownian drivers.
|
RandomVariable |
getNumeraire(double time)
Return the numeraire at a given time index.
|
MonteCarloProcess |
getProcess()
Get the numerical scheme used to generate the stochastic process.
|
default RandomVariable |
getRandomVariableForConstant(double value)
Return a random variable initialized with a constant using the models random variable factory.
|
LocalDateTime |
getReferenceDate()
Returns the model's date corresponding to the time discretization's \( t = 0 \).
|
TimeDiscretization |
getTimeDiscretization()
Returns the time discretization of the model parameters.
|
void |
setProcess(MonteCarloProcess process)
Set the numerical scheme used to generate the stochastic process.
|
LocalDateTime getReferenceDate()
TimeDiscretization getTimeDiscretization()
int getNumberOfComponents()
RandomVariable applyStateSpaceTransform(int componentIndex, RandomVariable randomVariable)
componentIndex
- The component index i.randomVariable
- The state random variable Yi.default RandomVariable applyStateSpaceTransformInverse(int componentIndex, RandomVariable randomVariable)
RandomVariable[] getInitialState()
RandomVariable getNumeraire(double time) throws CalculationException
time
- The time t for which the numeraire N(t) should be returned.RandomVariableFromDoubleArray
CalculationException
- Thrown if the valuation fails, specific cause may be available via the cause()
method.RandomVariable[] getDrift(int timeIndex, RandomVariable[] realizationAtTimeIndex, RandomVariable[] realizationPredictor)
timeIndex
- The time index (related to the model times discretization).realizationAtTimeIndex
- The given realization at timeIndexrealizationPredictor
- The given realization at timeIndex+1
or null if no predictor is available.int getNumberOfFactors()
RandomVariable[] getFactorLoading(int timeIndex, int componentIndex, RandomVariable[] realizationAtTimeIndex)
timeIndex
- The time index (related to the model times discretization).componentIndex
- The index j of the driven component.realizationAtTimeIndex
- The realization of X at the time corresponding to timeIndex (in order to implement local and stochastic volatlity models).default RandomVariable getRandomVariableForConstant(double value)
value
- The constant value.void setProcess(MonteCarloProcess process)
process
- The process.MonteCarloProcess getProcess()
ProcessModel getCloneWithModifiedData(Map<String,Object> dataModified) throws CalculationException
dataModified
. If data is provided which is ignored by the model
no exception may be thrown.dataModified
- Key-value-map of parameters to modify.CalculationException
- Thrown when the model could not be created.Copyright © 2020. All rights reserved.