/usr/include/openturns/Solver.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 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 | // -*- C++ -*-
/**
* @brief Interface class for a nonlinear scalar solver
*
* 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_SOLVER_HXX
#define OPENTURNS_SOLVER_HXX
#include "openturns/OTprivate.hxx"
#include "openturns/SolverImplementation.hxx"
#include "openturns/Pointer.hxx"
#include "openturns/TypedInterfaceObject.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class Solver
*
* This class is an interface for the 1D nonlinear solvers
*/
class OT_API Solver :
public TypedInterfaceObject<SolverImplementation>
{
CLASSNAME;
public:
typedef Pointer<SolverImplementation> Implementation;
/** Default constructor */
Solver();
/** Parameter constructor */
Solver(const Implementation & p_implementation);
/** Parameter from an implementation */
Solver(const SolverImplementation & implementation);
/** Second parameter constructor */
Solver(const Scalar absoluteError,
const Scalar relativeError,
const Scalar residualError,
const UnsignedInteger maximumFunctionEvaluation);
/** Comparison operator */
Bool operator ==(const Solver & other) const;
/** String converter */
virtual String __repr__() const;
/** Solve attempt to find one root to the equation function(x) = value in [infPoint, supPoint] */
virtual Scalar solve(const Function & function,
const Scalar value,
const Scalar infPoint,
const Scalar supPoint) const;
/** Solve attempt to find one root to the equation function(x) = value in [infPoint, supPoint] given function(infPoint) and function(supPoint) */
virtual Scalar solve(const Function & function,
const Scalar value,
const Scalar infPoint,
const Scalar supPoint,
const Scalar infValue,
const Scalar supValue) const;
/** Absolute error accessor */
void setAbsoluteError(const Scalar absoluteError);
Scalar getAbsoluteError() const;
/** Relative error accessor */
void setRelativeError(const Scalar relativeError);
Scalar getRelativeError() const;
/** Residual error accessor */
void setResidualError(const Scalar residualError);
Scalar getResidualError() const;
/** Maximum function evaluation accessor */
void setMaximumFunctionEvaluation(const UnsignedInteger maximumFunctionEvaluation);
UnsignedInteger getMaximumFunctionEvaluation() const;
/** Used function evaluation */
UnsignedInteger getUsedFunctionEvaluation() const;
}; /* Class Solver */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_SOLVER_HXX */
|