Options
All
  • Public
  • Public/Protected
  • All
Menu

CPI cap or floor

Quoted as a fixed strike rate $ K $. Payoff: $$ P_n(0,T) \max(y (N [(1+K)^{T}-1] - N \left[ \frac{I(T)}{I(0)} -1 \right]), 0) $$ where $ T $ is the maturity time, $ P_n(0,t) $ is the nominal discount factor at time $ t $, $ N $ is the notional, and $ I(t) $ is the inflation index value at time $ t $.

Inflation is generally available on every day, including holidays and weekends. Hence there is a variable to state whether the observe/fix dates for inflation are adjusted or not. The default is not to adjust.

N.B. a cpi cap or floor is an option, not a cap or floor on a coupon. Thus this is very similar to a ZCIIS and has a single flow, this is as usual for cpi because it is cumulative up to option maturity from base date.

We do not inherit from Option, although this would be reasonable, because we do not have that degree of generality.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected _NPV

_NPV: Real

Protected _additionalResults

_additionalResults: Map<string, any> = new Map<string, any>()

_alwaysForward

_alwaysForward: boolean = false

Protected _baseCPI

_baseCPI: Real

_calculated

_calculated: boolean = false

_engine

_engine: PricingEngine

Protected _errorEstimate

_errorEstimate: Real

Protected _fixCalendar

_fixCalendar: Calendar

Protected _fixConvention

_fixConvention: BusinessDayConvention

Protected _fixDate

_fixDate: Date

_frozen

_frozen: boolean = false

Protected _infIndex

_isDisposed

_isDisposed: boolean = false

Protected _maturity

_maturity: Date

Protected _nominal

_nominal: Real

_observables

_observables: Set<Observable> = new Set()

Protected _observationInterpolation

_observationInterpolation: InterpolationType

Protected _observationLag

_observationLag: Period

_observers

_observers: Set<Observer> = new Set()

Protected _payCalendar

_payCalendar: Calendar

Protected _payConvention

_payConvention: BusinessDayConvention

Protected _payDate

_payDate: Date

Protected _startDate

_startDate: Date

Protected _strike

_strike: Rate

Protected _type

_type: Type

Protected _valuationDate

_valuationDate: Date

dispose

dispose: () => void

Type declaration

    • (): void
    • 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

NPV

  • returns the net present value of the instrument.

    Returns Real

additionalResults

  • additionalResults(): Map<string, any>
  • returns all additional result returned by the pricing engine.

    Returns Map<string, any>

alwaysForwardNotifications

  • alwaysForwardNotifications(): void
  • This method causes the object to forward all notifications, even when not calculated. The default behavior is to forward the first notification received, and discard the others until recalculated; the rationale is that observers were already notified, and don't need further notification until they recalculate, at which point this object would be recalculated too. After recalculation, this object would again forward the first notification received.

    warning Forwarding all notifications will cause a performance hit, and should be used only when discarding notifications cause an incorrect behavior.

    Returns void

calculate

  • calculate(): void

deepUpdate

  • deepUpdate(): void

errorEstimate

  • errorEstimate(): Real
  • returns the error estimate on the NPV when available.

    Returns Real

fetchResults

fixingDate

  • fixingDate(): Date
  • Returns Date

freeze

  • freeze(): void
  • This method constrains the object to return the presently cached results on successive invocations, even if arguments upon which they depend should change.

    Returns void

inflationIndex

init

isExpired

  • isExpired(): boolean

nominal

  • Returns Real

observationLag

  • Returns Period

payDate

  • payDate(): Date
  • Returns Date

performCalculations

  • performCalculations(): void

recalculate

  • recalculate(): void
  • This method force the recalculation of any results which would otherwise be cached. It is not declared as const since it needs to call the non-const notifyObservers method.

    note Explicit invocation of this method is not necessary if the object registered itself as observer with the structures on which such results depend. It is strongly advised to follow this policy when possible.

    Returns void

result

  • result(tag: string): any
  • returns any additional result returned by the pricing engine.

    Parameters

    • tag: string

    Returns any

setPricingEngine

  • set the pricing engine to be used.

    warning calling this method will have no effects in case the performCalculation method was overridden in a derived class.

    Parameters

    Returns void

setupArguments

setupExpired

  • setupExpired(): void
  • This method must leave the instrument in a consistent state when the expiration condition is met.

    Returns void

strike

  • $ K $ in the above formula.

    Returns Rate

type

  • Returns Type

unfreeze

  • unfreeze(): void
  • This method reverts the effect of the freeze method, thus re-enabling recalculations.

    Returns void

update

  • update(): void

valuationDate

  • valuationDate(): Date
  • returns the date the net present value refers to.

    Returns Date