Bond adapters of CashFlows functions. More...

#include <ql/pricingengines/bond/bondfunctions.hpp>

Collaboration diagram for BondFunctions:

Static Public Member Functions
Date inspectors
static Date	startDate (const Bond &bond)

static Date	maturityDate (const Bond &bond)

static bool	isTradable (const Bond &bond, Date settlementDate=Date())

CashFlow inspectors
static Leg::const_reverse_iterator	previousCashFlow (const Bond &bond, Date refDate=Date())

static Leg::const_iterator	nextCashFlow (const Bond &bond, Date refDate=Date())

static Date	previousCashFlowDate (const Bond &bond, Date refDate=Date())

static Date	nextCashFlowDate (const Bond &bond, Date refDate=Date())

static Real	previousCashFlowAmount (const Bond &bond, Date refDate=Date())

static Real	nextCashFlowAmount (const Bond &bond, Date refDate=Date())

Coupon inspectors
static Rate	previousCouponRate (const Bond &bond, Date settlementDate=Date())

static Rate	nextCouponRate (const Bond &bond, Date settlementDate=Date())

static Date	accrualStartDate (const Bond &bond, Date settlementDate=Date())

static Date	accrualEndDate (const Bond &bond, Date settlementDate=Date())

static Date	referencePeriodStart (const Bond &bond, Date settlementDate=Date())

static Date	referencePeriodEnd (const Bond &bond, Date settlementDate=Date())

static Time	accrualPeriod (const Bond &bond, Date settlementDate=Date())

static Date::serial_type	accrualDays (const Bond &bond, Date settlementDate=Date())

static Time	accruedPeriod (const Bond &bond, Date settlementDate=Date())

static Date::serial_type	accruedDays (const Bond &bond, Date settlementDate=Date())

static Real	accruedAmount (const Bond &bond, Date settlementDate=Date())

YieldTermStructure functions
static Real	cleanPrice (const Bond &bond, const YieldTermStructure &discountCurve, Date settlementDate=Date())

static Real	bps (const Bond &bond, const YieldTermStructure &discountCurve, Date settlementDate=Date())

static Rate	atmRate (const Bond &bond, const YieldTermStructure &discountCurve, Date settlementDate=Date(), Real cleanPrice=Null< Real >())

Yield (a.k.a. Internal Rate of Return, i.e. IRR) functions
static Real	cleanPrice (const Bond &bond, const InterestRate &yield, Date settlementDate=Date())

static Real	cleanPrice (const Bond &bond, Rate yield, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Date settlementDate=Date())

static Real	dirtyPrice (const Bond &bond, const InterestRate &yield, Date settlementDate=Date())

static Real	dirtyPrice (const Bond &bond, Rate yield, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Date settlementDate=Date())

static Real	bps (const Bond &bond, const InterestRate &yield, Date settlementDate=Date())

static Real	bps (const Bond &bond, Rate yield, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Date settlementDate=Date())

static Rate	yield (const Bond &bond, Real price, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Date settlementDate=Date(), Real accuracy=1.0e-10, Size maxIterations=100, Rate guess=0.05, Bond::Price::Type priceType=Bond::Price::Clean)

template<typename Solver >
static Rate	yield (const Solver &solver, const Bond &bond, Real price, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Date settlementDate=Date(), Real accuracy=1.0e-10, Rate guess=0.05, Bond::Price::Type priceType=Bond::Price::Clean)

static Time	duration (const Bond &bond, const InterestRate &yield, Duration::Type type=Duration::Modified, Date settlementDate=Date())

static Time	duration (const Bond &bond, Rate yield, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Duration::Type type=Duration::Modified, Date settlementDate=Date())

static Real	convexity (const Bond &bond, const InterestRate &yield, Date settlementDate=Date())

static Real	convexity (const Bond &bond, Rate yield, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Date settlementDate=Date())

static Real	basisPointValue (const Bond &bond, const InterestRate &yield, Date settlementDate=Date())

static Real	basisPointValue (const Bond &bond, Rate yield, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Date settlementDate=Date())

static Real	yieldValueBasisPoint (const Bond &bond, const InterestRate &yield, Date settlementDate=Date())

static Real	yieldValueBasisPoint (const Bond &bond, Rate yield, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Date settlementDate=Date())

Z-spread functions
static Real	cleanPrice (const Bond &bond, const ext::shared_ptr< YieldTermStructure > &discount, Spread zSpread, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Date settlementDate=Date())

