MathRoot::MultipleResult Struct Reference

Result for multiple root finding. Contains all found roots sorted in ascending order. More...

#include <MathRoot_MultipleUtils.hxx>

Public Member Functions
bool	IsDone () const
	Returns true if computation succeeded.
	operator bool () const
	Conversion to bool for convenient checking.
int	NbRoots () const
	Returns the number of roots found.
double	operator[] (int theIndex) const
	Access root by index (0-based).

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
	Computation status.
size_t	NbIterations = 0
	Total iterations across all roots.
NCollection_DynamicArray< double >	Roots
	Found roots (sorted)
NCollection_DynamicArray< double >	Values
	Function values at roots.
bool	IsAllNull = false
	True if function is essentially zero in range.

Detailed Description

Result for multiple root finding. Contains all found roots sorted in ascending order.

Member Function Documentation

IsDone()

bool MathRoot::MultipleResult::IsDone ( ) const

inline

Returns true if computation succeeded.

NbRoots()

int MathRoot::MultipleResult::NbRoots ( ) const

inline

Returns the number of roots found.

operator bool()

MathRoot::MultipleResult::operator bool ( ) const

inlineexplicit

Conversion to bool for convenient checking.

operator[]()

double MathRoot::MultipleResult::operator[] ( int theIndex ) const

inline

Access root by index (0-based).

Field Documentation

IsAllNull

bool MathRoot::MultipleResult::IsAllNull = false

True if function is essentially zero in range.

NbIterations

size_t MathRoot::MultipleResult::NbIterations = 0

Total iterations across all roots.

Roots

NCollection_DynamicArray<double> MathRoot::MultipleResult::Roots

Found roots (sorted)

Status

MathUtils::Status MathRoot::MultipleResult::Status = MathUtils::Status::NotConverged

Computation status.

Values

NCollection_DynamicArray<double> MathRoot::MultipleResult::Values

Function values at roots.

---

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

• MathRoot_MultipleUtils.hxx