|
finMath lib documentation | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AbstractModelInterface
The interface for a model of a stochastic process X where
X = f(Y) and
\[
dY_{j} = \mu_{j} dt + \lambda_{1,j} dW_{1} + \ldots + \lambda_{m,j} dW_{m}
\]
getInitialState()
.
getDrift(int, net.finmath.stochastic.RandomVariableInterface[], net.finmath.stochastic.RandomVariableInterface[])
.
getFactorLoading(int, int, net.finmath.stochastic.RandomVariableInterface[])
.
applyStateSpaceTransform(int, net.finmath.stochastic.RandomVariableInterface)
.
Method Summary | |
---|---|
RandomVariableInterface |
applyStateSpaceTransform(int componentIndex,
RandomVariableInterface randomVariable)
Applied the state space transform fi to the given state random variable such that Yi → fi(Yi) =: Xi. |
RandomVariableInterface[] |
getDrift(int timeIndex,
RandomVariableInterface[] realizationAtTimeIndex,
RandomVariableInterface[] realizationPredictor)
This method has to be implemented to return the drift, i.e. |
RandomVariableInterface[] |
getFactorLoading(int timeIndex,
int componentIndex,
RandomVariableInterface[] realizationAtTimeIndex)
This method has to be implemented to return the factor loadings, i.e. |
RandomVariableInterface[] |
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. |
RandomVariableInterface |
getNumeraire(double time)
Return the numeraire at a given time index. |
AbstractProcessInterface |
getProcess()
Get the numerical scheme used to generate the stochastic process. |
TimeDiscretizationInterface |
getTimeDiscretization()
Returns the time discretization of the model parameters. |
void |
setProcess(AbstractProcessInterface process)
Set the numerical scheme used to generate the stochastic process. |
Method Detail |
---|
TimeDiscretizationInterface getTimeDiscretization()
int getNumberOfComponents()
RandomVariableInterface applyStateSpaceTransform(int componentIndex, RandomVariableInterface randomVariable)
componentIndex
- The component index i.randomVariable
- The state random variable Yi.
RandomVariableInterface[] getInitialState()
RandomVariableInterface getNumeraire(double time) throws CalculationException
time
- The time t for which the numeraire N(t) should be returned.
RandomVariable
CalculationException
- Thrown if the valuation fails, specific cause may be available via the cause()
method.RandomVariableInterface[] getDrift(int timeIndex, RandomVariableInterface[] realizationAtTimeIndex, RandomVariableInterface[] 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 of no predictor is available.
int getNumberOfFactors()
RandomVariableInterface[] getFactorLoading(int timeIndex, int componentIndex, RandomVariableInterface[] 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).
void setProcess(AbstractProcessInterface process)
process
- The process.AbstractProcessInterface getProcess()
|
Copyright © 2014 Christian P. Fries. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |