Open CASCADE Technology 7.7.0
Public Member Functions
Extrema_FuncExtCS Class Reference

Function to find extrema of the distance between a curve and a surface. More...

#include <Extrema_FuncExtCS.hxx>

Inheritance diagram for Extrema_FuncExtCS:
Inheritance graph
[legend]

Public Member Functions

 Extrema_FuncExtCS ()
 
 Extrema_FuncExtCS (const Adaptor3d_Curve &C, const Adaptor3d_Surface &S)
 
void Initialize (const Adaptor3d_Curve &C, const Adaptor3d_Surface &S)
 sets the field mysurf of the function.
 
Standard_Integer NbVariables () const override
 Returns the number of variables of the function.
 
Standard_Integer NbEquations () const override
 Returns the number of equations of the function.
 
Standard_Boolean Value (const math_Vector &UV, math_Vector &F) override
 Calculation of Fi(U,V).
 
Standard_Boolean Derivatives (const math_Vector &UV, math_Matrix &DF) override
 Calculation of Fi'(U,V).
 
Standard_Boolean Values (const math_Vector &UV, math_Vector &F, math_Matrix &DF) override
 Calculation of Fi(U,V) and Fi'(U,V).
 
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
 Return the value of the Nth distance.
 
const Extrema_POnCurvPointOnCurve (const Standard_Integer N) const
 Returns the Nth extremum on C.
 
const Extrema_POnSurfPointOnSurface (const Standard_Integer N) const
 Return the Nth extremum on S.
 
TColStd_SequenceOfRealSquareDistances ()
 Change Sequence of SquareDistance.
 
Extrema_SequenceOfPOnCurvPointsOnCurve ()
 Change Sequence of PointOnCurv.
 
Extrema_SequenceOfPOnSurfPointsOnSurf ()
 Change Sequence of PointOnSurf.
 
virtual Standard_Integer NbVariables () const =0
 Returns the number of variables of the function.
 
virtual Standard_Integer NbEquations () const =0
 Returns the number of equations of the function.
 
virtual Standard_Boolean Value (const math_Vector &X, math_Vector &F)=0
 Computes the values <F> of the Functions for the variable <X>. Returns True if the computation was done successfully, False otherwise.
 
virtual Standard_Boolean Derivatives (const math_Vector &X, math_Matrix &D)=0
 Returns the values <D> of the derivatives for the variable <X>. Returns True if the computation was done successfully, False otherwise.
 
virtual Standard_Boolean Values (const math_Vector &X, math_Vector &F, math_Matrix &D)=0
 returns the values <F> of the functions and the derivatives <D> for the variable <X>. Returns True if the computation was done successfully, False otherwise.
 
- Public Member Functions inherited from math_FunctionSet
virtual Standard_Integer NbVariables () const =0
 Returns the number of variables of the function.
 
virtual Standard_Integer NbEquations () const =0
 Returns the number of equations of the function.
 
virtual Standard_Boolean Value (const math_Vector &X, math_Vector &F)=0
 Computes the values <F> of the functions for the 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 latestcall of any methods associated with the function. This function is called by each of the algorithms described later which define 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.
 
virtual ~math_FunctionSet ()
 

Detailed Description

Function to find extrema of the distance between a curve and a surface.

Constructor & Destructor Documentation

◆ Extrema_FuncExtCS() [1/2]

Extrema_FuncExtCS::Extrema_FuncExtCS ( )

◆ Extrema_FuncExtCS() [2/2]

Extrema_FuncExtCS::Extrema_FuncExtCS ( const Adaptor3d_Curve C,
const Adaptor3d_Surface S 
)

Member Function Documentation

◆ Derivatives()

Standard_Boolean Extrema_FuncExtCS::Derivatives ( const math_Vector UV,
math_Matrix DF 
)
overridevirtual

Calculation of Fi'(U,V).

Implements math_FunctionSetWithDerivatives.

◆ GetStateNumber()

virtual Standard_Integer Extrema_FuncExtCS::GetStateNumber ( )
overridevirtual

Save the found extremum.

Reimplemented from math_FunctionSet.

◆ Initialize()

void Extrema_FuncExtCS::Initialize ( const Adaptor3d_Curve C,
const Adaptor3d_Surface S 
)

sets the field mysurf of the function.

◆ NbEquations()

Standard_Integer Extrema_FuncExtCS::NbEquations ( ) const
overridevirtual

Returns the number of equations of the function.

Implements math_FunctionSetWithDerivatives.

◆ NbExt()

Standard_Integer Extrema_FuncExtCS::NbExt ( ) const

Return the number of found extrema.

◆ NbVariables()

Standard_Integer Extrema_FuncExtCS::NbVariables ( ) const
overridevirtual

Returns the number of variables of the function.

Implements math_FunctionSetWithDerivatives.

◆ PointOnCurve()

const Extrema_POnCurv & Extrema_FuncExtCS::PointOnCurve ( const Standard_Integer  N) const

Returns the Nth extremum on C.

◆ PointOnSurface()

const Extrema_POnSurf & Extrema_FuncExtCS::PointOnSurface ( const Standard_Integer  N) const

Return the Nth extremum on S.

◆ PointsOnCurve()

Extrema_SequenceOfPOnCurv & Extrema_FuncExtCS::PointsOnCurve ( )
inline

Change Sequence of PointOnCurv.

◆ PointsOnSurf()

Extrema_SequenceOfPOnSurf & Extrema_FuncExtCS::PointsOnSurf ( )
inline

Change Sequence of PointOnSurf.

◆ SquareDistance()

Standard_Real Extrema_FuncExtCS::SquareDistance ( const Standard_Integer  N) const

Return the value of the Nth distance.

◆ SquareDistances()

TColStd_SequenceOfReal & Extrema_FuncExtCS::SquareDistances ( )
inline

Change Sequence of SquareDistance.

◆ Value()

Standard_Boolean Extrema_FuncExtCS::Value ( const math_Vector UV,
math_Vector F 
)
overridevirtual

Calculation of Fi(U,V).

Implements math_FunctionSetWithDerivatives.

◆ Values()

Standard_Boolean Extrema_FuncExtCS::Values ( const math_Vector UV,
math_Vector F,
math_Matrix DF 
)
overridevirtual

Calculation of Fi(U,V) and Fi'(U,V).

Implements math_FunctionSetWithDerivatives.


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