Open CASCADE Technology 7.7.2
Public Member Functions
Extrema_FuncExtSS Class Reference

Function to find extrema of the distance between two surfaces. More...

#include <Extrema_FuncExtSS.hxx>

Inheritance diagram for Extrema_FuncExtSS:
Inheritance graph
[legend]

Public Member Functions

 Extrema_FuncExtSS ()
 
 Extrema_FuncExtSS (const Adaptor3d_Surface &S1, const Adaptor3d_Surface &S2)
 
void Initialize (const Adaptor3d_Surface &S1, const Adaptor3d_Surface &S2)
 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
 Calculate Fi(U,V).
 
Standard_Boolean Derivatives (const math_Vector &UV, math_Matrix &DF) override
 Calculate Fi'(U,V).
 
Standard_Boolean Values (const math_Vector &UV, math_Vector &F, math_Matrix &DF) override
 Calculate 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_POnSurfPointOnS1 (const Standard_Integer N) const
 Return the Nth extremum on S1.
 
const Extrema_POnSurfPointOnS2 (const Standard_Integer N) const
 Renvoie le Nieme extremum sur S2.
 
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 two surfaces.

Constructor & Destructor Documentation

◆ Extrema_FuncExtSS() [1/2]

Extrema_FuncExtSS::Extrema_FuncExtSS ( )

◆ Extrema_FuncExtSS() [2/2]

Extrema_FuncExtSS::Extrema_FuncExtSS ( const Adaptor3d_Surface S1,
const Adaptor3d_Surface S2 
)

Member Function Documentation

◆ Derivatives()

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

Calculate Fi'(U,V).

Implements math_FunctionSetWithDerivatives.

◆ GetStateNumber()

virtual Standard_Integer Extrema_FuncExtSS::GetStateNumber ( )
overridevirtual

Save the found extremum.

Reimplemented from math_FunctionSet.

◆ Initialize()

void Extrema_FuncExtSS::Initialize ( const Adaptor3d_Surface S1,
const Adaptor3d_Surface S2 
)

sets the field mysurf of the function.

◆ NbEquations()

Standard_Integer Extrema_FuncExtSS::NbEquations ( ) const
overridevirtual

Returns the number of equations of the function.

Implements math_FunctionSetWithDerivatives.

◆ NbExt()

Standard_Integer Extrema_FuncExtSS::NbExt ( ) const

Return the number of found extrema.

◆ NbVariables()

Standard_Integer Extrema_FuncExtSS::NbVariables ( ) const
overridevirtual

Returns the number of variables of the function.

Implements math_FunctionSetWithDerivatives.

◆ PointOnS1()

const Extrema_POnSurf & Extrema_FuncExtSS::PointOnS1 ( const Standard_Integer  N) const

Return the Nth extremum on S1.

◆ PointOnS2()

const Extrema_POnSurf & Extrema_FuncExtSS::PointOnS2 ( const Standard_Integer  N) const

Renvoie le Nieme extremum sur S2.

◆ SquareDistance()

Standard_Real Extrema_FuncExtSS::SquareDistance ( const Standard_Integer  N) const

Return the value of the Nth distance.

◆ Value()

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

Calculate Fi(U,V).

Implements math_FunctionSetWithDerivatives.

◆ Values()

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

Calculate Fi(U,V) and Fi'(U,V).

Implements math_FunctionSetWithDerivatives.


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