Detailed Description

Diagnostics collected during a conjugate-gradient solve.

Public Member Functions
bool	converged () const
	Return whether the requested residual tolerance was reached.

Public Attributes
size_t	iterations = 0
	Number of completed PCG updates.
double	initialPreconditionedResidualNorm
	Norm of the initial split-preconditioned residual.
double	finalPreconditionedResidualNorm
	Norm of the final split-preconditioned residual.
std::vector< double >	preconditionedResidualNormHistory
	Initial norm followed by one entry per completed PCG update, when enabled.
ConjugateGradientTerminationReason	terminationReason
	Reason the solve stopped.

Member Data Documentation

double gtsam::ConjugateGradientStats::finalPreconditionedResidualNorm

Initial value:

=

0.0

Norm of the final split-preconditioned residual.

double gtsam::ConjugateGradientStats::initialPreconditionedResidualNorm

Initial value:

=

0.0

Norm of the initial split-preconditioned residual.

ConjugateGradientTerminationReason gtsam::ConjugateGradientStats::terminationReason

Initial value:

=

@ kMaxIterations

The iteration limit was reached first.

Definition ConjugateGradientSolver.h:107

Reason the solve stopped.

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