GoTools Intersections Library: Go::SingularityInfo Class Reference

List of all members.


Public Member Functions
	SingularityInfo ()
	Default constructor.
	SingularityInfo (boost::shared_ptr< SingularityInfo > previous, bool use_previous=false)
	Inheritance constructor.
	SingularityInfo (boost::shared_ptr< SingularityInfo > previous, int missing_dir)
	Inheritance constructor.
bool	hasPoint ()
	Check if singular point has been found.
int	getNmbPoints (int nmb_par)
	Get number of singular points.
double	getParam (int dir)
	Get a parameter for th last found singularity or closest point.
void	addIterationCount ()
	Increment the iteration count.
void	addSimpleCount (bool simple1, bool simple2)
	Increment the number of times the intersection objects are characterized as simple.
void	setSingularPoint (double *par, int nmb_par)
	Set a singular point.
void	addSingularPoint (double *par, int nmb_par)
	Add a singular point.
Point	getPoint (int idx, int nmb_par)
	Get a singular point.
bool	iterationDone ()
	Check if the iteration is done.
bool	iterationSucceed ()
	Check if the iteration succeeded.
int	nmbSimple1 ()
	Get the number of times the first intersection object has been characterized as simple.
int	nmbSimple2 ()
	Get the number of times the second intersection object has been characterized as simple.
void	setHighPriSing (double *par, int nmb_par)
	Set a high priority singular point.
void	setHighPriSingType (SingularityClassification type)
	Set the high priority singular point type.
SingularityClassification	hasHighPriSing ()
	Get info on high priority singularities.
double	getHighPriSing (int idx)
	Get the high priority singularity.
std::vector< double >	getHighPriSing ()
	Get the high priority singularity.

Detailed Description

Constructor & Destructor Documentation

Go::SingularityInfo::SingularityInfo	(	boost::shared_ptr< SingularityInfo >	previous,
		bool	use_previous = `false`
	)

Inheritance constructor.

Parameters:

	previous	shared pointer to a SingularityInfo object
	use_previous	flag indicating if previous comes from a previous intersection problem

Go::SingularityInfo::SingularityInfo	(	boost::shared_ptr< SingularityInfo >	previous,
		int	missing_dir
	)

Inheritance constructor.

Parameters:

	previous	shared pointer to a SingularityInfo object
	missing_dir	if the dimension of the intersection problem has been reduced from previous, the index tells us which parameter direction that was removed. Indexing starts at 0.

Member Function Documentation

bool Go::SingularityInfo::hasPoint ( ) [inline]

Check if singular point has been found.

Returns:: true if a singular point has been found, false otherwise

Definition at line 75 of file SingularityInfo.h.

int Go::SingularityInfo::getNmbPoints ( int nmb_par ) [inline]

Get number of singular points.

Parameters:

nmb_par

the number of parameters

Returns:: the number of sinular points

Definition at line 81 of file SingularityInfo.h.

double Go::SingularityInfo::getParam ( int dir )

Get a parameter for th last found singularity or closest point.

Parameters:

dir

the index of the parameter direction

Returns:: the parameter value in the dir direction

void Go::SingularityInfo::addSimpleCount	(	bool	simple1,
		bool	simple2
	)			`[inline]`

Increment the number of times the intersection objects are characterized as simple.

Parameters:

	simple1	if `true`, increment for the first intersection object
	simple2	if `true`, increment for the second intersection object

Definition at line 102 of file SingularityInfo.h.

void Go::SingularityInfo::setSingularPoint	(	double *	par,
		int	nmb_par
	)

Set a singular point.

Parameters:

	par	parameter array of the singular point
	nmb_par	number of parameters in par

void Go::SingularityInfo::addSingularPoint	(	double *	par,
		int	nmb_par
	)

Add a singular point.

Parameters:

	par	parameter array of the singular point
	nmb_par	number of parameters in par

Point Go::SingularityInfo::getPoint	(	int	idx,
		int	nmb_par
	)

Get a singular point.

Parameters:

	idx	index to the singular point in question
	nmb_par	number of parameters

Returns:: the singular Point

bool Go::SingularityInfo::iterationDone ( ) [inline]

Check if the iteration is done.

Returns:: true if the iteration is done, false otherwise

Definition at line 128 of file SingularityInfo.h.

bool Go::SingularityInfo::iterationSucceed ( ) [inline]

Check if the iteration succeeded.

Returns:: true if the iteration succeeded, false otherwise

Definition at line 133 of file SingularityInfo.h.

int Go::SingularityInfo::nmbSimple1 ( ) [inline]

Get the number of times the first intersection object has been characterized as simple.

Returns:: the number of times

Definition at line 139 of file SingularityInfo.h.

int Go::SingularityInfo::nmbSimple2 ( ) [inline]

Get the number of times the second intersection object has been characterized as simple.

Returns:: the number of times

Definition at line 145 of file SingularityInfo.h.

void Go::SingularityInfo::setHighPriSing	(	double *	par,
		int	nmb_par
	)

Set a high priority singular point.

Parameters:

	par	parameter array of the singular point
	nmb_par	number of parameters in par

void Go::SingularityInfo::setHighPriSingType ( SingularityClassification type ) [inline]

Set the high priority singular point type.

Parameters:

type

the type of the singular point

Definition at line 155 of file SingularityInfo.h.

SingularityClassification Go::SingularityInfo::hasHighPriSing ( ) [inline]

Get info on high priority singularities.

Returns:: the singularity classification

Definition at line 160 of file SingularityInfo.h.

double Go::SingularityInfo::getHighPriSing ( int idx ) [inline]

Get the high priority singularity.

Parameters:

idx

index specifying a parameter of the singular point

Returns:: the parameter of the singular point in the idx direction

Definition at line 167 of file SingularityInfo.h.

std::vector<double> Go::SingularityInfo::getHighPriSing ( ) [inline]

Get the high priority singularity.

Returns:: the vector of parameters of the singular point

Definition at line 172 of file SingularityInfo.h.

Go::SingularityInfo Class Reference [Intersections]

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Go::SingularityInfo Class Reference
[Intersections]