straindesign.gurobi_interface
Gurobi solver interface for LP and MILP
Module Contents
- class straindesign.gurobi_interface.Gurobi_MILP_LP(c, A_ineq, b_ineq, A_eq, b_eq, lb, ub, vtype, indic_constr)[source]
Bases:
gurobipy.Model
Gurobi interface for MILP and LP
This class is a wrapper for the Gurobi-Python API to offer bindings and namings for functions for the construction and manipulation of MILPs and LPs in an vector-matrix-based manner that are consistent with those of the other solver interfaces in the StrainDesign package. The purpose is to unify the instructions for operating with MILPs and LPs throughout StrainDesign.
The Gurobi interface provides support for indicator constraints as well as for the populate function.
- Accepts a (mixed integer) linear problem in the form:
minimize(c), subject to: A_ineq * x <= b_ineq, A_eq * x = b_eq, lb <= x <= ub, forall(i) type(x_i) = vtype(i) (continous, binary, integer), indicator constraints: x(j) = [0|1] -> a_indic * x [<=|=|>=] b_indic
Please ensure that the number of variables and (in)equalities is consistent
Example
gurobi = Gurobi_MILP_LP(c, A_ineq, b_ineq, A_eq, b_eq, lb, ub, vtype, indic_constr)
- Parameters:
c (list of float) – (Default: None) The objective vector (Objective sense: minimization).
A_ineq (sparse.csr_matrix) – (Default: None) A coefficient matrix of the static inequalities.
b_ineq (list of float) – (Default: None) The right hand side of the static inequalities.
A_eq (sparse.csr_matrix) – (Default: None) A coefficient matrix of the static equalities.
b_eq (list of float) – (Default: None) The right hand side of the static equalities.
lb (list of float) – (Default: None) The lower variable bounds.
ub (list of float) – (Default: None) The upper variable bounds.
vtype (str) – (Default: None) A character string that specifies the type of each variable: ‘c’ontinous, ‘b’inary or ‘i’nteger
indic_constr (IndicatorConstraints) – (Default: None) A set of indicator constraints stored in an object of IndicatorConstraints (see reference manual or docstring).
Returns –
(Gurobi_MILP_LP):
A Gurobi MILP/LP interface class.
- add_eq_constraints(A_eq, b_eq)[source]
Add equality constraints to the model
Additional equality constraints have the form A_eq * x = b_eq. The number of columns in A_eq must match with the number of variables x in the problem.
- add_ineq_constraints(A_ineq, b_ineq)[source]
Add inequality constraints to the model
Additional inequality constraints have the form A_ineq * x <= b_ineq. The number of columns in A_ineq must match with the number of variables x in the problem.
- populate(n) Tuple[List, float, float] [source]
Generate a solution pool for MILPs
Example
sols_x, optim, status = cplex.populate()
- Returns:
(Tuple[List of lists, float, float])
solution_vectors, optimal_value, optimization_status
- set_ineq_constraint(idx, a_ineq, b_ineq)[source]
Replace a specific inequality constraint
Replace the constraint with the index idx with the constraint a_ineq*x ~ b_ineq
- set_objective_idx(C)[source]
Set the objective function with index-value pairs
e.g.: C=[[1, 1.0], [4,-0.2]]