// This file is generated by WOK (CPPExt). // Please do not edit this file; modify original file instead. // The copyright and license terms as defined for the original file apply to // this header file considered to be the "object code" form of the original source. #ifndef _math_FunctionRoots_HeaderFile #define _math_FunctionRoots_HeaderFile #ifndef _Standard_HeaderFile #include #endif #ifndef _Standard_Macro_HeaderFile #include #endif #ifndef _Standard_Boolean_HeaderFile #include #endif #ifndef _TColStd_SequenceOfReal_HeaderFile #include #endif #ifndef _TColStd_SequenceOfInteger_HeaderFile #include #endif #ifndef _Standard_Real_HeaderFile #include #endif #ifndef _Standard_Integer_HeaderFile #include #endif #ifndef _Standard_OStream_HeaderFile #include #endif 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: void* operator new(size_t,void* anAddress) { return anAddress; } void* operator new(size_t size) { return Standard::Allocate(size); } void operator delete(void *anAddress) { if (anAddress) Standard::Free((Standard_Address&)anAddress); } //! 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 // other Inline functions and methods (like "C++: function call" methods) #endif