net.finmath.montecarlo

Class BrownianMotionView

java.lang.Object

net.finmath.montecarlo.BrownianMotionView

All Implemented Interfaces:

BrownianMotionInterface

public class BrownianMotionView
extends java.lang.Object
implements BrownianMotionInterface

A Brownian motion which is defined by some factors of a given Brownian motion, i.e., for a given multi-factorial Brownian motion W, this Brownian motion is given by ( W(i[0]), W(i[1]) W(i[2]), ..., W(i[n-1]) ) where i is a given array of integers. You may use this class to change the number of factors and/or the order of a given Brownian motion. You may use this, to create a link between two models, where each model requires an individual object of type BrownianMotionInterface.

Constructor Summary

Constructors

Constructor and Description
BrownianMotionView(BrownianMotionInterface brownianMotion, java.lang.Integer[] factors) Create a sub-view on a Brownian motion.

Method Summary

Modifier and Type	Method and Description
RandomVariableInterface	getBrownianIncrement(int timeIndex, int factor) Return the Brownian increment for a given timeIndex.
BrownianMotionInterface	getCloneWithModifiedSeed(int seed) Return a new object implementing BrownianMotionInterface having the same specifications as this object but a different seed for the random number generator.
BrownianMotionInterface	getCloneWithModifiedTimeDiscretization(TimeDiscretizationInterface newTimeDiscretization) Return a new object implementing BrownianMotionInterface having the same specifications as this object but a different time discretization.
int	getNumberOfFactors() Returns the number of factors.
int	getNumberOfPaths() Returns the number of paths.
RandomVariableInterface	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 BrownianMotionInterface.
TimeDiscretizationInterface	getTimeDiscretization() Returns the time discretization used for this set of time-discrete Brownian increments.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrownianMotionView

public BrownianMotionView(BrownianMotionInterface brownianMotion,
                          java.lang.Integer[] factors)

Create a sub-view on a Brownian motion. The result is an object implementing BrownianMotionInterface, i.e. a Brownian motion, which maps factor indices to possilby other factors of the given Brownian motion. You may use this class to change the number of factors and/or the order.

Parameters:

brownianMotion - A given Brownian motion.

factors - A map of indices i → j for i = 0,1,2,3,... given as an array of j's

Method Detail

getBrownianIncrement

public RandomVariableInterface getBrownianIncrement(int timeIndex,
                                                    int factor)

Description copied from interface: BrownianMotionInterface

Return the Brownian increment for a given timeIndex. The method returns the random variable Δ W_j(t_i) := W_j(t_i+1)-W(t_i) for the given time index i and a given factor (index) j

Specified by:

getBrownianIncrement in interface BrownianMotionInterface

Parameters:

timeIndex - The time index (corresponding to the this class's time discretization).

factor - The index of the factor (independent scalar Brownian increment).

Returns:

The factor (component) of the Brownian increments (a random variable).

getTimeDiscretization

public TimeDiscretizationInterface getTimeDiscretization()

Description copied from interface: BrownianMotionInterface

Returns the time discretization used for this set of time-discrete Brownian increments.

Specified by:

getTimeDiscretization in interface BrownianMotionInterface

Returns:

The time discretization used for this set of time-discrete Brownian increments.

getNumberOfFactors

public int getNumberOfFactors()

Description copied from interface: BrownianMotionInterface

Returns the number of factors.

Specified by:

getNumberOfFactors in interface BrownianMotionInterface

Returns:

The number of factors.

getNumberOfPaths

public int getNumberOfPaths()

Description copied from interface: BrownianMotionInterface

Returns the number of paths.

Specified by:

getNumberOfPaths in interface BrownianMotionInterface

Returns:

The number of paths.

getRandomVariableForConstant

public RandomVariableInterface getRandomVariableForConstant(double value)

Description copied from interface: BrownianMotionInterface

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 BrownianMotionInterface.

Specified by:

getRandomVariableForConstant in interface BrownianMotionInterface

Parameters:

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

Returns:

A new random variable.

getCloneWithModifiedSeed

public BrownianMotionInterface getCloneWithModifiedSeed(int seed)

Description copied from interface: BrownianMotionInterface

Return a new object implementing BrownianMotionInterface having the same specifications as this object but a different seed for the random number generator. This method is useful if you like to make Monte-Carlo samplings by changing the seed.

Specified by:

getCloneWithModifiedSeed in interface BrownianMotionInterface

Parameters:

seed - New value for the seed.

Returns:

New object implementing BrownianMotionInterface.

getCloneWithModifiedTimeDiscretization

public BrownianMotionInterface getCloneWithModifiedTimeDiscretization(TimeDiscretizationInterface newTimeDiscretization)

Description copied from interface: BrownianMotionInterface

Return a new object implementing BrownianMotionInterface having the same specifications as this object but a different time discretization.

Specified by:

getCloneWithModifiedTimeDiscretization in interface BrownianMotionInterface

Parameters:

newTimeDiscretization - New time discretization

Returns:

New object implementing BrownianMotionInterface.