HestonModelHelper | quantlib.js

calibration helper for Heston model

Hierarchy

BlackCalibrationHelper
- HestonModelHelper

Implements

Index

Enumerations

CalibrationErrorType

Methods

Properties

_alwaysForward

_alwaysForward: boolean = false

_calculated

_calculated: boolean = false

Private _calendar

_calendar: Calendar

Private _dividendYield

_dividendYield: Handle<YieldTermStructure>

Protected _engine

_engine: PricingEngine

Private _exerciseDate

_exerciseDate: Date

_frozen

_frozen: boolean = false

_isDisposed

_isDisposed: boolean = false

Protected _marketValue

_marketValue: Real

Private _maturity

_maturity: Period

_observables

_observables: Set<Observable> = new Set()

_observers

_observers: Set<Observer> = new Set()

Private _option

_option: VanillaOption

Private _s0

_s0: Handle<Quote>

Protected _shift

_shift: Real

Private _strikePrice

_strikePrice: Real

Private _tau

_tau: Time

Protected _termStructure

_termStructure: Handle<YieldTermStructure>

Private _type

_type: Type

Protected _volatility

_volatility: Handle<Quote>

Protected _volatilityType

_volatilityType: VolatilityType

alwaysForwardNotifications

alwaysForwardNotifications: () => void

Type declaration

- (): void
- Returns void

calculate

calculate: () => void

Type declaration

- (): void
- Returns void

deepUpdate

deepUpdate: () => void

Type declaration

- (): void
- Returns void

dispose

dispose: () => void

Type declaration

- (): void
- Returns void

freeze

freeze: () => void

Type declaration

- (): void
- Returns void

isDisposed

isDisposed: boolean

notifyObservers

notifyObservers: () => void

Type declaration

- (): void
- Returns void

recalculate

recalculate: () => void

Type declaration

- (): void
- Returns void

registerObserver

registerObserver: (o: Observer) => void

Type declaration

- (o: Observer): void
- Parameters
  - o: Observer
  Returns void

registerWith

registerWith: (h: Observable) => void

Type declaration

- (h: Observable): void
- Parameters
  - h: Observable
  Returns void

registerWithObservables

registerWithObservables: (o: Observer) => void

Type declaration

- (o: Observer): void
- Parameters
  - o: Observer
  Returns void

unfreeze

unfreeze: () => void

Type declaration

- (): void
- Returns void

unregisterObserver

unregisterObserver: (o: Observer) => void

Type declaration

- (o: Observer): void
- Parameters
  - o: Observer
  Returns void

unregisterWith

unregisterWith: (h: Observable) => Size

Type declaration

- (h: Observable): Size
- Parameters
  - h: Observable
  Returns Size

unregisterWithAll

unregisterWithAll: () => void

Type declaration

- (): void
- Returns void

Methods

addTimesTo

addTimesTo(): void

Overrides BlackCalibrationHelper.addTimesTo
- Defined in ql/models/equity/hestonmodelhelper.ts:62
Returns void

blackPrice

blackPrice(volatility: Real): Real

Overrides BlackCalibrationHelper.blackPrice
- Defined in ql/models/equity/hestonmodelhelper.ts:88
Parameters
- volatility: Real
Returns Real

calibrationError

calibrationError(): Real

Inherited from BlackCalibrationHelper.calibrationError

Overrides LazyObjectCalibrationHelperBase.calibrationError
- Defined in ql/models/calibrationhelper.ts:57
Returns Real

hmhInit1

hmhInit1(maturity: Period, calendar: Calendar, s0: Real, strikePrice: Real, volatility: Handle<Quote>, riskFreeRate: Handle<YieldTermStructure>, dividendYield: Handle<YieldTermStructure>, errorType?: CalibrationErrorType): HestonModelHelper

- Defined in ql/models/equity/hestonmodelhelper.ts:22
Parameters
- maturity: Period
- calendar: Calendar
- s0: Real
- strikePrice: Real
- volatility: Handle<Quote>
- riskFreeRate: Handle<YieldTermStructure>
- dividendYield: Handle<YieldTermStructure>
- Default value errorType: CalibrationErrorType = BlackCalibrationHelper.CalibrationErrorType.RelativePriceError
Returns HestonModelHelper

hmhInit2

hmhInit2(maturity: Period, calendar: Calendar, s0: Handle<Quote>, strikePrice: Real, volatility: Handle<Quote>, riskFreeRate: Handle<YieldTermStructure>, dividendYield: Handle<YieldTermStructure>, errorType?: CalibrationErrorType): HestonModelHelper

