More "doxygenish" syntax.
3 * This file is a part of LEMON, a generic C++ optimization library
5 * Copyright (C) 2003-2006
6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
9 * Permission to use, modify and distribute this software is granted
10 * provided that this copyright notice appears in all copies. For
11 * precise terms see the accompanying LICENSE file.
13 * This software is provided "AS IS" with no warranty of any kind,
14 * express or implied, and with no claim as to its suitability for any
20 #include<lemon/lp_cplex.h>
23 ///\brief Implementation of the LEMON-CPLEX lp solver interface.
26 LpCplex::LpCplex() : LpSolverBase() {
28 // env = CPXopenCPLEXdevelop(&status);
29 env = CPXopenCPLEX(&status);
30 lp = CPXcreateprob(env, &status, "LP problem");
38 LpSolverBase &LpCplex::_newLp()
40 //The first approach opens a new environment
41 LpCplex* newlp=new LpCplex();
45 LpSolverBase &LpCplex::_copyLp() {
46 //The first approach opens a new environment
47 LpCplex* newlp=new LpCplex();
48 //The routine CPXcloneprob can be used to create a new CPLEX problem
49 //object and copy all the problem data from an existing problem
50 //object to it. Solution and starting information is not copied.
51 newlp->lp = CPXcloneprob(env, lp, &status);
55 int LpCplex::_addCol()
57 int i = CPXgetnumcols(env, lp);
59 lb[0]=-INF;//-CPX_INFBOUND;
60 ub[0]=INF;//CPX_INFBOUND;
61 status = CPXnewcols(env, lp, 1, NULL, lb, ub, NULL, NULL);
66 int LpCplex::_addRow()
68 //We want a row that is not constrained
70 sense[0]='L';//<= constraint
73 int i = CPXgetnumrows(env, lp);
74 status = CPXnewrows(env, lp, 1, rhs, sense, NULL, NULL);
79 void LpCplex::_eraseCol(int i) {
80 CPXdelcols(env, lp, i, i);
83 void LpCplex::_eraseRow(int i) {
84 CPXdelrows(env, lp, i, i);
87 void LpCplex::_getColName(int col, std::string &name)
91 CPXgetcolname(env, lp, 0, 0, 0, &storespace, col, col);
97 ///\bug return code unchecked for error
98 CPXgetcolname(env, lp, names, buf, storespace, &dontcare, col, col);
102 void LpCplex::_setColName(int col, const std::string &name)
106 names[0] = const_cast<char*>(name.c_str());
107 ///\bug return code unchecked for error
108 CPXchgcolname(env, lp, 1, &col, names);
111 ///\warning Data at index 0 is ignored in the arrays.
112 void LpCplex::_setRowCoeffs(int i,
115 Value const * values )
117 int rowlist[length+1];
119 for (int k=1;k<=length;++k){
122 status = CPXchgcoeflist(env, lp,
125 const_cast<int * >(indices+1),
126 const_cast<Value * >(values+1));
129 void LpCplex::_setColCoeffs(int i,
132 Value const * values)
134 int collist[length+1];
136 for (int k=1;k<=length;++k){
139 status = CPXchgcoeflist(env, lp,
141 const_cast<int * >(indices+1),
143 const_cast<Value * >(values+1));
146 void LpCplex::_setCoeff(int row, int col, Value value)
148 CPXchgcoef(env, lp, row, col, value);
151 void LpCplex::_setColLowerBound(int i, Value value)
159 status = CPXchgbds(env, lp, 1, indices, lu, bd);
163 void LpCplex::_setColUpperBound(int i, Value value)
171 status = CPXchgbds(env, lp, 1, indices, lu, bd);
174 //This will be easier to implement
175 void LpCplex::_setRowBounds(int i, Value lb, Value ub)
178 if (lb==INF || ub==-INF) {
189 CPXchgsense(env, lp, cnt, indices, sense);
190 CPXchgcoef(env, lp, i, -1, ub);
196 CPXchgsense(env, lp, cnt, indices, sense);
197 CPXchgcoef(env, lp, i, -1, lb);
202 CPXchgsense(env, lp, cnt, indices, sense);
203 CPXchgcoef(env, lp, i, -1, lb);
207 CPXchgsense(env, lp, cnt, indices, sense);
208 CPXchgcoef(env, lp, i, -1, lb);
209 CPXchgcoef(env, lp, i, -2, ub-lb);
215 // void LpCplex::_setRowLowerBound(int i, Value value)
217 // //Not implemented, obsolete
220 // void LpCplex::_setRowUpperBound(int i, Value value)
222 // //Not implemented, obsolete
223 // // //TODO Ezt kell meg megirni
224 // // //type of the problem
226 // // status = CPXgetsense(env, lp, sense, i, i);
228 // // status = CPXgetrhs(env, lp, rhs, i, i);
230 // // switch (sense[0]) {
231 // // case 'L'://<= constraint
233 // // case 'E'://= constraint
235 // // case 'G'://>= constraint
237 // // case 'R'://ranged constraint
243 // // status = CPXchgcoef(env, lp, i, -2, value_rng);
246 void LpCplex::_setObjCoeff(int i, Value obj_coef)
248 CPXchgcoef(env, lp, -1, i, obj_coef);
251 void LpCplex::_clearObj()
253 for (int i=0;i< CPXgetnumcols(env, lp);++i){
254 CPXchgcoef(env, lp, -1, i, 0);
258 // The routine returns zero unless an error occurred during the
259 // optimization. Examples of errors include exhausting available
260 // memory (CPXERR_NO_MEMORY) or encountering invalid data in the
261 // CPLEX problem object (CPXERR_NO_PROBLEM). Exceeding a
262 // user-specified CPLEX limit, or proving the model infeasible or
263 // unbounded, are not considered errors. Note that a zero return
264 // value does not necessarily mean that a solution exists. Use query
265 // routines CPXsolninfo, CPXgetstat, and CPXsolution to obtain
266 // further information about the status of the optimization.
267 LpCplex::SolveExitStatus LpCplex::_solve()
270 status = CPXlpopt(env, lp);
271 //status = CPXprimopt(env, lp);
273 //We want to exclude some cases
274 switch (CPXgetstat(env, lp)){
276 case CPX_IT_LIM_FEAS:
277 case CPX_IT_LIM_INFEAS:
278 case CPX_TIME_LIM_FEAS:
279 case CPX_TIME_LIM_INFEAS:
290 LpCplex::Value LpCplex::_getPrimal(int i)
293 CPXgetx(env, lp, &x, i, i);
297 LpCplex::Value LpCplex::_getDual(int i)
300 CPXgetpi(env, lp, &y, i, i);
304 LpCplex::Value LpCplex::_getPrimalValue()
307 //method = CPXgetmethod (env, lp);
308 //printf("CPXgetprobtype %d \n",CPXgetprobtype(env,lp));
309 status = CPXgetobjval(env, lp, &objval);
310 //printf("Objective value: %g \n",objval);
313 bool LpCplex::_isBasicCol(int i) {
314 int cstat[CPXgetnumcols(env, lp)];
315 CPXgetbase(env, lp, cstat, NULL);
316 return (cstat[i]==CPX_BASIC);
319 //7.5-os cplex statusai (Vigyazat: a 9.0-asei masok!)
320 // This table lists the statuses, returned by the CPXgetstat() routine, for solutions to LP problems or mixed integer problems. If no solution exists, the return value is zero.
322 // For Simplex, Barrier
324 // Optimal solution found
326 // Problem infeasible
330 // Objective limit exceeded in Phase II
332 // Iteration limit exceeded in Phase II
333 // 6 CPX_IT_LIM_INFEAS
334 // Iteration limit exceeded in Phase I
335 // 7 CPX_TIME_LIM_FEAS
336 // Time limit exceeded in Phase II
337 // 8 CPX_TIME_LIM_INFEAS
338 // Time limit exceeded in Phase I
339 // 9 CPX_NUM_BEST_FEAS
340 // Problem non-optimal, singularities in Phase II
341 // 10 CPX_NUM_BEST_INFEAS
342 // Problem non-optimal, singularities in Phase I
343 // 11 CPX_OPTIMAL_INFEAS
344 // Optimal solution found, unscaled infeasibilities
346 // Aborted in Phase II
347 // 13 CPX_ABORT_INFEAS
348 // Aborted in Phase I
349 // 14 CPX_ABORT_DUAL_INFEAS
350 // Aborted in barrier, dual infeasible
351 // 15 CPX_ABORT_PRIM_INFEAS
352 // Aborted in barrier, primal infeasible
353 // 16 CPX_ABORT_PRIM_DUAL_INFEAS
354 // Aborted in barrier, primal and dual infeasible
355 // 17 CPX_ABORT_PRIM_DUAL_FEAS
356 // Aborted in barrier, primal and dual feasible
357 // 18 CPX_ABORT_CROSSOVER
358 // Aborted in crossover
360 // Infeasible or unbounded
364 // Ezeket hova tegyem:
365 // ??case CPX_ABORT_DUAL_INFEAS
366 // ??case CPX_ABORT_CROSSOVER
367 // ??case CPX_INForUNBD
370 //Some more interesting stuff:
372 // CPX_PARAM_LPMETHOD 1062 int LPMETHOD
377 // 4 Standard Barrier
379 // Description: Method for linear optimization.
380 // Determines which algorithm is used when CPXlpopt() (or "optimize" in the Interactive Optimizer) is called. Currently the behavior of the "Automatic" setting is that CPLEX simply invokes the dual simplex method, but this capability may be expanded in the future so that CPLEX chooses the method based on problem characteristics
382 void statusSwitch(CPXENVptr env,int& stat){
384 CPXgetintparam (env,CPX_PARAM_LPMETHOD,&lpmethod);
386 if (stat==CPX_UNBOUNDED){
390 if (stat==CPX_INFEASIBLE)
396 LpCplex::SolutionStatus LpCplex::_getPrimalStatus()
399 int stat = CPXgetstat(env, lp);
400 statusSwitch(env,stat);
401 //CPXgetstat(env, lp);
402 //printf("A primal status: %d, CPX_OPTIMAL=%d \n",stat,CPX_OPTIMAL);
405 return UNDEFINED; //Undefined
406 case CPX_OPTIMAL://Optimal
408 case CPX_UNBOUNDED://Unbounded
409 return INFEASIBLE;//In case of dual simplex
411 case CPX_INFEASIBLE://Infeasible
412 // case CPX_IT_LIM_INFEAS:
413 // case CPX_TIME_LIM_INFEAS:
414 // case CPX_NUM_BEST_INFEAS:
415 // case CPX_OPTIMAL_INFEAS:
416 // case CPX_ABORT_INFEAS:
417 // case CPX_ABORT_PRIM_INFEAS:
418 // case CPX_ABORT_PRIM_DUAL_INFEAS:
419 return INFINITE;//In case of dual simplex
422 // case CPX_IT_LIM_FEAS:
423 // case CPX_TIME_LIM_FEAS:
424 // case CPX_NUM_BEST_FEAS:
425 // case CPX_ABORT_FEAS:
426 // case CPX_ABORT_PRIM_DUAL_FEAS:
429 return UNDEFINED; //Everything else comes here
435 //9.0-as cplex verzio statusai
436 // CPX_STAT_ABORT_DUAL_OBJ_LIM
437 // CPX_STAT_ABORT_IT_LIM
438 // CPX_STAT_ABORT_OBJ_LIM
439 // CPX_STAT_ABORT_PRIM_OBJ_LIM
440 // CPX_STAT_ABORT_TIME_LIM
441 // CPX_STAT_ABORT_USER
442 // CPX_STAT_FEASIBLE_RELAXED
443 // CPX_STAT_INFEASIBLE
444 // CPX_STAT_INForUNBD
447 // CPX_STAT_OPTIMAL_FACE_UNBOUNDED
448 // CPX_STAT_OPTIMAL_INFEAS
449 // CPX_STAT_OPTIMAL_RELAXED
450 // CPX_STAT_UNBOUNDED
452 LpCplex::SolutionStatus LpCplex::_getDualStatus()
454 int stat = CPXgetstat(env, lp);
455 statusSwitch(env,stat);
458 return UNDEFINED; //Undefined
459 case CPX_OPTIMAL://Optimal
464 return UNDEFINED; //Everything else comes here
469 LpCplex::ProblemTypes LpCplex::_getProblemType()
471 int stat = CPXgetstat(env, lp);
473 case CPX_OPTIMAL://Optimal
474 return PRIMAL_DUAL_FEASIBLE;
476 return PRIMAL_FEASIBLE_DUAL_INFEASIBLE;
477 // return PRIMAL_INFEASIBLE_DUAL_FEASIBLE;
478 // return PRIMAL_DUAL_INFEASIBLE;
480 //Seems to be that this is all we can say for sure
488 void LpCplex::_setMax()
490 CPXchgobjsen(env, lp, CPX_MAX);
492 void LpCplex::_setMin()
494 CPXchgobjsen(env, lp, CPX_MIN);