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_FunctionAllRoots.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

127 lines
4.1 KiB
C++

// Created on: 1991-07-17
// Created by: Isabelle GRIGNON
// Copyright (c) 1991-1999 Matra Datavision
// Copyright (c) 1999-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_FunctionAllRoots_HeaderFile
#define _math_FunctionAllRoots_HeaderFile
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>
#include <Standard_Boolean.hxx>
#include <TColStd_SequenceOfReal.hxx>
#include <TColStd_SequenceOfInteger.hxx>
#include <Standard_Real.hxx>
#include <Standard_Integer.hxx>
#include <Standard_OStream.hxx>
class Standard_OutOfRange;
class StdFail_NotDone;
class Standard_NumericError;
class math_FunctionWithDerivative;
class math_FunctionSample;
//! This algorithm uses a sample of the function to find
//! all intervals on which the function is null, and afterwards
//! uses the FunctionRoots algorithm to find the points
//! where the function is null outside the "null intervals".
//! Knowledge of the derivative is required.
class math_FunctionAllRoots
{
public:
DEFINE_STANDARD_ALLOC
//! The algorithm uses the sample to find intervals on which
//! the function is null. An interval is found if, for at least
//! two consecutive points of the sample, Ui and Ui+1, we get
//! |F(Ui)|<=EpsNul and |F(Ui+1)|<=EpsNul. The real bounds of
//! an interval are computed with the FunctionRoots.
//! algorithm.
//! Between two intervals, the roots of the function F are
//! calculated using the FunctionRoots algorithm.
Standard_EXPORT math_FunctionAllRoots(math_FunctionWithDerivative& F, const math_FunctionSample& S, const Standard_Real EpsX, const Standard_Real EpsF, const Standard_Real EpsNul);
//! Returns True if the computation has been done successfully.
Standard_Boolean IsDone() const;
//! Returns the number of intervals on which the function
//! is Null.
//! An exception is raised if IsDone returns False.
Standard_Integer NbIntervals() const;
//! Returns the interval of parameter of range Index.
//! An exception is raised if IsDone returns False;
//! An exception is raised if Index<=0 or Index >Nbintervals.
void GetInterval (const Standard_Integer Index, Standard_Real& A, Standard_Real& B) const;
//! returns the State Number associated to the interval Index.
//! An exception is raised if IsDone returns False;
//! An exception is raised if Index<=0 or Index >Nbintervals.
void GetIntervalState (const Standard_Integer Index, Standard_Integer& IFirst, Standard_Integer& ILast) const;
//! returns the number of points where the function is Null.
//! An exception is raised if IsDone returns False.
Standard_Integer NbPoints() const;
//! Returns the parameter of the point of range Index.
//! An exception is raised if IsDone returns False;
//! An exception is raised if Index<=0 or Index >NbPoints.
Standard_Real GetPoint (const Standard_Integer Index) const;
//! returns the State Number associated to the point Index.
//! An exception is raised if IsDone returns False;
//! An exception is raised if Index<=0 or Index >Nbintervals.
Standard_Integer GetPointState (const Standard_Integer Index) const;
//! Prints on the stream o information on the current state
//! of the object.
Standard_EXPORT void Dump (Standard_OStream& o) const;
protected:
private:
Standard_Boolean done;
TColStd_SequenceOfReal pdeb;
TColStd_SequenceOfReal pfin;
TColStd_SequenceOfReal piso;
TColStd_SequenceOfInteger ideb;
TColStd_SequenceOfInteger ifin;
TColStd_SequenceOfInteger iiso;
};
#include <math_FunctionAllRoots.lxx>
#endif // _math_FunctionAllRoots_HeaderFile