QuantLib_FractionalDividend (3) - Linux Manuals
QuantLib_FractionalDividend: Predetermined cash flow.
NAME
QuantLib::FractionalDividend - Predetermined cash flow.
SYNOPSIS
#include <ql/cashflows/dividend.hpp>
Inherits QuantLib::Dividend.
Public Member Functions
FractionalDividend (Real rate, const Date &date)
FractionalDividend (Real rate, Real nominal, const Date &date)
Dividend interface
virtual Real amount () const
returns the amount of the cash flow
virtual Real amount (Real underlying) const
Inspectors
Real rate () const
Real nominal () const
Protected Attributes
Detailed Description
Predetermined cash flow.
This cash flow pays a predetermined amount at a given date.
Member Function Documentation
virtual Real amount () const [virtual]
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.
Author
Generated automatically by Doxygen for QuantLib from the source code.