Module rates
Expand description
Single-currency interest-rate products: the two swaps, the forward-rate agreement, the money-market deposit, the STIR future, the zero-coupon swap and the tenor basis swap.
The template constructors (from_template) read the ported conventions and
the index registry and place dates the conventional way: the spot from the
template’s lag, tenors and periods advanced on the template calendar,
schedules generated forward from the effective date.
Structs§
- Cross
Currency Leg - One side of a cross-currency swap: a receive-oriented compiled leg and the identifiers naming what it is priced against.
- Cross
Currency Swap - A cross-currency swap: pay one leg, receive another, principal exchanged at both ends, valued in the pay currency.
- Forward
Rate Agreement - A forward-rate agreement: one accrual period, cash-settled at its start.
- Money
Market Deposit - A money-market deposit: principal lent at the start, principal and one simple accrual returned at maturity.
- Overnight
Indexed Swap - An overnight-indexed swap: fixed against a compounded overnight leg.
- Rate
Future - A short-term interest-rate futures position.
- Stated
Dates - The unadjusted effective and termination dates a swap was generated from — what its dated constructor takes.
- Tenor
Basis Swap - A single-currency tenor basis swap: a spread leg on one index, carrying the basis spread, received against a base leg on another index, paid. Each leg has its own schedule, day count and index window.
- Vanilla
Swap - A fixed-versus-IBOR swap.
- YoyInflation
Swap - A year-on-year inflation swap: a strip of annual index ratios against a strip of fixed coupons, each period settling on its own end date.
- Zero
Coupon Inflation Swap - A zero-coupon inflation swap: one payment each side at maturity, the inflation side paying the index’s growth over the swap’s life and the fixed side the growth its rate implies.
- Zero
Coupon Swap - A zero-coupon swap: one terminal fixed accrual against a floating side that compounds its periods’ index-window forwards, both paid at maturity.
Enums§
- Cross
Currency Error - Why a cross-currency template cannot become a swap.
- Rate
Future Error - Why a listed rate-future contract could not be booked.
Functions§
- accrual_
span 🔒 - A compiled leg’s first accrual start and last accrual end, its principal exchanges aside — the dates a cross-currency leg exchanges on.
- basis_
leg_ 🔒index - The registered term or overnight index a tenor basis leg projects on, or
CurveError::UnknownIndexnaming the codes a leg accepts — those two families, and only those. - business_
day_ 🔒on_ or_ after - The first business day on or after
dateoncal. - business_
day_ 🔒on_ or_ before - The last business day on or before
dateoncal. - index_
currency 🔒 - The currency an index’s registry row names.
- nd_
conversions 🔒 - One conversion per payment of a non-deliverable cross-currency leg, in leg
order: an initial exchange at the agreed
dealrate, a final exchange the lag before it pays, and each coupon byanchor— the lag before its payment, or before its period end for value on it (EMTA-ISDA MP8). - non_
deliverable_ 🔒legs - Both legs of a swap made non-deliverable in
settlement, with the collateral the converted payments discount on and the foreign key their forward reads. - over_
accrual 🔒 - xccy_
leg_ 🔒index legwith every IBOR coupon projected over its own accrual period rather than its index’s tenor: the same coupons, fixing on the same dates. The index a cross-currency leg floats on: the template’s own where the leg was stated on a value, else the registry’s for its code.