Options
All
  • Public
  • Public/Protected
  • All
Menu

Forward rate agreement (FRA) class

  1. Unlike the forward contract conventions on carryable financial assets (stocks, bonds, commodities), the valueDate for a FRA is taken to be the day when the forward loan or deposit begins and when full settlement takes place (based on the NPV of the contract on that date). maturityDate is the date when the forward loan or deposit ends. In fact, the FRA settles and expires on the valueDate, not on the (later) maturityDate. It follows that (maturityDate - valueDate) is the tenor/term of the underlying loan or deposit

  2. Choose position type = Long for an "FRA purchase" (future long loan, short deposit [borrower])

  3. Choose position type = Short for an "FRA sale" (future short loan, long deposit [lender])

  4. If strike is given in the constructor, can calculate the NPV of the contract via NPV().

  5. If forward rate is desired/unknown, it can be obtained via forwardRate(). In this case, the strike variable in the constructor is irrelevant and will be ignored.

Example: link examples\FRA.ts

todo Add preconditions and tests

todo Should put an instance of ForwardRateAgreement in the FraRateHelper to ensure consistency with the piecewise yield curve.

todo Differentiate between BBA (British)/AFB (French) assumed here and ABA (Australian) banker conventions in the calculations.

warning This class still needs to be rigorously tested

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 _businessDayConvention

_businessDayConvention: BusinessDayConvention

_calculated

_calculated: boolean = false

Protected _calendar

_calendar: Calendar

Protected _dayCounter

_dayCounter: DayCounter

Protected _discountCurve

_discountCurve: Handle<YieldTermStructure>

_engine

_engine: PricingEngine

Protected _errorEstimate

_errorEstimate: Real

Protected _forwardRate

_forwardRate: InterestRate

Protected _fraType

_fraType: Type

_frozen

_frozen: boolean = false

Protected _incomeDiscountCurve

_incomeDiscountCurve: Handle<YieldTermStructure>

Protected _index

_index: IborIndex

_isDisposed

_isDisposed: boolean = false

Protected _maturityDate

_maturityDate: Date

Protected _notionalAmount

_notionalAmount: Real

_observables

_observables: Set<Observable> = new Set()

_observers

_observers: Set<Observer> = new Set()

Protected _payoff

_payoff: Payoff

Protected _settlementDays

_settlementDays: Natural

Protected _strikeForwardRate

_strikeForwardRate: InterestRate

Protected _underlyingIncome

_underlyingIncome: Real

Protected _underlyingSpotValue

_underlyingSpotValue: Real

Protected _valuationDate

_valuationDate: Date

Protected _valueDate

_valueDate: 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

businessDayConvention

calculate

  • calculate(): void

calendar

dayCounter

deepUpdate

  • deepUpdate(): void

discountCurve

errorEstimate

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

    Returns Real

fetchResults

  • When a derived result structure is defined for an instrument, this method should be overridden to read from it. This is mandatory in case a pricing engine is used.

    Parameters

    Returns void

fixingDate

  • fixingDate(): Date
  • Returns Date

forwardRate

  • Returns InterestRate

forwardValue

  • forwardValue(): Real
  • forward value/price of underlying, discounting income/dividends note if this is a bond forward price, is must be a dirty forward price.

    Returns Real

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

impliedYield

  • Simple yield calculation based on underlying spot and forward values, taking into account underlying income. When $ t>0 $, call with: underlyingSpotValue=spotValue(t), forwardValue=strikePrice, to get current yield. For a repo, if $ t=0 $, impliedYield should reproduce the spot repo rate. For FRA's, this should reproduce the relevant zero rate at the FRA's _maturityDate;

    Parameters

    Returns InterestRate

incomeDiscountCurve

init

isExpired

  • isExpired(): boolean
  • Returns boolean

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

settlementDate

  • settlementDate(): Date

setupArguments

  • When a derived argument structure is defined for an instrument, this method should be overridden to fill it. This is mandatory in case a pricing engine is used.

    Parameters

    Returns void

setupExpired

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

    Returns void

spotIncome

spotValue

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