include/opencascade/math_GaussSingleIntegration.hxx

0001 // Created on: 1991-05-14
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1991-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _math_GaussSingleIntegration_HeaderFile
0018 #define _math_GaussSingleIntegration_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <Standard_OStream.hxx>
0025 class math_Function;
0026
0027
0028
0029 //! This class implements the integration of a function of a single variable
0030 //! between the parameter bounds Lower and Upper.
0031 //! Warning: Order must be inferior or equal to 61.
0032 class math_GaussSingleIntegration
0033 {
0034 public:
0035
0036   DEFINE_STANDARD_ALLOC
0037
0038
0039   Standard_EXPORT math_GaussSingleIntegration();
0040
0041
0042   //! The Gauss-Legendre integration with N = Order points of integration,
0043   //! is done on the function F between the bounds Lower and Upper.
0044   Standard_EXPORT math_GaussSingleIntegration(math_Function& F, const Standard_Real Lower, const Standard_Real Upper, const Standard_Integer Order);
0045
0046
0047   //! The Gauss-Legendre integration with N = Order points of integration  and
0048   //! given tolerance = Tol is done on the function F between the bounds
0049   //! Lower and Upper.
0050   Standard_EXPORT math_GaussSingleIntegration(math_Function& F, const Standard_Real Lower, const Standard_Real Upper, const Standard_Integer Order, const Standard_Real Tol);
0051
0052   //! returns True if all has been correctly done.
0053     Standard_Boolean IsDone() const;
0054
0055   //! returns the value of the integral.
0056     Standard_Real Value() const;
0057
0058   //! Prints information on the current state of the object.
0059   Standard_EXPORT void Dump (Standard_OStream& o) const;
0060
0061
0062
0063
0064 protected:
0065
0066
0067
0068
0069
0070 private:
0071
0072
0073   //! performs  actual  computation
0074   Standard_EXPORT void Perform (math_Function& F, const Standard_Real Lower, const Standard_Real Upper, const Standard_Integer Order);
0075
0076
0077   Standard_Real Val;
0078   Standard_Boolean Done;
0079
0080
0081 };
0082
0083
0084 #include <math_GaussSingleIntegration.lxx>
0085
0086
0087
0088
0089
0090 #endif // _math_GaussSingleIntegration_HeaderFile