setcallback
Purpose
Synopsis
procedure setcallback(cbtype:integer, cb:string)
procedure setcallback(cbtype:integer, pr:procedure|function)
Arguments
|
cbtype
|
Type of the callback:
|
||||||||||||||||||||||||||||||||||||||||||||||
|
cb
|
Name of the callback function/procedure (that must be public); the parameters and the type of the return value (if any) vary depending on the type of the callback:
|
||||||||||||||||||||||||||||||||||||||||||||||
|
pr
|
A subroutine reference compatible with the corresponding callback (see above).
|
Example
The following example defines a procedure to handle solution printing and sets it to be called whenever an integer solution is found using the integer solution callback:
public procedure printsol
declarations
objval:real
end-declarations
objval:= getparam("XPRS_lpobjval")
writeln("Solution value: ", objval)
end-procedure
setcallback(XPRS_CB_INTSOL, "printsol")
Further information
1. This procedure sets the optimizer callback functions and procedures. For a detailed description of these callbacks the user is referred to the
Xpress Optimizer Reference Manual.
2. Passing an empty string (
"") as the function name disables the corresponding callback.
3. The arguments of the Mosel subroutines implementing callback functions correspond to the arguments documented in the
Xpress Optimizer Reference Manual, with the exception of arguments that are used for passing back information to the solver: these are replaced by the subroutine return values. For the logging callbacks, the return value
true interrupts the solving. For the
PRENODE and
OPTNODE callbacks the return value
true declares the current node to be infeasible. The return value of the
BARITER callback is the selected barrier action (see
XPRSaddcbbariteraction in the
Xpress Optimizer Reference Manual for details). The cut manager routine is called repeatedly at each node until it returns
false.
4. Whilst the solution values can be accessed from Mosel in any callback function/procedure, all other information such as the problem status or the value of the objective function must be obtained directly from the Optimizer using function
getparam.
5. The function
setucbdata can be used to return information to the optimizer from the callback `CHGBRANCH'.
6. The functions
rejectintsol and
setcbcutoff can be used to return information to the optimizer from the callback `PREINTSOL'.
7. The function
setgndata can be used to return information to the optimizer from the callback `GAPNOTIFY'.
8. When the
mmxnlp model is used, this function can also be used to set the callbacks relevant to non-linear problems only. Please see the documentation of the
mmxnlp module for the list of extra callbacks.
Module
© 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.