IntTools_Root Class Reference

The class is to describe the root of function of one variable for Edge/Edge and Edge/Surface algorithms. More...

#include <IntTools_Root.hxx>

Public Member Functions
	IntTools_Root ()
	Empty constructor. More...
	IntTools_Root (const Standard_Real aRoot, const Standard_Integer aType)
	Initializes my by range of parameters and type of root. More...
void	SetRoot (const Standard_Real aRoot)
	Sets the Root's value. More...
void	SetType (const Standard_Integer aType)
	Sets the Root's Type. More...
void	SetStateBefore (const TopAbs_State aState)
	Set the value of the state before the root (at t=Root-dt) More...
void	SetStateAfter (const TopAbs_State aState)
	Set the value of the state after the root (at t=Root-dt) More...
void	SetLayerHeight (const Standard_Real aHeight)
	Not used in Edge/Edge algorithm. More...
void	SetInterval (const Standard_Real t1, const Standard_Real t2, const Standard_Real f1, const Standard_Real f2)
	Sets the interval from which the Root was found [t1,t2] and the corresponding values of the function on the bounds f(t1), f(t2). More...
Standard_Real	Root () const
	Returns the Root value. More...
Standard_Integer	Type () const
	Returns the type of the root =0 - Simple (was found by bisection method); =2 - Smart when f1=0, f2!=0 or vice versa (was found by Fibbonacci method); =1 - Pure (pure zero for all t [t1,t2] );. More...
TopAbs_State	StateBefore () const
	Returns the state before the root. More...
TopAbs_State	StateAfter () const
	Returns the state after the root. More...
Standard_Real	LayerHeight () const
	Not used in Edge/Edge algorithm. More...
Standard_Boolean	IsValid () const
	Returns the validity flag for the root, True if myStateBefore==TopAbs_OUT && myStateAfter==TopAbs_IN or myStateBefore==TopAbs_OUT && myStateAfter==TopAbs_ON or myStateBefore==TopAbs_ON && myStateAfter==TopAbs_OUT or myStateBefore==TopAbs_IN && myStateAfter==TopAbs_OUT . For other cases it returns False. More...
void	Interval (Standard_Real &t1, Standard_Real &t2, Standard_Real &f1, Standard_Real &f2) const
	Returns the values of interval from which the Root was found [t1,t2] and the corresponding values of the function on the bounds f(t1), f(t2). More...

Detailed Description

The class is to describe the root of function of one variable for Edge/Edge and Edge/Surface algorithms.

Constructor & Destructor Documentation

IntTools_Root() [1/2]

IntTools_Root::IntTools_Root

(

)

Empty constructor.

IntTools_Root() [2/2]

IntTools_Root::IntTools_Root	(	const Standard_Real	aRoot,
		const Standard_Integer	aType
	)

Initializes my by range of parameters and type of root.

Member Function Documentation

Interval()

void IntTools_Root::Interval	(	Standard_Real &	t1,
		Standard_Real &	t2,
		Standard_Real &	f1,
		Standard_Real &	f2
	)		const

Returns the values of interval from which the Root was found [t1,t2] and the corresponding values of the function on the bounds f(t1), f(t2).

IsValid()

Standard_Boolean IntTools_Root::IsValid

(

)

const

Returns the validity flag for the root, True if myStateBefore==TopAbs_OUT && myStateAfter==TopAbs_IN or myStateBefore==TopAbs_OUT && myStateAfter==TopAbs_ON or myStateBefore==TopAbs_ON && myStateAfter==TopAbs_OUT or myStateBefore==TopAbs_IN && myStateAfter==TopAbs_OUT . For other cases it returns False.

LayerHeight()

Standard_Real IntTools_Root::LayerHeight

(

)

const

Not used in Edge/Edge algorithm.

Root()

Standard_Real IntTools_Root::Root

(

)

const

Returns the Root value.

SetInterval()

void IntTools_Root::SetInterval	(	const Standard_Real	t1,
		const Standard_Real	t2,
		const Standard_Real	f1,
		const Standard_Real	f2
	)

Sets the interval from which the Root was found [t1,t2] and the corresponding values of the function on the bounds f(t1), f(t2).

SetLayerHeight()

void IntTools_Root::SetLayerHeight

(

const Standard_Real

aHeight

)

Not used in Edge/Edge algorithm.

SetRoot()

void IntTools_Root::SetRoot

(

const Standard_Real

aRoot

)

Sets the Root's value.

SetStateAfter()

void IntTools_Root::SetStateAfter

(

const TopAbs_State

aState

)

Set the value of the state after the root (at t=Root-dt)

SetStateBefore()

void IntTools_Root::SetStateBefore

(

const TopAbs_State

aState

)

Set the value of the state before the root (at t=Root-dt)

SetType()

void IntTools_Root::SetType

(

const Standard_Integer

aType

)

Sets the Root's Type.

StateAfter()

TopAbs_State IntTools_Root::StateAfter

(

)

const

Returns the state after the root.

StateBefore()

TopAbs_State IntTools_Root::StateBefore

(

)

const

Returns the state before the root.

Type()

Standard_Integer IntTools_Root::Type

(

)

const

Returns the type of the root =0 - Simple (was found by bisection method); =2 - Smart when f1=0, f2!=0 or vice versa (was found by Fibbonacci method); =1 - Pure (pure zero for all t [t1,t2] );.

---

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

• IntTools_Root.hxx