1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-26 10:19:45 +03:00
occt/src/math/math_KronrodSingleIntegration.hxx
abv 42cf5bc1ca 0024002: Overall code and build procedure refactoring -- automatic
Automatic upgrade of OCCT code by command "occt_upgrade . -nocdl":
- WOK-generated header files from inc and sources from drv are moved to src
- CDL files removed
- All packages are converted to nocdlpack
2015-07-12 07:42:38 +03:00

125 lines
4.4 KiB
C++

// Created on: 2005-12-08
// Created by: Sergey KHROMOV
// Copyright (c) 2005-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
#ifndef _math_KronrodSingleIntegration_HeaderFile
#define _math_KronrodSingleIntegration_HeaderFile
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>
#include <Standard_Boolean.hxx>
#include <Standard_Real.hxx>
#include <Standard_Integer.hxx>
#include <math_Vector.hxx>
class StdFail_NotDone;
class math_Function;
//! This class implements the Gauss-Kronrod method of
//! integral computation.
class math_KronrodSingleIntegration
{
public:
DEFINE_STANDARD_ALLOC
//! An empty constructor.
Standard_EXPORT math_KronrodSingleIntegration();
//! Constructor. Takes the function, the lower and upper bound
//! values, the initial number of Kronrod points
Standard_EXPORT math_KronrodSingleIntegration(math_Function& theFunction, const Standard_Real theLower, const Standard_Real theUpper, const Standard_Integer theNbPnts);
//! Constructor. Takes the function, the lower and upper bound
//! values, the initial number of Kronrod points, the
//! tolerance value and the maximal number of iterations as
//! parameters.
Standard_EXPORT math_KronrodSingleIntegration(math_Function& theFunction, const Standard_Real theLower, const Standard_Real theUpper, const Standard_Integer theNbPnts, const Standard_Real theTolerance, const Standard_Integer theMaxNbIter);
//! Computation of the integral. Takes the function,
//! the lower and upper bound values, the initial number
//! of Kronrod points, the relative tolerance value and the
//! maximal number of iterations as parameters.
//! theNbPnts should be odd and greater then or equal to 3.
Standard_EXPORT void Perform (math_Function& theFunction, const Standard_Real theLower, const Standard_Real theUpper, const Standard_Integer theNbPnts);
//! Computation of the integral. Takes the function,
//! the lower and upper bound values, the initial number
//! of Kronrod points, the relative tolerance value and the
//! maximal number of iterations as parameters.
//! theNbPnts should be odd and greater then or equal to 3.
//! Note that theTolerance is relative, i.e. the criterion of
//! solution reaching is:
//! Abs(Kronrod - Gauss)/Abs(Kronrod) < theTolerance.
//! theTolerance should be positive.
Standard_EXPORT void Perform (math_Function& theFunction, const Standard_Real theLower, const Standard_Real theUpper, const Standard_Integer theNbPnts, const Standard_Real theTolerance, const Standard_Integer theMaxNbIter);
//! Returns Standard_True if computation is performed
//! successfully.
Standard_Boolean IsDone() const;
//! Returns the value of the integral.
Standard_Real Value() const;
//! Returns the value of the relative error reached.
Standard_Real ErrorReached() const;
//! Returns the value of the relative error reached.
Standard_Real AbsolutError() const;
//! Returns the number of Kronrod points
//! for which the result is computed.
Standard_Integer OrderReached() const;
//! Returns the number of iterations
//! that were made to compute result.
Standard_Integer NbIterReached() const;
Standard_EXPORT static Standard_Boolean GKRule (math_Function& theFunction, const Standard_Real theLower, const Standard_Real theUpper, const math_Vector& theGaussP, const math_Vector& theGaussW, const math_Vector& theKronrodP, const math_Vector& theKronrodW, Standard_Real& theValue, Standard_Real& theError);
protected:
private:
Standard_Boolean myIsDone;
Standard_Real myValue;
Standard_Real myErrorReached;
Standard_Real myAbsolutError;
Standard_Integer myNbPntsReached;
Standard_Integer myNbIterReached;
};
#include <math_KronrodSingleIntegration.lxx>
#endif // _math_KronrodSingleIntegration_HeaderFile