tinyopt::Options::StopCriteria Struct Reference

Public Attributes
uint16_t	max_iters = 50
	Maximum number of outer iterations.
float	min_error = 1e-12f
	Minimum error/cost.
float	min_rerr_dec = 1e-10f
	Minimum relative error decrease.
float	min_step_norm2 = 1e-14f
	Minimum squared step norm.
float	min_grad_norm2 = 1e-18f
	Minimum squared gradient norm.
uint8_t	max_total_failures = 0
	Overall max failures to decrease error.
uint8_t	max_consec_failures = 5
	Maximum consecutive failures to decrease error.
double	max_duration_ms = 0
	Maximum optimization duration in milliseconds.
std::function< bool(double, double, double)>	stop_callback
std::function< bool(float, const VecXf &, const VecXf &)>	stop_callback2
std::function< bool(const VecXf &dx, bool is_rollback)>	step_callback

Member Data Documentation

step_callback

std::function<bool(const VecXf &dx, bool is_rollback)> tinyopt::Options::StopCriteria::step_callback

Called after every parameter update with the step dx that was added to the parameters and is_rollback, true when a rejected step is undone (dx is then the negated step). Summing the dx of all calls tracks the current parameters. Return true to stop.

---

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

• include/tinyopt/optimizers/options.h