Options
All
  • Public
  • Public/Protected
  • All
Menu

Cash flow dependent on an index ratio.

This cash flow is not a coupon, i.e., there's no accrual. The amount is either i(T)/i(0) or i(T)/i(0) - 1, depending on the growthOnly parameter.

We expect this to be used inside an instrument that does all the date adjustment etc., so this takes just dates and does not change them. growthOnly = false means i(T)/i(0), which is a bond-type setting. growthOnly = true means i(T)/i(0) - 1, which is a swap-type setting.

Hierarchy

Implements

Index

Constructors

constructor

  • new IndexedCashFlow(notional: Real, index: Index, baseDate: Date, fixingDate: Date, paymentDate: Date, growthOnly?: boolean): IndexedCashFlow
  • Parameters

    • notional: Real
    • index: Index
    • baseDate: Date
    • fixingDate: Date
    • paymentDate: Date
    • Default value growthOnly: boolean = false

    Returns IndexedCashFlow

Properties

Private _baseDate

_baseDate: Date

Private _fixingDate

_fixingDate: Date

Private _growthOnly

_growthOnly: boolean

Private _index

_index: Index

_isDisposed

_isDisposed: boolean = false

Private _notional

_notional: Real

_observables

_observables: Set<Observable> = new Set()

_observers

_observers: Set<Observer> = new Set()

Private _paymentDate

_paymentDate: Date

deepUpdate

deepUpdate: () => void

Type declaration

    • (): void
    • Returns void

dispose

dispose: () => void

Type declaration

    • (): void
    • Returns void

exCouponDate

exCouponDate: () => Date

Type declaration

    • (): Date
    • Returns Date

hasOccurred

hasOccurred: (refDate: Date, includeRefDate: boolean) => boolean

Type declaration

    • (refDate: Date, includeRefDate: boolean): boolean
    • Parameters

      • refDate: Date
      • includeRefDate: boolean

      Returns boolean

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

tradingExCoupon

tradingExCoupon: () => boolean

Type declaration

    • (): boolean
    • Returns boolean

unregisterObserver

unregisterObserver: (o: Observer) => void

Type declaration

unregisterWith

unregisterWith: (h: Observable) => Size

Type declaration

unregisterWithAll

unregisterWithAll: () => void

Type declaration

    • (): void
    • Returns void

Methods

accept

amount1

baseDate

  • baseDate(): Date
  • Returns Date

date

  • date(): Date

fixingDate

  • fixingDate(): Date
  • Returns Date

growthOnly

  • growthOnly(): boolean
  • Returns boolean

index

  • Returns Index

notional

  • Returns Real

update

  • update(): void