QuantLib: FractionalDividend Class Reference

Predetermined cash flow. More...

#include <dividend.hpp>

Inheritance diagram for FractionalDividend:

Collaboration diagram for FractionalDividend:

Public Member Functions
	FractionalDividend (Real rate, const Date &date)

	FractionalDividend (Real rate, Real nominal, const Date &date)

Dividend interface
Real	amount () const override
	returns the amount of the cash flow More...

Real	amount (Real underlying) const override

Public Member Functions inherited from Dividend
	Dividend (const Date &date)

Date	date () const override

void	accept (AcyclicVisitor &) override

Public Member Functions inherited from CashFlow
	~CashFlow () override=default

bool	hasOccurred (const Date &refDate=Date(), ext::optional< bool > includeRefDate=ext::nullopt) const override
	returns true if an event has already occurred before a date More...

void	performCalculations () const override

virtual Date	exCouponDate () const
	returns the date that the cash flow trades exCoupon More...

bool	tradingExCoupon (const Date &refDate=Date()) const
	returns true if the cashflow is trading ex-coupon on the refDate More...

Public Member Functions inherited from Event
	~Event () override=default

Public Member Functions inherited from Observable
	Observable ()=default

	Observable (const Observable &)

Observable &	operator= (const Observable &)

	Observable (Observable &&)=delete

Observable &	operator= (Observable &&)=delete

virtual	~Observable ()=default

void	notifyObservers ()

Public Member Functions inherited from LazyObject
	LazyObject ()

	~LazyObject () override=default

void	update () override

bool	isCalculated () const

void	forwardFirstNotificationOnly ()

void	alwaysForwardNotifications ()

void	recalculate ()

void	freeze ()

void	unfreeze ()

Public Member Functions inherited from Observer
	Observer ()=default

	Observer (const Observer &)

Observer &	operator= (const Observer &)

virtual	~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	update ()=0

virtual void	deepUpdate ()

Inspectors
Real	rate_

Real	nominal_

Real	rate () const

Real	nominal () const

Additional Inherited Members
Public Types inherited from Observer
typedef set_type::iterator	iterator

Protected Member Functions inherited from LazyObject
virtual void	calculate () const

Protected Attributes inherited from Dividend
Date	date_

Protected Attributes inherited from LazyObject
bool	calculated_ = false

bool	frozen_ = false

bool	alwaysForward_

Detailed Description

Predetermined cash flow.

This cash flow pays a fractional amount at a given date.

Definition at line 74 of file dividend.hpp.

Constructor & Destructor Documentation

◆ FractionalDividend() [1/2]

FractionalDividend	(	Real	rate,
		const Date &	date
	)

Definition at line 76 of file dividend.hpp.

◆ FractionalDividend() [2/2]

FractionalDividend	(	Real	rate,
		Real	nominal,
		const Date &	date
	)

Definition at line 79 of file dividend.hpp.

Member Function Documentation

◆ amount() [1/2]

Real amount ( ) const

overridevirtual

returns the amount of the cash flow

Note: The amount is not discounted, i.e., it is the actual amount paid at the cash flow date.

Implements Dividend.

Definition at line 83 of file dividend.hpp.

◆ amount() [2/2]

Real amount ( Real underlying ) const

overridevirtual

Implements Dividend.

Definition at line 87 of file dividend.hpp.

◆ rate()

Real rate ( ) const

Definition at line 91 of file dividend.hpp.

◆ nominal()

Real nominal ( ) const

Definition at line 92 of file dividend.hpp.

Member Data Documentation

◆ rate_

Real rate_

protected

Definition at line 95 of file dividend.hpp.

◆ nominal_

Real nominal_