Options
All
  • Public
  • Public/Protected
  • All
Menu

zero-inflation-indexed swap

fixed x zero-inflation, i.e. fixed x CPI(i'th fixing)/CPI(base) versus floating + spread

Note that this does ony the inflation-vs-floating-leg. Extension to inflation-vs-fixed-leg. is simple - just replace the floating leg with a fixed leg.

Typically there are notional exchanges at the end: either inflated-notional vs notional; or just (inflated-notional - notional) vs zero. The latter is perhaphs more typical. warning Setting subtractInflationNominal to true means that the original inflation nominal is subtracted from both nominals before they are exchanged, even if they are different.

This swap can mimic a ZCIIS where [(1+q)^n - 1] is exchanged against (cpi ratio - 1), by using differnt nominals on each leg and setting subtractInflationNominal to true. ALSO - there must be just one date in each schedule.

The two legs can have different schedules, fixing (days vs lag), settlement, and roll conventions. N.B. accrual adjustment periods are already in the schedules. Trade date and swap settlement date are outside the scope of the instrument.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected _NPV

_NPV: Real

Protected _additionalResults

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

_alwaysForward

_alwaysForward: boolean = false

Private _baseCPI

_baseCPI: Real

_calculated

_calculated: boolean = false

Protected _endDiscounts

_endDiscounts: DiscountFactor[]

_engine

_engine: PricingEngine

Protected _errorEstimate

_errorEstimate: Real

Private _fairRate

_fairRate: Rate

Private _fairSpread

_fairSpread: Spread

Private _fixedDayCount

_fixedDayCount: DayCounter

Private _fixedIndex

_fixedIndex: ZeroInflationIndex

Private _fixedPaymentRoll

_fixedPaymentRoll: BusinessDayConvention

Private _fixedRate

_fixedRate: Rate

Private _fixedSchedule

_fixedSchedule: Schedule

Private _fixingDays

_fixingDays: Natural

Private _floatDayCount

_floatDayCount: DayCounter

Private _floatIndex

_floatIndex: IborIndex

Private _floatPaymentRoll

_floatPaymentRoll: BusinessDayConvention

Private _floatSchedule

_floatSchedule: Schedule

_frozen

_frozen: boolean = false

Private _inflationNominal

_inflationNominal: Real

_isDisposed

_isDisposed: boolean = false

Protected _legBPS

_legBPS: Real[]

Protected _legNPV

_legNPV: Real[]

Protected _legs

_legs: Leg[]

Private _nominal

_nominal: Real

Protected _npvDateDiscount

_npvDateDiscount: DiscountFactor

_observables

_observables: Set<Observable> = new Set()

Private _observationInterpolation

_observationInterpolation: InterpolationType

Private _observationLag

_observationLag: Period

_observers

_observers: Set<Observer> = new Set()

Protected _payer

_payer: Real[]

Private _spread

_spread: Spread

Protected _startDiscounts

_startDiscounts: DiscountFactor[]

Private _subtractInflationNominal

_subtractInflationNominal: boolean

Private _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

baseCPI

  • Returns Real

calculate

  • calculate(): void

cpiLeg

  • cpiLeg(): Leg
  • Returns Leg

deepUpdate

  • deepUpdate(): void

endDiscounts

errorEstimate

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

    Returns Real

fairRate

  • Returns Rate

fairSpread

  • Returns Spread

fetchResults

fixedDayCount

  • Returns DayCounter

fixedIndex

fixedLegNPV

  • fixedLegNPV(): Real
  • Returns Real

fixedPaymentRoll

fixedRate

  • Returns Rate

fixedSchedule

  • Returns Schedule

fixingDays

  • Returns Natural

floatDayCount

  • Returns DayCounter

floatIndex

  • Returns IborIndex

floatLeg

  • floatLeg(): Leg
  • Returns Leg

floatLegNPV

  • floatLegNPV(): Real
  • Returns Real

floatPaymentRoll

floatSchedule

  • Returns Schedule

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

inflationNominal

  • inflationNominal(): Real
  • Returns Real

init

init1

  • Parameters

    • firstLeg: Leg
    • secondLeg: Leg

    Returns Swap

init2

  • init2(legs: Leg[], payer: boolean[]): Swap
  • Parameters

    • legs: Leg[]
    • payer: boolean[]

    Returns Swap

init3

  • Parameters

    Returns Swap

isExpired

  • isExpired(): boolean

leg

  • Parameters

    Returns Leg

legBPS

  • Parameters

    Returns Real

legNPV

  • Parameters

    Returns Real

maturityDate

  • maturityDate(): Date
  • Returns Date

nominal

  • Returns Real

npvDateDiscount

observationInterpolation

observationLag

  • Returns Period

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
  • Returns void

spread

  • Returns Spread

startDate

  • startDate(): Date
  • Returns Date

startDiscounts

subtractInflationNominal

  • subtractInflationNominal(): boolean
  • Returns boolean

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