Initializing help system before first use

Methods of the class problem

The tables below show all methods of the class problem of the Xpress Python interface, with the exception of callbacks, which are listed separately. Their invocation is therefore to be preceded by a problem object (the class prefix problem. is omitted in the table for compactness), as follows:

import xpress as xp
p = xp.problem()
x = p.addVariable()
p.setObjective(x + 3 * x**2 + 2)
    

Declares a callback which will be called after each objective in a multi-objective problem is solved.
[Callback, Multiobjective]
Declares a barrier iteration callback function, called after each iteration during the interior point algorithm, with the ability to access the current barrier solution/slack/duals or reduced cost values, and to ask barrier to stop. This callback function will be called in addition to any callbacks already added by problem.addBarIterationCallback. This functionality is not available for the hybrid gradient method.
[Barrier, Callback]
Declares a barrier log callback function, called at each iteration during the interior point algorithm. This callback function will be called in addition to any barrier log callbacks already added by problem.addBarlogCallback. This functionality is not available for the hybrid gradient method.
[Barrier, Callback]
Declares a callback which will be called before each objective in a multi-objective problem is solved.
[Callback, Multiobjective]
Declares a callback function that will be called after the selection of a MIP entity to branch on.
[Branching, Callback]
Declares a callback function which is called every time the Optimizer checks if the time limit has been reached. This callback function will be called in addition to any callbacks already added by problem.addCheckTimeCallback.
[Callback, Limits]
Adds columns to the optimizer matrix.
[Problem Creation]
Declares a callback to be called when a solve executed in compute mode needs to be restarted.
[Callback, Compute Interface]
Adds one or more constraints to the problem.
Declares a cut log callback function, called each time the cut log is printed.
[Callback, Logging]
Declares a callback function that is called when the Optimizer could separate cutting planes during the branch and bound search.
[Callback, Cuts]
Adds cuts directly to the matrix at the current node.
[Cuts]
Declares a gap notification callback, to be called when a MIP solve reaches a predefined target, set using the MIPRELGAPNOTIFY, MIPABSGAPNOTIFY, MIPABSGAPNOTIFYOBJ and/or MIPABSGAPNOTIFYBOUND controls.
[Callback, Limits]
Adds one or more general constraints to the problem.
[Piecewise Linear and General Constraints, Problem Creation]
Adds one or more indicator constraints to the problem.
Declares a user infeasible node callback function, called after the current node has been found to be infeasible during the Branch and Bound search.
[Branch and Bound Search, Callback]
Declares a user integer solution callback function, called every time an integer solution is found by heuristics or during the Branch and Bound search. This callback function will be called in addition to any callbacks already added by problem.addIntsolCallback.
[Callback, Solution]
Declares a simplex log callback function which is called after every LPLOG iterations of the simplex algorithm. This callback function will be called in addition to any callbacks already added by problem.addLplogCallback.
[Callback, LP]
Adds cuts to the Optimizer's internal cut pool from within the cutround callback set by problem.addCutRoundCallback.
[Callback, Cuts]
Declares an output callback function, called every time a text line relating to the given problem is output by the Optimizer.
[Callback, Logging]
Declares a MIP log callback function, called each time the MIP log is printed. This callback function will be called in addition to any callbacks already added by problem.addMiplogCallback.
[Callback, Logging]
Adds a new feasible, infeasible or partial MIP solution for the problem to the Optimizer.
[Solution]
Declares a MIP thread callback function, called every time a MIP worker problem is created by the parallel MIP code. This callback function will be called in addition to any callbacks already added by problem.addMipThreadCallback.
[Callback, Parallel]
Declares a destroy MIP thread callback function, called every time a MIP thread is destroyed by the parallel MIP code. This callback function will be called in addition to any callbacks already added by problem.addMipThreadDestroyCallback.
[Callback, Parallel]
Add a user callback to be called every time a new multistart job finishes. Can be used to overwrite the default solution ranking function
[Callback, Multistart]
Add a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
[Callback, Multistart]
Add a user callback to be called every time a multistart winner has been declared
[Callback, Multistart]
When a model is loaded, the rows, columns, sets, piecewise linear and general constraints of the model may not have names associated with them.
[Problem Creation]
Declares a callback function that will be called every time a new node is created during the branch and bound search. This callback function will be called in addition to any callbacks already added by problem.addNewnodeCallback.
[Branch and Bound Search, Callback]
Add a user callback to be called when an evaluation of a coefficient fails during the solve
[Callback, Numerics]
Declares a user node cutoff callback function, called every time a node is cut off as a result of an improved integer solution being found during the branch and bound search. This callback function will be called in addition to any callbacks already added by problem.addNodecutoffCallback.
[Branch and Bound Search, Callback]
Declares a callback function, called during the branch and bound search, after the LP relaxation has been solved for the current node, but before any internal cuts and heuristics have been applied. This callback function will be called in addition to any callbacks already added by problem.addNodeLPSolvedCallback.
[Branch and Bound Search, Callback]
Appends an objective function with the given coefficients to a multi-objective problem. The weight and priority of the objective are set to the given values.
[Multiobjective, Problem Creation]
Adds one or more objective functions to the problem.
Declares an optimal node callback function, called during the branch and bound search, after the LP relaxation has been solved for the current node, and after any internal cuts and heuristics have been applied, but before the Optimizer checks if the current node should be branched. This callback function will be called in addition to any callbacks already added by problem.addOptnodeCallback.
[Branch and Bound Search, Callback]
Declares a user integer solution callback function, called when an integer solution is found by heuristics or during the branch and bound search, but before it is accepted by the Optimizer.
[Callback, Solution]
Declares a preprocess node callback function, called before the LP relaxation of a node has been optimized, so the solution at the node will not be available. This callback function will be called in addition to any callbacks already added by problem.addPrenodeCallback.
[Branch and Bound Search, Callback]
Declares a callback to be called after presolve has been performed.
[Callback, Presolve]
Adds one or more piecewise linear constraints to the problem.
[Piecewise Linear and General Constraints, Problem Creation]
Adds a new quadratic matrix into a row defined by triplets.
[Problem Creation, Quadratic]
Adds rows to the optimizer matrix.
[Problem Creation]
Allows sets to be added to the problem after passing it to the Optimizer using the input routines.
[MIP Entities, Problem Creation]
Add a user callback to be called at the end of the cascading process, after the last variable has been cascaded
[Callback, Cascading, SLP]
Add a user callback to be called at the start of the cascading process, before any variables have been cascaded
[Callback, Cascading, SLP]
Add a user callback to be called after each column has been cascaded
[Callback, Cascading, SLP]
Add a user callback to be called after cascading a column was not successful
[Callback, Cascading, SLP]
Add a user callback to be called during the Xpress-SLP augmentation process
[Callback, SLP]
Add a user callback used to override the update of variables with small determining column
[Callback, Cascading, SLP]
Add a user callback to be called during MISLP when an integer solution is obtained
[Callback, MISLP]
Add a user callback to be called at the end of each SLP iteration
[Callback, SLP]
Add a user callback to be called at the start of each SLP iteration
[Callback, SLP]
Add a user callback to be called after each column has been tested for convergence
[Callback, SLP, SLP-convergence]
Add a user callback to be called before the linearization is updated
[Callback, SLP]
Creates a special ordered set (SOS) constraint within the problem.
Declares a callback function to be called each time a solution added by problem.addMipSol has been processed. This callback function will be called in addition to any callbacks already added by problem.addUserSolNotifyCallback.
[Callback, Solution]
Creates a variable within the problem.
Creates a dictionary or array of variables and adds them to the problem.
Calculates various measures for the stability of the current basis, including the basis condition number.
[Linear Algebra, LP]
Returns upper and lower sensitivity ranges for specified variables' lower and upper bounds.
[LP, Sensitivity Analysis]
Post-multiplies a (row) vector provided by the user by the inverse of the current basis.
[Linear Algebra, LP]
Calculates the objective value of a given solution.
[Solution]
Calculates the objective value of the given objective function in a multi-objective problem.
[Multiobjective, Solution]
Calculates the reduced cost values for a given (row) dual solution.
[Linear Algebra, Solution]
Calculates the row slack values for a given solution.
[Solution]
Calculates the required property of a solution, like maximum infeasibility of a given primal and dual solution.
[Solution]
Used to change the bounds on columns in the matrix.
[Problem Modification]
Used to change a single coefficient in the matrix.
[Problem Modification]
Used to change the type of a specified set of columns in the matrix.
[MIP Entities, Problem Modification]
Used to change semi-continuous or semi-integer lower bounds, or upper limits on partial integers.
[MIP Entities, Problem Modification]
Used to change multiple coefficients in the matrix.
[Problem Modification]
Used to change multiple quadratic coefficients in the objective function. If any of the coefficients does not exist already, new coefficients will be added to the objective function.
[Problem Modification, Quadratic]
Used to change the objective function coefficients.
[Problem Modification]
Modifies one or more coefficients of an objective function in a multi-objective problem.
[Multiobjective, Problem Modification]
Changes the problem's objective function sense to minimize or maximize.
[Problem Modification]
Used to change a single quadratic coefficient in the objective function corresponding to the variable pair (objqcol1,objqcol2) of the Hessian matrix.
[Problem Modification, Quadratic]
Changes a single quadratic coefficient in a row.
[Problem Modification, Quadratic]
Used to change righthand side values of the problem.
[Problem Modification]
Used to change the range for a row of the problem matrix.
[Problem Modification]
Used to change the type of a row in the matrix.
[Problem Modification]
Resets the search for Irreducible Infeasible Sets (IIS).
[Infeasibility]
Clears extra information attached to a range of rows.
[Problem Modification]
Obtains a copy of a problem.
Copies callback functions defined for one problem to another.
Copies controls defined for one problem to another.
Provides a basic optimal solution for a given solution of an LP problem.
[Barrier, LP]
Delete columns from a matrix.
[Problem Creation]
Delete one or more constraints from the problem.
During the branch and bound search, cuts are stored in the cut pool to be applied at descendant nodes.
[Cuts]
Deletes cuts from the matrix at the current node.
[Cuts]
Delete general constraints from a problem.
[Piecewise Linear and General Constraints, Problem Creation]
Delete indicator constraints.
[MIP Entities, Problem Creation]
Removes an objective function from the problem.
[Problem Creation]
Delete piecewise linear constraints from a problem.
[Piecewise Linear and General Constraints, Problem Creation]
Deletes the quadratic part of a row or of the objective function.
[Problem Creation, Quadratic]
Delete rows from a matrix.
[Problem Creation]
Delete sets from a problem.
[MIP Entities, Problem Creation]
Delete one or more SOSs from the problem.
Delete one or more variables from the problem.
Displays the list of controls and their current value for those controls that have been set to a non default value.
[Controls and Attributes]
Performs a dual side range sensitivity analysis, i.e.
[LP, Sensitivity Analysis]
Initiates a search for an Irreducible Infeasible Set (IIS) in an infeasible problem.
[Infeasibility]
Fixes all the MIP entities to the values of the last found MIP solution.
[MIP Entities, Problem Modification]
Pre-multiplies a (column) vector provided by the user by the inverse of the current matrix.
[Linear Algebra, LP]
Retrieves one or more attributes of a problem.
Accesses the id number and the type information of an attribute given its name.
[Controls and Attributes]
Returns the current basis into the user's data arrays.
[Linear Algebra, LP]
Obtains the dual values from the solution associated with the current callback.
Returns the dual values from the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Returns the reduced costs from the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Returns the slack values from the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Returns the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Obtains the reduced costs from the solution associated with the current callback.
Obtains the slack values from the solution associated with the current callback.
Obtains the solution associated with the current callback.
Returns a single coefficient in the constraint matrix.
[Problem Information]
Returns the nonzeros in the constraint matrix for the columns in a given range.
[Problem Information]
Returns the column types for the columns in a given range.
[MIP Entities, Problem Information]
Returns one or more constraint of a problem corresponding to one or more indices passed as arguments.
Retrieves one or more controls of a problem.
Accesses the id number and the type information of a control given its name.
[Controls and Attributes]
Returns a list of cut indices from the cut pool.
[Cuts]
Returns cuts from the cut pool.
[Cuts]
Retrieves a list of cut pointers for the cuts active at the current node.
[Cuts]
Used to return in which rows a list of cuts are currently loaded into the Optimizer. This is useful for example to retrieve the duals associated with active cuts.
[Cuts]
Used to calculate the slack value of a cut with respect to the current LP relaxation solution.
[Cuts]
Used to return the directives that have been loaded into a matrix.
[Branching, Problem Information]
Retrieves a dual ray (dual unbounded direction) for the current problem, if the problem is found to be infeasible.
[LP, Solution]
Obtains the dual values associated with the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Returns the general constraints y = f(x1, ..., xn, c1, ..., cm) in a given range.
[Piecewise Linear and General Constraints, Problem Information]
Returns information for an Irreducible Infeasible Set: size, variables and constraints (row and column vectors), and conflicting sides of the variables. For pure linear problems there is also information on duals, reduced costs and isolations.
[Infeasibility]
Returns the index for a specified row or column name.
[Problem Information]
Returns the indicator constraint condition (indicator variable and complement flag) associated to the rows in a given range.
[Problem Information]
Returns a list of infeasible primal and dual variables.
[LP, Solution]
Used to obtain the last barrier solution values following optimization that used the barrier solver.
[Barrier, Solution]
Returns the lower bounds for the columns in a given range.
[Problem Information]
Used to obtain the LP solution values following optimization.
[LP, Solution]
Retrieves the current suppression status of a message.
[Misc]
Retrieves integr and entity information about a problem. It must be called before problem.mipOptimize if the presolve option is used.
[MIP Entities, Problem Information]
Returns the nonzeros in the quadratic objective coefficients matrix for the columns in a given range.
[Problem Information, Quadratic]
Returns the names for the rows, columns, sets, piecewise linear constraints, general constraints or objectives in a given range.
[Names Manager]
Returns the objective function coefficients for the columns in a given range.
[Problem Information]
For a given objective function, returns the objective coefficients for the columns in a given range.
[Multiobjective, Problem Information]
Returns True if Optimizer messages will be written to the Python output stream, False otherwise.
Returns the pivot order of the basic variables.
[LP, Simplex]
Returns a list of potential leaving variables if a specified variable enters the basis.
[LP, Simplex]
Returns the current basis from memory into the user's data areas.
[LP, Simplex]
Returns the mapping of the row and column numbers from the presolve problem back to the original problem.
[Presolve, Problem Information]
Returns the solution for the presolved problem from memory.
[Presolve, Solution]
Retrieves a primal ray (primal unbounded direction) for the current problem, if the problem is found to be unbounded.
[LP, Solution]
Returns the current problem name.
[Problem Information]
Returns the piecewise linear constraints y = f(x) in a given range.
[Piecewise Linear and General Constraints, Problem Information]
Returns a single quadratic objective function coefficient corresponding to the variable pair (objqcol1, objqcol2) of the Hessian matrix.
[Problem Information, Quadratic]
Returns a single quadratic constraint coefficient corresponding to the variable pair (rowqcol1, rowqcol2) of the Hessian of a given constraint.
[Problem Information, Quadratic]
Returns the nonzeros in a quadratic constraint coefficients matrix for the columns in a given range.
[Problem Information, Quadratic]
Returns the nonzeros in a quadratic constraint coefficients matrix as triplets (index pairs with coefficients).
[Problem Information, Quadratic]
Returns the list indices of the rows that have quadratic coefficients.
[Problem Information, Quadratic]
Obtains the reduced costs associated with the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Returns the right hand side elements for the rows in a given range.
[Problem Information]
Returns the right hand side range values for the rows in a given range.
[Problem Information]
Retrieve if a range of rows have been set up as special rows.
[Problem Information]
Returns the nonzeros in the constraint matrix for the rows in a given range.
[Problem Information]
Returns the row types for the rows in a given range.
[Problem Information]
Returns the the current scaling of the matrix.
[Numerics]
Returns a list primal and dual variables that are infeasible for the scaled original problem. If the problem is currently presolved, it is postsolved before the function returns.
[LP, Numerics]
Obtains the slack values associated with the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Obtains the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Returns one or more SOSs of a problem corresponding to one or more indices passed as arguments.
Returns the upper bounds for the columns in a given range.
[Problem Information]
Returns the index vector which causes the primal simplex or dual simplex algorithm to determine that a matrix is primal or dual unbounded respectively.
[LP, Solution]
Returns one or more variables of a problem corresponding to one or more indices passed as arguments.
Performs an automated search for independent Irreducible Infeasible Sets (IIS) in an infeasible problem.
[Infeasibility]
Performs the isolation identification procedure for an Irreducible Infeasible Set (IIS). This function applies only to linear problems.
[Infeasibility]
Returns statistics on the Irreducible Infeasible Sets (IIS) found so far by problem.firstIIS, problem.nextIIS or problem.IISAll.
[Infeasibility]
Interrupts the Optimizer algorithms.
[Solution Process]
Loads a basis from the user's areas.
[Data Input, LP]
Loads directives into the current problem to specify which MIP entities the Optimizer should continue to branch on when a node solution is integer feasible.
[Branching, Data Input]
Loads cuts from the cut pool into the matrix.
[Cuts, Data Input]
Specifies that a set of rows in the matrix will be treated as delayed rows during a tree search.
[Cuts, Problem Input]
Loads directives into the matrix.
[Data Input]
Enables the user to pass a matrix directly to the Optimizer, rather than reading the matrix from a file.
[LP, Problem Input]
Loads an LP solution for the problem into the Optimizer.
[Data Input, LP, Solution]
Used to load a MIP problem into the Optimizer data structures.
[MIP Entities, Problem Input]
Loads a starting MIP solution for the problem into the Optimizer.
[Data Input, MIP Entities, Solution]
Used to load a mixed integer quadratic problem with quadratic constraints into the Optimizer data structure.
[Problem Input, Quadratic]
Used to load a MIQP problem, hence a MIP with quadratic objective coefficients, into the Optimizer data structures.
[Problem Input, Quadratic]
Specifies that a set of rows in the matrix will be treated as model cuts.
[Cuts, Data Input]
Loads a presolved basis from the user's areas.
[Data Input, LP]
Loads directives into the presolved matrix.
[Branching, Data Input]
Used to load a quadratic problem with quadratic side constraints into the Optimizer data structure.
[Problem Input, Quadratic]
Used to load a quadratic problem into the Optimizer data structure.
[Problem Input, Quadratic]
Allows the user to mark rows and columns in order to prevent the presolve removing these rows and columns from the matrix.
[Data Input, Presolve]
This function begins a search for the optimal continuous (LP) solution.
[LP, Solution Process]
This function begins a tree search for the optimal MIP solution.
[MIP Entities, Solution Process]
A combined version of problem.msAddJob and problem.msAddPreset.
[Data Input, Multistart]
Adds a multistart job to the multistart pool
[Data Input, Multistart]
Loads a preset of jobs into the multistart job pool.
[Data Input, Multistart]
Removes all scheduled jobs from the multistart job pool
[Multistart]
Continues the search for further Irreducible Infeasible Sets (IIS), or calls problem.firstIIS if no IIS has been identified yet.
[Infeasibility]
Add non-linear formulas to the SLP problem.
[Problem Modification]
Calculate the slack values for the provided solution in the non-linear problem
[Solution]
Add or replace a single matrix formula using a parsed or unparsed formula
[Problem Modification]
Add or replace a single matrix formula using a character string for the formula.
[Problem Modification]
Transfer the current solution to initial values
[Data Input]
Delete nonlinear formulas from the current problem
[Problem Modification]
Evaluate a formula using the current values of the variables
[Solution]
Retrieve a single matrix formula as a formula split into tokens.
[Problem Information]
Retrieve the list of positions of the nonlinear formulas in the problem
[Problem Information]
Retrieve a single matrix formula in a character string.
[Problem Information]
Load non-linear formulas into the SLP problem
[Problem Information]
Maximize or minimize an SLP problem
[Solution Process]
Restores the problem to its pre-solve state
[Presolve]
Print a summary of any evaluation errors that may have occurred during solving a problem
[Logging]
Set the initial value of a variable
[Data Input]
Validate the feasibility of constraints in a converged solution
[Solution]
Validates the first order optimality conditions also known as the Karush-Kuhn-Tucker (KKT) conditions versus the currect solution
[Solution]
Prints an extensive analysis on a given constraint of the SLP problem
[Solution]
Validate the feasibility of constraints for a given solution
[Solution]
Returns upper and lower sensitivity ranges for specified objective function coefficients.
[LP, Sensitivity Analysis]
This function begins a search for the optimal solution of the problem.
[Solution Process]
Performs a simplex pivot by bringing variable enter into the basis and removing leave.
[Linear Algebra, Simplex]
Postsolve the current matrix when it is in a presolved state.
[Presolve, Solution Process]
Postsolves a primal solution formulated in the presolved space into the corresponding solution formulated in the input space. The problem itself is unchanged.
[Presolve, Solution]
Presolves a row formulated in terms of the original variables such that it can be added to a presolved matrix.
[Misc, Presolve]
Presolves a primal solution formulated in the input space into the corresponding solution formulated in the presolved space. The problem itself is unchanged.
[Presolve, Solution]
Prints a given Irreducible Infeasible Set (IIS) in the log.
[Infeasibility, Logging]
Instructs the Optimizer to read in a previously saved basis from a file.
[File IO, LP]
Reads a solution from a binary solution file.
[File IO, Solution]
Reads a directives file to help direct the tree search.
[Branching, File IO]
Reads an (X)MPS or LP format matrix from file.
[File IO, Problem Creation]
Reads an ASCII solution file .slx created by the problem.writeSlxSol function.
[File IO, Solution]
Removes a callback function previously added by problem.addAfterObjectiveCallback.
[Callback, Multiobjective]
Removes a barrier iteration callback function previously added by problem.addBarIterationCallback. The specified callback function will no longer be called after it has been removed.
[Barrier, Callback]
Removes a Newton barrier log callback function previously added by problem.addBarlogCallback. The specified callback function will no longer be called after it has been removed.
[Barrier, Callback]
Removes a callback function previously added by problem.addBeforeObjectiveCallback.
[Callback, Multiobjective]
Removes a callback function previously added by problem.addChangeBranchObjectCallback.
[Branching, Callback]
Removes a callback function previously added by problem.addCheckTimeCallback.
[Callback, Limits]
Removes a computerestart callback function previously added by problem.addComputeRestartCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Compute Interface]
Removes a cut log callback function previously added by problem.addCutlogCallback.
[Callback, Logging]
Removes a cut round callback function previously added by problem.addCutRoundCallback.
[Callback, Cuts]
Removes a callback function previously added by problem.addGapNotifyCallback.
[Callback, Limits]
Removes a user infeasible node callback function previously added by problem.addInfnodeCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes an integer solution callback function previously added by problem.addIntsolCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Solution]
Removes a simplex log callback function previously added by problem.addLplogCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Logging]
Removes a message callback function previously added by problem.addMessageCallback.
[Callback, Logging]
Removes a MIP log callback function previously added by problem.addMiplogCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Logging]
Removes a callback function previously added by problem.addMipThreadCallback.
[Callback, Parallel]
Removes a child thread destruction callback function previously added by problem.addMipThreadDestroyCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Parallel]
Removes a callback function previously added by problem.addMsJobEndCallback.
[Callback, Multistart]
Removes a callback function previously added by problem.addMsJobStartCallback.
[Callback, Multistart]
Removes a callback function previously added by problem.addMsWinnerCallback.
[Callback, Multistart]
Removes a new-node callback function previously added by problem.addNewnodeCallback.
[Branch and Bound Search, Callback]
Removes a callback function previously added by problem.addNlpCoefEvalErrorCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Numerics]
Removes a node-cutoff callback function previously added by problem.addNodecutoffCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes a node callback function previously added by problem.addNodeLPSolvedCallback.
[Branch and Bound Search, Callback]
Removes a node-optimal callback function previously added by problem.addOptnodeCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes a pre-integer solution callback function previously added by problem.addPreIntsolCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Solution]
Removes a preprocess node callback function previously added by problem.addPrenodeCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes a presolve callback function previously added by problem.addPresolveCallback.
[Callback, Presolve]
Removes a callback function previously added by problem.addSlpCascadeEndCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpCascadeStartCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpCascadeVarCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpCascadeVarFailCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpConstructCallback. The specified callback function will no longer be called after it has been removed.
[Callback, SLP]
Removes a callback function previously added by problem.addSlpDrColCallback.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpIntSolCallback.
[Callback, MISLP]
Removes a callback function previously added by problem.addSlpIterEndCallback.
[Callback, SLP]
Removes a callback function previously added by problem.addSlpIterStartCallback. The specified callback function will no longer be called after it has been removed.
[Callback, SLP]
Removes a callback function previously added by problem.addSlpIterVarCallback.
[Callback, SLP, SLP-convergence]
Removes a callback function previously added by problem.addSlpPreUpdateLinearizationCallback. The specified callback function will no longer be called after it has been removed.
[Callback, SLP]
Removes a user solution notification callback previously added by problem.addUserSolNotifyCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Solution]
Provides a simplified interface for problem.repairWeightedInfeas.
[Infeasibility]
By relaxing a set of selected constraints and bounds of an infeasible problem, it attempts to identify a 'solution' that violates the selected set of constraints and bounds minimally, while satisfying all other constraints and bounds. Among such solution candidates, it selects one that is optimal regarding the original objective function.
[Infeasibility]
An extended version of problem.repairWeightedInfeas that allows for bounding the level of relaxation allowed.
[Infeasibility]
Clears all information regarding an optimization problem and returns it to the same status as it would be after creation.
Restores the Optimizer's data structures from a file created by problem.saveAs . Optimization may then recommence from the point at which the file was created.
[File IO, Save Restore]
Returns upper and lower sensitivity ranges for specified right hand side (RHS) function coefficients.
[LP, Sensitivity Analysis]
Alias of problem.saveAs.
Saves the current data structures to file and terminates the run
[File IO, Save Restore]
Re-scales the current matrix.
[Numerics]
Sets one or more controls of a problem.
Sets a single control to its default value.
[Controls and Attributes]
Sets all controls to their default values.
[Controls and Attributes]
Specifies that a set of rows in the matrix will be treated as indicator constraints during a tree search.
[Problem Creation]
This directs all Optimizer output to a log file.
[File IO, Logging]
Manages suppression of messages.
[Misc]
Sets the objective function of the problem.
Enables or disables writing Optimizer messages to the Python output stream.
Sets the current problem name.
[Problem Information]
Add non-linear coefficients to the SLP problem.
[Problem Modification, SLP]
Establish a re-calculation sequence for SLP variables with determining rows.
[Data Input, SLP]
Re-calculate consistent values for SLP variables based on the current values of the remaining variables.
[Cascading, SLP, Solution Process]
Set a variable specific cascade iteration limit
[Data Input, SLP]
Add or change a single matrix coefficient using a parsed or unparsed formula.
[Problem Modification, SLP]
Add or change a single matrix coefficient using a character string for the formula.
[Problem Modification, SLP]
Changes the type of the delta assigned to a nonlinear variable
[Problem Modification, SLP]
Change the status setting of a constraint
[Bit-vector, Data Input, SLP]
Set or change the initial penalty error weight for a row
[Data Input, SLP]
Create the full augmented SLP matrix and data structures, ready for optimization
[SLP, Solution Process]
Delete coefficients from the current problem.
[Problem Modification, SLP]
Evaluate a coefficient using the current values of the variables
[Solution]
Fixe the values of the error vectors
[Solution Process]
Retrieve a single matrix coefficient as a formula split into tokens.
[Problem Information, SLP]
Retrieve the list of positions of the nonlinear coefficients in the problem.
[Problem Information, SLP]
Retrieve a single matrix coefficient as a formula in a character string.
[Problem Information, SLP]
Get current column information.
[SLP, Solution]
Get current row information.
[SLP, Solution]
Retrieve the status setting of a constraint
[Bit-vector, SLP, Solution]
Get the initial penalty error weight for a row
[Data Information, SLP]
Load non-linear coefficients into the SLP problem.
[Problem Information, SLP]
Reset the SLP problem to match a just augmented system
[SLP, Solution Process]
Set the determining row of a variable
[Cascading, Data Input, SLP]
Removes the augmentation and returns the problem to its pre-linearization state
[SLP, Solution Process]
Updates the current linearization
[SLP, Solution Process]
Post-multiplies a (row) vector provided by the user by the inverse of the current matrix. Sparse version of problem.BTran.
[Linear Algebra, Simplex]
Pre-multiplies a (column) vector provided by the user by the inverse of the current matrix. Sparse version of problem.FTran.
[Linear Algebra, Simplex]
Stores cuts into the cut pool, but does not apply them to the current node.
[Cuts]
Performs strong branching iterations on all specified bound changes.
[Branching]
Performs strong branching iterations on all specified bound changes.
[Branching]
This function begins a tuner session for the current problem.
[Tuner]
This function begins a tuner session for a set of problems.
[Tuner]
This function loads a user defined tuner method from the given file.
[File IO, Tuner]
This function writes the current tuner method to a given file or prints it to the console.
[File IO, Tuner]
Writes the current basis to a file for later input into the Optimizer.
[File IO, LP]
Writes the current MIP or LP solution to a binary solution file for later input into the Optimizer.
[File IO, Solution]
Writes the tree search directives from the current problem to a directives file.
[Branching, File IO]
Writes an LP/MPS/CSV file containing a given Irreducible Infeasible Set (IIS).
[File IO, Infeasibility]
Writes the current problem to an MPS or LP file.
[File IO]
Writes the current solution to a fixed format ASCII file, problem_name .prt.
[File IO, Solution]
Creates an ASCII solution file (.slx) using a similar format to MPS files.
[File IO, Solution]
Writes the current solution to a CSV format ASCII file, problem_name.asc (and .hdr).
[File IO, Solution]

