0024044: Performance improvements: Foundation Classes (math)
[occt.git] / src / math / math_GaussMultipleIntegration.cdl
1 -- Created on: 1991-05-14
2 -- Created by: Laurent PAINNOT
3 -- Copyright (c) 1991-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22
23
24 class GaussMultipleIntegration from math
25     ---Purpose:
26     -- This class implements the integration of a function of multiple 
27     -- variables between the parameter bounds Lower[a..b] and Upper[a..b].
28     --  Warning: Each element of Order must be inferior or equal to 61.
29
30
31 uses Vector from math, 
32      IntegerVector from math, 
33      MultipleVarFunction from math,
34      OStream from Standard
35
36 raises NotDone from StdFail
37
38 is
39
40      Create(F: in out MultipleVarFunction; Lower, Upper: Vector;
41             Order: IntegerVector)
42      ---Purpose:
43      -- The Gauss-Legendre integration with Order = points of 
44      -- integration for each unknow, is done on the function F 
45      -- between the bounds Lower and Upper.
46      
47      returns GaussMultipleIntegration;
48      
49      IsDone(me)
50         ---Purpose: returns True if all has been correctly done.
51         ---C++: inline
52
53      returns Boolean
54      is static;
55      
56      Value(me)
57         ---Purpose: returns the value of the integral.
58         ---C++: inline
59
60      returns Real
61      raises NotDone
62      is static;
63
64
65     Dump(me; o: in out OStream)
66         ---Purpose: Prints information on the current state of the object.
67
68     is static;
69
70
71
72 fields
73
74 Val: Real;
75 Done: Boolean;
76
77 end GaussMultipleIntegration;