Initializing help system before first use

XPRSaddcbusersolnotify

Purpose
Declares a callback function to be called each time a solution added by XPRSaddmipsol has been processed. This callback function will be called in addition to any callbacks already added by XPRSaddcbusersolnotify.
Topic areas
Callback, Solution
Synopsis
int XPRS_CC XPRSaddcbusersolnotify(XPRSprob prob, void (XPRS_CC *usersolnotify)(XPRSprob cbprob, void* cbdata, const char* solname, int status), void* data, int priority);
Arguments
prob 
The current problem.
usersolnotify 
The callback function which takes four arguments, cbprob, cbdata, solname and status and has no return value.
cbprob 
The problem passed to the callback function, usersolnotify.
cbdata 
The user-defined data passed as data when setting up the callback with XPRSaddcbusersolnotify.
solname 
The string name assigned to the solution when it was loaded into the Optimizer using XPRSaddmipsol.
status 
One of the following status values:
0 
An error occurred while processing the solution. ( XPRS_USERSOLSTATUS_ERROR)
1 
Solution is feasible. ( XPRS_USERSOLSTATUS_ACCEPTED_FEASIBLE)
2 
Solution is feasible after reoptimizing with fixed MIP entities. ( XPRS_USERSOLSTATUS_ACCEPTED_OPTIMIZED)
3 
A local search heuristic was applied and a feasible solution discovered. ( XPRS_USERSOLSTATUS_SEARCHED_SOL)
4 
A local search heuristic was applied but a feasible solution was not found. ( XPRS_USERSOLSTATUS_SEARCHED_NOSOL)
5 
Solution is infeasible and a local search could not be applied. ( XPRS_USERSOLSTATUS_REJECTED_INFEAS_NOSEARCH)
6 
Solution is partial and a local search could not be applied. ( XPRS_USERSOLSTATUS_REJECTED_PARTIAL_NOSEARCH)
7 
Failed to reoptimize the problem with MIP entities fixed to the provided solution. Likely because a time or iteration limit was reached. ( XPRS_USERSOLSTATUS_REJECTED_FAILED_OPTIMIZE)
8 
Solution is dropped. This can happen if the MIP problem is changed or solved to completion before the solution could be processed. ( XPRS_USERSOLSTATUS_DROPPED)
9 
The solution is worse than the current MIP cutoff value. ( XPRS_USERSOLSTATUS_REJECTED_CUTOFF)
data 
A user-defined data to be passed to the callback function, usersolnotify.
priority 
An integer that determines the order in which multiple callbacks will be invoked. The callback added with a higher priority will be called before a callback with a lower priority. Set to 0 if not required.
Further information
If presolve is turned on, any solution added with XPRSaddmipsol will first be presolved before it can be checked. The value returned in status refers to the presolved solution, which might have had values adjusted due to bound changes, fixing of variables, etc.
Related topics
XPRSremovecbusersolnotify, XPRSaddmipsol.

Parent Topic Console and Library Functions

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