Initializing help system before first use

XSLPsetcbitervar

XSLPsetcbitervar

Purpose
Set a user callback to be called after each column has been tested for convergence
Synopsis
int XPRS_CC XSLPsetcbitervar(XSLPprob Prob, int (XPRS_CC *UserFunc) (XSLPprob myProb, void *myObject, int ColIndex), void *Object);
Arguments
Prob 
The current SLP problem.
UserFunc 
The function to be called after each column has been tested for convergence. UserFunc returns an integer value. The return value is interpreted as a convergence status. The possible values are:
< 0 
The variable has not converged;
0 
The convergence status of the variable is unchanged;
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.
myProb 
The problem passed to the callback function.
myObject 
The user-defined object passed as Object to XSLPsetcbitervar.
ColIndex 
The number of the column which has been tested for convergence.
Object 
Address of a user-defined object, which can be used for any purpose by the function. Object is passed to UserFunc as myObject.
Example
The following example sets up a callback to be executed after each variable has been tested for convergence. The user object Important is an integer array which has already been set up and holds a flag for each variable indicating whether it is important that it converges. 
int *Important;
XSLPsetcbitervar(Prob, CBIterVar, &Important);
The following sample callback function tests if the variable is already converged. If not, then it checks if the variable is important. If it is not important, the function returns a convergence status of 99. 
int XPRS_CC CBIterVar(XSLPprob MyProb, void *Obj, int iCol) {
  int *Important, Converged;
  Important = *(int **) Obj;
  XSLPgetvar(MyProb, iCol, NULL, NULL, NULL,
             NULL, NULL, NULL, NULL,
             NULL, NULL, &Converged, NULL,
             NULL, NULL, NULL, NULL);
  if (Converged) return 0;
  if (!Important[iCol]) return 99;
  return -1;
}
The Object argument is used here to hold the address of the array Important.
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
XSLPsetcbiterend, XSLPsetcbiterstart

Parent Topic Library functions

© 2001-2019 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.