relentless.optimize.ConvergenceTest

class relentless.optimize.ConvergenceTest

Abstract base class for optimization convergence tests.

A ConvergenceTest defines a test to determine if an ObjectiveFunction \(f\left(\mathbf{x}\right)\), defined on a set of design variables \(\mathbf{x}=\left[x_1,\cdots,x_n\right]\), has converged to a desired point.

Methods

converged(result)

Check if the function is converged.

abstract converged(result)

Check if the function is converged.

Parameters:

result (ObjectiveFunctionResult) – The result to check for convergence.

Returns:

True if the result is converged.

Return type:

bool