XSLPsetcbcascadestart
XSLPsetcbcascadestart |
Purpose
Set a user callback to be called at the start of the cascading process, before any variables have been cascaded
Synopsis
int XPRS_CC XSLPsetcbcascadestart(XSLPprob Prob, int (XPRS_CC *UserFunc) (XSLPprob myProb, void *myObject), void *Object);
Arguments
|
Prob
|
The current SLP problem.
|
|
UserFunc
|
The function to be called at the start of the cascading process.
UserFunc returns an integer value. If the return value is nonzero, the cascading process will be omitted for 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
XSLPsetcbcascadestart.
|
|
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 at the start of the cascading process to save the current values of the variables:
double *cSol; XSLPsetcbcascadestart(Prob, CBCascStart, &cSol);
A suitable callback function might resemble this:
int XPRS_CC CBCascStart(XSLPprob MyProb, void *Obj) {
int iCol, nCol;
double *cSol;
cSol = * (double **) Obj;
XSLPgetintcontrol(MyProb, XPRS_COLS, &nCol);
for (iCol=0;iCol<nCol;iCol++) {
XSLPgetvar(MyProb, iCol, NULL, NULL, NULL,
NULL, NULL, NULL, &cSol[iCol],
NULL, NULL, NULL, NULL,
NULL, NULL, NULL, NULL);
}
return 0;
}
The
Object argument is used here to hold the address of the array
cSol which we populate with the solution values.
Further information
This callback can be used at the start of the cascading, before any of the solution values have been recalculated.
Related topics