/usr/include/oce/math_FunctionRoots.hxx is in liboce-foundation-dev 0.17.2-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 89 90 91 92 93 94 95 96 97 98 99 100 | // 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_FunctionRoots_HeaderFile
#define _math_FunctionRoots_HeaderFile
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Macro.hxx>
#include <Standard_Boolean.hxx>
#include <TColStd_SequenceOfReal.hxx>
#include <TColStd_SequenceOfInteger.hxx>
#include <Standard_Real.hxx>
#include <Standard_Integer.hxx>
#include <Standard_OStream.hxx>
class Standard_RangeError;
class StdFail_NotDone;
class math_FunctionWithDerivative;
//! This class implements an algorithm which finds all the real roots of
//! a function with derivative within a given range.
//! Knowledge of the derivative is required.
class math_FunctionRoots
{
public:
DEFINE_STANDARD_ALLOC
//! Calculates all the real roots of a function F-K within the range
//! A..B. whithout conditions on A and B
//! A solution X is found when
//! abs(Xi - Xi-1) <= Epsx and abs(F(Xi)-K) <= EpsF.
//! The function is considered as null between A and B if
//! abs(F-K) <= EpsNull within this range.
Standard_EXPORT math_FunctionRoots(math_FunctionWithDerivative& F, const Standard_Real A, const Standard_Real B, const Standard_Integer NbSample, const Standard_Real EpsX = 0.0, const Standard_Real EpsF = 0.0, const Standard_Real EpsNull = 0.0, const Standard_Real K = 0.0);
//! Returns true if the computations are successful, otherwise returns false.
Standard_Boolean IsDone() const;
//! returns true if the function is considered as null between A and B.
//! Exceptions
//! StdFail_NotDone if the algorithm fails (and IsDone returns false).
Standard_Boolean IsAllNull() const;
//! Returns the number of solutions found.
//! Exceptions
//! StdFail_NotDone if the algorithm fails (and IsDone returns false).
Standard_Integer NbSolutions() const;
//! Returns the Nth value of the root of function F.
//! Exceptions
//! StdFail_NotDone if the algorithm fails (and IsDone returns false).
Standard_Real Value (const Standard_Integer Nieme) const;
//! returns the StateNumber of the Nieme root.
//! Exception RangeError is raised if Nieme is < 1
//! or Nieme > NbSolutions.
Standard_Integer StateNumber (const Standard_Integer Nieme) const;
//! Prints on the stream o information on the current state
//! of the object.
Standard_EXPORT void Dump (Standard_OStream& o) const;
protected:
private:
Standard_Boolean Done;
Standard_Boolean AllNull;
TColStd_SequenceOfReal Sol;
TColStd_SequenceOfInteger NbStateSol;
};
#include <math_FunctionRoots.lxx>
#endif // _math_FunctionRoots_HeaderFile
|