bertini::algorithm::NewtonRefineResult< ComplexT > Struct Template Reference

The outcome of a standalone Newton refinement. More...

#include <newton_refine.hpp>

Public Attributes
SuccessCode	code
	Success when the step norm reached the tolerance; FailedToConverge or MatrixSolveFailure otherwise.
Vec< ComplexT >	point
	The refined point (the best iterate reached, even on failure).
NumErrorT	achieved
	Infinity norm of the last Newton step – the consecutive-approximation agreement actually achieved.
unsigned	iterations
	Number of Newton iterations taken.

Detailed Description

template<typename ComplexT>
struct bertini::algorithm::NewtonRefineResult< ComplexT >

The outcome of a standalone Newton refinement.

Template Parameters

ComplexT

the complex number type the refinement ran in.

Member Data Documentation

achieved

template<typename ComplexT>

NumErrorT bertini::algorithm::NewtonRefineResult< ComplexT >::achieved

Infinity norm of the last Newton step – the consecutive-approximation agreement actually achieved.

code

template<typename ComplexT>

SuccessCode bertini::algorithm::NewtonRefineResult< ComplexT >::code

Success when the step norm reached the tolerance; FailedToConverge or MatrixSolveFailure otherwise.

iterations

template<typename ComplexT>

unsigned bertini::algorithm::NewtonRefineResult< ComplexT >::iterations

Number of Newton iterations taken.

point

template<typename ComplexT>

Vec<ComplexT> bertini::algorithm::NewtonRefineResult< ComplexT >::point

The refined point (the best iterate reached, even on failure).