0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / math / math_GaussMultipleIntegration.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_GaussMultipleIntegration_HeaderFile
18 #define _math_GaussMultipleIntegration_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 <math_Vector.hxx>
27 #include <math_IntegerVector.hxx>
28 #include <Standard_OStream.hxx>
29 class StdFail_NotDone;
30 class math_MultipleVarFunction;
31
32
33
34 //! This class implements the integration of a function of multiple
35 //! variables between the parameter bounds Lower[a..b] and Upper[a..b].
36 //! Warning: Each element of Order must be inferior or equal to 61.
37 class math_GaussMultipleIntegration 
38 {
39 public:
40
41   DEFINE_STANDARD_ALLOC
42
43   
44
45   //! The Gauss-Legendre integration with Order = points of
46   //! integration for each unknown, is done on the function F
47   //! between the bounds Lower and Upper.
48   Standard_EXPORT math_GaussMultipleIntegration(math_MultipleVarFunction& F, const math_Vector& Lower, const math_Vector& Upper, const math_IntegerVector& Order);
49   
50   //! returns True if all has been correctly done.
51     Standard_Boolean IsDone() const;
52   
53   //! returns the value of the integral.
54     Standard_Real Value() const;
55   
56   //! Prints information on the current state of the object.
57   Standard_EXPORT void Dump (Standard_OStream& o) const;
58
59
60
61
62 protected:
63
64
65
66
67
68 private:
69
70
71
72   Standard_Real Val;
73   Standard_Boolean Done;
74
75
76 };
77
78
79 #include <math_GaussMultipleIntegration.lxx>
80
81
82
83
84
85 #endif // _math_GaussMultipleIntegration_HeaderFile