AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::numerics::PolynomialRootResult Struct Reference

Result metadata for an all-roots polynomial solve. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/core/numerics/polynomial_solvers.hpp>

Public Attributes

axom::Array< std::complex< double > > roots
 
bool converged {false}
 
int iterations {0}
 
int effective_degree {0}
 
double max_update {0.0}
 
double max_residual {0.0}
 

Detailed Description

Result metadata for an all-roots polynomial solve.

Member Data Documentation

◆ roots

axom::Array<std::complex<double> > axom::numerics::PolynomialRootResult::roots

◆ converged

bool axom::numerics::PolynomialRootResult::converged {false}

◆ iterations

int axom::numerics::PolynomialRootResult::iterations {0}

◆ effective_degree

int axom::numerics::PolynomialRootResult::effective_degree {0}

◆ max_update

double axom::numerics::PolynomialRootResult::max_update {0.0}

◆ max_residual

double axom::numerics::PolynomialRootResult::max_residual {0.0}

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