0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / AppDef / AppDef_MyGradientOfCompute.hxx
1 // Created on: 1991-12-02
2 // Created by: Laurent PAINNOT
3 // Copyright (c) 1991-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 _AppDef_MyGradientOfCompute_HeaderFile
18 #define _AppDef_MyGradientOfCompute_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <AppParCurves_MultiCurve.hxx>
25 #include <math_Vector.hxx>
26 #include <Standard_Real.hxx>
27 #include <Standard_Boolean.hxx>
28 #include <Standard_Integer.hxx>
29 #include <AppParCurves_HArray1OfConstraintCouple.hxx>
30 class Standard_OutOfRange;
31 class StdFail_NotDone;
32 class AppDef_MultiLine;
33 class AppDef_MyLineTool;
34 class AppDef_ParLeastSquareOfMyGradientOfCompute;
35 class AppDef_ResConstraintOfMyGradientOfCompute;
36 class AppDef_ParFunctionOfMyGradientOfCompute;
37 class AppDef_Gradient_BFGSOfMyGradientOfCompute;
38 class AppParCurves_MultiCurve;
39
40
41
42 class AppDef_MyGradientOfCompute 
43 {
44 public:
45
46   DEFINE_STANDARD_ALLOC
47
48   
49   Standard_EXPORT AppDef_MyGradientOfCompute(const AppDef_MultiLine& SSP, const Standard_Integer FirstPoint, const Standard_Integer LastPoint, const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints, math_Vector& Parameters, const Standard_Integer Deg, const Standard_Real Tol3d, const Standard_Real Tol2d, const Standard_Integer NbIterations = 200);
50   
51   Standard_EXPORT Standard_Boolean IsDone() const;
52   
53   Standard_EXPORT AppParCurves_MultiCurve Value() const;
54   
55   Standard_EXPORT Standard_Real Error (const Standard_Integer Index) const;
56   
57   Standard_EXPORT Standard_Real MaxError3d() const;
58   
59   Standard_EXPORT Standard_Real MaxError2d() const;
60   
61   Standard_EXPORT Standard_Real AverageError() const;
62
63
64
65
66 protected:
67
68
69
70
71
72 private:
73
74
75
76   AppParCurves_MultiCurve SCU;
77   math_Vector ParError;
78   Standard_Real AvError;
79   Standard_Real MError3d;
80   Standard_Real MError2d;
81   Standard_Boolean Done;
82
83
84 };
85
86
87
88
89
90
91
92 #endif // _AppDef_MyGradientOfCompute_HeaderFile