mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-07 18:30:55 +03:00
42cf5bc1ca
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
112 lines
3.3 KiB
C++
112 lines
3.3 KiB
C++
// Created on: 1991-05-13
|
|
// Created by: Laurent PAINNOT
|
|
// 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_FunctionRoots_HeaderFile
|
|
#define _math_FunctionRoots_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_RangeError;
|
|
class StdFail_NotDone;
|
|
class math_FunctionWithDerivative;
|
|
|
|
|
|
|
|
//! This class implements an algorithm which finds all the real roots of
|
|
//! a function with derivative within a given range.
|
|
//! Knowledge of the derivative is required.
|
|
class math_FunctionRoots
|
|
{
|
|
public:
|
|
|
|
DEFINE_STANDARD_ALLOC
|
|
|
|
|
|
//! Calculates all the real roots of a function F-K within the range
|
|
//! A..B. whithout conditions on A and B
|
|
//! A solution X is found when
|
|
//! abs(Xi - Xi-1) <= Epsx and abs(F(Xi)-K) <= EpsF.
|
|
//! The function is considered as null between A and B if
|
|
//! abs(F-K) <= EpsNull within this range.
|
|
Standard_EXPORT math_FunctionRoots(math_FunctionWithDerivative& F, const Standard_Real A, const Standard_Real B, const Standard_Integer NbSample, const Standard_Real EpsX = 0.0, const Standard_Real EpsF = 0.0, const Standard_Real EpsNull = 0.0, const Standard_Real K = 0.0);
|
|
|
|
//! Returns true if the computations are successful, otherwise returns false.
|
|
Standard_Boolean IsDone() const;
|
|
|
|
|
|
//! returns true if the function is considered as null between A and B.
|
|
//! Exceptions
|
|
//! StdFail_NotDone if the algorithm fails (and IsDone returns false).
|
|
Standard_Boolean IsAllNull() const;
|
|
|
|
//! Returns the number of solutions found.
|
|
//! Exceptions
|
|
//! StdFail_NotDone if the algorithm fails (and IsDone returns false).
|
|
Standard_Integer NbSolutions() const;
|
|
|
|
//! Returns the Nth value of the root of function F.
|
|
//! Exceptions
|
|
//! StdFail_NotDone if the algorithm fails (and IsDone returns false).
|
|
Standard_Real Value (const Standard_Integer Nieme) const;
|
|
|
|
|
|
//! returns the StateNumber of the Nieme root.
|
|
//! Exception RangeError is raised if Nieme is < 1
|
|
//! or Nieme > NbSolutions.
|
|
Standard_Integer StateNumber (const Standard_Integer Nieme) 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;
|
|
Standard_Boolean AllNull;
|
|
TColStd_SequenceOfReal Sol;
|
|
TColStd_SequenceOfInteger NbStateSol;
|
|
|
|
|
|
};
|
|
|
|
|
|
#include <math_FunctionRoots.lxx>
|
|
|
|
|
|
|
|
|
|
|
|
#endif // _math_FunctionRoots_HeaderFile
|