Class AmericanOptionBlackScholesModelBoundary

java.lang.Object

net.finmath.finitedifference.assetderivativevaluation.boundaries.AmericanOptionBlackScholesModelBoundary

All Implemented Interfaces:

FiniteDifferenceBoundary

public class AmericanOptionBlackScholesModelBoundary
extends Object
implements FiniteDifferenceBoundary

Boundary condition for an AmericanOption under the FDMBlackScholesModel.

This class supports both the legacy boundary API returning double[] and the newer explicit boundary-condition API returning BoundaryCondition objects.

Author:

Andrea Mazzon, Alessandro Gnoatto

Constructor Summary

Constructors

Constructor	Description
AmericanOptionBlackScholesModelBoundary(FDMBlackScholesModel model)	Creates the boundary condition associated with a given FDMBlackScholesModel.

Method Summary

Modifier and Type	Method	Description
BoundaryCondition[]	getBoundaryConditionsAtLowerBoundary(FiniteDifferenceEquityProduct product, double time, double... stateVariables)	Returns the boundary conditions at the lower boundary.
BoundaryCondition[]	getBoundaryConditionsAtUpperBoundary(FiniteDifferenceEquityProduct product, double time, double... stateVariables)	Returns the boundary conditions at the upper boundary.

Methods inherited from class Object

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

Constructor Details

AmericanOptionBlackScholesModelBoundary

public AmericanOptionBlackScholesModelBoundary(FDMBlackScholesModel model)

Creates the boundary condition associated with a given FDMBlackScholesModel.

Parameters:

model - The Black-Scholes model used to determine risk-free and dividend discount factors.

Method Details

getBoundaryConditionsAtLowerBoundary

public BoundaryCondition[] getBoundaryConditionsAtLowerBoundary(FiniteDifferenceEquityProduct product,
 double time,
 double... stateVariables)

Description copied from interface: FiniteDifferenceBoundary

Returns the boundary conditions at the lower boundary.

The returned array is indexed by state-variable dimension.

Specified by:

getBoundaryConditionsAtLowerBoundary in interface FiniteDifferenceBoundary

Parameters:

product - The product being valued.

time - The running time.

stateVariables - The state variables specifying the boundary location.

Returns:

The lower-boundary conditions by dimension.

getBoundaryConditionsAtUpperBoundary

public BoundaryCondition[] getBoundaryConditionsAtUpperBoundary(FiniteDifferenceEquityProduct product,
 double time,
 double... stateVariables)

Description copied from interface: FiniteDifferenceBoundary

Returns the boundary conditions at the upper boundary.

The returned array is indexed by state-variable dimension.

Specified by:

getBoundaryConditionsAtUpperBoundary in interface FiniteDifferenceBoundary

Parameters:

product - The product being valued.

time - The running time.

stateVariables - The state variables specifying the boundary location.

Returns:

The upper-boundary conditions by dimension.