static Spread	zSpread (const Bond &bond, Real cleanPrice, const ext::shared_ptr< YieldTermStructure > &, const DayCounter &dayCounter, Compounding compounding, Frequency frequency, Date settlementDate=Date(), Real accuracy=1.0e-10, Size maxIterations=100, Rate guess=0.0)

Detailed Description

Bond adapters of CashFlows functions.

See CashFlows for functions' documentation.

These adapters calls into CashFlows functions passing as input the Bond cashflows, the dirty price (i.e. npv) calculated from clean price, the bond settlement date (unless another date is given), zero ex-dividend days, and excluding any cashflow on the settlement date.

Prices are always clean, as per market convention.

Definition at line 54 of file bondfunctions.hpp.

Member Function Documentation

◆ startDate()

Date startDate ( const Bond & bond )

static

Definition at line 31 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maturityDate()

Date maturityDate ( const Bond & bond )

static

Definition at line 35 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isTradable()

bool isTradable	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 39 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ previousCashFlow()

Leg::const_reverse_iterator previousCashFlow	(	const Bond &	bond,
		Date	refDate = `Date()`
	)

static

Definition at line 48 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ nextCashFlow()

Leg::const_iterator nextCashFlow	(	const Bond &	bond,
		Date	refDate = `Date()`
	)

static

Definition at line 57 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ previousCashFlowDate()

Date previousCashFlowDate	(	const Bond &	bond,
		Date	refDate = `Date()`
	)

static

Definition at line 66 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextCashFlowDate()

Date nextCashFlowDate	(	const Bond &	bond,
		Date	refDate = `Date()`
	)

static

Definition at line 75 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ previousCashFlowAmount()

Real previousCashFlowAmount	(	const Bond &	bond,
		Date	refDate = `Date()`
	)

static

Definition at line 84 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ nextCashFlowAmount()

Real nextCashFlowAmount	(	const Bond &	bond,
		Date	refDate = `Date()`
	)

static

Definition at line 93 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ previousCouponRate()

Rate previousCouponRate	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 102 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextCouponRate()

Rate nextCouponRate	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 111 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ accrualStartDate()

Date accrualStartDate	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 120 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ accrualEndDate()

Date accrualEndDate	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 133 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ referencePeriodStart()

Date referencePeriodStart	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 146 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ referencePeriodEnd()

Date referencePeriodEnd	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 159 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ accrualPeriod()

Time accrualPeriod	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 172 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ accrualDays()

Date::serial_type accrualDays	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 185 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ accruedPeriod()

Time accruedPeriod	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 198 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ accruedDays()

Date::serial_type accruedDays	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 211 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ accruedAmount()

Real accruedAmount	(	const Bond &	bond,
		Date	settlementDate = `Date()`
	)

static

Definition at line 224 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cleanPrice() [1/4]

Real cleanPrice	(	const Bond &	bond,
		const YieldTermStructure &	discountCurve,
		Date	settlementDate = `Date()`
	)

static

Definition at line 239 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bps() [1/3]

Real bps	(	const Bond &	bond,
		const YieldTermStructure &	discountCurve,
		Date	settlementDate = `Date()`
	)

static

Definition at line 256 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmRate()

Rate atmRate	(	const Bond &	bond,
		const YieldTermStructure &	discountCurve,
		Date	settlementDate = `Date()`,
		Real	cleanPrice = `Null<Real>()`
	)

static

Definition at line 271 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ cleanPrice() [2/4]

Real cleanPrice	(	const Bond &	bond,
		const InterestRate &	yield,
		Date	settlementDate = `Date()`
	)

static

Definition at line 293 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ cleanPrice() [3/4]

Real cleanPrice	(	const Bond &	bond,
		Rate	yield,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Date	settlementDate = `Date()`
	)

static

Definition at line 299 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ dirtyPrice() [1/2]

Real dirtyPrice	(	const Bond &	bond,
		const InterestRate &	yield,
		Date	settlementDate = `Date()`
	)

static

Definition at line 309 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dirtyPrice() [2/2]

Real dirtyPrice	(	const Bond &	bond,
		Rate	yield,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Date	settlementDate = `Date()`
	)

static

Definition at line 325 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ bps() [2/3]

Real bps	(	const Bond &	bond,
		const InterestRate &	yield,
		Date	settlementDate = `Date()`
	)

static

Definition at line 335 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ bps() [3/3]

Real bps	(	const Bond &	bond,
		Rate	yield,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Date	settlementDate = `Date()`
	)

static

Definition at line 350 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ yield() [1/2]

