/usr/include/ql/cashflows/dividend.hpp is in libquantlib0-dev 1.1-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2005 Joseph Wang
Copyright (C) 2006 StatPro Italia srl
This file is part of QuantLib, a free-software/open-source library
for financial quantitative analysts and developers - http://quantlib.org/
QuantLib is free software: you can redistribute it and/or modify it
under the terms of the QuantLib license. You should have received a
copy of the license along with this program; if not, please email
<quantlib-dev@lists.sf.net>. The license is also available online at
<http://quantlib.org/license.shtml>.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the license for more details.
*/
/*! \file dividend.hpp
\brief A stock dividend
*/
#ifndef quantlib_dividend_hpp
#define quantlib_dividend_hpp
#include <ql/cashflow.hpp>
#include <ql/utilities/null.hpp>
#include <vector>
namespace QuantLib {
//! Predetermined cash flow
/*! This cash flow pays a predetermined amount at a given date. */
class Dividend : public CashFlow {
public:
Dividend(const Date& date)
: date_(date) {}
//! \name Event interface
//@{
Date date() const { return date_; }
//@}
//! \name CashFlow interface
//@{
virtual Real amount() const = 0;
//@}
virtual Real amount(Real underlying) const = 0;
//! \name Visitability
//@{
virtual void accept(AcyclicVisitor&);
//@}
protected:
Date date_;
};
//! Predetermined cash flow
/*! This cash flow pays a predetermined amount at a given date. */
class FixedDividend : public Dividend {
public:
FixedDividend(Real amount, const Date& date)
: Dividend(date), amount_(amount) {}
//! \name Dividend interface
//@{
virtual Real amount() const { return amount_; }
virtual Real amount(Real) const { return amount_; }
//@}
protected:
Real amount_;
};
//! Predetermined cash flow
/*! This cash flow pays a fractional amount at a given date. */
class FractionalDividend : public Dividend {
public:
FractionalDividend(Real rate, const Date& date)
: Dividend(date), rate_(rate), nominal_(Null<Real>()) {}
FractionalDividend(Real rate, Real nominal, const Date& date)
: Dividend(date), rate_(rate), nominal_(nominal) {}
//! \name Dividend interface
//@{
virtual Real amount() const {
QL_REQUIRE(nominal_ != Null<Real>(), "no nominal given");
return rate_ * nominal_;
}
virtual Real amount(Real underlying) const {
return rate_ * underlying;
}
//@}
//! \name Inspectors
//@{
Real rate() const { return rate_; }
Real nominal() const { return nominal_; }
//@}
protected:
Real rate_;
Real nominal_;
};
//! helper function building a sequence of fixed dividends
std::vector<boost::shared_ptr<Dividend> >
DividendVector(const std::vector<Date>& dividendDates,
const std::vector<Real>& dividends);
}
#endif
|