The following table contains the problem functions to be called for nonlinear problems.

Declares a callback which will be called after each objective in a multi-objective problem is solved.
[Callback, Multiobjective]
Declares a barrier iteration callback function, called after each iteration during the interior point algorithm, with the ability to access the current barrier solution/slack/duals or reduced cost values, and to ask barrier to stop. This callback function will be called in addition to any callbacks already added by problem.addBarIterationCallback. This functionality is not available for the hybrid gradient method.
[Barrier, Callback]
Declares a barrier log callback function, called at each iteration during the interior point algorithm. This callback function will be called in addition to any barrier log callbacks already added by problem.addBarlogCallback. This functionality is not available for the hybrid gradient method.
[Barrier, Callback]
Declares a callback which will be called before each objective in a multi-objective problem is solved.
[Callback, Multiobjective]
Declares a callback function that will be called after the selection of a MIP entity to branch on.
[Branching, Callback]
Declares a callback function which is called every time the Optimizer checks if the time limit has been reached. This callback function will be called in addition to any callbacks already added by problem.addCheckTimeCallback.
[Callback, Limits]
Adds columns to the optimizer matrix.
[Problem Creation]
Declares a callback to be called when a solve executed in compute mode needs to be restarted.
[Callback, Compute Interface]
Adds one or more constraints to the problem.
Declares a cut log callback function, called each time the cut log is printed.
[Callback, Logging]
Declares a callback function that is called when the Optimizer could separate cutting planes during the branch and bound search.
[Callback, Cuts]
Adds cuts directly to the matrix at the current node.
[Cuts]
Declares a gap notification callback, to be called when a MIP solve reaches a predefined target, set using the MIPRELGAPNOTIFY, MIPABSGAPNOTIFY, MIPABSGAPNOTIFYOBJ and/or MIPABSGAPNOTIFYBOUND controls.
[Callback, Limits]
Adds one or more general constraints to the problem.
[Piecewise Linear and General Constraints, Problem Creation]
Adds one or more indicator constraints to the problem.
Declares a user infeasible node callback function, called after the current node has been found to be infeasible during the Branch and Bound search.
[Branch and Bound Search, Callback]
Declares a user integer solution callback function, called every time an integer solution is found by heuristics or during the Branch and Bound search. This callback function will be called in addition to any callbacks already added by problem.addIntsolCallback.
[Callback, Solution]
Declares a simplex log callback function which is called after every LPLOG iterations of the simplex algorithm. This callback function will be called in addition to any callbacks already added by problem.addLplogCallback.
[Callback, LP]
Adds cuts to the Optimizer's internal cut pool from within the cutround callback set by problem.addCutRoundCallback.
[Callback, Cuts]
Declares an output callback function, called every time a text line relating to the given problem is output by the Optimizer.
[Callback, Logging]
Declares a MIP log callback function, called each time the MIP log is printed. This callback function will be called in addition to any callbacks already added by problem.addMiplogCallback.
[Callback, Logging]
Adds a new feasible, infeasible or partial MIP solution for the problem to the Optimizer.
[Solution]
Declares a MIP thread callback function, called every time a MIP worker problem is created by the parallel MIP code. This callback function will be called in addition to any callbacks already added by problem.addMipThreadCallback.
[Callback, Parallel]
Declares a destroy MIP thread callback function, called every time a MIP thread is destroyed by the parallel MIP code. This callback function will be called in addition to any callbacks already added by problem.addMipThreadDestroyCallback.
[Callback, Parallel]
Add a user callback to be called every time a new multistart job finishes. Can be used to overwrite the default solution ranking function
[Callback, Multistart]
Add a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
[Callback, Multistart]
Add a user callback to be called every time a multistart winner has been declared
[Callback, Multistart]
When a model is loaded, the rows, columns, sets, piecewise linear and general constraints of the model may not have names associated with them.
[Problem Creation]
Declares a callback function that will be called every time a new node is created during the branch and bound search. This callback function will be called in addition to any callbacks already added by problem.addNewnodeCallback.
[Branch and Bound Search, Callback]
Add a user callback to be called when an evaluation of a coefficient fails during the solve
[Callback, Numerics]
Declares a user node cutoff callback function, called every time a node is cut off as a result of an improved integer solution being found during the branch and bound search. This callback function will be called in addition to any callbacks already added by problem.addNodecutoffCallback.
[Branch and Bound Search, Callback]
Declares a callback function, called during the branch and bound search, after the LP relaxation has been solved for the current node, but before any internal cuts and heuristics have been applied. This callback function will be called in addition to any callbacks already added by problem.addNodeLPSolvedCallback.
[Branch and Bound Search, Callback]
Appends an objective function with the given coefficients to a multi-objective problem. The weight and priority of the objective are set to the given values.
[Multiobjective, Problem Creation]
Adds one or more objective functions to the problem.
Declares an optimal node callback function, called during the branch and bound search, after the LP relaxation has been solved for the current node, and after any internal cuts and heuristics have been applied, but before the Optimizer checks if the current node should be branched. This callback function will be called in addition to any callbacks already added by problem.addOptnodeCallback.
[Branch and Bound Search, Callback]
Declares a user integer solution callback function, called when an integer solution is found by heuristics or during the branch and bound search, but before it is accepted by the Optimizer.
[Callback, Solution]
Declares a preprocess node callback function, called before the LP relaxation of a node has been optimized, so the solution at the node will not be available. This callback function will be called in addition to any callbacks already added by problem.addPrenodeCallback.
[Branch and Bound Search, Callback]
Declares a callback to be called after presolve has been performed.
[Callback, Presolve]
Adds one or more piecewise linear constraints to the problem.
[Piecewise Linear and General Constraints, Problem Creation]
Adds a new quadratic matrix into a row defined by triplets.
[Problem Creation, Quadratic]
Adds rows to the optimizer matrix.
[Problem Creation]
Allows sets to be added to the problem after passing it to the Optimizer using the input routines.
[MIP Entities, Problem Creation]
Add a user callback to be called at the end of the cascading process, after the last variable has been cascaded
[Callback, Cascading, SLP]
Add a user callback to be called at the start of the cascading process, before any variables have been cascaded
[Callback, Cascading, SLP]
Add a user callback to be called after each column has been cascaded
[Callback, Cascading, SLP]
Add a user callback to be called after cascading a column was not successful
[Callback, Cascading, SLP]
Add a user callback to be called during the Xpress-SLP augmentation process
[Callback, SLP]
Add a user callback used to override the update of variables with small determining column
[Callback, Cascading, SLP]
Add a user callback to be called during MISLP when an integer solution is obtained
[Callback, MISLP]
Add a user callback to be called at the end of each SLP iteration
[Callback, SLP]
Add a user callback to be called at the start of each SLP iteration
[Callback, SLP]
Add a user callback to be called after each column has been tested for convergence
[Callback, SLP, SLP-convergence]
Add a user callback to be called before the linearization is updated
[Callback, SLP]
Creates a special ordered set (SOS) constraint within the problem.
Declares a callback function to be called each time a solution added by problem.addMipSol has been processed. This callback function will be called in addition to any callbacks already added by problem.addUserSolNotifyCallback.
[Callback, Solution]
Creates a variable within the problem.
Creates a dictionary or array of variables and adds them to the problem.
Calculates various measures for the stability of the current basis, including the basis condition number.
[Linear Algebra, LP]
Returns upper and lower sensitivity ranges for specified variables' lower and upper bounds.
[LP, Sensitivity Analysis]
Post-multiplies a (row) vector provided by the user by the inverse of the current basis.
[Linear Algebra, LP]
Calculates the objective value of a given solution.
[Solution]
Calculates the objective value of the given objective function in a multi-objective problem.
[Multiobjective, Solution]
Calculates the reduced cost values for a given (row) dual solution.
[Linear Algebra, Solution]
Calculates the row slack values for a given solution.
[Solution]
Calculates the required property of a solution, like maximum infeasibility of a given primal and dual solution.
[Solution]
Used to change the bounds on columns in the matrix.
[Problem Modification]
Used to change a single coefficient in the matrix.
[Problem Modification]
Used to change the type of a specified set of columns in the matrix.
[MIP Entities, Problem Modification]
Used to change semi-continuous or semi-integer lower bounds, or upper limits on partial integers.
[MIP Entities, Problem Modification]
Used to change multiple coefficients in the matrix.
[Problem Modification]
Used to change multiple quadratic coefficients in the objective function. If any of the coefficients does not exist already, new coefficients will be added to the objective function.
[Problem Modification, Quadratic]
Used to change the objective function coefficients.
[Problem Modification]
Modifies one or more coefficients of an objective function in a multi-objective problem.
[Multiobjective, Problem Modification]
Changes the problem's objective function sense to minimize or maximize.
[Problem Modification]
Used to change a single quadratic coefficient in the objective function corresponding to the variable pair (objqcol1,objqcol2) of the Hessian matrix.
[Problem Modification, Quadratic]
Changes a single quadratic coefficient in a row.
[Problem Modification, Quadratic]
Used to change righthand side values of the problem.
[Problem Modification]
Used to change the range for a row of the problem matrix.
[Problem Modification]
Used to change the type of a row in the matrix.
[Problem Modification]
Resets the search for Irreducible Infeasible Sets (IIS).
[Infeasibility]
Clears extra information attached to a range of rows.
[Problem Modification]
Obtains a copy of a problem.
Copies callback functions defined for one problem to another.
Copies controls defined for one problem to another.
Provides a basic optimal solution for a given solution of an LP problem.
[Barrier, LP]
Delete columns from a matrix.
[Problem Creation]
Delete one or more constraints from the problem.
During the branch and bound search, cuts are stored in the cut pool to be applied at descendant nodes.
[Cuts]
Deletes cuts from the matrix at the current node.
[Cuts]
Delete general constraints from a problem.
[Piecewise Linear and General Constraints, Problem Creation]
Delete indicator constraints.
[MIP Entities, Problem Creation]
Removes an objective function from the problem.
[Problem Creation]
Delete piecewise linear constraints from a problem.
[Piecewise Linear and General Constraints, Problem Creation]
Deletes the quadratic part of a row or of the objective function.
[Problem Creation, Quadratic]
Delete rows from a matrix.
[Problem Creation]
Delete sets from a problem.
[MIP Entities, Problem Creation]
Delete one or more SOSs from the problem.
Delete one or more variables from the problem.
Displays the list of controls and their current value for those controls that have been set to a non default value.
[Controls and Attributes]
Performs a dual side range sensitivity analysis, i.e.
[LP, Sensitivity Analysis]
Initiates a search for an Irreducible Infeasible Set (IIS) in an infeasible problem.
[Infeasibility]
Fixes all the MIP entities to the values of the last found MIP solution.
[MIP Entities, Problem Modification]
Pre-multiplies a (column) vector provided by the user by the inverse of the current matrix.
[Linear Algebra, LP]
Retrieves one or more attributes of a problem.
Accesses the id number and the type information of an attribute given its name.
[Controls and Attributes]
Returns the current basis into the user's data arrays.
[Linear Algebra, LP]
Obtains the dual values from the solution associated with the current callback.
Returns the dual values from the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Returns the reduced costs from the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Returns the slack values from the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Returns the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Obtains the reduced costs from the solution associated with the current callback.
Obtains the slack values from the solution associated with the current callback.
Obtains the solution associated with the current callback.
Returns a single coefficient in the constraint matrix.
[Problem Information]
Returns the nonzeros in the constraint matrix for the columns in a given range.
[Problem Information]
Returns the column types for the columns in a given range.
[MIP Entities, Problem Information]
Returns one or more constraint of a problem corresponding to one or more indices passed as arguments.
Retrieves one or more controls of a problem.
Accesses the id number and the type information of a control given its name.
[Controls and Attributes]
Returns a list of cut indices from the cut pool.
[Cuts]
Returns cuts from the cut pool.
[Cuts]
Retrieves a list of cut pointers for the cuts active at the current node.
[Cuts]
Used to return in which rows a list of cuts are currently loaded into the Optimizer. This is useful for example to retrieve the duals associated with active cuts.
[Cuts]
Used to calculate the slack value of a cut with respect to the current LP relaxation solution.
[Cuts]
Used to return the directives that have been loaded into a matrix.
[Branching, Problem Information]
Retrieves a dual ray (dual unbounded direction) for the current problem, if the problem is found to be infeasible.
[LP, Solution]
Obtains the dual values associated with the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Returns the general constraints y = f(x1, ..., xn, c1, ..., cm) in a given range.
[Piecewise Linear and General Constraints, Problem Information]
Returns information for an Irreducible Infeasible Set: size, variables and constraints (row and column vectors), and conflicting sides of the variables. For pure linear problems there is also information on duals, reduced costs and isolations.
[Infeasibility]
Returns the index for a specified row or column name.
[Problem Information]
Returns the indicator constraint condition (indicator variable and complement flag) associated to the rows in a given range.
[Problem Information]
Returns a list of infeasible primal and dual variables.
[LP, Solution]
Used to obtain the last barrier solution values following optimization that used the barrier solver.
[Barrier, Solution]
Returns the lower bounds for the columns in a given range.
[Problem Information]
Used to obtain the LP solution values following optimization.
[LP, Solution]
Retrieves the current suppression status of a message.
[Misc]
Retrieves integr and entity information about a problem. It must be called before problem.mipOptimize if the presolve option is used.
[MIP Entities, Problem Information]
Returns the nonzeros in the quadratic objective coefficients matrix for the columns in a given range.
[Problem Information, Quadratic]
Returns the names for the rows, columns, sets, piecewise linear constraints, general constraints or objectives in a given range.
[Names Manager]
Returns the objective function coefficients for the columns in a given range.
[Problem Information]
For a given objective function, returns the objective coefficients for the columns in a given range.
[Multiobjective, Problem Information]
Returns True if Optimizer messages will be written to the Python output stream, False otherwise.
Returns the pivot order of the basic variables.
[LP, Simplex]
Returns a list of potential leaving variables if a specified variable enters the basis.
[LP, Simplex]
Returns the current basis from memory into the user's data areas.
[LP, Simplex]
Returns the mapping of the row and column numbers from the presolve problem back to the original problem.
[Presolve, Problem Information]
Returns the solution for the presolved problem from memory.
[Presolve, Solution]
Retrieves a primal ray (primal unbounded direction) for the current problem, if the problem is found to be unbounded.
[LP, Solution]
Returns the current problem name.
[Problem Information]
Returns the piecewise linear constraints y = f(x) in a given range.
[Piecewise Linear and General Constraints, Problem Information]
Returns a single quadratic objective function coefficient corresponding to the variable pair (objqcol1, objqcol2) of the Hessian matrix.
[Problem Information, Quadratic]
Returns a single quadratic constraint coefficient corresponding to the variable pair (rowqcol1, rowqcol2) of the Hessian of a given constraint.
[Problem Information, Quadratic]
Returns the nonzeros in a quadratic constraint coefficients matrix for the columns in a given range.
[Problem Information, Quadratic]
Returns the nonzeros in a quadratic constraint coefficients matrix as triplets (index pairs with coefficients).
[Problem Information, Quadratic]
Returns the list indices of the rows that have quadratic coefficients.
[Problem Information, Quadratic]
Obtains the reduced costs associated with the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Returns the right hand side elements for the rows in a given range.
[Problem Information]
Returns the right hand side range values for the rows in a given range.
[Problem Information]
Retrieve if a range of rows have been set up as special rows.
[Problem Information]
Returns the nonzeros in the constraint matrix for the rows in a given range.
[Problem Information]
Returns the row types for the rows in a given range.
[Problem Information]
Returns the the current scaling of the matrix.
[Numerics]
Returns a list primal and dual variables that are infeasible for the scaled original problem. If the problem is currently presolved, it is postsolved before the function returns.
[LP, Numerics]
Obtains the slack values associated with the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Obtains the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Returns one or more SOSs of a problem corresponding to one or more indices passed as arguments.
Returns the upper bounds for the columns in a given range.
[Problem Information]
Returns the index vector which causes the primal simplex or dual simplex algorithm to determine that a matrix is primal or dual unbounded respectively.
[LP, Solution]
Returns one or more variables of a problem corresponding to one or more indices passed as arguments.
Performs an automated search for independent Irreducible Infeasible Sets (IIS) in an infeasible problem.
[Infeasibility]
Performs the isolation identification procedure for an Irreducible Infeasible Set (IIS). This function applies only to linear problems.
[Infeasibility]
Returns statistics on the Irreducible Infeasible Sets (IIS) found so far by problem.firstIIS, problem.nextIIS or problem.IISAll.
[Infeasibility]
Interrupts the Optimizer algorithms.
[Solution Process]
Loads a basis from the user's areas.
[Data Input, LP]
Loads directives into the current problem to specify which MIP entities the Optimizer should continue to branch on when a node solution is integer feasible.
[Branching, Data Input]
Loads cuts from the cut pool into the matrix.
[Cuts, Data Input]
Specifies that a set of rows in the matrix will be treated as delayed rows during a tree search.
[Cuts, Problem Input]
Loads directives into the matrix.
[Data Input]
Enables the user to pass a matrix directly to the Optimizer, rather than reading the matrix from a file.
[LP, Problem Input]
Loads an LP solution for the problem into the Optimizer.
[Data Input, LP, Solution]
Used to load a MIP problem into the Optimizer data structures.
[MIP Entities, Problem Input]
Loads a starting MIP solution for the problem into the Optimizer.
[Data Input, MIP Entities, Solution]
Used to load a mixed integer quadratic problem with quadratic constraints into the Optimizer data structure.
[Problem Input, Quadratic]
Used to load a MIQP problem, hence a MIP with quadratic objective coefficients, into the Optimizer data structures.
[Problem Input, Quadratic]
Specifies that a set of rows in the matrix will be treated as model cuts.
[Cuts, Data Input]
Loads a presolved basis from the user's areas.
[Data Input, LP]
Loads directives into the presolved matrix.
[Branching, Data Input]
Used to load a quadratic problem with quadratic side constraints into the Optimizer data structure.
[Problem Input, Quadratic]
Used to load a quadratic problem into the Optimizer data structure.
[Problem Input, Quadratic]
Allows the user to mark rows and columns in order to prevent the presolve removing these rows and columns from the matrix.
[Data Input, Presolve]
This function begins a search for the optimal continuous (LP) solution.
[LP, Solution Process]
This function begins a tree search for the optimal MIP solution.
[MIP Entities, Solution Process]
A combined version of problem.msAddJob and problem.msAddPreset.
[Data Input, Multistart]
Adds a multistart job to the multistart pool
[Data Input, Multistart]
Loads a preset of jobs into the multistart job pool.
[Data Input, Multistart]
Removes all scheduled jobs from the multistart job pool
[Multistart]
Continues the search for further Irreducible Infeasible Sets (IIS), or calls problem.firstIIS if no IIS has been identified yet.
[Infeasibility]
Add non-linear formulas to the SLP problem.
[Problem Modification]
Calculate the slack values for the provided solution in the non-linear problem
[Solution]
Add or replace a single matrix formula using a parsed or unparsed formula
[Problem Modification]
Add or replace a single matrix formula using a character string for the formula.
[Problem Modification]
Transfer the current solution to initial values
[Data Input]
Delete nonlinear formulas from the current problem
[Problem Modification]
Evaluate a formula using the current values of the variables
[Solution]
Retrieve a single matrix formula as a formula split into tokens.
[Problem Information]
Retrieve the list of positions of the nonlinear formulas in the problem
[Problem Information]
Retrieve a single matrix formula in a character string.
[Problem Information]
Load non-linear formulas into the SLP problem
[Problem Information]
Maximize or minimize an SLP problem
[Solution Process]
Restores the problem to its pre-solve state
[Presolve]
Print a summary of any evaluation errors that may have occurred during solving a problem
[Logging]
Set the initial value of a variable
[Data Input]
Validate the feasibility of constraints in a converged solution
[Solution]
Validates the first order optimality conditions also known as the Karush-Kuhn-Tucker (KKT) conditions versus the currect solution
[Solution]
Prints an extensive analysis on a given constraint of the SLP problem
[Solution]
Validate the feasibility of constraints for a given solution
[Solution]
Returns upper and lower sensitivity ranges for specified objective function coefficients.
[LP, Sensitivity Analysis]
This function begins a search for the optimal solution of the problem.
[Solution Process]
Performs a simplex pivot by bringing variable enter into the basis and removing leave.
[Linear Algebra, Simplex]
Postsolve the current matrix when it is in a presolved state.
[Presolve, Solution Process]
Postsolves a primal solution formulated in the presolved space into the corresponding solution formulated in the input space. The problem itself is unchanged.
[Presolve, Solution]
Presolves a row formulated in terms of the original variables such that it can be added to a presolved matrix.
[Misc, Presolve]
Presolves a primal solution formulated in the input space into the corresponding solution formulated in the presolved space. The problem itself is unchanged.
[Presolve, Solution]
Prints a given Irreducible Infeasible Set (IIS) in the log.
[Infeasibility, Logging]
Instructs the Optimizer to read in a previously saved basis from a file.
[File IO, LP]
Reads a solution from a binary solution file.
[File IO, Solution]
Reads a directives file to help direct the tree search.
[Branching, File IO]
Reads an (X)MPS or LP format matrix from file.
[File IO, Problem Creation]
Reads an ASCII solution file .slx created by the problem.writeSlxSol function.
[File IO, Solution]
Removes a callback function previously added by problem.addAfterObjectiveCallback.
[Callback, Multiobjective]
Removes a barrier iteration callback function previously added by problem.addBarIterationCallback. The specified callback function will no longer be called after it has been removed.
[Barrier, Callback]
Removes a Newton barrier log callback function previously added by problem.addBarlogCallback. The specified callback function will no longer be called after it has been removed.
[Barrier, Callback]
Removes a callback function previously added by problem.addBeforeObjectiveCallback.
[Callback, Multiobjective]
Removes a callback function previously added by problem.addChangeBranchObjectCallback.
[Branching, Callback]
Removes a callback function previously added by problem.addCheckTimeCallback.
[Callback, Limits]
Removes a computerestart callback function previously added by problem.addComputeRestartCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Compute Interface]
Removes a cut log callback function previously added by problem.addCutlogCallback.
[Callback, Logging]
Removes a cut round callback function previously added by problem.addCutRoundCallback.
[Callback, Cuts]
Removes a callback function previously added by problem.addGapNotifyCallback.
[Callback, Limits]
Removes a user infeasible node callback function previously added by problem.addInfnodeCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes an integer solution callback function previously added by problem.addIntsolCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Solution]
Removes a simplex log callback function previously added by problem.addLplogCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Logging]
Removes a message callback function previously added by problem.addMessageCallback.
[Callback, Logging]
Removes a MIP log callback function previously added by problem.addMiplogCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Logging]
Removes a callback function previously added by problem.addMipThreadCallback.
[Callback, Parallel]
Removes a child thread destruction callback function previously added by problem.addMipThreadDestroyCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Parallel]
Removes a callback function previously added by problem.addMsJobEndCallback.
[Callback, Multistart]
Removes a callback function previously added by problem.addMsJobStartCallback.
[Callback, Multistart]
Removes a callback function previously added by problem.addMsWinnerCallback.
[Callback, Multistart]
Removes a new-node callback function previously added by problem.addNewnodeCallback.
[Branch and Bound Search, Callback]
Removes a callback function previously added by problem.addNlpCoefEvalErrorCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Numerics]
Removes a node-cutoff callback function previously added by problem.addNodecutoffCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes a node callback function previously added by problem.addNodeLPSolvedCallback.
[Branch and Bound Search, Callback]
Removes a node-optimal callback function previously added by problem.addOptnodeCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes a pre-integer solution callback function previously added by problem.addPreIntsolCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Solution]
Removes a preprocess node callback function previously added by problem.addPrenodeCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes a presolve callback function previously added by problem.addPresolveCallback.
[Callback, Presolve]
Removes a callback function previously added by problem.addSlpCascadeEndCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpCascadeStartCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpCascadeVarCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpCascadeVarFailCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpConstructCallback. The specified callback function will no longer be called after it has been removed.
[Callback, SLP]
Removes a callback function previously added by problem.addSlpDrColCallback.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpIntSolCallback.
[Callback, MISLP]
Removes a callback function previously added by problem.addSlpIterEndCallback.
[Callback, SLP]
Removes a callback function previously added by problem.addSlpIterStartCallback. The specified callback function will no longer be called after it has been removed.
[Callback, SLP]
Removes a callback function previously added by problem.addSlpIterVarCallback.
[Callback, SLP, SLP-convergence]
Removes a callback function previously added by problem.addSlpPreUpdateLinearizationCallback. The specified callback function will no longer be called after it has been removed.
[Callback, SLP]
Removes a user solution notification callback previously added by problem.addUserSolNotifyCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Solution]
Provides a simplified interface for problem.repairWeightedInfeas.
[Infeasibility]
By relaxing a set of selected constraints and bounds of an infeasible problem, it attempts to identify a 'solution' that violates the selected set of constraints and bounds minimally, while satisfying all other constraints and bounds. Among such solution candidates, it selects one that is optimal regarding the original objective function.
[Infeasibility]
An extended version of problem.repairWeightedInfeas that allows for bounding the level of relaxation allowed.
[Infeasibility]
Clears all information regarding an optimization problem and returns it to the same status as it would be after creation.
Restores the Optimizer's data structures from a file created by problem.saveAs . Optimization may then recommence from the point at which the file was created.
[File IO, Save Restore]
Returns upper and lower sensitivity ranges for specified right hand side (RHS) function coefficients.
[LP, Sensitivity Analysis]
Alias of problem.saveAs.
Saves the current data structures to file and terminates the run
[File IO, Save Restore]
Re-scales the current matrix.
[Numerics]
Sets one or more controls of a problem.
Sets a single control to its default value.
[Controls and Attributes]
Sets all controls to their default values.
[Controls and Attributes]
Specifies that a set of rows in the matrix will be treated as indicator constraints during a tree search.
[Problem Creation]
This directs all Optimizer output to a log file.
[File IO, Logging]
Manages suppression of messages.
[Misc]
Sets the objective function of the problem.
Enables or disables writing Optimizer messages to the Python output stream.
Sets the current problem name.
[Problem Information]
Add non-linear coefficients to the SLP problem.
[Problem Modification, SLP]
Establish a re-calculation sequence for SLP variables with determining rows.
[Data Input, SLP]
Re-calculate consistent values for SLP variables based on the current values of the remaining variables.
[Cascading, SLP, Solution Process]
Set a variable specific cascade iteration limit
[Data Input, SLP]
Add or change a single matrix coefficient using a parsed or unparsed formula.
[Problem Modification, SLP]
Add or change a single matrix coefficient using a character string for the formula.
[Problem Modification, SLP]
Changes the type of the delta assigned to a nonlinear variable
[Problem Modification, SLP]
Change the status setting of a constraint
[Bit-vector, Data Input, SLP]
Set or change the initial penalty error weight for a row
[Data Input, SLP]
Create the full augmented SLP matrix and data structures, ready for optimization
[SLP, Solution Process]
Delete coefficients from the current problem.
[Problem Modification, SLP]
Evaluate a coefficient using the current values of the variables
[Solution]
Fixe the values of the error vectors
[Solution Process]
Retrieve a single matrix coefficient as a formula split into tokens.
[Problem Information, SLP]
Retrieve the list of positions of the nonlinear coefficients in the problem.
[Problem Information, SLP]
Retrieve a single matrix coefficient as a formula in a character string.
[Problem Information, SLP]
Get current column information.
[SLP, Solution]
Get current row information.
[SLP, Solution]
Retrieve the status setting of a constraint
[Bit-vector, SLP, Solution]
Get the initial penalty error weight for a row
[Data Information, SLP]
Load non-linear coefficients into the SLP problem.
[Problem Information, SLP]
Reset the SLP problem to match a just augmented system
[SLP, Solution Process]
Set the determining row of a variable
[Cascading, Data Input, SLP]
Removes the augmentation and returns the problem to its pre-linearization state
[SLP, Solution Process]
Updates the current linearization
[SLP, Solution Process]
Post-multiplies a (row) vector provided by the user by the inverse of the current matrix. Sparse version of problem.BTran.
[Linear Algebra, Simplex]
Pre-multiplies a (column) vector provided by the user by the inverse of the current matrix. Sparse version of problem.FTran.
[Linear Algebra, Simplex]
Stores cuts into the cut pool, but does not apply them to the current node.
[Cuts]
Performs strong branching iterations on all specified bound changes.
[Branching]
Performs strong branching iterations on all specified bound changes.
[Branching]
This function begins a tuner session for the current problem.
[Tuner]
This function begins a tuner session for a set of problems.
[Tuner]
This function loads a user defined tuner method from the given file.
[File IO, Tuner]
This function writes the current tuner method to a given file or prints it to the console.
[File IO, Tuner]
Writes the current basis to a file for later input into the Optimizer.
[File IO, LP]
Writes the current MIP or LP solution to a binary solution file for later input into the Optimizer.
[File IO, Solution]
Writes the tree search directives from the current problem to a directives file.
[Branching, File IO]
Writes an LP/MPS/CSV file containing a given Irreducible Infeasible Set (IIS).
[File IO, Infeasibility]
Writes the current problem to an MPS or LP file.
[File IO]
Writes the current solution to a fixed format ASCII file, problem_name .prt.
[File IO, Solution]
Creates an ASCII solution file (.slx) using a similar format to MPS files.
[File IO, Solution]
Writes the current solution to a CSV format ASCII file, problem_name.asc (and .hdr).
[File IO, Solution]

