Initializing help system before first use

XSLPsetcbcascadevar

XSLPsetcbcascadevar

Purpose
Set a user callback to be called after each column has been cascaded
Synopsis
int XPRS_CC XSLPsetcbcascadevar(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 cascaded. UserFunc returns an integer value. If the return value is nonzero, the cascading process will be omitted for the remaining variables during the current SLP iteration, but the optimization will continue.
myProb 
The problem passed to the callback function.
myObject 
The user-defined object passed as Object to XSLPsetcbcascadevar.
ColIndex 
The number of the column which has been cascaded.
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 cascaded: 
double *cSol;
XSLPsetcbcascadevar(Prob, CBCascVar, &cSol);
The following sample callback function resets the value of the variable if the cascaded value is of the opposite sign to the original value: 
int XPRS_CC CBCascVar(XSLPprob MyProb, void *Obj, int iCol) {
  double *cSol, Value;
  cSol = * (double **) Obj;
  XSLPgetvar(MyProb, iCol, NULL, NULL, NULL,
             NULL, NULL, NULL, &Value,
             NULL, NULL, NULL, NULL,
             NULL, NULL, NULL, NULL);
  if (Value * cSol[iCol] < 0) {
    Value = cSol[iCol];
    XSLPchgvar(MyProb, ColNum, NULL, NULL, NULL, NULL,
               NULL, NULL, &Value, NULL, NULL, NULL,
               NULL);
  }
  return 0;
}
The Object argument is used here to hold the address of the array cSol which we assume has been populated with the original solution values.
Further information
This callback can be used after each variable has been cascaded and its new value has been calculated.
Related topics
XSLPcascade, XSLPsetcbcascadeend, XSLPsetcbcascadestart, XSLPsetcbcascadevarfail

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.