OISRateHelper | quantlib.js

Rate helper for bootstrapping over Overnight Indexed Swap rates

Hierarchy

RelativeDateBootstrapHelper
- OISRateHelper

Implements

Index

Constructors

constructor

Methods

Constructors

constructor

new OISRateHelper(settlementDays: Natural, tenor: Period, fixedRate: Handle<Quote>, overnightIndex: OvernightIndex, discount?: Handle<YieldTermStructure>, telescopicValueDates?: boolean, paymentLag?: Natural, paymentConvention?: BusinessDayConvention, paymentFrequency?: Frequency, paymentCalendar?: Calendar, forwardStart?: Period, overnightSpread?: Spread): OISRateHelper

- Defined in ql/termstructures/yield/oisratehelper.ts:21
Parameters
- settlementDays: Natural
- tenor: Period
- fixedRate: Handle<Quote>
- overnightIndex: OvernightIndex
- Default value discount: Handle<YieldTermStructure> = new Handle()
- Default value telescopicValueDates: boolean = false
- Default value paymentLag: Natural = 0
- Default value paymentConvention: BusinessDayConvention = BusinessDayConvention.Following
- Default value paymentFrequency: Frequency = Frequency.Annual
- Default value paymentCalendar: Calendar = new Calendar()
- Default value forwardStart: Period = new Period().init1(0, TimeUnit.Days)
- Default value overnightSpread: Spread = 0
Returns OISRateHelper

Properties

Protected _discountHandle

_discountHandle: Handle<YieldTermStructure>

Protected _discountRelinkableHandle

_discountRelinkableHandle: RelinkableHandle<YieldTermStructure> = new RelinkableHandle()

Protected _earliestDate

_earliestDate: Date

Protected _evaluationDate

_evaluationDate: Date

Protected _forwardStart

_forwardStart: Period

_isDisposed

_isDisposed: boolean = false

Protected _latestDate

_latestDate: Date

Protected _latestRelevantDate

_latestRelevantDate: Date

Protected _maturityDate

_maturityDate: Date

_observables

_observables: Set<Observable> = new Set()

_observers

_observers: Set<Observer> = new Set()

Protected _overnightIndex

_overnightIndex: OvernightIndex

Protected _overnightSpread

_overnightSpread: Spread

Protected _paymentCalendar

_paymentCalendar: Calendar

Protected _paymentConvention

_paymentConvention: BusinessDayConvention

Protected _paymentFrequency

_paymentFrequency: Frequency

Protected _paymentLag

_paymentLag: Natural

Protected _pillarDate

_pillarDate: Date

Protected _quote

_quote: Handle<Quote>

Protected _settlementDays

_settlementDays: Natural

Protected _swap

_swap: OvernightIndexedSwap

Protected _telescopicValueDates

_telescopicValueDates: boolean

Protected _tenor

_tenor: Period

Protected _termStructure

_termStructure: Curve

Protected _termStructureHandle

_termStructureHandle: RelinkableHandle<YieldTermStructure> = new RelinkableHandle()

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

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

accept

accept(v: AcyclicVisitor): void

Overrides BootstrapHelper.accept
- Defined in ql/termstructures/yield/oisratehelper.ts:109
Parameters
- v: AcyclicVisitor
Returns void

bshInit1

bshInit1(quote: Handle<Quote>): BootstrapHelper

Inherited from BootstrapHelper.bshInit1
- Defined in ql/termstructures/bootstraphelper.ts:42
Parameters
- quote: Handle<Quote>
Returns BootstrapHelper

bshInit2

bshInit2(quote: Real): BootstrapHelper

Inherited from BootstrapHelper.bshInit2
- Defined in ql/termstructures/bootstraphelper.ts:50
Parameters
- quote: Real
Returns BootstrapHelper

deepUpdate

deepUpdate(): void

Inherited from ObserverObservable.deepUpdate
- Defined in mixins/ql/patterns/observerobservable.ts:23
Returns void

earliestDate

earliestDate(): Date

Inherited from BootstrapHelper.earliestDate
- Defined in ql/termstructures/bootstraphelper.ts:93
earliest relevant date

