0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / math / math_GaussSingleIntegration.hxx
1 // Created on: 1991-05-14
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 _math_GaussSingleIntegration_HeaderFile
18 #define _math_GaussSingleIntegration_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Real.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_Integer.hxx>
27 #include <Standard_OStream.hxx>
28 class StdFail_NotDone;
29 class math_Function;
30
31
32
33 //! This class implements the integration of a function of a single variable
34 //! between the parameter bounds Lower and Upper.
35 //! Warning: Order must be inferior or equal to 61.
36 class math_GaussSingleIntegration 
37 {
38 public:
39
40   DEFINE_STANDARD_ALLOC
41
42   
43   Standard_EXPORT math_GaussSingleIntegration();
44   
45
46   //! The Gauss-Legendre integration with N = Order points of integration,
47   //! is done on the function F between the bounds Lower and Upper.
48   Standard_EXPORT math_GaussSingleIntegration(math_Function& F, const Standard_Real Lower, const Standard_Real Upper, const Standard_Integer Order);
49   
50
51   //! The Gauss-Legendre integration with N = Order points of integration  and
52   //! given tolerance = Tol is done on the function F between the bounds
53   //! Lower and Upper.
54   Standard_EXPORT math_GaussSingleIntegration(math_Function& F, const Standard_Real Lower, const Standard_Real Upper, const Standard_Integer Order, const Standard_Real Tol);
55   
56   //! returns True if all has been correctly done.
57     Standard_Boolean IsDone() const;
58   
59   //! returns the value of the integral.
60     Standard_Real Value() const;
61   
62   //! Prints information on the current state of the object.
63   Standard_EXPORT void Dump (Standard_OStream& o) const;
64
65
66
67
68 protected:
69
70
71
72
73
74 private:
75
76   
77   //! performs  actual  computation
78   Standard_EXPORT void Perform (math_Function& F, const Standard_Real Lower, const Standard_Real Upper, const Standard_Integer Order);
79
80
81   Standard_Real Val;
82   Standard_Boolean Done;
83
84
85 };
86
87
88 #include <math_GaussSingleIntegration.lxx>
89
90
91
92
93
94 #endif // _math_GaussSingleIntegration_HeaderFile