XSLPsetcbslpend
XSLPsetcbslpend |
Purpose
Set a user callback to be called at the end of the SLP optimization
Synopsis
int XPRS_CC XSLPsetcbslpend(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 end of the SLP optimization.
UserFunc returns an integer value. If the return value is nonzero, the optimization will return an error code and the "User Return Code" error will be set.
|
|
myProb
|
The problem passed to the callback function.
|
|
myObject
|
The user-defined object passed as
Object to
XSLPsetcbslpend.
|
|
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 end of the SLP optimization. It frees the memory allocated to the object created when the optimization began:
void *ObjData; ObjData = NULL; XSLPsetcbslpend(Prob, CBSlpEnd, &ObjData);
A suitable callback function might resemble this:
int XPRS_CC CBSlpEnd(XSLPprob MyProb, void *Obj) {
void *ObjData;
ObjData = * (void **) Obj;
if (ObjData) free(ObjData);
* (void **) Obj = NULL;
return 0;
}
Further information
This callback can be used at the end of the SLP optimization to carry out any further processing or housekeeping before the optimization function returns.
Related topics