/usr/include/ql/math/interpolations/mixedinterpolation.hpp is in libquantlib0-dev 1.9.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 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2010 Ferdinando Ametrano
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 mixedinterpolation.hpp
\brief mixed interpolation between discrete points
*/
#ifndef quantlib_mixed_interpolation_hpp
#define quantlib_mixed_interpolation_hpp
#include <ql/math/interpolations/linearinterpolation.hpp>
#include <ql/math/interpolations/cubicinterpolation.hpp>
#include <ql/utilities/dataformatters.hpp>
namespace QuantLib {
namespace detail {
template<class I1, class I2, class Ia, class Ib>
class MixedInterpolationImpl;
}
struct MixedInterpolation {
enum Behavior {
ShareRanges, /*!< Define both interpolations over the
whole range defined by the passed
iterators. This is the default
behavior. */
SplitRanges /*!< Define the first interpolation over the
first part of the range, and the second
interpolation over the second part. */
};
};
//! mixed linear/cubic interpolation between discrete points
/*! \ingroup interpolations */
class MixedLinearCubicInterpolation : public Interpolation {
public:
/*! \pre the \f$ x \f$ values must be sorted. */
template <class I1, class I2>
MixedLinearCubicInterpolation(const I1& xBegin, const I1& xEnd,
const I2& yBegin, Size n,
MixedInterpolation::Behavior behavior,
CubicInterpolation::DerivativeApprox da,
bool monotonic,
CubicInterpolation::BoundaryCondition leftC,
Real leftConditionValue,
CubicInterpolation::BoundaryCondition rightC,
Real rightConditionValue) {
impl_ = boost::shared_ptr<Interpolation::Impl>(new
detail::MixedInterpolationImpl<I1, I2, Linear, Cubic>(
xBegin, xEnd, yBegin, n, behavior,
Linear(),
Cubic(da, monotonic,
leftC, leftConditionValue,
rightC, rightConditionValue)));
impl_->update();
}
/*! \pre the \f$ x \f$ values must be sorted.
\deprecated Use the other constructor
*/
//QL_DEPRECATED
template <class I1, class I2>
MixedLinearCubicInterpolation(const I1& xBegin, const I1& xEnd,
const I2& yBegin, Size n,
CubicInterpolation::DerivativeApprox da,
bool monotonic,
CubicInterpolation::BoundaryCondition leftC,
Real leftConditionValue,
CubicInterpolation::BoundaryCondition rightC,
Real rightConditionValue) {
impl_ = boost::shared_ptr<Interpolation::Impl>(new
detail::MixedInterpolationImpl<I1, I2, Linear, Cubic>(
xBegin, xEnd, yBegin, n,
MixedInterpolation::ShareRanges,
Linear(),
Cubic(da, monotonic,
leftC, leftConditionValue,
rightC, rightConditionValue)));
impl_->update();
}
};
//! mixed linear/cubic interpolation factory and traits
/*! \ingroup interpolations */
class MixedLinearCubic {
public:
MixedLinearCubic(Size n,
MixedInterpolation::Behavior behavior,
CubicInterpolation::DerivativeApprox da,
bool monotonic = true,
CubicInterpolation::BoundaryCondition leftCondition
= CubicInterpolation::SecondDerivative,
Real leftConditionValue = 0.0,
CubicInterpolation::BoundaryCondition rightCondition
= CubicInterpolation::SecondDerivative,
Real rightConditionValue = 0.0)
: n_(n), behavior_(behavior), da_(da), monotonic_(monotonic),
leftType_(leftCondition), rightType_(rightCondition),
leftValue_(leftConditionValue), rightValue_(rightConditionValue) {}
/*! \deprecated Use the other constructor */
QL_DEPRECATED
MixedLinearCubic(Size n,
CubicInterpolation::DerivativeApprox da,
bool monotonic,
CubicInterpolation::BoundaryCondition leftCondition
= CubicInterpolation::SecondDerivative,
Real leftConditionValue = 0.0,
CubicInterpolation::BoundaryCondition rightCondition
= CubicInterpolation::SecondDerivative,
Real rightConditionValue = 0.0)
: n_(n), behavior_(MixedInterpolation::ShareRanges),
da_(da), monotonic_(monotonic),
leftType_(leftCondition), rightType_(rightCondition),
leftValue_(leftConditionValue), rightValue_(rightConditionValue) {}
template <class I1, class I2>
Interpolation interpolate(const I1& xBegin, const I1& xEnd,
const I2& yBegin) const {
return MixedLinearCubicInterpolation(xBegin, xEnd,
yBegin, n_, behavior_,
da_, monotonic_,
leftType_, leftValue_,
rightType_, rightValue_);
}
// fix below
static const bool global = true;
static const Size requiredPoints = 3;
private:
Size n_;
MixedInterpolation::Behavior behavior_;
CubicInterpolation::DerivativeApprox da_;
bool monotonic_;
CubicInterpolation::BoundaryCondition leftType_, rightType_;
Real leftValue_, rightValue_;
};
// convenience classes
class MixedLinearCubicNaturalSpline : public MixedLinearCubicInterpolation {
public:
/*! \pre the \f$ x \f$ values must be sorted. */
template <class I1, class I2>
MixedLinearCubicNaturalSpline(const I1& xBegin, const I1& xEnd,
const I2& yBegin, Size n,
MixedInterpolation::Behavior behavior
= MixedInterpolation::ShareRanges)
: MixedLinearCubicInterpolation(xBegin, xEnd, yBegin, n, behavior,
CubicInterpolation::Spline, false,
CubicInterpolation::SecondDerivative, 0.0,
CubicInterpolation::SecondDerivative, 0.0) {}
};
class MixedLinearMonotonicCubicNaturalSpline : public MixedLinearCubicInterpolation {
public:
/*! \pre the \f$ x \f$ values must be sorted. */
template <class I1, class I2>
MixedLinearMonotonicCubicNaturalSpline(const I1& xBegin, const I1& xEnd,
const I2& yBegin, Size n,
MixedInterpolation::Behavior behavior
= MixedInterpolation::ShareRanges)
: MixedLinearCubicInterpolation(xBegin, xEnd, yBegin, n, behavior,
CubicInterpolation::Spline, true,
CubicInterpolation::SecondDerivative, 0.0,
CubicInterpolation::SecondDerivative, 0.0) {}
};
class MixedLinearKrugerCubic : public MixedLinearCubicInterpolation {
public:
/*! \pre the \f$ x \f$ values must be sorted. */
template <class I1, class I2>
MixedLinearKrugerCubic(const I1& xBegin, const I1& xEnd,
const I2& yBegin, Size n,
MixedInterpolation::Behavior behavior
= MixedInterpolation::ShareRanges)
: MixedLinearCubicInterpolation(xBegin, xEnd, yBegin, n, behavior,
CubicInterpolation::Kruger, false,
CubicInterpolation::SecondDerivative, 0.0,
CubicInterpolation::SecondDerivative, 0.0) {}
};
class MixedLinearFritschButlandCubic : public MixedLinearCubicInterpolation {
public:
/*! \pre the \f$ x \f$ values must be sorted. */
template <class I1, class I2>
MixedLinearFritschButlandCubic(const I1& xBegin, const I1& xEnd,
const I2& yBegin, Size n,
MixedInterpolation::Behavior behavior
= MixedInterpolation::ShareRanges)
: MixedLinearCubicInterpolation(xBegin, xEnd, yBegin, n, behavior,
CubicInterpolation::FritschButland, false,
CubicInterpolation::SecondDerivative, 0.0,
CubicInterpolation::SecondDerivative, 0.0) {}
};
class MixedLinearParabolic : public MixedLinearCubicInterpolation {
public:
/*! \pre the \f$ x \f$ values must be sorted. */
template <class I1, class I2>
MixedLinearParabolic(const I1& xBegin, const I1& xEnd,
const I2& yBegin, Size n,
MixedInterpolation::Behavior behavior
= MixedInterpolation::ShareRanges)
: MixedLinearCubicInterpolation(xBegin, xEnd, yBegin, n, behavior,
CubicInterpolation::Parabolic, false,
CubicInterpolation::SecondDerivative, 0.0,
CubicInterpolation::SecondDerivative, 0.0) {}
};
class MixedLinearMonotonicParabolic : public MixedLinearCubicInterpolation {
public:
/*! \pre the \f$ x \f$ values must be sorted. */
template <class I1, class I2>
MixedLinearMonotonicParabolic(const I1& xBegin, const I1& xEnd,
const I2& yBegin, Size n,
MixedInterpolation::Behavior behavior
= MixedInterpolation::ShareRanges)
: MixedLinearCubicInterpolation(xBegin, xEnd, yBegin, n, behavior,
CubicInterpolation::Parabolic, true,
CubicInterpolation::SecondDerivative, 0.0,
CubicInterpolation::SecondDerivative, 0.0) {}
};
namespace detail {
template <class I1, class I2, class Interpolator1, class Interpolator2>
class MixedInterpolationImpl
: public Interpolation::templateImpl<I1,I2> {
public:
MixedInterpolationImpl(const I1& xBegin, const I1& xEnd,
const I2& yBegin, Size n,
MixedInterpolation::Behavior behavior
= MixedInterpolation::ShareRanges,
const Interpolator1& factory1 = Interpolator1(),
const Interpolator2& factory2 = Interpolator2())
: Interpolation::templateImpl<I1,I2>(
xBegin, xEnd, yBegin,
std::max<Size>(Interpolator1::requiredPoints,
Interpolator2::requiredPoints)),
n_(n) {
xBegin2_ = this->xBegin_ + n_;
yBegin2_ = this->yBegin_ + n_;
QL_REQUIRE(xBegin2_<this->xEnd_,
"too large n (" << n << ") for " <<
this->xEnd_-this->xBegin_ << "-element x sequence");
switch (behavior) {
case MixedInterpolation::ShareRanges:
interpolation1_ = factory1.interpolate(this->xBegin_,
this->xEnd_,
this->yBegin_);
interpolation2_ = factory2.interpolate(this->xBegin_,
this->xEnd_,
this->yBegin_);
break;
case MixedInterpolation::SplitRanges:
interpolation1_ = factory1.interpolate(this->xBegin_,
this->xBegin2_+1,
this->yBegin_);
interpolation2_ = factory2.interpolate(this->xBegin2_,
this->xEnd_,
this->yBegin2_);
break;
default:
QL_FAIL("unknown mixed-interpolation behavior: " << behavior);
}
}
QL_DEPRECATED
MixedInterpolationImpl(const I1& xBegin, const I1& xEnd,
const I2& yBegin, Size n,
const Interpolator1& factory1,
const Interpolator2& factory2 = Interpolator2())
: Interpolation::templateImpl<I1,I2>(
xBegin, xEnd, yBegin,
std::max<Size>(Interpolator1::requiredPoints,
Interpolator2::requiredPoints)),
n_(n) {
xBegin2_ = this->xBegin_ + n_;
yBegin2_ = this->yBegin_ + n_;
QL_REQUIRE(xBegin2_<this->xEnd_,
"too large n (" << n << ") for " <<
this->xEnd_-this->xBegin_ << "-element x sequence");
interpolation1_ = factory1.interpolate(this->xBegin_,
this->xEnd_,
this->yBegin_);
interpolation2_ = factory2.interpolate(this->xBegin_,
this->xEnd_,
this->yBegin_);
}
void update() {
interpolation1_.update();
interpolation2_.update();
}
Real value(Real x) const {
if (x<*(this->xBegin2_))
return interpolation1_(x, true);
return interpolation2_(x, true);
}
Real primitive(Real x) const {
if (x<*(this->xBegin2_))
return interpolation1_.primitive(x, true);
return interpolation2_.primitive(x, true) -
interpolation2_.primitive(*xBegin2_, true) +
interpolation1_.primitive(*xBegin2_, true);
}
Real derivative(Real x) const {
if (x<*(this->xBegin2_))
return interpolation1_.derivative(x, true);
return interpolation2_.derivative(x, true);
}
Real secondDerivative(Real x) const {
if (x<*(this->xBegin2_))
return interpolation1_.secondDerivative(x, true);
return interpolation2_.secondDerivative(x, true);
}
Size switchIndex() { return n_; }
private:
I1 xBegin2_;
I2 yBegin2_;
Size n_;
Interpolation interpolation1_, interpolation2_;
};
}
}
#endif
|