Search
Preparing search index...
The search index is not available
quantlib.js
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"ql/pricingengines/vanilla/fdamericanengine"
FDAmericanEngine
Class FDAmericanEngine
Finite-differences pricing engine for American one asset options
test
the correctness of the returned value is tested by reproducing results available in literature.
the correctness of the returned greeks is tested by reproducing numerical derivatives.
Hierarchy
FDEngineAdapterOneAssetOptionEngine
FDAmericanEngine
Implements
Observable
Observer
PricingEngine
GenericEngine
<
Arguments
,
Results
>
engine
FDEngineAdapter
Index
Constructors
constructor
Properties
Scheme
_arguments
_is
Disposed
_observables
_observers
_results
base
calculate
deep
Update
dispose
engine
fdea
Init
get
Arguments
get
Results
is
Disposed
notify
Observers
register
Observer
register
With
register
With
Observables
reset
unregister
Observer
unregister
With
unregister
With
All
update
Methods
fd
Init
Constructors
constructor
new FDAmerican
Engine
(
Scheme
:
any
)
:
FDAmericanEngine
Parameters
Scheme:
any
Returns
FDAmericanEngine
Properties
Scheme
Scheme
:
any
_arguments
_arguments
:
Arguments
= new OneAssetOption.Arguments()
_is
Disposed
_is
Disposed
:
boolean
= false
_observables
_observables
:
Set
<
Observable
>
= new Set()
_observers
_observers
:
Set
<
Observer
>
= new Set()
_results
_results
:
Results
= new OneAssetOption.Results()
base
base
:
any
calculate
calculate
:
(
)
=>
void
Type declaration
(
)
:
void
Returns
void
deep
Update
deep
Update
:
(
)
=>
void
Type declaration
(
)
:
void
Returns
void
dispose
dispose
:
(
)
=>
void
Type declaration
(
)
:
void
Returns
void
engine
engine
:
any
fdea
Init
fdea
Init
:
(
process
:
GeneralizedBlackScholesProcess
, timeSteps
?:
Size
, gridPoints
?:
Size
, timeDependent
?:
boolean
)
=>
FDEngineAdapter
Type declaration
(
process
:
GeneralizedBlackScholesProcess
, timeSteps
?:
Size
, gridPoints
?:
Size
, timeDependent
?:
boolean
)
:
FDEngineAdapter
Parameters
process:
GeneralizedBlackScholesProcess
Optional
timeSteps:
Size
Optional
gridPoints:
Size
Optional
timeDependent:
boolean
Returns
FDEngineAdapter
get
Arguments
get
Arguments
:
(
)
=>
Arguments
Type declaration
(
)
:
Arguments
Returns
Arguments
get
Results
get
Results
:
(
)
=>
Results
Type declaration
(
)
:
Results
Returns
Results
is
Disposed
is
Disposed
:
boolean
notify
Observers
notify
Observers
:
(
)
=>
void
Type declaration
(
)
:
void
Returns
void
register
Observer
register
Observer
:
(
o
:
Observer
)
=>
void
Type declaration
(
o
:
Observer
)
:
void
Parameters
o:
Observer
Returns
void
register
With
register
With
:
(
h
:
Observable
)
=>
void
Type declaration
(
h
:
Observable
)
:
void
Parameters
h:
Observable
Returns
void
register
With
Observables
register
With
Observables
:
(
o
:
Observer
)
=>
void
Type declaration
(
o
:
Observer
)
:
void
Parameters
o:
Observer
Returns
void
reset
reset
:
(
)
=>
void
Type declaration
(
)
:
void
Returns
void
unregister
Observer
unregister
Observer
:
(
o
:
Observer
)
=>
void
Type declaration
(
o
:
Observer
)
:
void
Parameters
o:
Observer
Returns
void
unregister
With
unregister
With
:
(
h
:
Observable
)
=>
Size
Type declaration
(
h
:
Observable
)
:
Size
Parameters
h:
Observable
Returns
Size
unregister
With
All
unregister
With
All
:
(
)
=>
void
Type declaration
(
)
:
void
Returns
void
update
update
:
(
)
=>
void
Type declaration
(
)
:
void
Returns
void
Methods
fd
Init
fd
Init
(
process
:
GeneralizedBlackScholesProcess
, timeSteps
?:
Size
, gridPoints
?:
Size
, timeDependent
?:
boolean
)
:
FDAmericanEngine
Parameters
process:
GeneralizedBlackScholesProcess
Default value
timeSteps:
Size
= 100
Default value
gridPoints:
Size
= 100
Default value
timeDependent:
boolean
= false
Returns
FDAmericanEngine
Globals
"ql/pricingengines/vanilla/fdamericanengine"
FDAmerican
Engine
constructor
Scheme
_arguments
_is
Disposed
_observables
_observers
_results
base
calculate
deep
Update
dispose
engine
fdea
Init
get
Arguments
get
Results
is
Disposed
notify
Observers
register
Observer
register
With
register
With
Observables
reset
unregister
Observer
unregister
With
unregister
With
All
update
fd
Init
Finite-differences pricing engine for American one asset options