IntPatch_TheSurfFunction Class Reference

#include <IntPatch_TheSurfFunction.hxx>

Inheritance diagram for IntPatch_TheSurfFunction:

Public Member Functions
	IntPatch_TheSurfFunction ()
	IntPatch_TheSurfFunction (const Handle< Adaptor3d_Surface > &PS, const IntSurf_Quadric &IS)
	IntPatch_TheSurfFunction (const IntSurf_Quadric &IS)
void	Set (const Handle< Adaptor3d_Surface > &PS)
void	SetImplicitSurface (const IntSurf_Quadric &IS)
void	Set (const Standard_Real Tolerance)
Standard_Integer	NbVariables () const
	Returns the number of variables of the function.
Standard_Integer	NbEquations () const
	Returns the number of equations of the function.
Standard_Boolean	Value (const math_Vector &X, math_Vector &F)
	Computes the values <F> of the Functions for the variable <X>. Returns True if the computation was done successfully, False otherwise.
Standard_Boolean	Derivatives (const math_Vector &X, math_Matrix &D)
	Returns the values <D> of the derivatives for the variable <X>. Returns True if the computation was done successfully, False otherwise.
Standard_Boolean	Values (const math_Vector &X, math_Vector &F, math_Matrix &D)
	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.
Standard_Real	Root () const
Standard_Real	Tolerance () const
	Returns the value Tol so that if Abs(Func.Root())<Tol the function is considered null.
const gp_Pnt &	Point () const
Standard_Boolean	IsTangent ()
const gp_Vec &	Direction3d ()
const gp_Dir2d &	Direction2d ()
const Handle< Adaptor3d_Surface > &	PSurface () const
const IntSurf_Quadric &	ISurface () const
Public Member Functions inherited from math_FunctionSet
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 ()

Constructor & Destructor Documentation

IntPatch_TheSurfFunction() [1/3]

IntPatch_TheSurfFunction::IntPatch_TheSurfFunction

(

)

IntPatch_TheSurfFunction() [2/3]

IntPatch_TheSurfFunction::IntPatch_TheSurfFunction	(	const Handle< Adaptor3d_Surface > &	PS,
		const IntSurf_Quadric &	IS
	)

IntPatch_TheSurfFunction() [3/3]

IntPatch_TheSurfFunction::IntPatch_TheSurfFunction

(

const IntSurf_Quadric &

IS

)

Member Function Documentation

Derivatives()

Standard_Boolean IntPatch_TheSurfFunction::Derivatives ( const math_Vector &  X, math_Matrix &  D  )

virtual

Returns the values <D> of the derivatives for the variable <X>. Returns True if the computation was done successfully, False otherwise.

Implements math_FunctionSetWithDerivatives.

Direction2d()

const gp_Dir2d & IntPatch_TheSurfFunction::Direction2d

(

)

Direction3d()

const gp_Vec & IntPatch_TheSurfFunction::Direction3d

(

)

IsTangent()

Standard_Boolean IntPatch_TheSurfFunction::IsTangent

(

)

ISurface()

const IntSurf_Quadric & IntPatch_TheSurfFunction::ISurface

(

)

const

NbEquations()

Standard_Integer IntPatch_TheSurfFunction::NbEquations ( ) const

virtual

Returns the number of equations of the function.

Implements math_FunctionSetWithDerivatives.

NbVariables()

Standard_Integer IntPatch_TheSurfFunction::NbVariables ( ) const

virtual

Returns the number of variables of the function.

Implements math_FunctionSetWithDerivatives.

Point()

const gp_Pnt & IntPatch_TheSurfFunction::Point

(

)

const

PSurface()

const Handle< Adaptor3d_Surface > & IntPatch_TheSurfFunction::PSurface

(

)

const

Root()

Standard_Real IntPatch_TheSurfFunction::Root

(

)

const

Set() [1/2]

void IntPatch_TheSurfFunction::Set

(

const Handle< Adaptor3d_Surface > &

PS

)

Set() [2/2]

void IntPatch_TheSurfFunction::Set

(

const Standard_Real

Tolerance

)

SetImplicitSurface()

void IntPatch_TheSurfFunction::SetImplicitSurface

(

const IntSurf_Quadric &

IS

)

Tolerance()

Standard_Real IntPatch_TheSurfFunction::Tolerance

(

)

const

Returns the value Tol so that if Abs(Func.Root())<Tol the function is considered null.

Value()

Standard_Boolean IntPatch_TheSurfFunction::Value ( const math_Vector &  X, math_Vector &  F  )

virtual

Computes the values <F> of the Functions for the variable <X>. Returns True if the computation was done successfully, False otherwise.

Implements math_FunctionSetWithDerivatives.

Values()

Standard_Boolean IntPatch_TheSurfFunction::Values ( const math_Vector &  X, math_Vector &  F, math_Matrix &  D  )

virtual

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.

Implements math_FunctionSetWithDerivatives.

---

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

• IntPatch_TheSurfFunction.hxx