MathRoot::AllRootsResult Struct Reference

Result for all roots finder including null intervals. More...

#include <MathRoot_All.hxx>

Public Member Functions
bool	IsDone () const
	operator bool () const
int	NbRoots () const
int	NbIntervals () const

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
NCollection_DynamicArray< double >	Roots
	Isolated root locations.
NCollection_DynamicArray< int >	RootStates
	State numbers for roots.
NCollection_DynamicArray< NullInterval >	NullIntervals
	Intervals where function is null.

Detailed Description

Result for all roots finder including null intervals.

Member Function Documentation

IsDone()

bool MathRoot::AllRootsResult::IsDone ( ) const

inline

NbIntervals()

int MathRoot::AllRootsResult::NbIntervals ( ) const

inline

NbRoots()

int MathRoot::AllRootsResult::NbRoots ( ) const

inline

operator bool()

MathRoot::AllRootsResult::operator bool ( ) const

inlineexplicit

Field Documentation

NullIntervals

NCollection_DynamicArray<NullInterval> MathRoot::AllRootsResult::NullIntervals

Intervals where function is null.

Roots

NCollection_DynamicArray<double> MathRoot::AllRootsResult::Roots

Isolated root locations.

RootStates

NCollection_DynamicArray<int> MathRoot::AllRootsResult::RootStates

State numbers for roots.

Status

MathUtils::Status MathRoot::AllRootsResult::Status = MathUtils::Status::NotConverged

---

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

• MathRoot_All.hxx