The following table contains methods that can be called from a problem before optimization has started, to add or remove callbacks.

Declares a callback which will be called after each objective in a multi-objective problem is solved.
[Callback, Multiobjective]
Declares a barrier iteration callback function, called after each iteration during the interior point algorithm, with the ability to access the current barrier solution/slack/duals or reduced cost values, and to ask barrier to stop. This callback function will be called in addition to any callbacks already added by problem.addBarIterationCallback. This functionality is not available for the hybrid gradient method.
[Barrier, Callback]
Declares a barrier log callback function, called at each iteration during the interior point algorithm. This callback function will be called in addition to any barrier log callbacks already added by problem.addBarlogCallback. This functionality is not available for the hybrid gradient method.
[Barrier, Callback]
Declares a callback which will be called before each objective in a multi-objective problem is solved.
[Callback, Multiobjective]
Declares a callback function that will be called after the selection of a MIP entity to branch on.
[Branching, Callback]
Declares a callback function which is called every time the Optimizer checks if the time limit has been reached. This callback function will be called in addition to any callbacks already added by problem.addCheckTimeCallback.
[Callback, Limits]
Adds columns to the optimizer matrix.
[Problem Creation]
Declares a callback to be called when a solve executed in compute mode needs to be restarted.
[Callback, Compute Interface]
Adds one or more constraints to the problem.
Declares a cut log callback function, called each time the cut log is printed.
[Callback, Logging]
Declares a callback function that is called when the Optimizer could separate cutting planes during the branch and bound search.
[Callback, Cuts]
Adds cuts directly to the matrix at the current node.
[Cuts]
Declares a gap notification callback, to be called when a MIP solve reaches a predefined target, set using the MIPRELGAPNOTIFY, MIPABSGAPNOTIFY, MIPABSGAPNOTIFYOBJ and/or MIPABSGAPNOTIFYBOUND controls.
[Callback, Limits]
Adds one or more general constraints to the problem.
[Piecewise Linear and General Constraints, Problem Creation]
Adds one or more indicator constraints to the problem.
Declares a user infeasible node callback function, called after the current node has been found to be infeasible during the Branch and Bound search.
[Branch and Bound Search, Callback]
Declares a user integer solution callback function, called every time an integer solution is found by heuristics or during the Branch and Bound search. This callback function will be called in addition to any callbacks already added by problem.addIntsolCallback.
[Callback, Solution]
Declares a simplex log callback function which is called after every LPLOG iterations of the simplex algorithm. This callback function will be called in addition to any callbacks already added by problem.addLplogCallback.
[Callback, LP]
Adds cuts to the Optimizer's internal cut pool from within the cutround callback set by problem.addCutRoundCallback.
[Callback, Cuts]
Declares an output callback function, called every time a text line relating to the given problem is output by the Optimizer.
[Callback, Logging]
Declares a MIP log callback function, called each time the MIP log is printed. This callback function will be called in addition to any callbacks already added by problem.addMiplogCallback.
[Callback, Logging]
Adds a new feasible, infeasible or partial MIP solution for the problem to the Optimizer.
[Solution]
Declares a MIP thread callback function, called every time a MIP worker problem is created by the parallel MIP code. This callback function will be called in addition to any callbacks already added by problem.addMipThreadCallback.
[Callback, Parallel]
Declares a destroy MIP thread callback function, called every time a MIP thread is destroyed by the parallel MIP code. This callback function will be called in addition to any callbacks already added by problem.addMipThreadDestroyCallback.
[Callback, Parallel]
Add a user callback to be called every time a new multistart job finishes. Can be used to overwrite the default solution ranking function
[Callback, Multistart]
Add a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
[Callback, Multistart]
Add a user callback to be called every time a multistart winner has been declared
[Callback, Multistart]
When a model is loaded, the rows, columns, sets, piecewise linear and general constraints of the model may not have names associated with them.
[Problem Creation]
Declares a callback function that will be called every time a new node is created during the branch and bound search. This callback function will be called in addition to any callbacks already added by problem.addNewnodeCallback.
[Branch and Bound Search, Callback]
Add a user callback to be called when an evaluation of a coefficient fails during the solve
[Callback, Numerics]
Declares a user node cutoff callback function, called every time a node is cut off as a result of an improved integer solution being found during the branch and bound search. This callback function will be called in addition to any callbacks already added by problem.addNodecutoffCallback.
[Branch and Bound Search, Callback]
Declares a callback function, called during the branch and bound search, after the LP relaxation has been solved for the current node, but before any internal cuts and heuristics have been applied. This callback function will be called in addition to any callbacks already added by problem.addNodeLPSolvedCallback.
[Branch and Bound Search, Callback]
Appends an objective function with the given coefficients to a multi-objective problem. The weight and priority of the objective are set to the given values.
[Multiobjective, Problem Creation]
Adds one or more objective functions to the problem.
Declares an optimal node callback function, called during the branch and bound search, after the LP relaxation has been solved for the current node, and after any internal cuts and heuristics have been applied, but before the Optimizer checks if the current node should be branched. This callback function will be called in addition to any callbacks already added by problem.addOptnodeCallback.
[Branch and Bound Search, Callback]
Declares a user integer solution callback function, called when an integer solution is found by heuristics or during the branch and bound search, but before it is accepted by the Optimizer.
[Callback, Solution]
Declares a preprocess node callback function, called before the LP relaxation of a node has been optimized, so the solution at the node will not be available. This callback function will be called in addition to any callbacks already added by problem.addPrenodeCallback.
[Branch and Bound Search, Callback]
Declares a callback to be called after presolve has been performed.
[Callback, Presolve]
Adds one or more piecewise linear constraints to the problem.
[Piecewise Linear and General Constraints, Problem Creation]
Adds a new quadratic matrix into a row defined by triplets.
[Problem Creation, Quadratic]
Adds rows to the optimizer matrix.
[Problem Creation]
Allows sets to be added to the problem after passing it to the Optimizer using the input routines.
[MIP Entities, Problem Creation]
Add a user callback to be called at the end of the cascading process, after the last variable has been cascaded
[Callback, Cascading, SLP]
Add a user callback to be called at the start of the cascading process, before any variables have been cascaded
[Callback, Cascading, SLP]
Add a user callback to be called after each column has been cascaded
[Callback, Cascading, SLP]
Add a user callback to be called after cascading a column was not successful
[Callback, Cascading, SLP]
Add a user callback to be called during the Xpress-SLP augmentation process
[Callback, SLP]
Add a user callback used to override the update of variables with small determining column
[Callback, Cascading, SLP]
Add a user callback to be called during MISLP when an integer solution is obtained
[Callback, MISLP]
Add a user callback to be called at the end of each SLP iteration
[Callback, SLP]
Add a user callback to be called at the start of each SLP iteration
[Callback, SLP]
Add a user callback to be called after each column has been tested for convergence
[Callback, SLP, SLP-convergence]
Add a user callback to be called before the linearization is updated
[Callback, SLP]
Creates a special ordered set (SOS) constraint within the problem.
Declares a callback function to be called each time a solution added by problem.addMipSol has been processed. This callback function will be called in addition to any callbacks already added by problem.addUserSolNotifyCallback.
[Callback, Solution]
Creates a variable within the problem.
Creates a dictionary or array of variables and adds them to the problem.
Calculates various measures for the stability of the current basis, including the basis condition number.
[Linear Algebra, LP]
Returns upper and lower sensitivity ranges for specified variables' lower and upper bounds.
[LP, Sensitivity Analysis]
Post-multiplies a (row) vector provided by the user by the inverse of the current basis.
[Linear Algebra, LP]
Calculates the objective value of a given solution.
[Solution]
Calculates the objective value of the given objective function in a multi-objective problem.
[Multiobjective, Solution]
Calculates the reduced cost values for a given (row) dual solution.
[Linear Algebra, Solution]
Calculates the row slack values for a given solution.
[Solution]
Calculates the required property of a solution, like maximum infeasibility of a given primal and dual solution.
[Solution]
Used to change the bounds on columns in the matrix.
[Problem Modification]
Used to change a single coefficient in the matrix.
[Problem Modification]
Used to change the type of a specified set of columns in the matrix.
[MIP Entities, Problem Modification]
Used to change semi-continuous or semi-integer lower bounds, or upper limits on partial integers.
[MIP Entities, Problem Modification]
Used to change multiple coefficients in the matrix.
[Problem Modification]
Used to change multiple quadratic coefficients in the objective function. If any of the coefficients does not exist already, new coefficients will be added to the objective function.
[Problem Modification, Quadratic]
Used to change the objective function coefficients.
[Problem Modification]
Modifies one or more coefficients of an objective function in a multi-objective problem.
[Multiobjective, Problem Modification]
Changes the problem's objective function sense to minimize or maximize.
[Problem Modification]
Used to change a single quadratic coefficient in the objective function corresponding to the variable pair (objqcol1,objqcol2) of the Hessian matrix.
[Problem Modification, Quadratic]
Changes a single quadratic coefficient in a row.
[Problem Modification, Quadratic]
Used to change righthand side values of the problem.
[Problem Modification]
Used to change the range for a row of the problem matrix.
[Problem Modification]
Used to change the type of a row in the matrix.
[Problem Modification]
Resets the search for Irreducible Infeasible Sets (IIS).
[Infeasibility]
Clears extra information attached to a range of rows.
[Problem Modification]
Obtains a copy of a problem.
Copies callback functions defined for one problem to another.
Copies controls defined for one problem to another.
Provides a basic optimal solution for a given solution of an LP problem.
[Barrier, LP]
Delete columns from a matrix.
[Problem Creation]
Delete one or more constraints from the problem.
During the branch and bound search, cuts are stored in the cut pool to be applied at descendant nodes.
[Cuts]
Deletes cuts from the matrix at the current node.
[Cuts]
Delete general constraints from a problem.
[Piecewise Linear and General Constraints, Problem Creation]
Delete indicator constraints.
[MIP Entities, Problem Creation]
Removes an objective function from the problem.
[Problem Creation]
Delete piecewise linear constraints from a problem.
[Piecewise Linear and General Constraints, Problem Creation]
Deletes the quadratic part of a row or of the objective function.
[Problem Creation, Quadratic]
Delete rows from a matrix.
[Problem Creation]
Delete sets from a problem.
[MIP Entities, Problem Creation]
Delete one or more SOSs from the problem.
Delete one or more variables from the problem.
Displays the list of controls and their current value for those controls that have been set to a non default value.
[Controls and Attributes]
Performs a dual side range sensitivity analysis, i.e.
[LP, Sensitivity Analysis]
Initiates a search for an Irreducible Infeasible Set (IIS) in an infeasible problem.
[Infeasibility]
Fixes all the MIP entities to the values of the last found MIP solution.
[MIP Entities, Problem Modification]
Pre-multiplies a (column) vector provided by the user by the inverse of the current matrix.
[Linear Algebra, LP]
Retrieves one or more attributes of a problem.
Accesses the id number and the type information of an attribute given its name.
[Controls and Attributes]
Returns the current basis into the user's data arrays.
[Linear Algebra, LP]
Obtains the dual values from the solution associated with the current callback.
Returns the dual values from the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Returns the reduced costs from the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Returns the slack values from the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Returns the solution to the presolved problem associated with the current callback.
[Callback, Solution]
Obtains the reduced costs from the solution associated with the current callback.
Obtains the slack values from the solution associated with the current callback.
Obtains the solution associated with the current callback.
Returns a single coefficient in the constraint matrix.
[Problem Information]
Returns the nonzeros in the constraint matrix for the columns in a given range.
[Problem Information]
Returns the column types for the columns in a given range.
[MIP Entities, Problem Information]
Returns one or more constraint of a problem corresponding to one or more indices passed as arguments.
Retrieves one or more controls of a problem.
Accesses the id number and the type information of a control given its name.
[Controls and Attributes]
Returns a list of cut indices from the cut pool.
[Cuts]
Returns cuts from the cut pool.
[Cuts]
Retrieves a list of cut pointers for the cuts active at the current node.
[Cuts]
Used to return in which rows a list of cuts are currently loaded into the Optimizer. This is useful for example to retrieve the duals associated with active cuts.
[Cuts]
Used to calculate the slack value of a cut with respect to the current LP relaxation solution.
[Cuts]
Used to return the directives that have been loaded into a matrix.
[Branching, Problem Information]
Retrieves a dual ray (dual unbounded direction) for the current problem, if the problem is found to be infeasible.
[LP, Solution]
Obtains the dual values associated with the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Returns the general constraints y = f(x1, ..., xn, c1, ..., cm) in a given range.
[Piecewise Linear and General Constraints, Problem Information]
Returns information for an Irreducible Infeasible Set: size, variables and constraints (row and column vectors), and conflicting sides of the variables. For pure linear problems there is also information on duals, reduced costs and isolations.
[Infeasibility]
Returns the index for a specified row or column name.
[Problem Information]
Returns the indicator constraint condition (indicator variable and complement flag) associated to the rows in a given range.
[Problem Information]
Returns a list of infeasible primal and dual variables.
[LP, Solution]
Used to obtain the last barrier solution values following optimization that used the barrier solver.
[Barrier, Solution]
Returns the lower bounds for the columns in a given range.
[Problem Information]
Used to obtain the LP solution values following optimization.
[LP, Solution]
Retrieves the current suppression status of a message.
[Misc]
Retrieves integr and entity information about a problem. It must be called before problem.mipOptimize if the presolve option is used.
[MIP Entities, Problem Information]
Returns the nonzeros in the quadratic objective coefficients matrix for the columns in a given range.
[Problem Information, Quadratic]
Returns the names for the rows, columns, sets, piecewise linear constraints, general constraints or objectives in a given range.
[Names Manager]
Returns the objective function coefficients for the columns in a given range.
[Problem Information]
For a given objective function, returns the objective coefficients for the columns in a given range.
[Multiobjective, Problem Information]
Returns True if Optimizer messages will be written to the Python output stream, False otherwise.
Returns the pivot order of the basic variables.
[LP, Simplex]
Returns a list of potential leaving variables if a specified variable enters the basis.
[LP, Simplex]
Returns the current basis from memory into the user's data areas.
[LP, Simplex]
Returns the mapping of the row and column numbers from the presolve problem back to the original problem.
[Presolve, Problem Information]
Returns the solution for the presolved problem from memory.
[Presolve, Solution]
Retrieves a primal ray (primal unbounded direction) for the current problem, if the problem is found to be unbounded.
[LP, Solution]
Returns the current problem name.
[Problem Information]
Returns the piecewise linear constraints y = f(x) in a given range.
[Piecewise Linear and General Constraints, Problem Information]
Returns a single quadratic objective function coefficient corresponding to the variable pair (objqcol1, objqcol2) of the Hessian matrix.
[Problem Information, Quadratic]
Returns a single quadratic constraint coefficient corresponding to the variable pair (rowqcol1, rowqcol2) of the Hessian of a given constraint.
[Problem Information, Quadratic]
Returns the nonzeros in a quadratic constraint coefficients matrix for the columns in a given range.
[Problem Information, Quadratic]
Returns the nonzeros in a quadratic constraint coefficients matrix as triplets (index pairs with coefficients).
[Problem Information, Quadratic]
Returns the list indices of the rows that have quadratic coefficients.
[Problem Information, Quadratic]
Obtains the reduced costs associated with the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Returns the right hand side elements for the rows in a given range.
[Problem Information]
Returns the right hand side range values for the rows in a given range.
[Problem Information]
Retrieve if a range of rows have been set up as special rows.
[Problem Information]
Returns the nonzeros in the constraint matrix for the rows in a given range.
[Problem Information]
Returns the row types for the rows in a given range.
[Problem Information]
Returns the the current scaling of the matrix.
[Numerics]
Returns a list primal and dual variables that are infeasible for the scaled original problem. If the problem is currently presolved, it is postsolved before the function returns.
[LP, Numerics]
Obtains the slack values associated with the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Obtains the incumbent solution during or after optimization with problem.optimize, problem.mipOptimize, problem.lpOptimize or problem.nlpOptimize.
Returns one or more SOSs of a problem corresponding to one or more indices passed as arguments.
Returns the upper bounds for the columns in a given range.
[Problem Information]
Returns the index vector which causes the primal simplex or dual simplex algorithm to determine that a matrix is primal or dual unbounded respectively.
[LP, Solution]
Returns one or more variables of a problem corresponding to one or more indices passed as arguments.
Performs an automated search for independent Irreducible Infeasible Sets (IIS) in an infeasible problem.
[Infeasibility]
Performs the isolation identification procedure for an Irreducible Infeasible Set (IIS). This function applies only to linear problems.
[Infeasibility]
Returns statistics on the Irreducible Infeasible Sets (IIS) found so far by problem.firstIIS, problem.nextIIS or problem.IISAll.
[Infeasibility]
Interrupts the Optimizer algorithms.
[Solution Process]
Loads a basis from the user's areas.
[Data Input, LP]
Loads directives into the current problem to specify which MIP entities the Optimizer should continue to branch on when a node solution is integer feasible.
[Branching, Data Input]
Loads cuts from the cut pool into the matrix.
[Cuts, Data Input]
Specifies that a set of rows in the matrix will be treated as delayed rows during a tree search.
[Cuts, Problem Input]
Loads directives into the matrix.
[Data Input]
Enables the user to pass a matrix directly to the Optimizer, rather than reading the matrix from a file.
[LP, Problem Input]
Loads an LP solution for the problem into the Optimizer.
[Data Input, LP, Solution]
Used to load a MIP problem into the Optimizer data structures.
[MIP Entities, Problem Input]
Loads a starting MIP solution for the problem into the Optimizer.
[Data Input, MIP Entities, Solution]
Used to load a mixed integer quadratic problem with quadratic constraints into the Optimizer data structure.
[Problem Input, Quadratic]
Used to load a MIQP problem, hence a MIP with quadratic objective coefficients, into the Optimizer data structures.
[Problem Input, Quadratic]
Specifies that a set of rows in the matrix will be treated as model cuts.
[Cuts, Data Input]
Loads a presolved basis from the user's areas.
[Data Input, LP]
Loads directives into the presolved matrix.
[Branching, Data Input]
Used to load a quadratic problem with quadratic side constraints into the Optimizer data structure.
[Problem Input, Quadratic]
Used to load a quadratic problem into the Optimizer data structure.
[Problem Input, Quadratic]
Allows the user to mark rows and columns in order to prevent the presolve removing these rows and columns from the matrix.
[Data Input, Presolve]
This function begins a search for the optimal continuous (LP) solution.
[LP, Solution Process]
This function begins a tree search for the optimal MIP solution.
[MIP Entities, Solution Process]
A combined version of problem.msAddJob and problem.msAddPreset.
[Data Input, Multistart]
Adds a multistart job to the multistart pool
[Data Input, Multistart]
Loads a preset of jobs into the multistart job pool.
[Data Input, Multistart]
Removes all scheduled jobs from the multistart job pool
[Multistart]
Continues the search for further Irreducible Infeasible Sets (IIS), or calls problem.firstIIS if no IIS has been identified yet.
[Infeasibility]
Add non-linear formulas to the SLP problem.
[Problem Modification]
Calculate the slack values for the provided solution in the non-linear problem
[Solution]
Add or replace a single matrix formula using a parsed or unparsed formula
[Problem Modification]
Add or replace a single matrix formula using a character string for the formula.
[Problem Modification]
Transfer the current solution to initial values
[Data Input]
Delete nonlinear formulas from the current problem
[Problem Modification]
Evaluate a formula using the current values of the variables
[Solution]
Retrieve a single matrix formula as a formula split into tokens.
[Problem Information]
Retrieve the list of positions of the nonlinear formulas in the problem
[Problem Information]
Retrieve a single matrix formula in a character string.
[Problem Information]
Load non-linear formulas into the SLP problem
[Problem Information]
Maximize or minimize an SLP problem
[Solution Process]
Restores the problem to its pre-solve state
[Presolve]
Print a summary of any evaluation errors that may have occurred during solving a problem
[Logging]
Set the initial value of a variable
[Data Input]
Validate the feasibility of constraints in a converged solution
[Solution]
Validates the first order optimality conditions also known as the Karush-Kuhn-Tucker (KKT) conditions versus the currect solution
[Solution]
Prints an extensive analysis on a given constraint of the SLP problem
[Solution]
Validate the feasibility of constraints for a given solution
[Solution]
Returns upper and lower sensitivity ranges for specified objective function coefficients.
[LP, Sensitivity Analysis]
This function begins a search for the optimal solution of the problem.
[Solution Process]
Performs a simplex pivot by bringing variable enter into the basis and removing leave.
[Linear Algebra, Simplex]
Postsolve the current matrix when it is in a presolved state.
[Presolve, Solution Process]
Postsolves a primal solution formulated in the presolved space into the corresponding solution formulated in the input space. The problem itself is unchanged.
[Presolve, Solution]
Presolves a row formulated in terms of the original variables such that it can be added to a presolved matrix.
[Misc, Presolve]
Presolves a primal solution formulated in the input space into the corresponding solution formulated in the presolved space. The problem itself is unchanged.
[Presolve, Solution]
Prints a given Irreducible Infeasible Set (IIS) in the log.
[Infeasibility, Logging]
Instructs the Optimizer to read in a previously saved basis from a file.
[File IO, LP]
Reads a solution from a binary solution file.
[File IO, Solution]
Reads a directives file to help direct the tree search.
[Branching, File IO]
Reads an (X)MPS or LP format matrix from file.
[File IO, Problem Creation]
Reads an ASCII solution file .slx created by the problem.writeSlxSol function.
[File IO, Solution]
Removes a callback function previously added by problem.addAfterObjectiveCallback.
[Callback, Multiobjective]
Removes a barrier iteration callback function previously added by problem.addBarIterationCallback. The specified callback function will no longer be called after it has been removed.
[Barrier, Callback]
Removes a Newton barrier log callback function previously added by problem.addBarlogCallback. The specified callback function will no longer be called after it has been removed.
[Barrier, Callback]
Removes a callback function previously added by problem.addBeforeObjectiveCallback.
[Callback, Multiobjective]
Removes a callback function previously added by problem.addChangeBranchObjectCallback.
[Branching, Callback]
Removes a callback function previously added by problem.addCheckTimeCallback.
[Callback, Limits]
Removes a computerestart callback function previously added by problem.addComputeRestartCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Compute Interface]
Removes a cut log callback function previously added by problem.addCutlogCallback.
[Callback, Logging]
Removes a cut round callback function previously added by problem.addCutRoundCallback.
[Callback, Cuts]
Removes a callback function previously added by problem.addGapNotifyCallback.
[Callback, Limits]
Removes a user infeasible node callback function previously added by problem.addInfnodeCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes an integer solution callback function previously added by problem.addIntsolCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Solution]
Removes a simplex log callback function previously added by problem.addLplogCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Logging]
Removes a message callback function previously added by problem.addMessageCallback.
[Callback, Logging]
Removes a MIP log callback function previously added by problem.addMiplogCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Logging]
Removes a callback function previously added by problem.addMipThreadCallback.
[Callback, Parallel]
Removes a child thread destruction callback function previously added by problem.addMipThreadDestroyCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Parallel]
Removes a callback function previously added by problem.addMsJobEndCallback.
[Callback, Multistart]
Removes a callback function previously added by problem.addMsJobStartCallback.
[Callback, Multistart]
Removes a callback function previously added by problem.addMsWinnerCallback.
[Callback, Multistart]
Removes a new-node callback function previously added by problem.addNewnodeCallback.
[Branch and Bound Search, Callback]
Removes a callback function previously added by problem.addNlpCoefEvalErrorCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Numerics]
Removes a node-cutoff callback function previously added by problem.addNodecutoffCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes a node callback function previously added by problem.addNodeLPSolvedCallback.
[Branch and Bound Search, Callback]
Removes a node-optimal callback function previously added by problem.addOptnodeCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes a pre-integer solution callback function previously added by problem.addPreIntsolCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Solution]
Removes a preprocess node callback function previously added by problem.addPrenodeCallback. The specified callback function will no longer be called after it has been removed.
[Branch and Bound Search, Callback]
Removes a presolve callback function previously added by problem.addPresolveCallback.
[Callback, Presolve]
Removes a callback function previously added by problem.addSlpCascadeEndCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpCascadeStartCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpCascadeVarCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpCascadeVarFailCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpConstructCallback. The specified callback function will no longer be called after it has been removed.
[Callback, SLP]
Removes a callback function previously added by problem.addSlpDrColCallback.
[Callback, Cascading, SLP]
Removes a callback function previously added by problem.addSlpIntSolCallback.
[Callback, MISLP]
Removes a callback function previously added by problem.addSlpIterEndCallback.
[Callback, SLP]
Removes a callback function previously added by problem.addSlpIterStartCallback. The specified callback function will no longer be called after it has been removed.
[Callback, SLP]
Removes a callback function previously added by problem.addSlpIterVarCallback.
[Callback, SLP, SLP-convergence]
Removes a callback function previously added by problem.addSlpPreUpdateLinearizationCallback. The specified callback function will no longer be called after it has been removed.
[Callback, SLP]
Removes a user solution notification callback previously added by problem.addUserSolNotifyCallback. The specified callback function will no longer be called after it has been removed.
[Callback, Solution]
Provides a simplified interface for problem.repairWeightedInfeas.
[Infeasibility]
By relaxing a set of selected constraints and bounds of an infeasible problem, it attempts to identify a 'solution' that violates the selected set of constraints and bounds minimally, while satisfying all other constraints and bounds. Among such solution candidates, it selects one that is optimal regarding the original objective function.
[Infeasibility]
An extended version of problem.repairWeightedInfeas that allows for bounding the level of relaxation allowed.
[Infeasibility]
Clears all information regarding an optimization problem and returns it to the same status as it would be after creation.
Restores the Optimizer's data structures from a file created by problem.saveAs . Optimization may then recommence from the point at which the file was created.
[File IO, Save Restore]
Returns upper and lower sensitivity ranges for specified right hand side (RHS) function coefficients.
[LP, Sensitivity Analysis]
Alias of problem.saveAs.
Saves the current data structures to file and terminates the run
[File IO, Save Restore]
Re-scales the current matrix.
[Numerics]
Sets one or more controls of a problem.
Sets a single control to its default value.
[Controls and Attributes]
Sets all controls to their default values.
[Controls and Attributes]
Specifies that a set of rows in the matrix will be treated as indicator constraints during a tree search.
[Problem Creation]
This directs all Optimizer output to a log file.
[File IO, Logging]
Manages suppression of messages.
[Misc]
Sets the objective function of the problem.
Enables or disables writing Optimizer messages to the Python output stream.
Sets the current problem name.
[Problem Information]
Add non-linear coefficients to the SLP problem.
[Problem Modification, SLP]
Establish a re-calculation sequence for SLP variables with determining rows.
[Data Input, SLP]
Re-calculate consistent values for SLP variables based on the current values of the remaining variables.
[Cascading, SLP, Solution Process]
Set a variable specific cascade iteration limit
[Data Input, SLP]
Add or change a single matrix coefficient using a parsed or unparsed formula.
[Problem Modification, SLP]
Add or change a single matrix coefficient using a character string for the formula.
[Problem Modification, SLP]
Changes the type of the delta assigned to a nonlinear variable
[Problem Modification, SLP]
Change the status setting of a constraint
[Bit-vector, Data Input, SLP]
Set or change the initial penalty error weight for a row
[Data Input, SLP]
Create the full augmented SLP matrix and data structures, ready for optimization
[SLP, Solution Process]
Delete coefficients from the current problem.
[Problem Modification, SLP]
Evaluate a coefficient using the current values of the variables
[Solution]
Fixe the values of the error vectors
[Solution Process]
Retrieve a single matrix coefficient as a formula split into tokens.
[Problem Information, SLP]
Retrieve the list of positions of the nonlinear coefficients in the problem.
[Problem Information, SLP]
Retrieve a single matrix coefficient as a formula in a character string.
[Problem Information, SLP]
Get current column information.
[SLP, Solution]
Get current row information.
[SLP, Solution]
Retrieve the status setting of a constraint
[Bit-vector, SLP, Solution]
Get the initial penalty error weight for a row
[Data Information, SLP]
Load non-linear coefficients into the SLP problem.
[Problem Information, SLP]
Reset the SLP problem to match a just augmented system
[SLP, Solution Process]
Set the determining row of a variable
[Cascading, Data Input, SLP]
Removes the augmentation and returns the problem to its pre-linearization state
[SLP, Solution Process]
Updates the current linearization
[SLP, Solution Process]
Post-multiplies a (row) vector provided by the user by the inverse of the current matrix. Sparse version of problem.BTran.
[Linear Algebra, Simplex]
Pre-multiplies a (column) vector provided by the user by the inverse of the current matrix. Sparse version of problem.FTran.
[Linear Algebra, Simplex]
Stores cuts into the cut pool, but does not apply them to the current node.
[Cuts]
Performs strong branching iterations on all specified bound changes.
[Branching]
Performs strong branching iterations on all specified bound changes.
[Branching]
This function begins a tuner session for the current problem.
[Tuner]
This function begins a tuner session for a set of problems.
[Tuner]
This function loads a user defined tuner method from the given file.
[File IO, Tuner]
This function writes the current tuner method to a given file or prints it to the console.
[File IO, Tuner]
Writes the current basis to a file for later input into the Optimizer.
[File IO, LP]
Writes the current MIP or LP solution to a binary solution file for later input into the Optimizer.
[File IO, Solution]
Writes the tree search directives from the current problem to a directives file.
[Branching, File IO]
Writes an LP/MPS/CSV file containing a given Irreducible Infeasible Set (IIS).
[File IO, Infeasibility]
Writes the current problem to an MPS or LP file.
[File IO]
Writes the current solution to a fixed format ASCII file, problem_name .prt.
[File IO, Solution]
Creates an ASCII solution file (.slx) using a similar format to MPS files.
[File IO, Solution]
Writes the current solution to a CSV format ASCII file, problem_name.asc (and .hdr).
[File IO, Solution]

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