FixedVsFloatingSwap Class Reference

Fixed vs floating swap. More...

#include <ql/instruments/fixedvsfloatingswap.hpp>

Inheritance diagram for FixedVsFloatingSwap:

Classes
class	arguments
	Arguments for simple swap calculation More...
class	results
	Results from simple swap calculation More...

Public Member Functions
	FixedVsFloatingSwap (Type type, std::vector< Real > fixedNominals, Schedule fixedSchedule, Rate fixedRate, DayCounter fixedDayCount, std::vector< Real > floatingNominals, Schedule floatingSchedule, ext::shared_ptr< IborIndex > iborIndex, Spread spread, DayCounter floatingDayCount, ext::optional< BusinessDayConvention > paymentConvention=ext::nullopt, Integer paymentLag=0, const Calendar &paymentCalendar=Calendar())
Inspectors
Type	type () const
Real	nominal () const
const std::vector< Real > &	nominals () const
const std::vector< Real > &	fixedNominals () const
const Schedule &	fixedSchedule () const
Rate	fixedRate () const
const DayCounter &	fixedDayCount () const
const std::vector< Real > &	floatingNominals () const
const Schedule &	floatingSchedule () const
const ext::shared_ptr< IborIndex > &	iborIndex () const
Spread	spread () const
const DayCounter &	floatingDayCount () const
BusinessDayConvention	paymentConvention () const
const Leg &	fixedLeg () const
const Leg &	floatingLeg () const
Public Member Functions inherited from Swap
void	deepUpdate () override
Size	numberOfLegs () const
const std::vector< Leg > &	legs () const
virtual Date	startDate () const
virtual Date	maturityDate () const
Real	legBPS (Size j) const
Real	legNPV (Size j) const
DiscountFactor	startDiscounts (Size j) const
DiscountFactor	endDiscounts (Size j) const
DiscountFactor	npvDateDiscount () const
const Leg &	leg (Size j) const
bool	payer (Size j) const
bool	isExpired () const override
	returns whether the instrument might have value greater than zero.
void	setupArguments (PricingEngine::arguments *) const override
void	fetchResults (const PricingEngine::results *) const override
	Swap (const Leg &firstLeg, const Leg &secondLeg)
	Swap (const std::vector< Leg > &legs, const std::vector< bool > &payer)
Public Member Functions inherited from Instrument
Real	NPV () const
	returns the net present value of the instrument.
Real	errorEstimate () const
	returns the error estimate on the NPV when available.
const Date &	valuationDate () const
	returns the date the net present value refers to.
template<typename T>
T	result (const std::string &tag) const
	returns any additional result returned by the pricing engine.
const std::map< std::string, ext::any > &	additionalResults () const
	returns all additional result returned by the pricing engine.
void	setPricingEngine (const ext::shared_ptr< PricingEngine > &)
	set the pricing engine to be used.
Public Member Functions inherited from LazyObject
void	update () override
bool	isCalculated () const
void	forwardFirstNotificationOnly ()
void	alwaysForwardNotifications ()
void	recalculate ()
void	freeze ()
void	unfreeze ()
Public Member Functions inherited from Observable
	Observable (const Observable &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (Observable &&)=delete
void	notifyObservers ()
Public Member Functions inherited from Observer
	Observer (const Observer &)
Observer &	operator= (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 ()

Results
Real	fixedLegBPS () const
Real	fixedLegNPV () const
Rate	fairRate () const
Real	floatingLegBPS () const
Real	floatingLegNPV () const
Spread	fairSpread () const
void	setupArguments (PricingEngine::arguments *args) const override
void	fetchResults (const PricingEngine::results *) const override

Additional Inherited Members
Public Types inherited from Swap
enum	Type { Receiver = -1 , Payer = 1 }
Public Types inherited from Observer
typedef set_type::iterator	iterator
void	setupExpired () const override
	Swap (Size legs)
Protected Member Functions inherited from Instrument
void	calculate () const override
void	performCalculations () const override
std::vector< Leg >	legs_
std::vector< Real >	payer_
std::vector< Real >	legNPV_
std::vector< Real >	legBPS_
std::vector< DiscountFactor >	startDiscounts_
std::vector< DiscountFactor >	endDiscounts_
DiscountFactor	npvDateDiscount_
Protected Attributes inherited from Instrument
Real	NPV_
Real	errorEstimate_
Date	valuationDate_
std::map< std::string, ext::any >	additionalResults_
ext::shared_ptr< PricingEngine >	engine_
bool	calculated_ = false
bool	frozen_ = false
bool	alwaysForward_

Detailed Description

Fixed vs floating swap.

If no payment convention is passed, the convention of the floating-rate schedule is used.

Warning

if Settings::includeReferenceDateCashFlows() is set to true, payments occurring at the settlement date of the swap might be included in the NPV and therefore affect the fair-rate and fair-spread calculation. This might not be what you want.

Member Function Documentation

nominal()

Real nominal

(

)

const

This throws if the nominal is not constant across coupons.

nominals()

const std::vector< Real > & nominals

(

)

const

This throws if the nominals are not the same for the two legs.

setupArguments()

void setupArguments ( PricingEngine::arguments * ) const

overridevirtual

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.

Reimplemented from Instrument.

fetchResults()

void fetchResults ( const PricingEngine::results * r ) const

overridevirtual

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.

Reimplemented from Instrument.