# GCPnts_DistFunction Class Reference

Class to define function, which calculates square distance between point on curve C(u), U1 <= u <= U2 and line passing through points C(U1) and C(U2) This function is used in any minimisation algorithm to define maximal deviation between curve and line, which required one variable function without derivative (for ex. math_BrentMinimum) More...

`#include <GCPnts_DistFunction.hxx>`

Inheritance diagram for GCPnts_DistFunction: [legend]

## Public Member Functions

GCPnts_DistFunction (const Adaptor3d_Curve &theCurve, const Standard_Real U1, const Standard_Real U2)

GCPnts_DistFunction (const GCPnts_DistFunction &theOther)

virtual Standard_Boolean Value (const Standard_Real X, Standard_Real &F)
Computes the value of the function <F> for a given value of variable <X>. returns True if the computation was done successfully, False otherwise. More... Public Member Functions inherited from math_Function
virtual ~math_Function ()
Virtual destructor, for safe inheritance. More...

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

## Detailed Description

Class to define function, which calculates square distance between point on curve C(u), U1 <= u <= U2 and line passing through points C(U1) and C(U2) This function is used in any minimisation algorithm to define maximal deviation between curve and line, which required one variable function without derivative (for ex. math_BrentMinimum)

## Constructor & Destructor Documentation

 GCPnts_DistFunction::GCPnts_DistFunction ( const Adaptor3d_Curve & theCurve, const Standard_Real U1, const Standard_Real U2 )
 GCPnts_DistFunction::GCPnts_DistFunction ( const GCPnts_DistFunction & theOther )

## Member Function Documentation

 virtual Standard_Boolean GCPnts_DistFunction::Value ( const Standard_Real X, Standard_Real & F )
virtual

Computes the value of the function <F> for a given value of variable <X>. returns True if the computation was done successfully, False otherwise.

Implements math_Function.

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