Rate yield	(	const Bond &	bond,
		Real	price,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Date	settlementDate = `Date()`,
		Real	accuracy = `1.0e-10`,
		Size	maxIterations = `100`,
		Rate	guess = `0.05`,
		Bond::Price::Type	priceType = `Bond::Price::Clean`
	)

static

Definition at line 360 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ yield() [2/2]

static Rate yield	(	const Solver &	solver,
		const Bond &	bond,
		Real	price,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Date	settlementDate = `Date()`,
		Real	accuracy = `1.0e-10`,
		Rate	guess = `0.05`,
		Bond::Price::Type	priceType = `Bond::Price::Clean`
	)

static

Definition at line 160 of file bondfunctions.hpp.

Here is the call graph for this function:

◆ duration() [1/2]

Time duration	(	const Bond &	bond,
		const InterestRate &	yield,
		Duration::Type	type = `Duration::Modified`,
		Date	settlementDate = `Date()`
	)

static

Definition at line 377 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ duration() [2/2]

Time duration	(	const Bond &	bond,
		Rate	yield,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Duration::Type	type = `Duration::Modified`,
		Date	settlementDate = `Date()`
	)

static

Definition at line 393 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ convexity() [1/2]

Real convexity	(	const Bond &	bond,
		const InterestRate &	yield,
		Date	settlementDate = `Date()`
	)

static

Definition at line 404 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convexity() [2/2]

Real convexity	(	const Bond &	bond,
		Rate	yield,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Date	settlementDate = `Date()`
	)

static

Definition at line 418 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ basisPointValue() [1/2]

Real basisPointValue	(	const Bond &	bond,
		const InterestRate &	yield,
		Date	settlementDate = `Date()`
	)

static

Definition at line 428 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ basisPointValue() [2/2]

Real basisPointValue	(	const Bond &	bond,
		Rate	yield,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Date	settlementDate = `Date()`
	)

static

Definition at line 442 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ yieldValueBasisPoint() [1/2]

Real yieldValueBasisPoint	(	const Bond &	bond,
		const InterestRate &	yield,
		Date	settlementDate = `Date()`
	)

static

Definition at line 453 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ yieldValueBasisPoint() [2/2]

Real yieldValueBasisPoint	(	const Bond &	bond,
		Rate	yield,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Date	settlementDate = `Date()`
	)

static

Definition at line 467 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ cleanPrice() [4/4]

Real cleanPrice	(	const Bond &	bond,
		const ext::shared_ptr< YieldTermStructure > &	discount,
		Spread	zSpread,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Date	settlementDate = `Date()`
	)

static

Definition at line 478 of file bondfunctions.cpp.

Here is the call graph for this function:

◆ zSpread()

Spread zSpread	(	const Bond &	bond,
		Real	cleanPrice,
		const ext::shared_ptr< YieldTermStructure > &	d,
		const DayCounter &	dayCounter,
		Compounding	compounding,
		Frequency	frequency,
		Date	settlementDate = `Date()`,
		Real	accuracy = `1.0e-10`,
		Size	maxIterations = `100`,
		Rate	guess = `0.0`
	)

static

Definition at line 499 of file bondfunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ startDate()

◆ maturityDate()

◆ isTradable()

◆ previousCashFlow()

◆ nextCashFlow()

◆ previousCashFlowDate()

◆ nextCashFlowDate()

◆ previousCashFlowAmount()

◆ nextCashFlowAmount()

◆ previousCouponRate()

◆ nextCouponRate()

◆ accrualStartDate()

◆ accrualEndDate()

◆ referencePeriodStart()

◆ referencePeriodEnd()

◆ accrualPeriod()

◆ accrualDays()

◆ accruedPeriod()

◆ accruedDays()

◆ accruedAmount()

◆ cleanPrice() [1/4]

◆ bps() [1/3]

◆ atmRate()

◆ cleanPrice() [2/4]

◆ cleanPrice() [3/4]

◆ dirtyPrice() [1/2]

◆ dirtyPrice() [2/2]

◆ bps() [2/3]

◆ bps() [3/3]

◆ yield() [1/2]

◆ yield() [2/2]

◆ duration() [1/2]

◆ duration() [2/2]

◆ convexity() [1/2]

◆ convexity() [2/2]

◆ basisPointValue() [1/2]

◆ basisPointValue() [2/2]

◆ yieldValueBasisPoint() [1/2]

◆ yieldValueBasisPoint() [2/2]

◆ cleanPrice() [4/4]

◆ zSpread()