QuantLib
A free/open-source library for quantitative finance
Reference manual - version 1.20
Public Member Functions | List of all members
SwapSpreadIndex Class Reference

class for swap-rate spread indexes More...

#include <ql/experimental/coupons/swapspreadindex.hpp>

+ Inheritance diagram for SwapSpreadIndex:

Public Member Functions

 SwapSpreadIndex (const std::string &familyName, const ext::shared_ptr< SwapIndex > &swapIndex1, const ext::shared_ptr< SwapIndex > &swapIndex2, Real gearing1=1.0, Real gearing2=-1.0)
 
InterestRateIndex interface
Date maturityDate (const Date &valueDate) const
 
Rate forecastFixing (const Date &fixingDate) const
 It can be overridden to implement particular conventions.
 
Rate pastFixing (const Date &fixingDate) const
 
bool allowsNativeFixings ()
 check if index allows for native fixings. More...
 
- Public Member Functions inherited from InterestRateIndex
 InterestRateIndex (const std::string &familyName, const Period &tenor, Natural settlementDays, const Currency &currency, const Calendar &fixingCalendar, const DayCounter &dayCounter)
 
std::string name () const
 Returns the name of the index. More...
 
Calendar fixingCalendar () const
 returns the calendar defining valid fixing dates
 
bool isValidFixingDate (const Date &fixingDate) const
 returns TRUE if the fixing date is a valid one
 
Rate fixing (const Date &fixingDate, bool forecastTodaysFixing=false) const
 returns the fixing at the given date More...
 
void update ()
 
std::string familyName () const
 
Period tenor () const
 
Natural fixingDays () const
 
Date fixingDate (const Date &valueDate) const
 
const Currencycurrency () const
 
const DayCounterdayCounter () const
 
virtual Date valueDate (const Date &fixingDate) const
 
- Public Member Functions inherited from Index
const TimeSeries< Real > & timeSeries () const
 returns the fixing TimeSeries
 
virtual void addFixing (const Date &fixingDate, Real fixing, bool forceOverwrite=false)
 stores the historical fixing at the given date More...
 
void addFixings (const TimeSeries< Real > &t, bool forceOverwrite=false)
 stores historical fixings from a TimeSeries More...
 
template<class DateIterator , class ValueIterator >
void addFixings (DateIterator dBegin, DateIterator dEnd, ValueIterator vBegin, bool forceOverwrite=false)
 stores historical fixings at the given dates More...
 
void clearFixings ()
 clears all stored historical fixings
 
- Public Member Functions inherited from Observable
 Observable (const Observable &)
 
Observableoperator= (const Observable &)
 
void notifyObservers ()
 
- Public Member Functions inherited from Observer
 Observer (const Observer &)
 
Observeroperator= (const Observer &)
 
std::pair< iterator, bool > registerWith (const ext::shared_ptr< Observable > &)
 
void registerWithObservables (const ext::shared_ptr< Observer > &)
 
Size unregisterWith (const ext::shared_ptr< Observable > &)
 
void unregisterWithAll ()
 
virtual void deepUpdate ()
 

Inspectors

ext::shared_ptr< SwapIndexswapIndex1 ()
 
ext::shared_ptr< SwapIndexswapIndex2 ()
 
Real gearing1 () const
 
Real gearing2 () const
 

Additional Inherited Members

- Public Types inherited from Observer
typedef boost::unordered_set< ext::shared_ptr< Observable > > set_type
 
typedef set_type::iterator iterator
 
- Protected Attributes inherited from InterestRateIndex
std::string familyName_
 
Period tenor_
 
Natural fixingDays_
 
Currency currency_
 
DayCounter dayCounter_
 
std::string name_
 

Detailed Description

class for swap-rate spread indexes

Member Function Documentation

◆ allowsNativeFixings()

bool allowsNativeFixings ( )
virtual

check if index allows for native fixings.

If this returns false, calls to addFixing and similar methods will raise an exception.

Reimplemented from Index.