0027067: Avoid use of virtual methods for implementation of destructors in legacy...
[occt.git] / src / math / math_NewtonMinimum.hxx
1 // Created on: 1996-02-28
2 // Created by: Philippe MANGIN
3 // Copyright (c) 1996-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _math_NewtonMinimum_HeaderFile
18 #define _math_NewtonMinimum_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Boolean.hxx>
25 #include <math_Status.hxx>
26 #include <math_Vector.hxx>
27 #include <math_Matrix.hxx>
28 #include <Standard_Real.hxx>
29 #include <Standard_Integer.hxx>
30 #include <Standard_OStream.hxx>
31 class StdFail_NotDone;
32 class Standard_DimensionError;
33 class math_MultipleVarFunctionWithHessian;
34
35
36
37 class math_NewtonMinimum 
38 {
39 public:
40
41   DEFINE_STANDARD_ALLOC
42
43   
44
45   //! The tolerance required on the solution is given by Tolerance.
46   //! Iteration are  stopped if (!WithSingularity) and H(F(Xi)) is not definite
47   //! positive (if the smaller eigenvalue of H < Convexity)
48   //! or IsConverged() returns True for 2 successives Iterations.
49   //! Warning: This constructor does not perform computation.
50   Standard_EXPORT math_NewtonMinimum(const math_MultipleVarFunctionWithHessian& theFunction, const Standard_Real theTolerance = 1.0e-7, const Standard_Integer theNbIterations = 40, const Standard_Real theConvexity = 1.0e-6, const Standard_Boolean theWithSingularity = Standard_True);
51   
52   //! Search the solution.
53   Standard_EXPORT void Perform (math_MultipleVarFunctionWithHessian& theFunction, const math_Vector& theStartingPoint);
54   
55   //! Destructor
56   Standard_EXPORT virtual ~math_NewtonMinimum();
57   
58
59   //! This method is called at the end of each iteration to check the convergence:
60   //! || Xi+1 - Xi || < Tolerance or || F(Xi+1) - F(Xi)|| < Tolerance * || F(Xi) ||
61   //! It can be redefined in a sub-class to implement a specific test.
62     virtual Standard_Boolean IsConverged() const;
63   
64   //! Tests if an error has occured.
65     Standard_Boolean IsDone() const;
66   
67   //! Tests if the Function is convexe during optimization.
68     Standard_Boolean IsConvex() const;
69   
70   //! returns the location vector of the minimum.
71   //! Exception NotDone is raised if an error has occured.
72     const math_Vector& Location() const;
73   
74   //! outputs the location vector of the minimum in Loc.
75   //! Exception NotDone is raised if an error has occured.
76   //! Exception DimensionError is raised if the range of Loc is not
77   //! equal to the range of the StartingPoint.
78     void Location (math_Vector& Loc) const;
79   
80   //! Set boundaries.
81   Standard_EXPORT void SetBoundary (const math_Vector& theLeftBorder, const math_Vector& theRightBorder);
82   
83   //! returns the value of the minimum.
84   //! Exception NotDone is raised if the minimum was not found.
85     Standard_Real Minimum() const;
86   
87   //! returns the gradient vector at the minimum.
88   //! Exception NotDone is raised if an error has occured.the minimum was not found.
89     const math_Vector& Gradient() const;
90   
91   //! outputs the gradient vector at the minimum in Grad.
92   //! Exception NotDone is raised if the minimum was not found.
93   //! Exception DimensionError is raised if the range of Grad is not
94   //! equal to the range of the StartingPoint.
95     void Gradient (math_Vector& Grad) const;
96   
97   //! returns the number of iterations really done in the
98   //! calculation of the minimum.
99   //! The exception NotDone is raised if an error has occured.
100     Standard_Integer NbIterations() const;
101   
102   //! Prints on the stream o information on the current state
103   //! of the object.
104   //! Is used to redefine the operator <<.
105   Standard_EXPORT void Dump (Standard_OStream& o) const;
106
107
108
109
110 protected:
111
112
113
114   math_Status TheStatus;
115   math_Vector TheLocation;
116   math_Vector TheGradient;
117   math_Vector TheStep;
118   math_Matrix TheHessian;
119   Standard_Real PreviousMinimum;
120   Standard_Real TheMinimum;
121   Standard_Real MinEigenValue;
122   Standard_Real XTol;
123   Standard_Real CTol;
124   Standard_Integer nbiter;
125   Standard_Boolean NoConvexTreatement;
126   Standard_Boolean Convex;
127   Standard_Boolean myIsBoundsDefined;
128   math_Vector myLeft;
129   math_Vector myRight;
130
131
132 private:
133
134
135
136   Standard_Boolean Done;
137   Standard_Integer Itermax;
138
139
140 };
141
142
143 #include <math_NewtonMinimum.lxx>
144
145
146
147
148
149 #endif // _math_NewtonMinimum_HeaderFile