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 //! This class implements the integration of a function of a single variable
0028 //! between the parameter bounds Lower and Upper.
0029 //! Warning: Order must be inferior or equal to 61.
0030 class math_GaussSingleIntegration
0031 {
0032 public:
0033   DEFINE_STANDARD_ALLOC
0034
0035   Standard_EXPORT math_GaussSingleIntegration();
0036
0037   //! The Gauss-Legendre integration with N = Order points of integration,
0038   //! is done on the function F between the bounds Lower and Upper.
0039   Standard_EXPORT math_GaussSingleIntegration(math_Function& F,
0040                                               const double   Lower,
0041                                               const double   Upper,
0042                                               const int      Order);
0043
0044   //! The Gauss-Legendre integration with N = Order points of integration and
0045   //! given tolerance = Tol is done on the function F between the bounds
0046   //! Lower and Upper.
0047   Standard_EXPORT math_GaussSingleIntegration(math_Function& F,
0048                                               const double   Lower,
0049                                               const double   Upper,
0050                                               const int      Order,
0051                                               const double   Tol);
0052
0053   //! returns True if all has been correctly done.
0054   bool IsDone() const;
0055
0056   //! returns the value of the integral.
0057   double Value() const;
0058
0059   //! Prints information on the current state of the object.
0060   Standard_EXPORT void Dump(Standard_OStream& o) const;
0061
0062 private:
0063   //! performs actual computation
0064   Standard_EXPORT void Perform(math_Function& F,
0065                                const double   Lower,
0066                                const double   Upper,
0067                                const int      Order);
0068
0069   double Val{};
0070   bool   Done{};
0071 };
0072
0073 #include <math_GaussSingleIntegration.lxx>
0074
0075 #endif // _math_GaussSingleIntegration_HeaderFile