Console Mode Functions
With both the Console and Advanced Mode functions described side-by-side in this chapter, library users can use this as a quick reference for the full capabilities of the Optimizer library. For users of Console Optimizer, only the following functions will be of relevance:
Command
|
Description
|
CHECKCONVEXITY |
Convexity checker.
|
EXIT |
Terminate the Console Optimizer.
|
HELP |
Quick reference help for the Optimizer console.
|
IIS |
Console IIS command.
|
PRINTRANGE |
Writes the ranging information to screen.
|
PRINTSOL |
Write the current solution to screen.
|
QUIT |
Terminate the Console Optimizer.
|
STOP |
Terminate the Console Optimizer.
|
TUNE |
Console Tuner command.
|
SETARCHCONSISTENCY |
Sets whether to force the same execution path on various CPU architecture extensions, in particular (pre-)AVX and AVX2.
|
ALTER |
Alters or changes matrix elements, right hand sides and constraint senses in the current problem.
|
BASISCONDITION |
This function is deprecated, and will be removed in future releases. Please use the XPRSbasisstability function instead. Calculates the condition number of the current basis after solving the LP relaxation.
|
BASISSTABILITY |
Calculates various measures for the stability of the current basis, including the basis condition number.
|
CHGOBJSENSE |
Changes the problem's objective function sense to minimize or maximize.
|
DUMPCONTROLS |
Displays the list of controls and their current value for those controls that have been set to a non default value.
|
FIXGLOBALS |
Fixes all the global entities to the values of the last found MIP solution. This is useful for finding the reduced costs for the continuous variables after the global variables have been fixed to their optimal values.
|
GLOBAL |
Starts the global search for an integer solution after solving the LP relaxation with XPRSmaxim (MAXIM) or XPRSminim (MINIM) or continues a global search if it has been interrupted. This function is deprecated and might be removed in a future release. XPRSmipoptimize should be used instead.
|
GOAL |
This function is deprecated, and will be removed in future releases. Perform goal programming.
|
LPOPTIMIZE |
This function begins a search for the optimal continuous (LP) solution. The direction of optimization is given by OBJSENSE. The status of the problem when the function completes can be checked using LPSTATUS. Any global entities in the problem will be ignored.
|
MAXIM, MINIM |
Begins a search for the optimal LP solution. These functions are deprecated and might be removed in a future release. XPRSlpoptimize or XPRSmipoptimize should be used instead.
|
MIPOPTIMIZE |
This function begins a global search for the optimal MIP solution. The direction of optimization is given by OBJSENSE. The status of the problem when the function completes can be checked using MIPSTATUS.
|
POSTSOLVE |
Postsolve the current matrix when it is in a presolved state.
|
RANGE |
Calculates the ranging information for a problem and saves it to the binary ranging file problem_name.rng.
|
READBASIS |
Instructs the Optimizer to read in a previously saved basis from a file.
|
READBINSOL |
Reads a solution from a binary solution file.
|
READDIRS |
Reads a directives file to help direct the global search.
|
READPROB |
Reads an (X)MPS or LP format matrix from file.
|
READSLXSOL |
Reads an ASCII solution file .slx created by the XPRSwriteslxsol function.
|
REFINEMIPSOL |
Executes the MIP solution refiner.
|
REPAIRINFEAS |
An extended version of XPRSrepairweightedinfeas that allows for bounding the level of relaxation allowed.
|
RESTORE |
Restores the Optimizer's data structures from a file created by XPRSsave (SAVE). Optimization may then recommence from the point at which the file was created.
|
SAVE |
Saves the current data structures to file and terminates the run
|
SCALE |
Re-scales the current matrix.
|
SETDEFAULTCONTROL |
Sets a single control to its default value.
|
SETDEFAULTS |
Sets all controls to their default values. Must be called before the problem is read or loaded by XPRSreadprob, XPRSloadglobal, XPRSloadlp, XPRSloadqglobal, XPRSloadqp.
|
SETLOGFILE |
This directs all Optimizer output to a log file.
|
SETPROBNAME |
Sets the current default problem name. This command is rarely used.
|
WRITEBASIS |
Writes the current basis to a file for later input into the Optimizer.
|
WRITEBINSOL |
Writes the current MIP or LP solution to a binary solution file for later input into the Optimizer.
|
WRITEDIRS |
Writes the global search directives from the current problem to a directives file.
|
WRITEPROB |
Writes the current problem to an MPS or LP file.
|
WRITEPRTRANGE |
Writes the ranging information to a fixed format ASCII file, problem_name.rrt. The binary range file (.rng) must already exist, created by XPRSrange (RANGE).
|
WRITEPRTSOL |
Writes the current solution to a fixed format ASCII file, problem_name .prt.
|
WRITERANGE |
Writes the ranging information to a CSV format ASCII file, problem_name.rsc (and .hdr). The binary range file (.rng) must already exist, created by XPRSrange (RANGE) and an associated header file.
|
WRITESLXSOL |
Creates an ASCII solution file (.slx) using a similar format to MPS files. These files can be read back into the Optimizer using the XPRSreadslxsol function.
|
WRITESOL |
Writes the current solution to a CSV format ASCII file, problem_name.asc (and .hdr).
|
For a list of functions by task, refer to Function Quick Reference.
© 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.