Open CASCADE Technology 7.7.2
Public Member Functions
Extrema_PCFOfEPCOfExtPC Class Reference

#include <Extrema_PCFOfEPCOfExtPC.hxx>

Inheritance diagram for Extrema_PCFOfEPCOfExtPC:
Inheritance graph
[legend]

Public Member Functions

 Extrema_PCFOfEPCOfExtPC ()
 
 Extrema_PCFOfEPCOfExtPC (const gp_Pnt &P, const Adaptor3d_Curve &C)
 
void Initialize (const Adaptor3d_Curve &C)
 sets the field mycurve of the function.
 
void SetPoint (const gp_Pnt &P)
 sets the field P of the function.
 
Standard_Boolean Value (const Standard_Real U, Standard_Real &F) override
 Calculation of F(U).
 
Standard_Boolean Derivative (const Standard_Real U, Standard_Real &DF) override
 Calculation of F'(U).
 
Standard_Boolean Values (const Standard_Real U, Standard_Real &F, Standard_Real &DF) override
 Calculation of F(U) and F'(U).
 
virtual Standard_Integer GetStateNumber () override
 Save the found extremum.
 
Standard_Integer NbExt () const
 Return the number of found extrema.
 
Standard_Real SquareDistance (const Standard_Integer N) const
 Returns the Nth distance.
 
Standard_Boolean IsMin (const Standard_Integer N) const
 Shows if the Nth distance is a minimum.
 
const Extrema_POnCurvPoint (const Standard_Integer N) const
 Returns the Nth extremum.
 
void SubIntervalInitialize (const Standard_Real theUfirst, const Standard_Real theUlast)
 Determines boundaries of subinterval for find of root.
 
Standard_Real SearchOfTolerance ()
 Computes a Tol value. If 1st derivative of curve |D1|<Tol, it is considered D1=0.
 
- Public Member Functions inherited from math_FunctionWithDerivative
virtual Standard_Boolean Value (const Standard_Real X, Standard_Real &F)=0
 Computes the value <F>of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.
 
virtual Standard_Boolean Derivative (const Standard_Real X, Standard_Real &D)=0
 Computes the derivative <D> of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.
 
virtual Standard_Boolean Values (const Standard_Real X, Standard_Real &F, Standard_Real &D)=0
 Computes the value <F> and the derivative <D> of the function for the variable <X>. Returns True if the calculation were successfully done, False otherwise.
 
virtual ~math_FunctionWithDerivative ()
 
- Public Member Functions inherited from math_Function
virtual ~math_Function ()
 Virtual destructor, for safe inheritance.
 
virtual Standard_Boolean Value (const Standard_Real X, Standard_Real &F)=0
 Computes the value of the function <F> for a given value of variable <X>. returns True if the computation was done successfully, False otherwise.
 
virtual Standard_Integer GetStateNumber ()
 returns the state of the function corresponding to the latest call of any methods associated with the function. This function is called by each of the algorithms described later which defined the function Integer Algorithm::StateNumber(). The algorithm has the responsibility to call this function when it has found a solution (i.e. a root or a minimum) and has to maintain the association between the solution found and this StateNumber. Byu default, this method returns 0 (which means for the algorithm: no state has been saved). It is the responsibility of the programmer to decide if he needs to save the current state of the function and to return an Integer that allows retrieval of the state.
 

Constructor & Destructor Documentation

◆ Extrema_PCFOfEPCOfExtPC() [1/2]

Extrema_PCFOfEPCOfExtPC::Extrema_PCFOfEPCOfExtPC ( )

◆ Extrema_PCFOfEPCOfExtPC() [2/2]

Extrema_PCFOfEPCOfExtPC::Extrema_PCFOfEPCOfExtPC ( const gp_Pnt P,
const Adaptor3d_Curve C 
)

Member Function Documentation

◆ Derivative()

Standard_Boolean Extrema_PCFOfEPCOfExtPC::Derivative ( const Standard_Real  U,
Standard_Real DF 
)
overridevirtual

Calculation of F'(U).

Implements math_FunctionWithDerivative.

◆ GetStateNumber()

virtual Standard_Integer Extrema_PCFOfEPCOfExtPC::GetStateNumber ( )
overridevirtual

Save the found extremum.

Reimplemented from math_Function.

◆ Initialize()

void Extrema_PCFOfEPCOfExtPC::Initialize ( const Adaptor3d_Curve C)

sets the field mycurve of the function.

◆ IsMin()

Standard_Boolean Extrema_PCFOfEPCOfExtPC::IsMin ( const Standard_Integer  N) const

Shows if the Nth distance is a minimum.

◆ NbExt()

Standard_Integer Extrema_PCFOfEPCOfExtPC::NbExt ( ) const

Return the number of found extrema.

◆ Point()

const Extrema_POnCurv & Extrema_PCFOfEPCOfExtPC::Point ( const Standard_Integer  N) const

Returns the Nth extremum.

◆ SearchOfTolerance()

Standard_Real Extrema_PCFOfEPCOfExtPC::SearchOfTolerance ( )

Computes a Tol value. If 1st derivative of curve |D1|<Tol, it is considered D1=0.

◆ SetPoint()

void Extrema_PCFOfEPCOfExtPC::SetPoint ( const gp_Pnt P)

sets the field P of the function.

◆ SquareDistance()

Standard_Real Extrema_PCFOfEPCOfExtPC::SquareDistance ( const Standard_Integer  N) const

Returns the Nth distance.

◆ SubIntervalInitialize()

void Extrema_PCFOfEPCOfExtPC::SubIntervalInitialize ( const Standard_Real  theUfirst,
const Standard_Real  theUlast 
)

Determines boundaries of subinterval for find of root.

◆ Value()

Standard_Boolean Extrema_PCFOfEPCOfExtPC::Value ( const Standard_Real  U,
Standard_Real F 
)
overridevirtual

Calculation of F(U).

Implements math_FunctionWithDerivative.

◆ Values()

Standard_Boolean Extrema_PCFOfEPCOfExtPC::Values ( const Standard_Real  U,
Standard_Real F,
Standard_Real DF 
)
overridevirtual

Calculation of F(U) and F'(U).

Implements math_FunctionWithDerivative.


The documentation for this class was generated from the following file: