nemos.solvers.OptimizationInfo

class nemos.solvers.OptimizationInfo(function_val, num_steps, converged, reached_max_steps)

Bases: Module

Basic diagnostic information about finished optimization runs.

Attributes

function_val	Function value.
num_steps	Number of optimization steps taken, array of int.
converged	Whether the optimization converged, array of bool.
reached_max_steps	Reached the maximum number of allowed steps.

Parameters:

• function_val (Array | None)

• num_steps (Array)

• converged (Array)

• reached_max_steps (Array)

__init__(function_val, num_steps, converged, reached_max_steps)

Parameters:

• function_val (Array | None)

• num_steps (Array)

• converged (Array)

• reached_max_steps (Array)

Return type:

None

Methods

__init__(function_val, num_steps, converged, ...)

converged: Array

Whether the optimization converged, array of bool.

function_val: Array | None

Function value. Optional as not all solvers store it.

num_steps: Array

Number of optimization steps taken, array of int.

reached_max_steps: Array

Reached the maximum number of allowed steps.