Class AmericanOptionBachelierModelBoundary

java.lang.Object

net.finmath.finitedifference.assetderivativevaluation.boundaries.AmericanOptionBachelierModelBoundary

All Implemented Interfaces:

FiniteDifferenceBoundary

public class AmericanOptionBachelierModelBoundary
extends Object
implements FiniteDifferenceBoundary

Boundary conditions for AmericanOption under the FDMBachelierModel.

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

Author:

Alessandro Gnoatto

Constructor Summary

Constructors

Constructor	Description
AmericanOptionBachelierModelBoundary(FDMBachelierModel model)	Performs the operation.

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

AmericanOptionBachelierModelBoundary

public AmericanOptionBachelierModelBoundary(FDMBachelierModel model)

Performs the operation.

Parameters:

model - The value.

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.