/usr/include/openturns/Brent.hxx is in libopenturns-dev 0.15-2.
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 | // -*- C++ -*-
/**
* @file Brent.hxx
* @brief Implementation class of the scalar nonlinear solver based on
*
* (C) Copyright 2005-2011 EDF-EADS-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 2.1 of the License.
*
* 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
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author: $LastChangedBy: schueller $
* @date: $LastChangedDate: 2011-04-11 12:32:27 +0200 (Mon, 11 Apr 2011) $
* Id: $Id: Brent.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_BRENT_HXX
#define OPENTURNS_BRENT_HXX
#include "OTprivate.hxx"
#include "SolverImplementation.hxx"
namespace OpenTURNS {
namespace Base {
namespace Solver {
/*
* @class Brent
*
* This class is an interface for the 1D nonlinear solverImplementations
*/
class Brent : public SolverImplementation
{
CLASSNAME;
public:
typedef SolverImplementation::NumericalMathFunction NumericalMathFunction;
typedef SolverImplementation::InvalidDimensionException InvalidDimensionException;
typedef SolverImplementation::InternalException InternalException;
/* Default constructor */
explicit Brent();
/* Parameter constructor */
explicit Brent(const NumericalScalar absoluteError,
const NumericalScalar relativeError,
const UnsignedLong maximumFunctionEvaluation);
/* Copy constructor */
/* Virtual constructor */
virtual Brent * 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 Brent method */
using SolverImplementation::solve;
NumericalScalar solve(const NumericalMathFunction & function,
const NumericalScalar value,
const NumericalScalar infPoint,
const NumericalScalar supPoint,
const NumericalScalar infValue,
const NumericalScalar supValue)
/* throw(InternalException, InvalidDimensionException) */;
private:
}; /* Class Brent */
} /* namespace Solver */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_BRENT_HXX */
|