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.
|
|
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.
|
|
Declares a barrier log callback function, called at each iteration during the interior point algorithm.
|
|
Declares a callback which will be called before each objective in a multi-objective problem is solved.
|
|
Declares a callback function which is called every time the Optimizer checks if the time limit has been reached.
|
|
Declares a callback function that will be called every time the Optimizer has selected a MIP entity for branching.
|
|
Declares a cut log callback function, called each time the cut log is printed.
|
|
Declares a callback function that is called when the Optimizer could separate cutting planes during the branch and bound search.
|
|
Declares a callback function that is called every time a MIP thread is destroyed by the parallel MIP code.
|
|
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.
|
|
Declares a user infeasible node callback function, called after the current node has been found to be infeasible during the Branch and Bound search.
|
|
Declares a user integer solution callback function, called every time an integer solution is found by heuristics or during the Branch and Bound search.
|
|
Declares a simplex log callback function which is called after every LPLOG iterations of the simplex algorithm.
|
|
Declares an output callback function, called every time a text line relating to the given prob is output by the Optimizer.
|
|
Declares a MIP log callback function, called each time the MIP log is printed.
|
|
Declares a MIP thread callback function, called every time a MIP worker problem is created by the parallel MIP code.
|
|
Declares a callback function that will be called every time a new node is created during the branch and bound search.
|
|
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.
|
|
Declares a node LP solved 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.
|
|
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.
|
|
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.
|
|
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.
|
|
Declares a callback to be called after presolve has been performed.
|
|
Declares a callback function to be called each time a solution added by problem.addmipsol has been processed.
|
|
Add non-linear coefficients to the SLP problem
|
|
Add columns to the problem after passing it to the Optimizer using the input routines.
|
|
Adds one or more constraints to the problem.
|
|
Adds cuts directly to the matrix at the current node.
|
|
Add a set of distribution factors
|
|
Adds one or more general constraints to the problem.
|
|
Adds one or more indicator constraints to the problem.
|
|
Adds cuts to the Optimizer's internal cut pool from within the cutround callback set by problem.addcbcutround.
[Callback, Cuts] |
|
Adds a new feasible, infeasible or partial MIP solution for the problem to the Optimizer.
|
|
Associates names with rows, columns, sets, piecewise linear constraints, general constraints or objectives.
|
|
Appends an objective function with the given coefficients to a multi-objective problem.
|
|
Adds one or more objective functions to the problem.
|
|
Adds one or more piecewise linear constraints to the problem.
|
|
Adds a new quadratic matrix into a row defined by triplets.
|
|
Adds rows and their coefficient to the problem.
|
|
Allows sets to be added to the problem after passing it to the Optimizer using the input routines.
[MIP Entities, Problem Creation] |
|
Creates a special ordered set (SOS) constraint within the problem.
|
|
Add sets of standard tolerance values to an SLP problem
|
|
Creates a variable within the problem.
|
|
Creates a dictionary or NumPy array of variables and adds them to the problem.
|
|
Add SLP variables defined as matrix columns to an SLP problem
|
|
Returns various measures for the stability of the current basis, including the basis condition number.
|
|
Returns upper and lower sensitivity ranges for specified variables' lower and upper bounds.
|
|
Post-multiplies a (row) vector provided by the user by the inverse of the current basis.
|
|
Returns the objective value of a given solution.
|
|
Returns the value of a given objective.
|
|
Returns the reduced cost values for a given (row) dual solution.
|
|
Calculates the row slack values for a given solution.
|
|
Returns the required property of a solution, like maximum infeasibility of a given primal and duals solution.
|
|
Re-calculate consistent values for SLP variables based on the current values of the remaining variables
|
|
Establish a re-calculation sequence for SLP variables with determining rows.
|
|
Changes the bounds on columns in the problem.
|
|
Set a variable specific cascade iteration limit
|
|
Changes a single coefficient in the problem.
|
|
Changes the type of a column in the problem.
|
|
Changes the type of the delta assigned to a nonlinear variable
|
|
Set or change a distribution factor
|
|
Changes semi-continuous or semi-integer lower bounds, or upper limits on partial integers.
|
|
Change multiple coefficients in the problem.
|
|
Change multiple quadratic coefficients in the objective function.
|
|
Change the objective function coefficients.
|
|
Modifies one or more coefficients of an objective function in a multi-objective problem.
|
|
Changes the problem's objective function objsense to minimize or maximize.
|
|
Change a single quadratic coefficient in the objective function corresponding to the variable pair (objqcol1,objqcol2) of the Hessian matrix.
|
|
Changes a single quadratic coefficient in a row.
|
|
Changes righthand side values of the problem.
|
|
Change the range for one or more rows of the problem.
|
|
Change the status setting of a constraint
|
|
Changes the type of a row in the problem.
|
|
Set or change the initial penalty error weight for a row
|
|
Add or change a set of convergence tolerances used for SLP variables
|
|
Define a column as an SLP variable or change the characteristics and values of an existing SLP variable
|
|
Clears extra information attached to a range of rows.
[Problem Modification] |
|
Create the full augmented SLP matrix and data structures, ready for optimization
|
|
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.
|
|
Delete coefficients from the current problem
|
|
Delete columns from a matrix.
[Problem Creation] |
|
Delete one or more constraints from the problem.
|
|
Deletes cuts from the cut pool.
|
|
Deletes cuts from the matrix at the current node.
|
|
Delete general constraints from a problem.
|
|
Delete indicator constraints.
|
|
Removes an objective function from a multi-objective problem.
|
|
Delete piecewise linear constraints from a problem.
|
|
Deletes the quadratic part of a row or of the objective function.
|
|
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 tolerance sets from the current problem
|
|
Delete one or more variables from the problem.
|
|
Convert SLP variables to normal columns.
|
|
Displays the list of controls and their current value for those controls that have been set to a non default value.
|
|
Performs a dual side range sensitivity analysis, i.e., calculates estimates for the possible ranges for dual values.
|
|
Evaluate a coefficient using the current values of the variables
|
|
Evaluate a formula using the current values of the variables
|
|
Fixes all the MIP entities to the values of the last found MIP solution.
|
|
Fixe the values of the error vectors
|
|
Pre-multiplies a (column) vector provided by the user by the inverse of the current matrix.
|
|
Retrieves one or more attributes of a problem.
|
|
Accesses the id number and the type information of an attribute given its name.
|
|
Returns the current basis into the user's data arrays.
|
|
Returns the current basis status for a specific col or row.
|
|
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.
|
|
Returns the reduced costs from the solution to the presolved problem associated with the current callback.
|
|
Returns the slack values from the solution to the presolved problem associated with the current callback.
|
|
Returns the solution to the presolved problem associated with the current callback.
|
|
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.
|
|
Retrieve a single nonlinear matrix coefficient as a formula split into tokens
|
|
Retrieve the list of positions of the nonlinear coefficients in the problem
|
|
Get current column information.
|
|
Returns the nonzeros in the constraint matrix for the columns in a given range.
|
|
Returns the column types for the columns in a given range.
|
|
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.
|
|
Returns a list of cut indices from the cut pool.
|
|
Returns cuts from the cut pool.
|
|
Retrieves a list of cuts for the cuts active at the current node.
|
|
Returns in which rows a list of cutind are currently loaded into the Optimizer.
|
|
Used to calculate the slack value of a cut with respect to the current LP relaxation solution.
|
|
Get a distribution factor
|
|
Returns the directives that have been loaded into a problem.
|
|
Retrieves a dual ray (dual unbounded direction) for the current problem, if the problem is found to be infeasible.
|
|
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.
|
|
Returns information for an Irreducible Infeasible Set: size, variables (row and column vectors) and conflicting sides of the variables, duals and reduced costs.
|
|
Returns the numerical index for a specified row, column, or set of the optimizer.
|
|
Returns the index for a specified row or column name.
|
|
Returns the indicator constraint condition (indicator variable and complement flag) associated to the rows in a given range.
|
|
Returns a list of infeasible primal and dual variables.
|
|
Obtains the last barrier solution values following optimization that used the barrier solver.
|
|
Returns the error message corresponding to the last error triggered by a library function.
|
|
Returns the lower bounds on the columns in a given range.
|
|
Obtains the LP solution values following optimization.
|
|
Returns the current suppression status of a message: nonzero if the message is not suppressed; 0 otherwise.
|
|
Retrieves MIP entity information about a problem.
|
|
Returns the nonzeros in the quadratic objective coefficients' matrix for the columns in a given range.
|
|
Returns the names for the rows, columns, sets, piecewise linear constraints, general constraints or objectives in a given range.
|
|
Returns the objective function coefficients for the columns in a given range.
|
|
Returns the coefficients of a given objective function for the columns in a given range.
|
|
Returns True if Optimizer messages will be written to the Python output stream, False otherwise.
|
|
Returns the pivot order of the basic variables.
|
|
Returns a list of potential leaving variables if a specified variable enters the basis.
|
|
Returns the current basis from memory into the user's data areas.
|
|
Returns the mapping of the row and column numbers from the presolve problem back to the original problem.
|
|
Returns the solution for the presolved problem from memory.
|
|
Retrieves a primal ray (primal unbounded direction) for the current problem, if the problem is found to be unbounded.
|
|
Returns the piecewise linear constraints y = f(x) in a given range.
|
|
Returns a single quadratic objective function coefficient corresponding to the variable pair (objqcol1, objqcol2) of the Hessian matrix.
|
|
Returns a single quadratic constraint coefficient corresponding to the variable pair (rowqcol1, rowqcol2) of the Hessian of a given constraint.
|
|
Returns the nonzeros in a quadratic constraint coefficients matrix for the columns in a given range.
|
|
Returns the nonzeros in a quadratic constraint coefficients matrix as triplets (index pairs with coefficients).
|
|
Returns a list of row objects that have quadratic coefficients.
|
|
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.
|
|
Returns the right hand side range values for the rows in a given range.
|
|
Retrieve if a range of rows have been set up as special rows.
[Problem Information] |
|
Get current row information.
|
|
Returns the nonzeros in the constraint matrix for the rows in a given range.
|
|
Retrieve the status setting of a constraint
|
|
Returns the row types for the rows in a given range.
|
|
Get the initial penalty error weight for a row
|
|
Returns the the current scaling of the matrix.
[Numerics] |
|
Returns a list of scaled infeasible primal and dual variables for the original problem.
|
|
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.
|
|
Retrieve the values of a set of convergence tolerances for an SLP problem
|
|
Returns the upper bounds on the columns in a given range.
|
|
Returns the index vector which causes the primal simplex or dual simplex algorithm to determine that a problem is primal or dual unbounded respectively.
|
|
Retrieve information about an SLP variable
|
|
Returns one or more variables of a problem corresponding to one or more indices passed as arguments.
|
|
Returns true if a dual ray (dual unbounded direction) exists for the current problem, if the problem is found to be infeasible.
|
|
Returns true if a primal ray (primal unbounded direction) exists for the current problem, if the problem is found to be unbounded.
|
|
Performs an automated search for independent Irreducible Infeasible Sets (IIS) in an infeasible problem.
|
|
Resets the search for Irreducible Infeasible Sets (IIS).
|
|
Initiates a search for an Irreducible Infeasible Set (IIS) in an infeasible problem.
|
|
Performs the isolation identification procedure for an Irreducible Infeasible Set (IIS).
|
|
Continues the search for further Irreducible Infeasible Sets (IIS).
|
|
Returns statistics on the Irreducible Infeasible Sets (IIS) found so far.
|
|
Writes an LP/MPS/CSV file containing a given Irreducible Infeasible Set (IIS).
|
|
Interrupts the Optimizer algorithms.
|
|
Loads a basis as specified by the user.
|
|
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.
|
|
Load non-linear coefficients into the SLP problem
|
|
Loads cuts from the cut pool into the matrix.
|
|
Specifies that a set of rows in the problem will be treated as delayed rows during a tree search.
|
|
Load a set of distribution factors
|
|
Loads directives into the problem.
|
|
Loads an LP solution for the problem into the Optimizer.
|
|
Loads a MIP solution for the problem into the Optimizer.
|
|
Specifies that a set of rows in the problem will be treated as model cuts.
|
|
Loads a presolved basis from the user's areas.
|
|
Loads directives into the presolved matrix.
|
|
Load an optimization problem, possibly with quadratic objective and/or constraints, and integer variables.
|
|
Allows the user to mark rows and columns in order to prevent the presolve removing these rows and columns from the problem.
|
|
Load sets of standard tolerance values into an SLP problem
|
|
Load SLP variables defined as matrix columns into an SLP problem
|
|
Begins a search for the optimal continuous (LP) solution.
|
|
Begins a tree search for the optimal MIP solution.
|
|
A combined version of msaddjob and msaddpreset.
|
|
Adds a multistart job to the multistart pool
|
|
Loads a preset of jobs into the multistart job pool.
|
|
Removes all scheduled jobs from the multistart job pool
|
|
Returns the name of the problem as a Python string.
|
|
Add non-linear formulas to the SLP problem.
[Problem Modification] |
|
Add or replace a single matrix formula using a parsed or unparsed formula
|
|
Add or replace a single matrix formula using a character string for the formula.
|
|
Delete nonlinear formulas from the current problem
[Problem Modification] |
|
Retrieve a single matrix formula split into tokens
|
|
Retrieve the list of positions of the nonlinear formulas in the problem
[Problem Information] |
|
Retrieve a single matrix formula in a character string
|
|
Load non-linear formulas into the SLP problem
[Problem Information] |
|
Solves an SLP problem
|
|
Set the initial value of a nonlinear variable
|
|
Returns upper and lower sensitivity ranges for specified objective function coefficients.
|
|
Begins a search for the optimal solution of the problem.
|
|
Performs a simplex pivot by bringing variable enter into the basis and removing leave.
[Linear Algebra, Simplex] |
|
Postsolve the current problem when it is in a presolved state.
|
|
Postsolves a primal solution formulated in the presolved space into the corresponding solution formulated in the original space. The problem itself is unchanged.
[Presolve, Solution] |
|
Perform a nonlinear presolve on the problem
|
|
Presolves a row formulated in terms of the original variables such that it can be added to a presolved problem.
|
|
Print a summary of any evaluation errors that may have occurred during solving a problem
|
|
Prints a given Irreducible Infeasible Set (IIS) in the log.
[Infeasibility, Logging] |
|
Print the dimensions and memory allocations for a problem
|
|
Read an optimization problem into a Python problem object created prior to the call.
|
|
Instructs the Optimizer to read in a previously saved basis from a file.
|
|
Reads a solution from a binary solution file.
|
|
Reads a directives file to help direct the tree search.
|
|
Reads an ASCII solution file .slx created by the problem.writeslxsol function.
|
|
Runs the MIP solution refiner.
|
|
Reset the SLP problem to match a just augmented system
|
|
Removes a user after objective callback function previously added by addcbafterobjective.
|
|
Removes a barrier iteration callback function previously added by addcbbariteration.
|
|
Removes a newton barrier log callback function previously added by addcbbarlog.
|
|
Removes a user before objective callback function previously added by addcbbeforeobjective.
|
|
Removes a callback function previously added by problem.addcbchecktime.
|
|
Removes a callback function previously added by addcbchgbranchobject.
|
|
Removes a cut log callback function previously added by addcbcutlog.
|
|
Removes a cut round callback function previously added by addcbcutround.
|
|
Removes a slave thread destruction callback function previously added by addcbdestroymt.
|
|
Removes a callback function previously added by problem.addcbgapnotify.
|
|
Removes a user infeasible node callback function previously added by addcbinfnode.
|
|
Removes an integer solution callback function previously added by addcbintsol.
|
|
Removes a simplex log callback function previously added by addcblplog.
|
|
Removes a message callback function previously added by addcbmessage.
|
|
Removes a MIP log callback function previously added by addcbmiplog.
|
|
Removes a callback function previously added by addcbmipthread.
|
|
Removes a new-node callback function previously added by addcbnewnode.
|
|
Removes a node-cutoff callback function previously added by addcbnodecutoff.
|
|
Removes a node lp solved callback function previously added by addcbnodelpsolved.
|
|
Removes a node-optimal callback function previously added by addcboptnode.
|
|
Removes a pre-integer solution callback function previously added by addcbpreintsol.
|
|
Removes a preprocess node callback function previously added by addcbprenode.
|
|
Removes a presolve callback function previously added by addcbpresolve.
|
|
Removes a user solution notification callback previously added by problem.addcbusersolnotify.
|
|
Provides a simplified interface for problem.repairweightedinfeas.
|
|
Attempts to identify a 'solution' that violates a selected set of constraints and bounds minimally, while satisfying all other constraints and bounds.
|
|
An extended version of problem.repairweightedinfeas that allows for bounding the level of relaxation allowed.
|
|
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.save.
|
|
Returns upper and lower sensitivity ranges for specified right hand side (RHS) function coefficients.
|
|
Saves the current data structures, i.e., matrices, control settings and problem attribute settings to file and terminates the run so that optimization can be resumed later.
|
|
Re-scales the current problem.
|
|
Analyze the current matrix for largest/smallest coefficients and ratios
|
|
Set a user callback to be called at the end of the cascading process, after the last variable has been cascaded
|
|
Set a user callback to be called at the start of the cascading process, before any variables have been cascaded
|
|
Set a user callback to be called after each column has been cascaded
|
|
Set a user callback to be called after cascading a column was not successful
|
|
Set a user callback to be called when an evaluation of a coefficient fails during the solve
|
|
Set a user callback to be called during the Xpress SLP augmentation process
|
|
Set a user callback to be called when an SLP problem is about to be destroyed
|
|
Set a user callback used to override the update of variables with small determining column
|
|
Set a user callback to be called during MISLP when an integer solution is obtained
|
|
Set a user callback to be called at the end of each SLP iteration
|
|
Set a user callback to be called at the start of each SLP iteration
|
|
Set a user callback to be called after each column has been tested for convergence
|
|
Set a user callback to be called whenever Xpress Nonlinear outputs a line of text
|
|
Set a user callback to be called every time a new multistart job finishes.
|
|
Set a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
|
|
Set a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
|
|
Set a user callback to be called during MISLP when an optimal SLP solution is obtained at a node
|
|
Set a user callback to be called during MISLP after the set-up of the SLP problem to be solved at a node, but before SLP optimization
|
|
Set a user callback to be called before the linearization is updated
|
|
Set a user callback to be called at the end of the SLP optimization
|
|
Set a user callback to be called during MISLP after the SLP optimization at each node.
|
|
Set a user callback to be called at the start of the SLP optimization
|
|
Sets one or more controls of a problem.
|
|
Transfer the current solution to initial values
|
|
Sets one control to its default value.
|
|
Sets all controls to their default values.
|
|
Specifies that a set of rows in the problem will be treated as indicator constraints during a tree search.
|
|
This directs all Optimizer output to a log file.
|
|
Manages suppression of messages.
|
|
Sets the objective function of the problem.
|
|
Enables or disables writing Optimizer messages to the Python output stream.
|
|
Sets the current default problem name.
|
|
Add or change a single matrix coefficient using a parsed or unparsed formula
|
|
Add or change a single matrix coefficient using a string for the formula
|
|
Retrieve a single matrix formula split into tokens
|
|
Retrieve a single matrix coefficient as a formula in a character string
|
|
Set the determining row of a variable
[Cascading, Data Input, SLP] |
|
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.
|
|
Performs strong branching iterations on all specified bound changes.
|
|
Performs strong branching iterations on all specified bound changes.
|
|
Begin a tuner session for the current problem.
|
|
Begins a tuner session for a set of problems.
|
|
Load a user defined tuner method from the given file.
|
|
Writes the current tuner method to a given file or prints it to the console.
|
|
Reset the SLP problem and removes the augmentation structures
|
|
Updates the current linearization
|
|
Validate the feasibility of constraints in a converged solution
|
|
Validates the first order optimality conditions also known as the Karush-Kuhn-Tucker (KKT) conditions versus the currect solution
|
|
Prints an extensive analysis on a given constraint of the SLP problem
|
|
Validate the feasibility of constraints for a given solution
|
|
Writes the current problem to an MPS or LP file.
|
|
Writes the current basis to a file for later input into the Optimizer.
|
|
Writes the current MIP or LP solution to a binary solution file for later input into the Optimizer.
|
|
Writes the tree search directives from the current problem to a directives file.
|
|
Writes the current solution to a fixed format ASCII file, problem_name.prt.
|
|
Creates an ASCII solution file (.slx) using a similar format to MPS files.
|
|
Writes the current solution to a CSV format ASCII file, problem_name.asc(and .hdr).
|
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.
|
|
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.
|
|
Declares a barrier log callback function, called at each iteration during the interior point algorithm.
|
|
Declares a callback which will be called before each objective in a multi-objective problem is solved.
|
|
Declares a callback function which is called every time the Optimizer checks if the time limit has been reached.
|
|
Declares a callback function that will be called every time the Optimizer has selected a MIP entity for branching.
|
|
Declares a cut log callback function, called each time the cut log is printed.
|
|
Declares a callback function that is called when the Optimizer could separate cutting planes during the branch and bound search.
|
|
Declares a callback function that is called every time a MIP thread is destroyed by the parallel MIP code.
|
|
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.
|
|
Declares a user infeasible node callback function, called after the current node has been found to be infeasible during the Branch and Bound search.
|
|
Declares a user integer solution callback function, called every time an integer solution is found by heuristics or during the Branch and Bound search.
|
|
Declares a simplex log callback function which is called after every LPLOG iterations of the simplex algorithm.
|
|
Declares an output callback function, called every time a text line relating to the given prob is output by the Optimizer.
|
|
Declares a MIP log callback function, called each time the MIP log is printed.
|
|
Declares a MIP thread callback function, called every time a MIP worker problem is created by the parallel MIP code.
|
|
Declares a callback function that will be called every time a new node is created during the branch and bound search.
|
|
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.
|
|
Declares a node LP solved 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.
|
|
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.
|
|
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.
|
|
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.
|
|
Declares a callback to be called after presolve has been performed.
|
|
Declares a callback function to be called each time a solution added by problem.addmipsol has been processed.
|
|
Add non-linear coefficients to the SLP problem
|
|
Add columns to the problem after passing it to the Optimizer using the input routines.
|
|
Adds one or more constraints to the problem.
|
|
Adds cuts directly to the matrix at the current node.
|
|
Add a set of distribution factors
|
|
Adds one or more general constraints to the problem.
|
|
Adds one or more indicator constraints to the problem.
|
|
Adds cuts to the Optimizer's internal cut pool from within the cutround callback set by problem.addcbcutround.
[Callback, Cuts] |
|
Adds a new feasible, infeasible or partial MIP solution for the problem to the Optimizer.
|
|
Associates names with rows, columns, sets, piecewise linear constraints, general constraints or objectives.
|
|
Appends an objective function with the given coefficients to a multi-objective problem.
|
|
Adds one or more objective functions to the problem.
|
|
Adds one or more piecewise linear constraints to the problem.
|
|
Adds a new quadratic matrix into a row defined by triplets.
|
|
Adds rows and their coefficient to the problem.
|
|
Allows sets to be added to the problem after passing it to the Optimizer using the input routines.
[MIP Entities, Problem Creation] |
|
Creates a special ordered set (SOS) constraint within the problem.
|
|
Add sets of standard tolerance values to an SLP problem
|
|
Creates a variable within the problem.
|
|
Creates a dictionary or NumPy array of variables and adds them to the problem.
|
|
Add SLP variables defined as matrix columns to an SLP problem
|
|
Returns various measures for the stability of the current basis, including the basis condition number.
|
|
Returns upper and lower sensitivity ranges for specified variables' lower and upper bounds.
|
|
Post-multiplies a (row) vector provided by the user by the inverse of the current basis.
|
|
Returns the objective value of a given solution.
|
|
Returns the value of a given objective.
|
|
Returns the reduced cost values for a given (row) dual solution.
|
|
Calculates the row slack values for a given solution.
|
|
Returns the required property of a solution, like maximum infeasibility of a given primal and duals solution.
|
|
Re-calculate consistent values for SLP variables based on the current values of the remaining variables
|
|
Establish a re-calculation sequence for SLP variables with determining rows.
|
|
Changes the bounds on columns in the problem.
|
|
Set a variable specific cascade iteration limit
|
|
Changes a single coefficient in the problem.
|
|
Changes the type of a column in the problem.
|
|
Changes the type of the delta assigned to a nonlinear variable
|
|
Set or change a distribution factor
|
|
Changes semi-continuous or semi-integer lower bounds, or upper limits on partial integers.
|
|
Change multiple coefficients in the problem.
|
|
Change multiple quadratic coefficients in the objective function.
|
|
Change the objective function coefficients.
|
|
Modifies one or more coefficients of an objective function in a multi-objective problem.
|
|
Changes the problem's objective function objsense to minimize or maximize.
|
|
Change a single quadratic coefficient in the objective function corresponding to the variable pair (objqcol1,objqcol2) of the Hessian matrix.
|
|
Changes a single quadratic coefficient in a row.
|
|
Changes righthand side values of the problem.
|
|
Change the range for one or more rows of the problem.
|
|
Change the status setting of a constraint
|
|
Changes the type of a row in the problem.
|
|
Set or change the initial penalty error weight for a row
|
|
Add or change a set of convergence tolerances used for SLP variables
|
|
Define a column as an SLP variable or change the characteristics and values of an existing SLP variable
|
|
Clears extra information attached to a range of rows.
[Problem Modification] |
|
Create the full augmented SLP matrix and data structures, ready for optimization
|
|
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.
|
|
Delete coefficients from the current problem
|
|
Delete columns from a matrix.
[Problem Creation] |
|
Delete one or more constraints from the problem.
|
|
Deletes cuts from the cut pool.
|
|
Deletes cuts from the matrix at the current node.
|
|
Delete general constraints from a problem.
|
|
Delete indicator constraints.
|
|
Removes an objective function from a multi-objective problem.
|
|
Delete piecewise linear constraints from a problem.
|
|
Deletes the quadratic part of a row or of the objective function.
|
|
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 tolerance sets from the current problem
|
|
Delete one or more variables from the problem.
|
|
Convert SLP variables to normal columns.
|
|
Displays the list of controls and their current value for those controls that have been set to a non default value.
|
|
Performs a dual side range sensitivity analysis, i.e., calculates estimates for the possible ranges for dual values.
|
|
Evaluate a coefficient using the current values of the variables
|
|
Evaluate a formula using the current values of the variables
|
|
Fixes all the MIP entities to the values of the last found MIP solution.
|
|
Fixe the values of the error vectors
|
|
Pre-multiplies a (column) vector provided by the user by the inverse of the current matrix.
|
|
Retrieves one or more attributes of a problem.
|
|
Accesses the id number and the type information of an attribute given its name.
|
|
Returns the current basis into the user's data arrays.
|
|
Returns the current basis status for a specific col or row.
|
|
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.
|
|
Returns the reduced costs from the solution to the presolved problem associated with the current callback.
|
|
Returns the slack values from the solution to the presolved problem associated with the current callback.
|
|
Returns the solution to the presolved problem associated with the current callback.
|
|
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.
|
|
Retrieve a single nonlinear matrix coefficient as a formula split into tokens
|
|
Retrieve the list of positions of the nonlinear coefficients in the problem
|
|
Get current column information.
|
|
Returns the nonzeros in the constraint matrix for the columns in a given range.
|
|
Returns the column types for the columns in a given range.
|
|
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.
|
|
Returns a list of cut indices from the cut pool.
|
|
Returns cuts from the cut pool.
|
|
Retrieves a list of cuts for the cuts active at the current node.
|
|
Returns in which rows a list of cutind are currently loaded into the Optimizer.
|
|
Used to calculate the slack value of a cut with respect to the current LP relaxation solution.
|
|
Get a distribution factor
|
|
Returns the directives that have been loaded into a problem.
|
|
Retrieves a dual ray (dual unbounded direction) for the current problem, if the problem is found to be infeasible.
|
|
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.
|
|
Returns information for an Irreducible Infeasible Set: size, variables (row and column vectors) and conflicting sides of the variables, duals and reduced costs.
|
|
Returns the numerical index for a specified row, column, or set of the optimizer.
|
|
Returns the index for a specified row or column name.
|
|
Returns the indicator constraint condition (indicator variable and complement flag) associated to the rows in a given range.
|
|
Returns a list of infeasible primal and dual variables.
|
|
Obtains the last barrier solution values following optimization that used the barrier solver.
|
|
Returns the error message corresponding to the last error triggered by a library function.
|
|
Returns the lower bounds on the columns in a given range.
|
|
Obtains the LP solution values following optimization.
|
|
Returns the current suppression status of a message: nonzero if the message is not suppressed; 0 otherwise.
|
|
Retrieves MIP entity information about a problem.
|
|
Returns the nonzeros in the quadratic objective coefficients' matrix for the columns in a given range.
|
|
Returns the names for the rows, columns, sets, piecewise linear constraints, general constraints or objectives in a given range.
|
|
Returns the objective function coefficients for the columns in a given range.
|
|
Returns the coefficients of a given objective function for the columns in a given range.
|
|
Returns True if Optimizer messages will be written to the Python output stream, False otherwise.
|
|
Returns the pivot order of the basic variables.
|
|
Returns a list of potential leaving variables if a specified variable enters the basis.
|
|
Returns the current basis from memory into the user's data areas.
|
|
Returns the mapping of the row and column numbers from the presolve problem back to the original problem.
|
|
Returns the solution for the presolved problem from memory.
|
|
Retrieves a primal ray (primal unbounded direction) for the current problem, if the problem is found to be unbounded.
|
|
Returns the piecewise linear constraints y = f(x) in a given range.
|
|
Returns a single quadratic objective function coefficient corresponding to the variable pair (objqcol1, objqcol2) of the Hessian matrix.
|
|
Returns a single quadratic constraint coefficient corresponding to the variable pair (rowqcol1, rowqcol2) of the Hessian of a given constraint.
|
|
Returns the nonzeros in a quadratic constraint coefficients matrix for the columns in a given range.
|
|
Returns the nonzeros in a quadratic constraint coefficients matrix as triplets (index pairs with coefficients).
|
|
Returns a list of row objects that have quadratic coefficients.
|
|
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.
|
|
Returns the right hand side range values for the rows in a given range.
|
|
Retrieve if a range of rows have been set up as special rows.
[Problem Information] |
|
Get current row information.
|
|
Returns the nonzeros in the constraint matrix for the rows in a given range.
|
|
Retrieve the status setting of a constraint
|
|
Returns the row types for the rows in a given range.
|
|
Get the initial penalty error weight for a row
|
|
Returns the the current scaling of the matrix.
[Numerics] |
|
Returns a list of scaled infeasible primal and dual variables for the original problem.
|
|
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.
|
|
Retrieve the values of a set of convergence tolerances for an SLP problem
|
|
Returns the upper bounds on the columns in a given range.
|
|
Returns the index vector which causes the primal simplex or dual simplex algorithm to determine that a problem is primal or dual unbounded respectively.
|
|
Retrieve information about an SLP variable
|
|
Returns one or more variables of a problem corresponding to one or more indices passed as arguments.
|
|
Returns true if a dual ray (dual unbounded direction) exists for the current problem, if the problem is found to be infeasible.
|
|
Returns true if a primal ray (primal unbounded direction) exists for the current problem, if the problem is found to be unbounded.
|
|
Performs an automated search for independent Irreducible Infeasible Sets (IIS) in an infeasible problem.
|
|
Resets the search for Irreducible Infeasible Sets (IIS).
|
|
Initiates a search for an Irreducible Infeasible Set (IIS) in an infeasible problem.
|
|
Performs the isolation identification procedure for an Irreducible Infeasible Set (IIS).
|
|
Continues the search for further Irreducible Infeasible Sets (IIS).
|
|
Returns statistics on the Irreducible Infeasible Sets (IIS) found so far.
|
|
Writes an LP/MPS/CSV file containing a given Irreducible Infeasible Set (IIS).
|
|
Interrupts the Optimizer algorithms.
|
|
Loads a basis as specified by the user.
|
|
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.
|
|
Load non-linear coefficients into the SLP problem
|
|
Loads cuts from the cut pool into the matrix.
|
|
Specifies that a set of rows in the problem will be treated as delayed rows during a tree search.
|
|
Load a set of distribution factors
|
|
Loads directives into the problem.
|
|
Loads an LP solution for the problem into the Optimizer.
|
|
Loads a MIP solution for the problem into the Optimizer.
|
|
Specifies that a set of rows in the problem will be treated as model cuts.
|
|
Loads a presolved basis from the user's areas.
|
|
Loads directives into the presolved matrix.
|
|
Load an optimization problem, possibly with quadratic objective and/or constraints, and integer variables.
|
|
Allows the user to mark rows and columns in order to prevent the presolve removing these rows and columns from the problem.
|
|
Load sets of standard tolerance values into an SLP problem
|
|
Load SLP variables defined as matrix columns into an SLP problem
|
|
Begins a search for the optimal continuous (LP) solution.
|
|
Begins a tree search for the optimal MIP solution.
|
|
A combined version of msaddjob and msaddpreset.
|
|
Adds a multistart job to the multistart pool
|
|
Loads a preset of jobs into the multistart job pool.
|
|
Removes all scheduled jobs from the multistart job pool
|
|
Returns the name of the problem as a Python string.
|
|
Add non-linear formulas to the SLP problem.
[Problem Modification] |
|
Add or replace a single matrix formula using a parsed or unparsed formula
|
|
Add or replace a single matrix formula using a character string for the formula.
|
|
Delete nonlinear formulas from the current problem
[Problem Modification] |
|
Retrieve a single matrix formula split into tokens
|
|
Retrieve the list of positions of the nonlinear formulas in the problem
[Problem Information] |
|
Retrieve a single matrix formula in a character string
|
|
Load non-linear formulas into the SLP problem
[Problem Information] |
|
Solves an SLP problem
|
|
Set the initial value of a nonlinear variable
|
|
Returns upper and lower sensitivity ranges for specified objective function coefficients.
|
|
Begins a search for the optimal solution of the problem.
|
|
Performs a simplex pivot by bringing variable enter into the basis and removing leave.
[Linear Algebra, Simplex] |
|
Postsolve the current problem when it is in a presolved state.
|
|
Postsolves a primal solution formulated in the presolved space into the corresponding solution formulated in the original space. The problem itself is unchanged.
[Presolve, Solution] |
|
Perform a nonlinear presolve on the problem
|
|
Presolves a row formulated in terms of the original variables such that it can be added to a presolved problem.
|
|
Print a summary of any evaluation errors that may have occurred during solving a problem
|
|
Prints a given Irreducible Infeasible Set (IIS) in the log.
[Infeasibility, Logging] |
|
Print the dimensions and memory allocations for a problem
|
|
Read an optimization problem into a Python problem object created prior to the call.
|
|
Instructs the Optimizer to read in a previously saved basis from a file.
|
|
Reads a solution from a binary solution file.
|
|
Reads a directives file to help direct the tree search.
|
|
Reads an ASCII solution file .slx created by the problem.writeslxsol function.
|
|
Runs the MIP solution refiner.
|
|
Reset the SLP problem to match a just augmented system
|
|
Removes a user after objective callback function previously added by addcbafterobjective.
|
|
Removes a barrier iteration callback function previously added by addcbbariteration.
|
|
Removes a newton barrier log callback function previously added by addcbbarlog.
|
|
Removes a user before objective callback function previously added by addcbbeforeobjective.
|
|
Removes a callback function previously added by problem.addcbchecktime.
|
|
Removes a callback function previously added by addcbchgbranchobject.
|
|
Removes a cut log callback function previously added by addcbcutlog.
|
|
Removes a cut round callback function previously added by addcbcutround.
|
|
Removes a slave thread destruction callback function previously added by addcbdestroymt.
|
|
Removes a callback function previously added by problem.addcbgapnotify.
|
|
Removes a user infeasible node callback function previously added by addcbinfnode.
|
|
Removes an integer solution callback function previously added by addcbintsol.
|
|
Removes a simplex log callback function previously added by addcblplog.
|
|
Removes a message callback function previously added by addcbmessage.
|
|
Removes a MIP log callback function previously added by addcbmiplog.
|
|
Removes a callback function previously added by addcbmipthread.
|
|
Removes a new-node callback function previously added by addcbnewnode.
|
|
Removes a node-cutoff callback function previously added by addcbnodecutoff.
|
|
Removes a node lp solved callback function previously added by addcbnodelpsolved.
|
|
Removes a node-optimal callback function previously added by addcboptnode.
|
|
Removes a pre-integer solution callback function previously added by addcbpreintsol.
|
|
Removes a preprocess node callback function previously added by addcbprenode.
|
|
Removes a presolve callback function previously added by addcbpresolve.
|
|
Removes a user solution notification callback previously added by problem.addcbusersolnotify.
|
|
Provides a simplified interface for problem.repairweightedinfeas.
|
|
Attempts to identify a 'solution' that violates a selected set of constraints and bounds minimally, while satisfying all other constraints and bounds.
|
|
An extended version of problem.repairweightedinfeas that allows for bounding the level of relaxation allowed.
|
|
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.save.
|
|
Returns upper and lower sensitivity ranges for specified right hand side (RHS) function coefficients.
|
|
Saves the current data structures, i.e., matrices, control settings and problem attribute settings to file and terminates the run so that optimization can be resumed later.
|
|
Re-scales the current problem.
|
|
Analyze the current matrix for largest/smallest coefficients and ratios
|
|
Set a user callback to be called at the end of the cascading process, after the last variable has been cascaded
|
|
Set a user callback to be called at the start of the cascading process, before any variables have been cascaded
|
|
Set a user callback to be called after each column has been cascaded
|
|
Set a user callback to be called after cascading a column was not successful
|
|
Set a user callback to be called when an evaluation of a coefficient fails during the solve
|
|
Set a user callback to be called during the Xpress SLP augmentation process
|
|
Set a user callback to be called when an SLP problem is about to be destroyed
|
|
Set a user callback used to override the update of variables with small determining column
|
|
Set a user callback to be called during MISLP when an integer solution is obtained
|
|
Set a user callback to be called at the end of each SLP iteration
|
|
Set a user callback to be called at the start of each SLP iteration
|
|
Set a user callback to be called after each column has been tested for convergence
|
|
Set a user callback to be called whenever Xpress Nonlinear outputs a line of text
|
|
Set a user callback to be called every time a new multistart job finishes.
|
|
Set a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
|
|
Set a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
|
|
Set a user callback to be called during MISLP when an optimal SLP solution is obtained at a node
|
|
Set a user callback to be called during MISLP after the set-up of the SLP problem to be solved at a node, but before SLP optimization
|
|
Set a user callback to be called before the linearization is updated
|
|
Set a user callback to be called at the end of the SLP optimization
|
|
Set a user callback to be called during MISLP after the SLP optimization at each node.
|
|
Set a user callback to be called at the start of the SLP optimization
|
|
Sets one or more controls of a problem.
|
|
Transfer the current solution to initial values
|
|
Sets one control to its default value.
|
|
Sets all controls to their default values.
|
|
Specifies that a set of rows in the problem will be treated as indicator constraints during a tree search.
|
|
This directs all Optimizer output to a log file.
|
|
Manages suppression of messages.
|
|
Sets the objective function of the problem.
|
|
Enables or disables writing Optimizer messages to the Python output stream.
|
|
Sets the current default problem name.
|
|
Add or change a single matrix coefficient using a parsed or unparsed formula
|
|
Add or change a single matrix coefficient using a string for the formula
|
|
Retrieve a single matrix formula split into tokens
|
|
Retrieve a single matrix coefficient as a formula in a character string
|
|
Set the determining row of a variable
[Cascading, Data Input, SLP] |
|
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.
|
|
Performs strong branching iterations on all specified bound changes.
|
|
Performs strong branching iterations on all specified bound changes.
|
|
Begin a tuner session for the current problem.
|
|
Begins a tuner session for a set of problems.
|
|
Load a user defined tuner method from the given file.
|
|
Writes the current tuner method to a given file or prints it to the console.
|
|
Reset the SLP problem and removes the augmentation structures
|
|
Updates the current linearization
|
|
Validate the feasibility of constraints in a converged solution
|
|
Validates the first order optimality conditions also known as the Karush-Kuhn-Tucker (KKT) conditions versus the currect solution
|
|
Prints an extensive analysis on a given constraint of the SLP problem
|
|
Validate the feasibility of constraints for a given solution
|
|
Writes the current problem to an MPS or LP file.
|
|
Writes the current basis to a file for later input into the Optimizer.
|
|
Writes the current MIP or LP solution to a binary solution file for later input into the Optimizer.
|
|
Writes the tree search directives from the current problem to a directives file.
|
|
Writes the current solution to a fixed format ASCII file, problem_name.prt.
|
|
Creates an ASCII solution file (.slx) using a similar format to MPS files.
|
|
Writes the current solution to a CSV format ASCII file, problem_name.asc(and .hdr).
|
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.
|
|
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.
|
|
Declares a barrier log callback function, called at each iteration during the interior point algorithm.
|
|
Declares a callback which will be called before each objective in a multi-objective problem is solved.
|
|
Declares a callback function which is called every time the Optimizer checks if the time limit has been reached.
|
|
Declares a callback function that will be called every time the Optimizer has selected a MIP entity for branching.
|
|
Declares a cut log callback function, called each time the cut log is printed.
|
|
Declares a callback function that is called when the Optimizer could separate cutting planes during the branch and bound search.
|
|
Declares a callback function that is called every time a MIP thread is destroyed by the parallel MIP code.
|
|
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.
|
|
Declares a user infeasible node callback function, called after the current node has been found to be infeasible during the Branch and Bound search.
|
|
Declares a user integer solution callback function, called every time an integer solution is found by heuristics or during the Branch and Bound search.
|
|
Declares a simplex log callback function which is called after every LPLOG iterations of the simplex algorithm.
|
|
Declares an output callback function, called every time a text line relating to the given prob is output by the Optimizer.
|
|
Declares a MIP log callback function, called each time the MIP log is printed.
|
|
Declares a MIP thread callback function, called every time a MIP worker problem is created by the parallel MIP code.
|
|
Declares a callback function that will be called every time a new node is created during the branch and bound search.
|
|
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.
|
|
Declares a node LP solved 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.
|
|
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.
|
|
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.
|
|
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.
|
|
Declares a callback to be called after presolve has been performed.
|
|
Declares a callback function to be called each time a solution added by problem.addmipsol has been processed.
|
|
Add non-linear coefficients to the SLP problem
|
|
Add columns to the problem after passing it to the Optimizer using the input routines.
|
|
Adds one or more constraints to the problem.
|
|
Adds cuts directly to the matrix at the current node.
|
|
Add a set of distribution factors
|
|
Adds one or more general constraints to the problem.
|
|
Adds one or more indicator constraints to the problem.
|
|
Adds cuts to the Optimizer's internal cut pool from within the cutround callback set by problem.addcbcutround.
[Callback, Cuts] |
|
Adds a new feasible, infeasible or partial MIP solution for the problem to the Optimizer.
|
|
Associates names with rows, columns, sets, piecewise linear constraints, general constraints or objectives.
|
|
Appends an objective function with the given coefficients to a multi-objective problem.
|
|
Adds one or more objective functions to the problem.
|
|
Adds one or more piecewise linear constraints to the problem.
|
|
Adds a new quadratic matrix into a row defined by triplets.
|
|
Adds rows and their coefficient to the problem.
|
|
Allows sets to be added to the problem after passing it to the Optimizer using the input routines.
[MIP Entities, Problem Creation] |
|
Creates a special ordered set (SOS) constraint within the problem.
|
|
Add sets of standard tolerance values to an SLP problem
|
|
Creates a variable within the problem.
|
|
Creates a dictionary or NumPy array of variables and adds them to the problem.
|
|
Add SLP variables defined as matrix columns to an SLP problem
|
|
Returns various measures for the stability of the current basis, including the basis condition number.
|
|
Returns upper and lower sensitivity ranges for specified variables' lower and upper bounds.
|
|
Post-multiplies a (row) vector provided by the user by the inverse of the current basis.
|
|
Returns the objective value of a given solution.
|
|
Returns the value of a given objective.
|
|
Returns the reduced cost values for a given (row) dual solution.
|
|
Calculates the row slack values for a given solution.
|
|
Returns the required property of a solution, like maximum infeasibility of a given primal and duals solution.
|
|
Re-calculate consistent values for SLP variables based on the current values of the remaining variables
|
|
Establish a re-calculation sequence for SLP variables with determining rows.
|
|
Changes the bounds on columns in the problem.
|
|
Set a variable specific cascade iteration limit
|
|
Changes a single coefficient in the problem.
|
|
Changes the type of a column in the problem.
|
|
Changes the type of the delta assigned to a nonlinear variable
|
|
Set or change a distribution factor
|
|
Changes semi-continuous or semi-integer lower bounds, or upper limits on partial integers.
|
|
Change multiple coefficients in the problem.
|
|
Change multiple quadratic coefficients in the objective function.
|
|
Change the objective function coefficients.
|
|
Modifies one or more coefficients of an objective function in a multi-objective problem.
|
|
Changes the problem's objective function objsense to minimize or maximize.
|
|
Change a single quadratic coefficient in the objective function corresponding to the variable pair (objqcol1,objqcol2) of the Hessian matrix.
|
|
Changes a single quadratic coefficient in a row.
|
|
Changes righthand side values of the problem.
|
|
Change the range for one or more rows of the problem.
|
|
Change the status setting of a constraint
|
|
Changes the type of a row in the problem.
|
|
Set or change the initial penalty error weight for a row
|
|
Add or change a set of convergence tolerances used for SLP variables
|
|
Define a column as an SLP variable or change the characteristics and values of an existing SLP variable
|
|
Clears extra information attached to a range of rows.
[Problem Modification] |
|
Create the full augmented SLP matrix and data structures, ready for optimization
|
|
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.
|
|
Delete coefficients from the current problem
|
|
Delete columns from a matrix.
[Problem Creation] |
|
Delete one or more constraints from the problem.
|
|
Deletes cuts from the cut pool.
|
|
Deletes cuts from the matrix at the current node.
|
|
Delete general constraints from a problem.
|
|
Delete indicator constraints.
|
|
Removes an objective function from a multi-objective problem.
|
|
Delete piecewise linear constraints from a problem.
|
|
Deletes the quadratic part of a row or of the objective function.
|
|
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 tolerance sets from the current problem
|
|
Delete one or more variables from the problem.
|
|
Convert SLP variables to normal columns.
|
|
Displays the list of controls and their current value for those controls that have been set to a non default value.
|
|
Performs a dual side range sensitivity analysis, i.e., calculates estimates for the possible ranges for dual values.
|
|
Evaluate a coefficient using the current values of the variables
|
|
Evaluate a formula using the current values of the variables
|
|
Fixes all the MIP entities to the values of the last found MIP solution.
|
|
Fixe the values of the error vectors
|
|
Pre-multiplies a (column) vector provided by the user by the inverse of the current matrix.
|
|
Retrieves one or more attributes of a problem.
|
|
Accesses the id number and the type information of an attribute given its name.
|
|
Returns the current basis into the user's data arrays.
|
|
Returns the current basis status for a specific col or row.
|
|
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.
|
|
Returns the reduced costs from the solution to the presolved problem associated with the current callback.
|
|
Returns the slack values from the solution to the presolved problem associated with the current callback.
|
|
Returns the solution to the presolved problem associated with the current callback.
|
|
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.
|
|
Retrieve a single nonlinear matrix coefficient as a formula split into tokens
|
|
Retrieve the list of positions of the nonlinear coefficients in the problem
|
|
Get current column information.
|
|
Returns the nonzeros in the constraint matrix for the columns in a given range.
|
|
Returns the column types for the columns in a given range.
|
|
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.
|
|
Returns a list of cut indices from the cut pool.
|
|
Returns cuts from the cut pool.
|
|
Retrieves a list of cuts for the cuts active at the current node.
|
|
Returns in which rows a list of cutind are currently loaded into the Optimizer.
|
|
Used to calculate the slack value of a cut with respect to the current LP relaxation solution.
|
|
Get a distribution factor
|
|
Returns the directives that have been loaded into a problem.
|
|
Retrieves a dual ray (dual unbounded direction) for the current problem, if the problem is found to be infeasible.
|
|
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.
|
|
Returns information for an Irreducible Infeasible Set: size, variables (row and column vectors) and conflicting sides of the variables, duals and reduced costs.
|
|
Returns the numerical index for a specified row, column, or set of the optimizer.
|
|
Returns the index for a specified row or column name.
|
|
Returns the indicator constraint condition (indicator variable and complement flag) associated to the rows in a given range.
|
|
Returns a list of infeasible primal and dual variables.
|
|
Obtains the last barrier solution values following optimization that used the barrier solver.
|
|
Returns the error message corresponding to the last error triggered by a library function.
|
|
Returns the lower bounds on the columns in a given range.
|
|
Obtains the LP solution values following optimization.
|
|
Returns the current suppression status of a message: nonzero if the message is not suppressed; 0 otherwise.
|
|
Retrieves MIP entity information about a problem.
|
|
Returns the nonzeros in the quadratic objective coefficients' matrix for the columns in a given range.
|
|
Returns the names for the rows, columns, sets, piecewise linear constraints, general constraints or objectives in a given range.
|
|
Returns the objective function coefficients for the columns in a given range.
|
|
Returns the coefficients of a given objective function for the columns in a given range.
|
|
Returns True if Optimizer messages will be written to the Python output stream, False otherwise.
|
|
Returns the pivot order of the basic variables.
|
|
Returns a list of potential leaving variables if a specified variable enters the basis.
|
|
Returns the current basis from memory into the user's data areas.
|
|
Returns the mapping of the row and column numbers from the presolve problem back to the original problem.
|
|
Returns the solution for the presolved problem from memory.
|
|
Retrieves a primal ray (primal unbounded direction) for the current problem, if the problem is found to be unbounded.
|
|
Returns the piecewise linear constraints y = f(x) in a given range.
|
|
Returns a single quadratic objective function coefficient corresponding to the variable pair (objqcol1, objqcol2) of the Hessian matrix.
|
|
Returns a single quadratic constraint coefficient corresponding to the variable pair (rowqcol1, rowqcol2) of the Hessian of a given constraint.
|
|
Returns the nonzeros in a quadratic constraint coefficients matrix for the columns in a given range.
|
|
Returns the nonzeros in a quadratic constraint coefficients matrix as triplets (index pairs with coefficients).
|
|
Returns a list of row objects that have quadratic coefficients.
|
|
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.
|
|
Returns the right hand side range values for the rows in a given range.
|
|
Retrieve if a range of rows have been set up as special rows.
[Problem Information] |
|
Get current row information.
|
|
Returns the nonzeros in the constraint matrix for the rows in a given range.
|
|
Retrieve the status setting of a constraint
|
|
Returns the row types for the rows in a given range.
|
|
Get the initial penalty error weight for a row
|
|
Returns the the current scaling of the matrix.
[Numerics] |
|
Returns a list of scaled infeasible primal and dual variables for the original problem.
|
|
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.
|
|
Retrieve the values of a set of convergence tolerances for an SLP problem
|
|
Returns the upper bounds on the columns in a given range.
|
|
Returns the index vector which causes the primal simplex or dual simplex algorithm to determine that a problem is primal or dual unbounded respectively.
|
|
Retrieve information about an SLP variable
|
|
Returns one or more variables of a problem corresponding to one or more indices passed as arguments.
|
|
Returns true if a dual ray (dual unbounded direction) exists for the current problem, if the problem is found to be infeasible.
|
|
Returns true if a primal ray (primal unbounded direction) exists for the current problem, if the problem is found to be unbounded.
|
|
Performs an automated search for independent Irreducible Infeasible Sets (IIS) in an infeasible problem.
|
|
Resets the search for Irreducible Infeasible Sets (IIS).
|
|
Initiates a search for an Irreducible Infeasible Set (IIS) in an infeasible problem.
|
|
Performs the isolation identification procedure for an Irreducible Infeasible Set (IIS).
|
|
Continues the search for further Irreducible Infeasible Sets (IIS).
|
|
Returns statistics on the Irreducible Infeasible Sets (IIS) found so far.
|
|
Writes an LP/MPS/CSV file containing a given Irreducible Infeasible Set (IIS).
|
|
Interrupts the Optimizer algorithms.
|
|
Loads a basis as specified by the user.
|
|
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.
|
|
Load non-linear coefficients into the SLP problem
|
|
Loads cuts from the cut pool into the matrix.
|
|
Specifies that a set of rows in the problem will be treated as delayed rows during a tree search.
|
|
Load a set of distribution factors
|
|
Loads directives into the problem.
|
|
Loads an LP solution for the problem into the Optimizer.
|
|
Loads a MIP solution for the problem into the Optimizer.
|
|
Specifies that a set of rows in the problem will be treated as model cuts.
|
|
Loads a presolved basis from the user's areas.
|
|
Loads directives into the presolved matrix.
|
|
Load an optimization problem, possibly with quadratic objective and/or constraints, and integer variables.
|
|
Allows the user to mark rows and columns in order to prevent the presolve removing these rows and columns from the problem.
|
|
Load sets of standard tolerance values into an SLP problem
|
|
Load SLP variables defined as matrix columns into an SLP problem
|
|
Begins a search for the optimal continuous (LP) solution.
|
|
Begins a tree search for the optimal MIP solution.
|
|
A combined version of msaddjob and msaddpreset.
|
|
Adds a multistart job to the multistart pool
|
|
Loads a preset of jobs into the multistart job pool.
|
|
Removes all scheduled jobs from the multistart job pool
|
|
Returns the name of the problem as a Python string.
|
|
Add non-linear formulas to the SLP problem.
[Problem Modification] |
|
Add or replace a single matrix formula using a parsed or unparsed formula
|
|
Add or replace a single matrix formula using a character string for the formula.
|
|
Delete nonlinear formulas from the current problem
[Problem Modification] |
|
Retrieve a single matrix formula split into tokens
|
|
Retrieve the list of positions of the nonlinear formulas in the problem
[Problem Information] |
|
Retrieve a single matrix formula in a character string
|
|
Load non-linear formulas into the SLP problem
[Problem Information] |
|
Solves an SLP problem
|
|
Set the initial value of a nonlinear variable
|
|
Returns upper and lower sensitivity ranges for specified objective function coefficients.
|
|
Begins a search for the optimal solution of the problem.
|
|
Performs a simplex pivot by bringing variable enter into the basis and removing leave.
[Linear Algebra, Simplex] |
|
Postsolve the current problem when it is in a presolved state.
|
|
Postsolves a primal solution formulated in the presolved space into the corresponding solution formulated in the original space. The problem itself is unchanged.
[Presolve, Solution] |
|
Perform a nonlinear presolve on the problem
|
|
Presolves a row formulated in terms of the original variables such that it can be added to a presolved problem.
|
|
Print a summary of any evaluation errors that may have occurred during solving a problem
|
|
Prints a given Irreducible Infeasible Set (IIS) in the log.
[Infeasibility, Logging] |
|
Print the dimensions and memory allocations for a problem
|
|
Read an optimization problem into a Python problem object created prior to the call.
|
|
Instructs the Optimizer to read in a previously saved basis from a file.
|
|
Reads a solution from a binary solution file.
|
|
Reads a directives file to help direct the tree search.
|
|
Reads an ASCII solution file .slx created by the problem.writeslxsol function.
|
|
Runs the MIP solution refiner.
|
|
Reset the SLP problem to match a just augmented system
|
|
Removes a user after objective callback function previously added by addcbafterobjective.
|
|
Removes a barrier iteration callback function previously added by addcbbariteration.
|
|
Removes a newton barrier log callback function previously added by addcbbarlog.
|
|
Removes a user before objective callback function previously added by addcbbeforeobjective.
|
|
Removes a callback function previously added by problem.addcbchecktime.
|
|
Removes a callback function previously added by addcbchgbranchobject.
|
|
Removes a cut log callback function previously added by addcbcutlog.
|
|
Removes a cut round callback function previously added by addcbcutround.
|
|
Removes a slave thread destruction callback function previously added by addcbdestroymt.
|
|
Removes a callback function previously added by problem.addcbgapnotify.
|
|
Removes a user infeasible node callback function previously added by addcbinfnode.
|
|
Removes an integer solution callback function previously added by addcbintsol.
|
|
Removes a simplex log callback function previously added by addcblplog.
|
|
Removes a message callback function previously added by addcbmessage.
|
|
Removes a MIP log callback function previously added by addcbmiplog.
|
|
Removes a callback function previously added by addcbmipthread.
|
|
Removes a new-node callback function previously added by addcbnewnode.
|
|
Removes a node-cutoff callback function previously added by addcbnodecutoff.
|
|
Removes a node lp solved callback function previously added by addcbnodelpsolved.
|
|
Removes a node-optimal callback function previously added by addcboptnode.
|
|
Removes a pre-integer solution callback function previously added by addcbpreintsol.
|
|
Removes a preprocess node callback function previously added by addcbprenode.
|
|
Removes a presolve callback function previously added by addcbpresolve.
|
|
Removes a user solution notification callback previously added by problem.addcbusersolnotify.
|
|
Provides a simplified interface for problem.repairweightedinfeas.
|
|
Attempts to identify a 'solution' that violates a selected set of constraints and bounds minimally, while satisfying all other constraints and bounds.
|
|
An extended version of problem.repairweightedinfeas that allows for bounding the level of relaxation allowed.
|
|
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.save.
|
|
Returns upper and lower sensitivity ranges for specified right hand side (RHS) function coefficients.
|
|
Saves the current data structures, i.e., matrices, control settings and problem attribute settings to file and terminates the run so that optimization can be resumed later.
|
|
Re-scales the current problem.
|
|
Analyze the current matrix for largest/smallest coefficients and ratios
|
|
Set a user callback to be called at the end of the cascading process, after the last variable has been cascaded
|
|
Set a user callback to be called at the start of the cascading process, before any variables have been cascaded
|
|
Set a user callback to be called after each column has been cascaded
|
|
Set a user callback to be called after cascading a column was not successful
|
|
Set a user callback to be called when an evaluation of a coefficient fails during the solve
|
|
Set a user callback to be called during the Xpress SLP augmentation process
|
|
Set a user callback to be called when an SLP problem is about to be destroyed
|
|
Set a user callback used to override the update of variables with small determining column
|
|
Set a user callback to be called during MISLP when an integer solution is obtained
|
|
Set a user callback to be called at the end of each SLP iteration
|
|
Set a user callback to be called at the start of each SLP iteration
|
|
Set a user callback to be called after each column has been tested for convergence
|
|
Set a user callback to be called whenever Xpress Nonlinear outputs a line of text
|
|
Set a user callback to be called every time a new multistart job finishes.
|
|
Set a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
|
|
Set a user callback to be called every time a new multistart job is created, and the pre-loaded settings are applied
|
|
Set a user callback to be called during MISLP when an optimal SLP solution is obtained at a node
|
|
Set a user callback to be called during MISLP after the set-up of the SLP problem to be solved at a node, but before SLP optimization
|
|
Set a user callback to be called before the linearization is updated
|
|
Set a user callback to be called at the end of the SLP optimization
|
|
Set a user callback to be called during MISLP after the SLP optimization at each node.
|
|
Set a user callback to be called at the start of the SLP optimization
|
|
Sets one or more controls of a problem.
|
|
Transfer the current solution to initial values
|
|
Sets one control to its default value.
|
|
Sets all controls to their default values.
|
|
Specifies that a set of rows in the problem will be treated as indicator constraints during a tree search.
|
|
This directs all Optimizer output to a log file.
|
|
Manages suppression of messages.
|
|
Sets the objective function of the problem.
|
|
Enables or disables writing Optimizer messages to the Python output stream.
|
|
Sets the current default problem name.
|
|
Add or change a single matrix coefficient using a parsed or unparsed formula
|
|
Add or change a single matrix coefficient using a string for the formula
|
|
Retrieve a single matrix formula split into tokens
|
|
Retrieve a single matrix coefficient as a formula in a character string
|
|
Set the determining row of a variable
[Cascading, Data Input, SLP] |
|
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.
|
|
Performs strong branching iterations on all specified bound changes.
|
|
Performs strong branching iterations on all specified bound changes.
|
|
Begin a tuner session for the current problem.
|
|
Begins a tuner session for a set of problems.
|
|
Load a user defined tuner method from the given file.
|
|
Writes the current tuner method to a given file or prints it to the console.
|
|
Reset the SLP problem and removes the augmentation structures
|
|
Updates the current linearization
|
|
Validate the feasibility of constraints in a converged solution
|
|
Validates the first order optimality conditions also known as the Karush-Kuhn-Tucker (KKT) conditions versus the currect solution
|
|
Prints an extensive analysis on a given constraint of the SLP problem
|
|
Validate the feasibility of constraints for a given solution
|
|
Writes the current problem to an MPS or LP file.
|
|
Writes the current basis to a file for later input into the Optimizer.
|
|
Writes the current MIP or LP solution to a binary solution file for later input into the Optimizer.
|
|
Writes the tree search directives from the current problem to a directives file.
|
|
Writes the current solution to a fixed format ASCII file, problem_name.prt.
|
|
Creates an ASCII solution file (.slx) using a similar format to MPS files.
|
|
Writes the current solution to a CSV format ASCII file, problem_name.asc(and .hdr).
|
© 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.