/usr/include/ql/cashflows/floatingratecoupon.hpp is in libquantlib0-dev 1.7.1-1.
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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2000, 2001, 2002, 2003 RiskMap srl
Copyright (C) 2003, 2004 StatPro Italia srl
Copyright (C) 2003 Nicolas Di Césaré
Copyright (C) 2006, 2007 Cristina Duminuco
Copyright (C) 2006 Ferdinando Ametrano
Copyright (C) 2007 Giorgio Facchinetti
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 floatingratecoupon.hpp
\brief Coupon paying a variable index-based rate
*/
#ifndef quantlib_floating_rate_coupon_hpp
#define quantlib_floating_rate_coupon_hpp
#include <ql/cashflows/coupon.hpp>
#include <ql/patterns/visitor.hpp>
#include <ql/time/daycounter.hpp>
#include <ql/handle.hpp>
namespace QuantLib {
class InterestRateIndex;
class YieldTermStructure;
class FloatingRateCouponPricer;
//! base floating-rate coupon class
class FloatingRateCoupon : public Coupon,
public Observer {
public:
FloatingRateCoupon(const Date& paymentDate,
Real nominal,
const Date& startDate,
const Date& endDate,
Natural fixingDays,
const boost::shared_ptr<InterestRateIndex>& index,
Real gearing = 1.0,
Spread spread = 0.0,
const Date& refPeriodStart = Date(),
const Date& refPeriodEnd = Date(),
const DayCounter& dayCounter = DayCounter(),
bool isInArrears = false);
//! \name CashFlow interface
//@{
Real amount() const { return rate() * accrualPeriod() * nominal(); }
//@}
//! \name Coupon interface
//@{
Rate rate() const;
Real price(const Handle<YieldTermStructure>& discountingCurve) const;
DayCounter dayCounter() const { return dayCounter_; }
Real accruedAmount(const Date&) const;
//@}
//! \name Inspectors
//@{
//! floating index
const boost::shared_ptr<InterestRateIndex>& index() const;
//! fixing days
Natural fixingDays() const { return fixingDays_; }
//! fixing date
virtual Date fixingDate() const;
//! index gearing, i.e. multiplicative coefficient for the index
Real gearing() const { return gearing_; }
//! spread paid over the fixing of the underlying index
Spread spread() const { return spread_; }
//! fixing of the underlying index
virtual Rate indexFixing() const;
//! convexity adjustment
virtual Rate convexityAdjustment() const;
//! convexity-adjusted fixing
virtual Rate adjustedFixing() const;
//! whether or not the coupon fixes in arrears
bool isInArrears() const { return isInArrears_; }
//@}
//! \name Observer interface
//@{
void update() { notifyObservers(); }
//@}
//! \name Visitability
//@{
virtual void accept(AcyclicVisitor&);
//@}
void setPricer(const boost::shared_ptr<FloatingRateCouponPricer>&);
boost::shared_ptr<FloatingRateCouponPricer> pricer() const;
protected:
//! convexity adjustment for the given index fixing
Rate convexityAdjustmentImpl(Rate fixing) const;
boost::shared_ptr<InterestRateIndex> index_;
DayCounter dayCounter_;
Natural fixingDays_;
Real gearing_;
Spread spread_;
bool isInArrears_;
boost::shared_ptr<FloatingRateCouponPricer> pricer_;
};
// inline definitions
inline const boost::shared_ptr<InterestRateIndex>&
FloatingRateCoupon::index() const {
return index_;
}
inline Rate FloatingRateCoupon::convexityAdjustment() const {
return convexityAdjustmentImpl(indexFixing());
}
inline Rate FloatingRateCoupon::adjustedFixing() const {
return (rate()-spread())/gearing();
}
inline boost::shared_ptr<FloatingRateCouponPricer>
FloatingRateCoupon::pricer() const {
return pricer_;
}
inline Rate
FloatingRateCoupon::convexityAdjustmentImpl(Rate fixing) const {
return (gearing() == 0.0 ? 0.0 : adjustedFixing()-fixing);
}
inline void FloatingRateCoupon::accept(AcyclicVisitor& v) {
Visitor<FloatingRateCoupon>* v1 =
dynamic_cast<Visitor<FloatingRateCoupon>*>(&v);
if (v1 != 0)
v1->visit(*this);
else
Coupon::accept(v);
}
}
#endif
|