nsz Git - libfirm/blob - ir/lpp/lpp_gurobi.c

   1 /*
   2  * Copyright (C) 2005-2011 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @author  Matthias Braun
  23  */
  24 #include "config.h"
  25
  26 #ifdef WITH_GUROBI
  27 #include "lpp_gurobi.h"
  28
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <math.h>
  32
  33 #include "obst.h"
  34
  35 #include <gurobi_c.h>
  36
  37 #include "error.h"
  38 #include "sp_matrix.h"
  39
  40 static char gurobi_cst_encoding[4] = { 0, GRB_EQUAL, GRB_LESS_EQUAL, GRB_GREATER_EQUAL };
  41 static char gurobi_var_encoding[4] = { 0, 0, GRB_CONTINUOUS, GRB_BINARY };
  42
  43 typedef struct _gurobi_t {
  44         lpp_t *lpp;
  45         GRBenv *env;
  46         GRBenv *modelenv;
  47         GRBmodel *model;
  48 } gurobi_t;
  49
  50 static void check_gurobi_error(gurobi_t *grb, int error)
  51 {
  52         if (error != 0) {
  53                 panic("gurobi error: %s", GRBgeterrormsg(grb->env));
  54         }
  55 }
  56
  57 static gurobi_t *new_gurobi(lpp_t *lpp)
  58 {
  59         int error;
  60
  61         gurobi_t *grb = XMALLOCZ(gurobi_t);
  62         grb->lpp = lpp;
  63         /* /tmp/firm_gurobi.log is a hack (see below) */
  64         error = GRBloadenv(&grb->env, "/tmp/firm_gurobi.log");
  65         check_gurobi_error(grb, error);
  66         /* Matze: do not set the FILE* for logging output. Because:
  67          *  a) the function is deprecated
  68          *  b) gurobi closes the FILE handle when it is done, which leads to
  69          *     very unexpected effects when you pass stdout or stderr as logging
  70          *     output.
  71          * The only thing gurobi sanely supports is giving a string with a filename
  72          * :-( ...so we use /tmp/firm_gurobi.log as a temporary measure...
  73          */
  74 #if 0
  75         error = GRBsetlogfile(grb->env, lpp->log);
  76         check_gurobi_error(grb, error);
  77 #endif
  78
  79         return grb;
  80 }
  81
  82 static void free_gurobi(gurobi_t *grb)
  83 {
  84         GRBfreemodel(grb->model);
  85         GRBfreeenv(grb->env);
  86         free(grb);
  87 }
  88
  89 /**
  90  * Build CPLEX data structure from LPP matrix.
  91  * @note: The LPP matrix is freed after this step, to save memory.
  92  */
  93 static void gurobi_construct(gurobi_t *grb)
  94 {
  95         const matrix_elem_t *elem;
  96         int                  i, o;
  97         //int                  sv_cnt;
  98         //int                 *indices;
  99         //double              *startv;
 100         int                  numcols, numrows, numentries;
 101         int                  objsen, *matbeg, *matcnt, *matind;
 102         double               *obj, *rhs, *matval, *lb;
 103         char                 *sense, *vartype;
 104         char                 **colname, **rowname;
 105         struct obstack       obst;
 106         lpp_t                *lpp = grb->lpp;
 107         int                  error;
 108
 109         numcols    = lpp->var_next-1;
 110         numrows    = lpp->cst_next-1;
 111         numentries = matrix_get_entries(lpp->m);
 112         objsen     = lpp->opt_type == lpp_minimize ? 1 : -1;
 113         obstack_init(&obst);
 114
 115         obj     = obstack_alloc(&obst, numcols * sizeof(*obj));
 116         lb      = obstack_alloc(&obst, numcols * sizeof(*lb));
 117         colname = obstack_alloc(&obst, numcols * sizeof(*colname));
 118         rowname = obstack_alloc(&obst, numrows * sizeof(*rowname));
 119         vartype = obstack_alloc(&obst, numcols * sizeof(*vartype));
 120         //indices = obstack_alloc(&obst, numcols * sizeof(*indices));
 121         //startv  = obstack_alloc(&obst, numcols * sizeof(*startv));
 122         matbeg  = obstack_alloc(&obst, numcols * sizeof(*matbeg));
 123         matcnt  = obstack_alloc(&obst, numcols * sizeof(*matcnt));
 124         matind  = obstack_alloc(&obst, numentries * sizeof(*matind));
 125         matval  = obstack_alloc(&obst, numentries * sizeof(*matval));
 126         rhs     = obstack_alloc(&obst, numrows * sizeof(*rhs));
 127         sense   = obstack_alloc(&obst, numrows * sizeof(*sense));
 128
 129         o      = 0;
 130         //sv_cnt = 0;
 131         /* fill the CPLEX matrix*/
 132         for (i = 0; i < numcols; ++i) {
 133                 lpp_name_t *curr_var = lpp->vars[1+i];
 134
 135                 obj[i] = matrix_get(lpp->m, 0, 1+i);
 136                 lb[i]  = 0.0;
 137
 138                 colname[i] = (char*) curr_var->name;
 139                 vartype[i] = gurobi_var_encoding[curr_var->type.var_type];
 140
 141 #if 0
 142                 if (curr_var->value_kind == lpp_value_start) {
 143                         panic("start values not supported in gurobi yet");
 144                         indices[sv_cnt]  = i;
 145                         startv[sv_cnt++] = curr_var->value;
 146                 }
 147 #endif
 148
 149                 matbeg[i] = o;
 150                 matcnt[i] = 0;
 151                 matrix_foreach_in_col(lpp->m, 1 + i, elem) {
 152                         if (elem->row == 0)
 153                                 continue;
 154                         matind[o] = elem->row-1;
 155                         matval[o] = elem->val;
 156                         matcnt[i]++;
 157                         o++;
 158                 }
 159         }
 160
 161         /* get constraint stuff (right hand side, type, name) */
 162         for (i = 0; i < numrows; ++i) {
 163                 lpp_name_t *curr_cst = lpp->csts[1 + i];
 164
 165                 rhs[i]     = matrix_get(lpp->m, 1 + i, 0);
 166                 sense[i]   = gurobi_cst_encoding[curr_cst->type.cst_type];
 167                 rowname[i] = (char*) curr_cst->name;
 168         }
 169
 170         error = GRBloadmodel(grb->env, &grb->model, lpp->name, numcols, numrows,
 171                              objsen, 0, obj, sense, rhs, matbeg, matcnt, matind,
 172                              matval, lb, NULL, vartype, colname, rowname);
 173         check_gurobi_error(grb, error);
 174         grb->modelenv = GRBgetenv(grb->model);
 175
 176         obstack_free(&obst, NULL);
 177         lpp_free_matrix(lpp);
 178 }
 179
 180 static void gurobi_solve(gurobi_t *grb)
 181 {
 182         lpp_t *lpp = grb->lpp;
 183         int i;
 184         int optimstatus;
 185         int error;
 186         int numcols = lpp->var_next-1;
 187         double *values;
 188         double  iterations;
 189
 190         /* Set the time limit appropriately */
 191         if(lpp->time_limit_secs > 0.0) {
 192                 error = GRBsetdblparam(grb->modelenv, GRB_DBL_PAR_TIMELIMIT, lpp->time_limit_secs);
 193                 check_gurobi_error(grb, error);
 194         }
 195
 196         /*
 197          * If we have enough time, we instruct cplex to imply some
 198          * of its higher order magic to pursue the best solution
 199          */
 200         if(lpp->emphasis) {
 201                 /* not implemented */
 202         }
 203
 204         /*
 205          * If a bound of the objective function is supplied,
 206          * set it accordingly, dependign on minimization or maximization.
 207          */
 208         if(lpp->set_bound) {
 209                 //panic("bound not implemented yet");
 210                 fprintf(stderr, "Warning: gurobi bound not implemented yet\n");
 211         }
 212
 213         /* solve */
 214         error = GRBoptimize(grb->model);
 215         check_gurobi_error(grb, error);
 216
 217         /* get solution status */
 218         error = GRBgetintattr(grb->model, GRB_INT_ATTR_STATUS, &optimstatus);
 219         check_gurobi_error(grb, error);
 220
 221         switch (optimstatus) {
 222         case GRB_OPTIMAL:           lpp->sol_state = lpp_optimal; break;
 223         case GRB_INFEASIBLE:        lpp->sol_state = lpp_infeasible; break;
 224         case GRB_INF_OR_UNBD:       lpp->sol_state = lpp_inforunb; break;
 225         case GRB_UNBOUNDED:         lpp->sol_state = lpp_unbounded; break;
 226         /* TODO: is this correct? */
 227         default:                    lpp->sol_state = lpp_feasible; break;
 228         }
 229
 230         if (lpp->sol_state >= lpp_feasible) {
 231                 /* get variable solution values */
 232                 values = alloca(numcols * sizeof(*values));
 233                 error = GRBgetdblattrarray(grb->model, GRB_DBL_ATTR_X, 0, numcols,
 234                                            values);
 235                 check_gurobi_error(grb, error);
 236                 for(i=0; i<numcols; ++i) {
 237                         lpp->vars[1+i]->value      = values[i];
 238                         lpp->vars[1+i]->value_kind = lpp_value_solution;
 239                 }
 240
 241                 /* Get the value of the objective function. */
 242                 error = GRBgetdblattr(grb->model, GRB_DBL_ATTR_OBJVAL, &lpp->objval);
 243                 check_gurobi_error(grb, error);
 244                 error = GRBgetdblattr(grb->model , GRB_DBL_ATTR_OBJBOUND,
 245                                       &lpp->best_bound);
 246                 if (error != 0) {
 247                         lpp->best_bound = FP_NAN;
 248                 }
 249         }
 250
 251         /* get some statistics */
 252         error = GRBgetdblattr(grb->model, GRB_DBL_ATTR_ITERCOUNT, &iterations);
 253         check_gurobi_error(grb, error);
 254         lpp->iterations = (unsigned) iterations;
 255
 256         error = GRBgetdblattr(grb->model, GRB_DBL_ATTR_RUNTIME, &lpp->sol_time);
 257         check_gurobi_error(grb, error);
 258 }
 259
 260 void lpp_solve_gurobi(lpp_t *lpp)
 261 {
 262         gurobi_t *grb = new_gurobi(lpp);
 263         gurobi_construct(grb);
 264         gurobi_solve(grb);
 265         free_gurobi(grb);
 266 }
 267
 268 #endif