/usr/include/openturns/Secant.hxx is in libopenturns-dev 1.9-5.
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 | // -*- C++ -*-
/**
* @brief Implementation class of the scalar nonlinear solver based on
*
* Copyright 2005-2017 Airbus-EDF-IMACS-Phimeca
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library 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
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef OPENTURNS_SECANT_HXX
#define OPENTURNS_SECANT_HXX
#include "openturns/OTprivate.hxx"
#include "openturns/SolverImplementation.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class Secant
*
* This class is an interface for the 1D nonlinear solverImplementations
*/
class OT_API Secant :
public SolverImplementation
{
CLASSNAME;
public:
/** Parameter constructor */
explicit Secant(const Scalar absoluteError = ResourceMap::GetAsScalar("Solver-DefaultAbsoluteError"),
const Scalar relativeError = ResourceMap::GetAsScalar("Solver-DefaultRelativeError"),
const Scalar residualError = ResourceMap::GetAsScalar("Solver-DefaultResidualError"),
const UnsignedInteger maximumFunctionEvaluation = ResourceMap::GetAsUnsignedInteger("Solver-DefaultMaximumFunctionEvaluation"));
/** Virtual constructor */
virtual Secant * clone() const;
/** String converter */
String __repr__() const;
/** Solve attempt to find one root to the equation function(x) = value in [infPoint, supPoint] given function(infPoint) and function(supPoint) with the Secant method */
using SolverImplementation::solve;
Scalar solve(const Function & function,
const Scalar value,
const Scalar infPoint,
const Scalar supPoint,
const Scalar infValue,
const Scalar supValue) const;
private:
}; /* Class Secant */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_SECANT_HXX */
|