ParameterOptimizerCheckVariableConvergence Method

A helper method to determine if each of the variables changed by less than their respective VariableTolerance in the last iteration.

Namespace: AGI.Foundation.NumericalMethods
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public static bool CheckVariableConvergence(
	IList<SolverVariableSettings> variables,
	double[] currentVariableValues,
	double[] previousVariableValues
)

Public Shared Function CheckVariableConvergence ( 
	variables As IList(Of SolverVariableSettings),
	currentVariableValues As Double(),
	previousVariableValues As Double()
) As Boolean

public:
static bool CheckVariableConvergence(
	IList<SolverVariableSettings^>^ variables, 
	array<double>^ currentVariableValues, 
	array<double>^ previousVariableValues
)

static member CheckVariableConvergence : 
        variables : IList<SolverVariableSettings> * 
        currentVariableValues : float[] * 
        previousVariableValues : float[] -> bool

Parameters

variables: Type: System.Collections.GenericIListSolverVariableSettings
The independent variables of the function.
currentVariableValues: Type: SystemDouble
The values of the independent variables for the current iteration.
previousVariableValues: Type: SystemDouble
The values of the independent variables for the previous iteration.

Return Value

Type: Boolean
if all of the variables changed by less than their respective tolerances; otherwise .

Reference

ParameterOptimizer Class

AGI.Foundation.NumericalMethods Namespace

ParameterOptimizerAddLanguageSpecificTextSet("LST582C860C_0?cpp=::|nu=.");CheckVariableConvergence Method

Parameters

Return Value

Reference

ParameterOptimizerCheckVariableConvergence Method