Geom2dGcc_FunctionTanCirCu Class Reference

This abstract class describes a Function of 1 Variable used to find a line tangent to a curve and a circle. More...

#include <Geom2dGcc_FunctionTanCirCu.hxx>

Inheritance diagram for Geom2dGcc_FunctionTanCirCu:

Public Member Functions
	Geom2dGcc_FunctionTanCirCu (const gp_Circ2d &Circ, const Geom2dAdaptor_Curve &Curv)
bool	Value (const double X, double &F) override
	Computes the value of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.
bool	Derivative (const double X, double &Deriv) override
	Computes the derivative of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.
bool	Values (const double X, double &F, double &Deriv) override
	Computes the value and the derivative of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.
Public Member Functions inherited from math_FunctionWithDerivative
	~math_FunctionWithDerivative () override
Public Member Functions inherited from math_Function
virtual	~math_Function ()=default
	Virtual destructor, for safe inheritance.
virtual int	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.

Detailed Description

This abstract class describes a Function of 1 Variable used to find a line tangent to a curve and a circle.

Constructor & Destructor Documentation

Geom2dGcc_FunctionTanCirCu()

Geom2dGcc_FunctionTanCirCu::Geom2dGcc_FunctionTanCirCu	(	const gp_Circ2d &	Circ,
		const Geom2dAdaptor_Curve &	Curv )

Member Function Documentation

Derivative()

bool Geom2dGcc_FunctionTanCirCu::Derivative ( const double X, double & Deriv )

overridevirtual

Computes the derivative of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

Implements math_FunctionWithDerivative.

Value()

bool Geom2dGcc_FunctionTanCirCu::Value ( const double X, double & F )

overridevirtual

Computes the value of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

Implements math_FunctionWithDerivative.

Values()

bool Geom2dGcc_FunctionTanCirCu::Values ( const double X, double & F, double & Deriv )

overridevirtual

Computes the value and the derivative of the function F for the variable X. It returns True if the computation is successfully done, False otherwise.

Implements math_FunctionWithDerivative.

---

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

• Geom2dGcc_FunctionTanCirCu.hxx