summaryrefslogtreecommitdiff
path: root/inc/math_FunctionRoots.hxx
blob: 6b7cbf8865b625f1569b3a4377aaf7a8ceabb416 (plain)
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// 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

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _TColStd_SequenceOfReal_HeaderFile
#include <TColStd_SequenceOfReal.hxx>
#endif
#ifndef _TColStd_SequenceOfInteger_HeaderFile
#include <TColStd_SequenceOfInteger.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 Standard_RangeError;
class StdFail_NotDone;
class math_FunctionWithDerivative;



//! This class implements an algorithm which finds all the real roots of <br>
//! a function with derivative within a given range. <br>
//! Knowledge of the derivative is required. <br>
class math_FunctionRoots  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Calculates all the real roots of a function F-K within the range <br>
//! A..B. whithout conditions on A and B <br>
//! A solution X is found when <br>
//!   abs(Xi - Xi-1) <= Epsx and abs(F(Xi)-K) <= EpsF. <br>
//! The function is considered as null between A and B if <br>
//! abs(F-K) <= EpsNull within this range. <br>
  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. <br>
        Standard_Boolean IsDone() const;
  
//! returns true if the function is considered as null between A and B. <br>
//! Exceptions <br>
//! StdFail_NotDone if the algorithm fails (and IsDone returns false). <br>
        Standard_Boolean IsAllNull() const;
  //! Returns the number of solutions found. <br>
//! Exceptions <br>
//! StdFail_NotDone if the algorithm fails (and IsDone returns false). <br>
        Standard_Integer NbSolutions() const;
  //! Returns the Nth value of the root of function F. <br>
//! Exceptions <br>
//! StdFail_NotDone if the algorithm fails (and IsDone returns false). <br>
        Standard_Real Value(const Standard_Integer Nieme) const;
  
//! returns the StateNumber  of the Nieme root. <br>
//! Exception RangeError is raised if Nieme is < 1 <br>
//!  or Nieme > NbSolutions. <br>
        Standard_Integer StateNumber(const Standard_Integer Nieme) 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_Boolean AllNull;
TColStd_SequenceOfReal Sol;
TColStd_SequenceOfInteger NbStateSol;


};


#include <math_FunctionRoots.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif