CPIVolatilitySurface | quantlib.js

zero inflation (i.e. CPI/RPI/HICP/etc.) volatility structures

Abstract interface. CPI volatility is always with respect to some base date. Also deal with lagged observations of an index with a (usually different) availability lag.

Hierarchy

VolatilityTermStructure
- CPIVolatilitySurface
  - ConstantCPIVolatility

Implements

Index

Properties

Protected _baseLevel

_baseLevel: Volatility

_bdc

_bdc: BusinessDayConvention

_calendar

_calendar: Calendar

_dayCounter

_dayCounter: DayCounter

_extrapolate

_extrapolate: boolean

Protected _frequency

_frequency: Frequency

Protected _indexIsInterpolated

_indexIsInterpolated: boolean

_isDisposed

_isDisposed: boolean = false

_moving

_moving: boolean

_observables

_observables: Set<Observable> = new Set()

Protected _observationLag

_observationLag: Period

_observers

_observers: Set<Observer> = new Set()

_referenceDate

_referenceDate: Date

_settlementDays

_settlementDays: Natural

_updated

_updated: boolean

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

- (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

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

baseDate

baseDate(): Date

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:104
Returns Date

baseLevel

baseLevel(): Volatility

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:145
Returns Volatility

businessDayConvention

businessDayConvention(): BusinessDayConvention

Inherited from VolatilityTermStructure.businessDayConvention
- Defined in ql/termstructures/voltermstructure.ts:46
Returns BusinessDayConvention

calendar

calendar(): Calendar

Inherited from TermStructure.calendar
- Defined in ql/termstructure.ts:151
the calendar used for reference and/or option date calculation

Returns Calendar

checkRange1

checkRange1(d: Date, extrapolate: boolean): void

Inherited from TermStructure.checkRange1
- Defined in ql/termstructure.ts:188
date-range check

Parameters
- d: Date
- extrapolate: boolean
Returns void

checkRange2

checkRange2(t: Time, extrapolate: boolean): void

Inherited from TermStructure.checkRange2
- Defined in ql/termstructure.ts:199
time-range check

Parameters
- t: Time
- extrapolate: boolean
Returns void

Protected checkRange3

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

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:160
Parameters
- d: Date
- strike: Rate
- extrapolate: boolean
Returns void

Protected checkRange4

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

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:176
Parameters
- t: Time
- strike: Rate
- extrapolate: boolean
Returns void

checkStrike

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

Inherited from VolatilityTermStructure.checkStrike
- Defined in ql/termstructures/voltermstructure.ts:64
Parameters
- k: Rate
- extrapolate: boolean
Returns void

cpivsInit

cpivsInit(settlementDays: Natural, cal: Calendar, bdc: BusinessDayConvention, dc: DayCounter, observationLag: Period, frequency: Frequency, indexIsInterpolated: boolean): CPIVolatilitySurface

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:28
Parameters
- settlementDays: Natural
- cal: Calendar
- bdc: BusinessDayConvention
- dc: DayCounter
- observationLag: Period
- frequency: Frequency
- indexIsInterpolated: boolean
Returns CPIVolatilitySurface

dayCounter

dayCounter(): DayCounter

Inherited from TermStructure.dayCounter
- Defined in ql/termstructure.ts:120
the day counter used for date/time conversion

Returns DayCounter

frequency

frequency(): Frequency

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:96
Returns Frequency

indexIsInterpolated

indexIsInterpolated(): boolean

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:100
Returns boolean

maxDate

maxDate(): Date

Inherited from TermStructure.maxDate
- Defined in ql/termstructure.ts:130
the latest date for which the curve can return values

Returns Date

maxStrike

maxStrike(): Real

Overrides VolatilityTermStructure.maxStrike
- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:156
Returns Real

maxTime

maxTime(): Time

Inherited from TermStructure.maxTime
- Defined in ql/termstructure.ts:135
the latest time for which the curve can return values

Returns Time

minStrike

minStrike(): Real

Overrides VolatilityTermStructure.minStrike
- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:152
Returns Real

observationLag

observationLag(): Period

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:92
Returns Period

optionDateFromTenor

optionDateFromTenor(p: Period): Date

Inherited from VolatilityTermStructure.optionDateFromTenor
- Defined in ql/termstructures/voltermstructure.ts:50
Parameters
- p: Period
Returns Date

referenceDate

referenceDate(): Date

Inherited from TermStructure.referenceDate
- Defined in ql/termstructure.ts:140
the date at which discount = 1.0 and/or variance = 0.0

Returns Date

settlementDays

settlementDays(): Natural

Inherited from TermStructure.settlementDays
- Defined in ql/termstructure.ts:156
the settlementDays used for reference date calculation

Returns Natural

timeFromBase

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

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:122
Parameters
- maturityDate: Date
- Default value obsLag: Period = new Period().init1(-1, TimeUnit.Days)
Returns Time

timeFromReference

timeFromReference(d: Date): Time

Inherited from TermStructure.timeFromReference
- Defined in ql/termstructure.ts:125
date/time conversion

Parameters
- d: Date
Returns Time

totalVariance1

totalVariance1(maturityDate: Date, strike: Rate, obsLag?: Period, extrapolate?: boolean): Volatility

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:74
Parameters
- maturityDate: Date
- strike: Rate
- Default value obsLag: Period = new Period().init1(-1, TimeUnit.Days)
- Default value extrapolate: boolean = false
Returns Volatility

totalVariance2

totalVariance2(tenor: Period, strike: Rate, obsLag?: Period, extrap?: boolean): Volatility

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:84
Parameters
- tenor: Period
- strike: Rate
- Default value obsLag: Period = new Period().init1(-1, TimeUnit.Days)
- Default value extrap: boolean = false
Returns Volatility

tsInit1

tsInit1(dc?: DayCounter): TermStructure

Inherited from TermStructure.tsInit1
- Defined in ql/termstructure.ts:79
Parameters
- Default value dc: DayCounter = new DayCounter()
Returns TermStructure

tsInit2

tsInit2(referenceDate: Date, calendar?: Calendar, dc?: DayCounter): TermStructure

Inherited from TermStructure.tsInit2
- Defined in ql/termstructure.ts:91
Parameters
- referenceDate: Date
- Default value calendar: Calendar = new Calendar()
- Default value dc: DayCounter = new DayCounter()
Returns TermStructure

tsInit3

tsInit3(settlementDays: Natural, calendar: Calendar, dc?: DayCounter): TermStructure

Inherited from TermStructure.tsInit3
- Defined in ql/termstructure.ts:107
Parameters
- settlementDays: Natural
- calendar: Calendar
- Default value dc: DayCounter = new DayCounter()
Returns TermStructure

update

update(): void

Inherited from TermStructure.update

Overrides ObserverObservableExtrapolator.update
- Defined in ql/termstructure.ts:163
Returns void

volatility1

volatility1(maturityDate: Date, strike: Rate, obsLag?: Period, extrapolate?: boolean): Volatility

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:40
Parameters
- maturityDate: Date
- strike: Rate
- Default value obsLag: Period = new Period().init1(-1, TimeUnit.Days)
- Default value extrapolate: boolean = false
Returns Volatility

volatility2

volatility2(optionTenor: Period, strike: Rate, obsLag?: Period, extrapolate?: boolean): Volatility

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:66
Parameters
- optionTenor: Period
- strike: Rate
- Default value obsLag: Period = new Period().init1(-1, TimeUnit.Days)
- Default value extrapolate: boolean = false
Returns Volatility

Protected volatilityImpl

volatilityImpl(length: Time, strike: Rate): Volatility

- Defined in ql/termstructures/volatility/inflation/cpivolatilitystructure.ts:191
Parameters
- length: Time
- strike: Rate
Returns Volatility

vtsInit1

vtsInit1(bdc: BusinessDayConvention, dc?: DayCounter): VolatilityTermStructure

Inherited from VolatilityTermStructure.vtsInit1
- Defined in ql/termstructures/voltermstructure.ts:21
Parameters
- bdc: BusinessDayConvention
- Default value dc: DayCounter = new DayCounter()
Returns VolatilityTermStructure

vtsInit2

vtsInit2(referenceDate: Date, cal: Calendar, bdc: BusinessDayConvention, dc?: DayCounter): VolatilityTermStructure

Inherited from VolatilityTermStructure.vtsInit2
- Defined in ql/termstructures/voltermstructure.ts:29
Parameters
- referenceDate: Date
- cal: Calendar
- bdc: BusinessDayConvention
- Default value dc: DayCounter = new DayCounter()
Returns VolatilityTermStructure

vtsInit3

vtsInit3(settlementDays: Natural, cal: Calendar, bdc: BusinessDayConvention, dc?: DayCounter): VolatilityTermStructure

Inherited from VolatilityTermStructure.vtsInit3
- Defined in ql/termstructures/voltermstructure.ts:38
Parameters
- settlementDays: Natural
- cal: Calendar
- bdc: BusinessDayConvention
- Default value dc: DayCounter = new DayCounter()
Returns VolatilityTermStructure

Hierarchy

Implements

Index

Properties

Methods

Properties

Protected _baseLevel

_bdc

_calendar

_dayCounter

_extrapolate

Protected _frequency

Protected _indexIsInterpolated

_isDisposed

_moving

_observables

Protected _observationLag

_observers

_referenceDate

_settlementDays

_updated

allowsExtrapolation

Type declaration

Returns boolean

deepUpdate

Type declaration

Returns void

disableExtrapolation

Type declaration

Parameters

Optional b: boolean

Returns void

dispose

Type declaration

Returns void

enableExtrapolation

Type declaration

Parameters

Optional b: boolean

Returns void

isDisposed

notifyObservers

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

unregisterObserver

Type declaration

Parameters

o: Observer

Returns void

unregisterWith

Type declaration

Parameters

h: Observable

Returns Size

unregisterWithAll

Type declaration

Returns void

Methods

baseDate

Returns Date

baseLevel

Returns Volatility

businessDayConvention

Returns BusinessDayConvention

calendar