src/math/math_GaussSingleIntegration.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 GaussSingleIntegration from math
  25         ---Purpose:
  26         -- This class implements the integration of a function of a single variable
  27         -- between the parameter bounds Lower and Upper.
  28         --  Warning: Order must be inferior or equal to 61.
  29
  30
  31 uses Function from math,
  32      OStream from Standard
  33
  34 raises NotDone from StdFail
  35
  36 is
  37      Create
  38      returns GaussSingleIntegration;
  39
  40      Create(F: in out Function; Lower, Upper: Real; Order: Integer)
  41         ---Purpose:
  42         -- The Gauss-Legendre integration with N = Order points of integration,
  43         -- is done on the function F between the bounds Lower and Upper.
  44
  45      returns GaussSingleIntegration;
  46
  47      Create(F: in out Function; Lower, Upper: Real; Order: Integer; Tol: Real)
  48         ---Purpose:
  49         -- The Gauss-Legendre integration with N = Order points of integration  and
  50         -- given tolerance = Tol is done on the function F between the bounds
  51         -- Lower and Upper.
  52
  53      returns GaussSingleIntegration;
  54
  55      Perform(me: in out; F: in out Function; Lower, Upper: Real; Order: Integer)
  56         ---Purpose:  perfoms  actual  computation
  57      is private;
  58
  59      IsDone(me)
  60         ---Purpose: returns True if all has been correctly done.
  61         ---C++: inline
  62
  63      returns Boolean
  64      is static;
  65
  66
  67      Value(me)
  68         ---Purpose: returns the value of the integral.
  69         ---C++: inline
  70
  71      returns Real
  72      raises NotDone
  73      is static;
  74
  75
  76     Dump(me; o: in out OStream)
  77         ---Purpose: Prints information on the current state of the object.
  78
  79     is static;
  80
  81
  82 fields
  83
  84 Val: Real;
  85 Done: Boolean;
  86
  87 end GaussSingleIntegration;