The earliest date at which data are needed by the helper in order to provide a quote.

Returns Date

impliedQuote

impliedQuote(): Real

Overrides BootstrapHelper.impliedQuote
- Defined in ql/termstructures/yield/oisratehelper.ts:52
Returns Real

Protected initializeDates

initializeDates(): void

Overrides RelativeDateBootstrapHelper.initializeDates
- Defined in ql/termstructures/yield/oisratehelper.ts:83
Returns void

latestDate

latestDate(): Date

Inherited from BootstrapHelper.latestDate
- Defined in ql/termstructures/bootstraphelper.ts:126
Returns Date

latestRelevantDate

latestRelevantDate(): Date

Inherited from BootstrapHelper.latestRelevantDate
- Defined in ql/termstructures/bootstraphelper.ts:112
latest relevant date

The latest date at which data are needed by the helper in order to provide a quote. It does not necessarily equal the maturity of the underlying instrument.

Returns Date

maturityDate

maturityDate(): Date

Inherited from BootstrapHelper.maturityDate
- Defined in ql/termstructures/bootstraphelper.ts:98
instrument's maturity date

Returns Date

pillarDate

pillarDate(): Date

Inherited from BootstrapHelper.pillarDate
- Defined in ql/termstructures/bootstraphelper.ts:119
Returns Date

quote

quote(): Handle<Quote>

Inherited from BootstrapHelper.quote
- Defined in ql/termstructures/bootstraphelper.ts:56
Returns Handle<Quote>

quoteError

quoteError(): Real

Inherited from BootstrapHelper.quoteError
- Defined in ql/termstructures/bootstraphelper.ts:64
Returns Real

rdbshInit1

rdbshInit1(quote: Handle<Quote>): void

Inherited from RelativeDateBootstrapHelper.rdbshInit1
- Defined in ql/termstructures/bootstraphelper.ts:165
Parameters
- quote: Handle<Quote>
Returns void

rdbshInit2

rdbshInit2(quote: Real): void

Inherited from RelativeDateBootstrapHelper.rdbshInit2
- Defined in ql/termstructures/bootstraphelper.ts:172
Parameters
- quote: Real
Returns void

setTermStructure

setTermStructure(t: YieldTermStructure): void

Overrides BootstrapHelper.setTermStructure
- Defined in ql/termstructures/yield/oisratehelper.ts:61
Parameters
- t: YieldTermStructure
Returns void

swap

swap(): OvernightIndexedSwap

- Defined in ql/termstructures/yield/oisratehelper.ts:79
Returns OvernightIndexedSwap

update

update(): void

Inherited from RelativeDateBootstrapHelper.update

Overrides BootstrapHelper.update
- Defined in ql/termstructures/bootstraphelper.ts:178
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

settlementDays: Natural

tenor: Period

fixedRate: Handle<Quote>

overnightIndex: OvernightIndex

Default value discount: Handle<YieldTermStructure> = new Handle()

Default value telescopicValueDates: boolean = false

Default value paymentLag: Natural = 0

Default value paymentConvention: BusinessDayConvention = BusinessDayConvention.Following

Default value paymentFrequency: Frequency = Frequency.Annual

Default value paymentCalendar: Calendar = new Calendar()

Default value forwardStart: Period = new Period().init1(0, TimeUnit.Days)

Default value overnightSpread: Spread = 0

Returns OISRateHelper

Properties

Protected _discountHandle

Protected _discountRelinkableHandle

Protected _earliestDate

Protected _evaluationDate

Protected _forwardStart

_isDisposed

Protected _latestDate

Protected _latestRelevantDate

Protected _maturityDate

_observables

_observers

Protected _overnightIndex

Protected _overnightSpread

Protected _paymentCalendar

Protected _paymentConvention

Protected _paymentFrequency

Protected _paymentLag

Protected _pillarDate

Protected _quote

Protected _settlementDays

Protected _swap

Protected _telescopicValueDates

Protected _tenor

Protected _termStructure

Protected _termStructureHandle

dispose

Type declaration

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