/usr/include/ql/math/solvers1d/newtonsafe.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 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2000, 2001, 2002, 2003 RiskMap 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 newtonsafe.hpp
\brief Safe (bracketed) Newton 1-D solver
*/
#ifndef quantlib_solver1d_newtonsafe_h
#define quantlib_solver1d_newtonsafe_h
#include <ql/math/solver1d.hpp>
namespace QuantLib {
//! safe %Newton 1-D solver
/*! \note This solver requires that the passed function object
implement a method <tt>Real derivative(Real)</tt>.
\test the correctness of the returned values is tested by
checking them against known good results.
\ingroup solvers
*/
class NewtonSafe : public Solver1D<NewtonSafe> {
public:
template <class F>
Real solveImpl(const F& f,
Real xAccuracy) const {
/* The implementation of the algorithm was inspired by
Press, Teukolsky, Vetterling, and Flannery,
"Numerical Recipes in C", 2nd edition,
Cambridge University Press
*/
Real froot, dfroot, dx, dxold;
Real xh, xl;
// Orient the search so that f(xl) < 0
if (fxMin_ < 0.0) {
xl = xMin_;
xh = xMax_;
} else {
xh = xMin_;
xl = xMax_;
}
// the "stepsize before last"
dxold = xMax_-xMin_;
// it was dxold=std::fabs(xMax_-xMin_); in Numerical Recipes
// here (xMax_-xMin_ > 0) is verified in the constructor
// and the last step
dx = dxold;
froot = f(root_);
dfroot = f.derivative(root_);
QL_REQUIRE(dfroot != Null<Real>(),
"NewtonSafe requires function's derivative");
++evaluationNumber_;
while (evaluationNumber_<=maxEvaluations_) {
// Bisect if (out of range || not decreasing fast enough)
if ((((root_-xh)*dfroot-froot)*
((root_-xl)*dfroot-froot) > 0.0)
|| (std::fabs(2.0*froot) > std::fabs(dxold*dfroot))) {
dxold = dx;
dx = (xh-xl)/2.0;
root_=xl+dx;
} else {
dxold = dx;
dx = froot/dfroot;
root_ -= dx;
}
// Convergence criterion
if (std::fabs(dx) < xAccuracy) {
f(root_);
++evaluationNumber_;
return root_;
}
froot = f(root_);
dfroot = f.derivative(root_);
++evaluationNumber_;
if (froot < 0.0)
xl=root_;
else
xh=root_;
}
QL_FAIL("maximum number of function evaluations ("
<< maxEvaluations_ << ") exceeded");
}
};
}
#endif
|