- Defined in ql/models/equity/hestonmodelhelper.ts:41
Parameters
- maturity: Period
- calendar: Calendar
- s0: Handle<Quote>
- strikePrice: Real
- volatility: Handle<Quote>
- riskFreeRate: Handle<YieldTermStructure>
- dividendYield: Handle<YieldTermStructure>
- Default value errorType: CalibrationErrorType = BlackCalibrationHelper.CalibrationErrorType.RelativePriceError
Returns HestonModelHelper

impliedVolatility

impliedVolatility(targetValue: Real, accuracy: Real, maxEvaluations: Size, minVol: Volatility, maxVol: Volatility): Volatility

Inherited from BlackCalibrationHelper.impliedVolatility
- Defined in ql/models/calibrationhelper.ts:101
Parameters
- targetValue: Real
- accuracy: Real
- maxEvaluations: Size
- minVol: Volatility
- maxVol: Volatility
Returns Volatility

init

init(volatility: Handle<Quote>, termStructure: Handle<YieldTermStructure>, calibrationErrorType?: CalibrationErrorType, type?: VolatilityType, shift?: Real): BlackCalibrationHelper

Inherited from BlackCalibrationHelper.init
- Defined in ql/models/calibrationhelper.ts:18
Parameters
- volatility: Handle<Quote>
- termStructure: Handle<YieldTermStructure>
- Default value calibrationErrorType: CalibrationErrorType = BlackCalibrationHelper.CalibrationErrorType.RelativePriceError
- Default value type: VolatilityType = VolatilityType.ShiftedLognormal
- Default value shift: Real = 0
Returns BlackCalibrationHelper

marketValue

marketValue(): Real

Inherited from BlackCalibrationHelper.marketValue
- Defined in ql/models/calibrationhelper.ts:48
Returns Real

maturity

maturity(): Time

- Defined in ql/models/equity/hestonmodelhelper.ts:100
Returns Time

modelValue

modelValue(): Real

Overrides BlackCalibrationHelper.modelValue
- Defined in ql/models/equity/hestonmodelhelper.ts:82
Returns Real

performCalculations

performCalculations(): void

Overrides BlackCalibrationHelper.performCalculations
- Defined in ql/models/equity/hestonmodelhelper.ts:64
Returns void

setPricingEngine

setPricingEngine(engine: PricingEngine): void

Inherited from BlackCalibrationHelper.setPricingEngine
- Defined in ql/models/calibrationhelper.ts:116
Parameters
- engine: PricingEngine
Returns void

update

update(): void

Inherited from LazyObjectCalibrationHelperBase.update
- Defined in mixins/ql/models/lazyobjectcalibrationhelperbase.ts:24
Returns void

volatility

volatility(): Handle<Quote>

Inherited from BlackCalibrationHelper.volatility
- Defined in ql/models/calibrationhelper.ts:40
Returns Handle<Quote>

volatilityType

volatilityType(): VolatilityType

Inherited from BlackCalibrationHelper.volatilityType
- Defined in ql/models/calibrationhelper.ts:44
Returns VolatilityType

Hierarchy

Implements

Index

Enumerations

Properties

Methods

Properties

_alwaysForward

_calculated

Private _calendar

Private _dividendYield

Protected _engine

Private _exerciseDate

_frozen

_isDisposed

Protected _marketValue

Private _maturity

_observables

_observers

Private _option

Private _s0

Protected _shift

Private _strikePrice

Private _tau

Protected _termStructure

Private _type

Protected _volatility

Protected _volatilityType

alwaysForwardNotifications

Type declaration

Returns void

calculate

Type declaration

Returns void

deepUpdate

Type declaration

Returns void

dispose

Type declaration

Returns void

freeze

Type declaration

Returns void

isDisposed

notifyObservers

Type declaration

Returns void

recalculate

Type declaration

Returns void

registerObserver

Type declaration

Parameters

o: Observer

Returns void

registerWith

Type declaration

Parameters

h: Observable

Returns void

registerWithObservables

Type declaration

Parameters

o: Observer

Returns void

unfreeze

Type declaration

Returns void

unregisterObserver

Type declaration

Parameters

o: Observer

Returns void

unregisterWith

Type declaration

Parameters

h: Observable

Returns Size

unregisterWithAll

Type declaration