Purpose
Sends a progress update notification for a single metric from the model to the Xpress Insight system.
Synopsis
procedure insightupdate(type:integer, value:real)
Argument
|
type
|
The type of metric to update.
|
INSIGHT_GAP
|
The gap to the optimal solution, as a percentage
|
|
INSIGHT_OBJVAL
|
The best solution value found so far
|
|
INSIGHT_NUMSOLS
|
The count of feasible solutions found so far
|
|
INSIGHT_OBJSENSE
|
The direction of the solve. INSIGHT_MINIMIZE (1) for minimize, INSIGHT_MAXIMIZE (-1) for maximize.
|
|
Example
insightupdate(INSIGHT_OBJVAL,51.9)
Notify Insight that the current best solution value is 51.9
Further information
1. This function allows the model to report back progress to the system where it is accessible by a client for display.
2. The Xpress Insight event mechanism does not use the mmjobs send function.
3. By default, mminsight registers the
insightupdateprogress function provided by the mminsight package as the callback function for the gapnotify callback. The
insightupdateprogress function calls insightupdate for any metric that has changed. It is expected that the developer will only need to call insightupdate directly if the gapnotify callback is registered against a function provided by the developer.
Related topics
© 2001-2020 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.
