Initializing help system before first use

problem.addSlpIterVarCallback

Purpose
Add a user callback to be called after each column has been tested for convergence
Topic areas
Callback, SLP, SLP-convergence
Synopsis
problem.addSlpIterVarCallback(slpitervar, data=None, priority=0)
slpitervar(cbprob, cbdata, col)
Arguments
slpitervar 
The function to be called after each column has been tested for convergence. slpitervar returns an integer value. The return value is interpreted as a convergence status. The possible values are:
< 0 
The variable has not converged;
0 
Keep the internal convergence status;
1 to 10 
The column has converged on a system-defined convergence criterion (these values should not normally be returned);
> 10 
The variable has converged on user criteria.
data 
Address of a user-defined object, which can be used for any purpose by the function. data is passed to slpitervar as cbdata.
priority 
An integer that determines the order in which callbacks of this type will be invoked. The callback added with a higher priority will be called before a callback with a lower priority. Set to 0 if not required.
cbprob 
The problem passed to the callback function.
cbdata 
The user-defined object passed as data to problem.addSlpIterVarCallback.
col 
The number of the column which has been tested for convergence.
Further information
This callback can be used after each variable has been checked for convergence, and allows the convergence status to be reset if required.
Related topics
problem.addSlpIterEndCallback, problem.addSlpIterStartCallback problem.removeSlpIterVarCallback

Parent Topic Methods of the class problem

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.