summaryrefslogtreecommitdiff
path: root/inc/math_BracketMinimum.hxx
blob: 493401493058c114ca8189ed88d700d75ea13966 (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
121
122
123
124
// 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_BracketMinimum_HeaderFile
#define _math_BracketMinimum_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 _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
class StdFail_NotDone;
class math_Function;


//!Given two distinct initial points, BracketMinimum <br>
//! implements the computation of three points (a, b, c) which <br>
//! bracket the minimum of the function and verify A less than <br>
//! B, B less than C and F(A) less than F(B), F(B) less than (C). <br>
class math_BracketMinimum  {
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); 
  }

  
//! Given two initial values this class computes a <br>
//! bracketing triplet of abscissae Ax, Bx, Cx <br>
//! (such that Bx is between Ax and Cx, F(Bx) is <br>
//! less than both F(Bx) and F(Cx)) the Brent minimization is done <br>
//! on the function F. <br>
  Standard_EXPORT   math_BracketMinimum(math_Function& F,const Standard_Real A,const Standard_Real B);
  
//! Given two initial values this class computes a <br>
//! bracketing triplet of abscissae Ax, Bx, Cx <br>
//! (such that Bx is between Ax and Cx, F(Bx) is <br>
//! less than both F(Bx) and F(Cx)) the Brent minimization is done <br>
//! on the function F. <br>
//! This constructor has to be used if F(A) is known. <br>
  Standard_EXPORT   math_BracketMinimum(math_Function& F,const Standard_Real A,const Standard_Real B,const Standard_Real FA);
  
//! Given two initial values this class computes a <br>
//! bracketing triplet of abscissae Ax, Bx, Cx <br>
//! (such that Bx is between Ax and Cx, F(Bx) is <br>
//! less than both F(Bx) and F(Cx)) the Brent minimization is done <br>
//! on the function F. <br>
//! This constructor has to be used if F(A) and F(B) are known. <br>
  Standard_EXPORT   math_BracketMinimum(math_Function& F,const Standard_Real A,const Standard_Real B,const Standard_Real FA,const Standard_Real FB);
  //! Returns true if the computations are successful, otherwise returns false. <br>
        Standard_Boolean IsDone() const;
  //! Returns the bracketed triplet of abscissae. <br>
//! Exceptions <br>
//! StdFail_NotDone if the algorithm fails (and IsDone returns false). <br>
  Standard_EXPORT     void Values(Standard_Real& A,Standard_Real& B,Standard_Real& C) const;
  //! returns the bracketed triplet function values. <br>
//! Exceptions <br>
//! StdFail_NotDone if the algorithm fails (and IsDone returns false). <br>
  Standard_EXPORT     void FunctionValues(Standard_Real& FA,Standard_Real& FB,Standard_Real& FC) const;
  //! Prints on the stream o information on the current state <br>
//!          of the object. <br>
//!          Is used to redefine the operator <<. <br>
  Standard_EXPORT     void Dump(Standard_OStream& o) const;





protected:

  //! Is used internally by the constructors. <br>
  Standard_EXPORT     void Perform(math_Function& F,const Standard_Real A,const Standard_Real B) ;




private:



Standard_Boolean Done;
Standard_Real Ax;
Standard_Real Bx;
Standard_Real Cx;
Standard_Real FAx;
Standard_Real FBx;
Standard_Real FCx;
Standard_Boolean myFA;
Standard_Boolean myFB;


};


#include <math_BracketMinimum.lxx>



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


#endif