OCC Main Page | FoundationClasses | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

FoundationClasses
TKMath
math


math_FunctionAllRoots Class Reference

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

#include <math_FunctionAllRoots.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT math_FunctionAllRoots (math_FunctionWithDerivative &F, const math_FunctionSample &S, const Standard_Real EpsX, const Standard_Real EpsF, const Standard_Real EpsNul)
 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_Boolean IsDone () const
 Returns True if the computation has been done successfully.
.
Standard_Integer NbIntervals () const
 Returns the number of intervals on which the function
is Null.
An exception is raised if IsDone returns False.
.
void GetInterval (const Standard_Integer Index, Standard_Real &A, Standard_Real &B) 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 GetIntervalState (const Standard_Integer Index, Standard_Integer &IFirst, Standard_Integer &ILast) 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.

Standard_Integer NbPoints () const
 returns the number of points where the function is Null.
An exception is raised if IsDone returns False.

Standard_Real GetPoint (const Standard_Integer Index) 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_Integer GetPointState (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_EXPORT void Dump (Standard_OStream &o) const
 Prints on the stream o information on the current state
of the object.
.

Private Attributes

Standard_Boolean done
TColStd_SequenceOfReal pdeb
TColStd_SequenceOfReal pfin
TColStd_SequenceOfReal piso
TColStd_SequenceOfInteger ideb
TColStd_SequenceOfInteger ifin
TColStd_SequenceOfInteger iiso


Constructor & Destructor Documentation

Standard_EXPORT math_FunctionAllRoots::math_FunctionAllRoots math_FunctionWithDerivative F,
const math_FunctionSample S,
const Standard_Real  EpsX,
const Standard_Real  EpsF,
const Standard_Real  EpsNul
 


Member Function Documentation

Standard_EXPORT void math_FunctionAllRoots::Dump Standard_OStream o  )  const
 

void math_FunctionAllRoots::GetInterval const Standard_Integer  Index,
Standard_Real A,
Standard_Real B
const [inline]
 

void math_FunctionAllRoots::GetIntervalState const Standard_Integer  Index,
Standard_Integer IFirst,
Standard_Integer ILast
const [inline]
 

Standard_Real math_FunctionAllRoots::GetPoint const Standard_Integer  Index  )  const [inline]
 

Standard_Integer math_FunctionAllRoots::GetPointState const Standard_Integer  Index  )  const [inline]
 

Standard_Boolean math_FunctionAllRoots::IsDone  )  const [inline]
 

Standard_Integer math_FunctionAllRoots::NbIntervals  )  const [inline]
 

Standard_Integer math_FunctionAllRoots::NbPoints  )  const [inline]
 

void math_FunctionAllRoots::operator delete void *  anAddress  )  [inline]
 

void* math_FunctionAllRoots::operator new size_t  size  )  [inline]
 

void* math_FunctionAllRoots::operator new size_t  ,
void *  anAddress
[inline]
 


Field Documentation

Standard_Boolean math_FunctionAllRoots::done [private]
 

TColStd_SequenceOfInteger math_FunctionAllRoots::ideb [private]
 

TColStd_SequenceOfInteger math_FunctionAllRoots::ifin [private]
 

TColStd_SequenceOfInteger math_FunctionAllRoots::iiso [private]
 

TColStd_SequenceOfReal math_FunctionAllRoots::pdeb [private]
 

TColStd_SequenceOfReal math_FunctionAllRoots::pfin [private]
 

TColStd_SequenceOfReal math_FunctionAllRoots::piso [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:12:45 2008 for OpenCASCADE by  doxygen 1.4.1