bertini::tracking::StepMetadata Struct Reference

Metadata produced by a single predict or correct step. More...

#include <config.hpp>

Public Attributes
NumErrorT	norm_J = 0
	||J|| (Frobenius) at the step.
NumErrorT	norm_J_inverse = 0
	estimate of ||J^{-1}|| via the condition probe.
NumErrorT	condition_number_estimate = 0
	norm_J * norm_J_inverse (refreshed per frequency_of_CN_estimation).
NumErrorT	size_proportion = 0
	AMP "a" (predictor only).
NumErrorT	error_estimate = 0
	embedded-method error estimate (predictor, embedded only).
NumErrorT	norm_delta_z = 0
	||latest Newton step|| (corrector only).

Detailed Description

Metadata produced by a single predict or correct step.

Collapses the formerly hand-threaded out-parameters (norm_J, norm_J_inverse, condition_number_estimate, size_proportion, error_estimate, norm_delta_z) into one struct. Not every field is written by every step: size_proportion/error_estimate are predictor-only (and error_estimate only for embedded methods); norm_delta_z is corrector-only. Unwritten fields keep their default of 0.

Member Data Documentation

condition_number_estimate

NumErrorT bertini::tracking::StepMetadata::condition_number_estimate = 0

norm_J * norm_J_inverse (refreshed per frequency_of_CN_estimation).

error_estimate

NumErrorT bertini::tracking::StepMetadata::error_estimate = 0

embedded-method error estimate (predictor, embedded only).

norm_delta_z

NumErrorT bertini::tracking::StepMetadata::norm_delta_z = 0

||latest Newton step|| (corrector only).

norm_J

NumErrorT bertini::tracking::StepMetadata::norm_J = 0

||J|| (Frobenius) at the step.

norm_J_inverse

NumErrorT bertini::tracking::StepMetadata::norm_J_inverse = 0

estimate of ||J^{-1}|| via the condition probe.

size_proportion

NumErrorT bertini::tracking::StepMetadata::size_proportion = 0

AMP "a" (predictor only).