/usr/include/oce/math_BracketedRoot.hxx is in liboce-foundation-dev 0.15-4.
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 | // This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to
// this header file considered to be the "object code" form of the original source.
#ifndef _math_BracketedRoot_HeaderFile
#define _math_BracketedRoot_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineAlloc_HeaderFile
#include <Standard_DefineAlloc.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
class StdFail_NotDone;
class math_Function;
//! This class implements the Brent method to find the root of a function <br>
//! located within two bounds. No knowledge of the derivative is required. <br>
class math_BracketedRoot {
public:
DEFINE_STANDARD_ALLOC
//! The Brent method is used to find the root of the function F between <br>
//! the bounds Bound1 and Bound2 on the function F. <br>
//! If F(Bound1)*F(Bound2) >0 the Brent method fails. <br>
//! The tolerance required for the root is given by Tolerance. <br>
//! The solution is found when : <br>
//! abs(Xi - Xi-1) <= Tolerance; <br>
//! The maximum number of iterations allowed is given by NbIterations. <br>
Standard_EXPORT math_BracketedRoot(math_Function& F,const Standard_Real Bound1,const Standard_Real Bound2,const Standard_Real Tolerance,const Standard_Integer NbIterations = 100,const Standard_Real ZEPS = 1.0e-12);
//! Returns true if the computations are successful, otherwise returns false. <br>
Standard_Boolean IsDone() const;
//! returns the value of the root. <br>
//! Exception NotDone is raised if the minimum was not found. <br>
Standard_Real Root() const;
//! returns the value of the function at the root. <br>
//! Exception NotDone is raised if the minimum was not found. <br>
Standard_Real Value() const;
//! returns the number of iterations really done during the <br>
//! computation of the Root. <br>
//! Exception NotDone is raised if the minimum was not found. <br>
Standard_Integer NbIterations() const;
//! Prints on the stream o information on the current state <br>
//! of the object. <br>
Standard_EXPORT void Dump(Standard_OStream& o) const;
protected:
private:
Standard_Boolean Done;
Standard_Real TheRoot;
Standard_Real TheError;
Standard_Integer NbIter;
};
#include <math_BracketedRoot.lxx>
// other Inline functions and methods (like "C++: function call" methods)
#endif
|