Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

Properties

_baseLevel

_baseLevel: Volatility

_bdc

_calendar

_calendar: Calendar

Protected _capFloorPrices

_dayCounter

_dayCounter: DayCounter

_extrapolate

_extrapolate: boolean

Protected _factory1D

_factory1D: Interpolator

_frequency

_frequency: Frequency

_indexIsInterpolated

_indexIsInterpolated: boolean

_isDisposed

_isDisposed: boolean = false

Protected _lastDate

_lastDate: Date

Protected _lastDateisSet

_lastDateisSet: boolean

_moving

_moving: boolean

_observables

_observables: Set<Observable> = new Set()

_observationLag

_observationLag: Period

_observers

_observers: Set<Observer> = new Set()

_referenceDate

_referenceDate: Date

_settlementDays

_settlementDays: Natural

Protected _slice

_slice: [Rate[], Volatility[]]

Protected _slope

_slope: Real

Protected _tempKinterpolation

_tempKinterpolation: Interpolation

_updated

_updated: boolean

Protected _yoyInflationCouponPricer

_yoyInflationCouponPricer: YoYInflationCapFloorEngine

Protected _yoyOptionletStripper

_yoyOptionletStripper: YoYOptionletStripper

allowsExtrapolation

allowsExtrapolation: () => boolean

Type declaration

    • (): boolean
    • Returns boolean

deepUpdate

deepUpdate: () => void

Type declaration

    • (): void
    • Returns void

disableExtrapolation

disableExtrapolation: (b?: boolean) => void

Type declaration

    • (b?: boolean): void
    • Parameters

      • Optional b: boolean

      Returns void

dispose

dispose: () => void

Type declaration

    • (): void
    • Returns void

enableExtrapolation

enableExtrapolation: (b?: boolean) => void

Type declaration

    • (b?: boolean): void
    • Parameters

      • Optional b: boolean

      Returns void

isDisposed

isDisposed: boolean

notifyObservers

notifyObservers: () => void

Type declaration

    • (): void
    • Returns void

registerObserver

registerObserver: (o: Observer) => void

Type declaration

registerWith

registerWith: (h: Observable) => void

Type declaration

registerWithObservables

registerWithObservables: (o: Observer) => void

Type declaration

unregisterObserver

unregisterObserver: (o: Observer) => void

Type declaration

unregisterWith

unregisterWith: (h: Observable) => Size

Type declaration

unregisterWithAll

unregisterWithAll: () => void

Type declaration

    • (): void
    • Returns void

Methods

Dslice

  • Parameters

    • d: Date

    Returns [Rate[], Volatility[]]

baseDate

  • baseDate(): Date

baseLevel

businessDayConvention

calendar

  • the calendar used for reference and/or option date calculation

    Returns Calendar

checkRange1

  • checkRange1(d: Date, extrapolate: boolean): void
  • date-range check

    Parameters

    • d: Date
    • extrapolate: boolean

    Returns void

checkRange2

  • checkRange2(t: Time, extrapolate: boolean): void
  • time-range check

    Parameters

    • t: Time
    • extrapolate: boolean

    Returns void

checkRange3

  • checkRange3(d: Date, strike: Rate, extrapolate: boolean): void
  • Parameters

    • d: Date
    • strike: Rate
    • extrapolate: boolean

    Returns void

checkRange4

  • checkRange4(t: Time, strike: Rate, extrapolate: boolean): void

checkStrike

  • checkStrike(k: Rate, extrapolate: boolean): void

dayCounter

frequency

indexIsInterpolated

  • indexIsInterpolated(): boolean

kiyoyovsInit

maxDate

  • maxDate(): Date
  • Returns Date

maxStrike

maxTime

  • the latest time for which the curve can return values

    Returns Time

minStrike

observationLag

  • The TS observes with a lag that is usually different from the availability lag of the index. An inflation rate is given, by default, for the maturity requested assuming this lag.

    Returns Period

optionDateFromTenor

  • optionDateFromTenor(p: Period): Date

performCalculations

  • performCalculations(): void
  • Returns void

referenceDate

  • referenceDate(): Date
  • the date at which discount = 1.0 and/or variance = 0.0

    Returns Date

setBaseLevel

settlementDays

timeFromBase

  • timeFromBase(maturityDate: Date, obsLag?: Period): Time
  • Parameters

    • maturityDate: Date
    • Default value obsLag: Period = new Period().init1(-1, TimeUnit.Days)

    Returns Time

timeFromReference

  • timeFromReference(d: Date): Time

totalVariance1

  • totalVariance1(maturityDate: Date, strike: Rate, obsLag?: Period, extrapolate?: boolean): Volatility
  • Returns the total integrated variance for a given exercise date and strike rate. Total integrated variance is useful because it scales out t for the optionlet pricing formulae. Note that it is called "total" because the surface does not know whether it represents Black, Bachelier or Displaced Diffusion variance. These are virtual so alternate connections between const vol and total var are possible.

    Because inflation is highly linked to dates (for interpolation, periods, etc) we do NOT provide a time version

    Parameters

    • maturityDate: Date
    • strike: Rate
    • Default value obsLag: Period = new Period().init1(-1, TimeUnit.Days)
    • Default value extrapolate: boolean = false

    Returns Volatility

totalVariance2

tsInit1

tsInit2

tsInit3

update

  • update(): void

Private updateSlice

  • updateSlice(d: Date): void
  • Parameters

    • d: Date

    Returns void

volatility1

  • Returns the volatility for a given maturity date and strike rate that observes inflation, by default, with the observation lag of the term structure. Because inflation is highly linked to dates (for interpolation, periods, etc) we do NOT provide a time version.

    Parameters

    • maturityDate: Date
    • strike: Rate
    • Default value obsLag: Period = new Period().init1(-1, TimeUnit.Days)
    • Default value extrapolate: boolean = false

    Returns Volatility

volatility2

  • Parameters

    • optionTenor: Period
    • strike: Rate
    • Default value obsLag: Period = new Period().init1(-1, TimeUnit.Days)
    • Default value extrapolate: boolean = false

    Returns Volatility

volatilityImpl

  • Implements the actual volatility surface calculation in derived classes e.g. bilinear interpolation. N.B. does not derive the surface.

    Parameters

    Returns Volatility

volatilityImpl1

  • Parameters

    • d: Date
    • strike: Rate

    Returns Volatility

volatilityImpl2

  • Parameters

    Returns Volatility

vtsInit1

vtsInit2

vtsInit3

yoyovsInit