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/capfloor/blackcapfloorengine"
BlackCapFloorEngine
Class BlackCapFloorEngine
Black-formula cap/floor engine
Hierarchy
engine
BlackCapFloorEngine
Implements
Observable
Observer
PricingEngine
Index
Constructors
constructor
Properties
_arguments
_discount
Curve
_displacement
_is
Disposed
_observables
_observers
_results
_vol
deep
Update
dispose
is
Disposed
notify
Observers
register
Observer
register
With
register
With
Observables
unregister
Observer
unregister
With
unregister
With
All
Methods
calculate
displacement
get
Arguments
get
Results
init1
init2
init3
reset
term
Structure
update
volatility
Constructors
constructor
new
Black
Cap
Floor
Engine
(
)
:
BlackCapFloorEngine
Returns
BlackCapFloorEngine
Properties
_arguments
_arguments
:
Arguments
Private
_discount
Curve
_discount
Curve
:
Handle
<
YieldTermStructure
>
Private
_displacement
_displacement
:
Real
_is
Disposed
_is
Disposed
:
boolean
= false
_observables
_observables
:
Set
<
Observable
>
= new Set()
_observers
_observers
:
Set
<
Observer
>
= new Set()
_results
_results
:
Results
Private
_vol
_vol
:
Handle
<
OptionletVolatilityStructure
>
deep
Update
deep
Update
:
(
)
=>
void
Type declaration
(
)
:
void
Returns
void
dispose
dispose
:
(
)
=>
void
Type declaration
(
)
:
void
Returns
void
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
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
Methods
calculate
calculate
(
)
:
void
Returns
void
displacement
displacement
(
)
:
Real
Returns
Real
get
Arguments
get
Arguments
(
)
:
Arguments
Returns
Arguments
get
Results
get
Results
(
)
:
Results
Returns
Results
init1
init1
(
discountCurve
:
Handle
<
YieldTermStructure
>
, vol
:
Volatility
, dc
?:
DayCounter
, displacement
?:
Real
)
:
BlackCapFloorEngine
Parameters
discountCurve:
Handle
<
YieldTermStructure
>
vol:
Volatility
Default value
dc:
DayCounter
= new Actual365Fixed()
Default value
displacement:
Real
= 0
Returns
BlackCapFloorEngine
init2
init2
(
discountCurve
:
Handle
<
YieldTermStructure
>
, vol
:
Handle
<
Quote
>
, dc
?:
DayCounter
, displacement
?:
Real
)
:
BlackCapFloorEngine
Parameters
discountCurve:
Handle
<
YieldTermStructure
>
vol:
Handle
<
Quote
>
Default value
dc:
DayCounter
= new Actual365Fixed()
Default value
displacement:
Real
= 0
Returns
BlackCapFloorEngine
init3
init3
(
discountCurve
:
Handle
<
YieldTermStructure
>
, vol
:
Handle
<
OptionletVolatilityStructure
>
, displacement
?:
Real
)
:
BlackCapFloorEngine
Parameters
discountCurve:
Handle
<
YieldTermStructure
>
vol:
Handle
<
OptionletVolatilityStructure
>
Default value
displacement:
Real
= QL_NULL_REAL
Returns
BlackCapFloorEngine
reset
reset
(
)
:
void
Returns
void
term
Structure
term
Structure
(
)
:
Handle
<
YieldTermStructure
>
Returns
Handle
<
YieldTermStructure
>
update
update
(
)
:
void
Returns
void
volatility
volatility
(
)
:
Handle
<
OptionletVolatilityStructure
>
Returns
Handle
<
OptionletVolatilityStructure
>
Globals
"ql/pricingengines/capfloor/blackcapfloorengine"
Black
Cap
Floor
Engine
constructor
_arguments
_discount
Curve
_displacement
_is
Disposed
_observables
_observers
_results
_vol
deep
Update
dispose
is
Disposed
notify
Observers
register
Observer
register
With
register
With
Observables
unregister
Observer
unregister
With
unregister
With
All
calculate
displacement
get
Arguments
get
Results
init1
init2
init3
reset
term
Structure
update
volatility
Black-formula cap/floor engine