4 * Copyright: (c) Universitaet Karlsruhe
5 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
6 * CVS-Id: $Id: lpp.c 27353 2010-04-07 13:33:16Z matze $
25 #include "sp_matrix.h"
29 #include "lpp_solvers.h"
32 #define HASH_NAME_T(n) HASH_STR((n)->name, strlen((n)->name))
34 static firm_dbg_module_t *dbg = NULL;
36 static inline char *obst_xstrdup(struct obstack *obst, const char *str) {
37 return obstack_copy0(obst, str, strlen(str));
40 static int cmp_name_t(const void *x, const void *y, size_t size) {
41 const lpp_name_t *n = x;
42 const lpp_name_t *m = y;
43 (void)size; /* stop warnings */
44 return strcmp(n->name, m->name);
48 * Update statistic information about matrix usage.
50 static void update_stats(lpp_t *lpp) {
51 lpp->n_elems = matrix_get_entries(lpp->m);
52 lpp->matrix_mem = lpp->n_elems * matrix_get_elem_size();
53 lpp->density = (double)lpp->n_elems / (double)(lpp->cst_next * lpp->var_next) * 100.0;
56 #define INITIAL_SIZE 64
58 lpp_t *new_lpp(const char *name, lpp_opt_t opt_type) {
59 return new_lpp_userdef(name, opt_type, INITIAL_SIZE, INITIAL_SIZE, 2.0);
62 lpp_t *new_lpp_userdef(const char *name, lpp_opt_t opt_type,
63 int estimated_vars, int estimated_csts, double grow_factor)
68 dbg = firm_dbg_register("lpp");
69 lpp = XMALLOCZ(lpp_t);
70 obstack_init(&lpp->obst);
72 lpp->name = obst_xstrdup(&lpp->obst, name);
73 lpp->opt_type = opt_type;
74 lpp->grow_factor = grow_factor;
75 lpp->cst2nr = new_set(cmp_name_t, estimated_csts);
76 lpp->var2nr = new_set(cmp_name_t, estimated_vars);
77 lpp->cst_size = estimated_csts;
78 lpp->var_size = estimated_vars;
79 lpp->csts = XMALLOCNZ(lpp_name_t *, estimated_csts);
80 lpp->vars = XMALLOCNZ(lpp_name_t *, estimated_vars);
81 lpp->m = new_matrix(estimated_csts, estimated_vars);
82 lpp->emphasis = lpp_balanced;
83 idx = lpp_add_cst(lpp, "obj", lpp_objective, 0);
85 idx = lpp_add_var(lpp, "rhs", lpp_rhs, 0);
91 void free_lpp_matrix(lpp_t *lpp) {
96 void free_lpp(lpp_t *lpp) {
97 obstack_free(&lpp->obst, NULL);
100 del_set(lpp->var2nr);
102 /* matrix might have been already deleted */
112 double lpp_get_fix_costs(lpp_t *lpp) {
113 return matrix_get(lpp->m, 0, 0);
116 void lpp_set_fix_costs(lpp_t *lpp, double value) {
117 matrix_set(lpp->m, 0, 0, value);
120 static inline int name2nr(set *where, const char *name) {
121 lpp_name_t find, *found;
123 found = set_find(where, &find, sizeof(find), HASH_NAME_T(&find));
124 return (found ? found->nr : -1);
127 #define cst_nr(lpp, name) name2nr(lpp->cst2nr, name)
128 #define var_nr(lpp, name) name2nr(lpp->var2nr, name)
130 static inline char *get_next_name(lpp_t *lpp) {
131 char *res = obstack_alloc(&lpp->obst, 12);
132 snprintf(res, 12, "_%d", lpp->next_name_number++);
136 int lpp_add_cst(lpp_t *lpp, const char *cst_name, lpp_cst_t cst_type, double rhs) {
137 lpp_name_t n, *inner;
139 DBG((dbg, LEVEL_2, "%s %d %g\n", cst_name, cst_type, rhs));
141 if (cst_name && cst_name[0] == '_')
142 return ERR_NAME_NOT_ALLOWED;
145 n.name = obst_xstrdup(&lpp->obst, cst_name);
147 n.name = get_next_name(lpp);
150 inner = set_insert(lpp->cst2nr, &n, sizeof(n), HASH_NAME_T(&n));
153 if (inner->nr == -1) {
154 inner->value_kind = lpp_none;
156 inner->nr = lpp->cst_next;
157 inner->type.cst_type = cst_type;
159 if (lpp->cst_next == lpp->cst_size) {
160 lpp->cst_size = (int)((double)lpp->cst_size * lpp->grow_factor) + 1;
161 lpp->csts = XREALLOC(lpp->csts, lpp_name_t *, lpp->cst_size);
164 lpp->csts[lpp->cst_next] = inner;
166 matrix_set(lpp->m, inner->nr, 0, rhs);
173 int lpp_add_cst_uniq(lpp_t *lpp, const char *cst_name, lpp_cst_t cst_type, double rhs) {
179 assert(!set_find(lpp->cst2nr, &n, sizeof(n), HASH_NAME_T(&n)) &&
180 "constraint already exists");
182 return lpp_add_cst(lpp, cst_name, cst_type, rhs);
185 int lpp_get_cst_idx(lpp_t *lpp, const char *cst_name) {
186 DBG((dbg, LEVEL_2, "%s --> %d\n", cst_name, cst_nr(lpp, cst_name)));
187 return cst_nr(lpp, cst_name);
190 void lpp_get_cst_name(lpp_t *lpp, int index, char *buf, size_t buf_size) {
191 DBG((dbg, LEVEL_2, "%d --> %s\n", index, lpp->csts[index]->name));
192 strncpy(buf, lpp->csts[index]->name, buf_size);
195 int lpp_add_var_default(lpp_t *lpp, const char *var_name, lpp_var_t var_type, double obj, double startval) {
198 val = lpp_add_var(lpp, var_name, var_type, obj);
199 lpp_set_start_value(lpp, val, startval);
204 int lpp_add_var(lpp_t *lpp, const char *var_name, lpp_var_t var_type, double obj) {
205 lpp_name_t n, *inner;
207 DBG((dbg, LEVEL_2, "%s %d %g\n", var_name, var_type, obj));
209 assert(var_type != lpp_invalid && "invalid is for internal use only");
211 if (var_name && var_name[0] == '_')
212 return ERR_NAME_NOT_ALLOWED;
215 n.name = obst_xstrdup(&lpp->obst, var_name);
217 n.name = get_next_name(lpp);
220 inner = set_insert(lpp->var2nr, &n, sizeof(n), HASH_NAME_T(&n));
223 if (inner->nr == -1) {
224 inner->nr = lpp->var_next;
225 inner->value_kind = 0;
227 inner->type.var_type = var_type;
229 if (lpp->var_next == lpp->var_size) {
230 lpp->var_size = (int)((double)lpp->var_size * lpp->grow_factor) + 1;
231 lpp->vars = XREALLOC(lpp->vars, lpp_name_t *, lpp->var_size);
234 lpp->vars[lpp->var_next] = inner;
236 matrix_set(lpp->m, 0, inner->nr, obj);
243 int lpp_get_var_idx(lpp_t *lpp, const char *var_name) {
244 DBG((dbg, LEVEL_2, "%s --> %d\n", var_name, var_nr(lpp, var_name)));
245 return var_nr(lpp, var_name);
248 void lpp_get_var_name(lpp_t *lpp, int index, char *buf, size_t buf_size) {
249 DBG((dbg, LEVEL_2, "%d --> %s\n", index, lpp->vars[index]->name));
250 strncpy(buf, lpp->vars[index]->name, buf_size);
253 int lpp_set_factor(lpp_t *lpp, const char *cst_name, const char *var_name, double value) {
256 cst = cst_nr(lpp, cst_name);
257 var = var_nr(lpp, var_name);
258 assert(cst != -1 && var != -1);
259 DBG((dbg, LEVEL_2, "%s[%d] %s[%d] %g\n", cst_name, cst, var_name, var, value));
260 matrix_set(lpp->m, cst, var, value);
265 int lpp_set_factor_fast(lpp_t *lpp, int cst_idx, int var_idx, double value) {
266 assert(cst_idx >= 0 && var_idx >= 0);
267 assert(cst_idx < lpp->cst_next && var_idx < lpp->var_next);
268 DBG((dbg, LEVEL_2, "%s[%d] %s[%d] %g\n", lpp->csts[cst_idx]->name, cst_idx, lpp->vars[var_idx]->name, var_idx, value));
269 matrix_set(lpp->m, cst_idx, var_idx, value);
274 int lpp_set_factor_fast_bulk(lpp_t *lpp, int cst_idx, int *var_idx, int num_vars, double value) {
275 assert(cst_idx >= 0 && cst_idx < lpp->cst_next);
276 assert(num_vars < lpp->var_next);
277 DBG((dbg, LEVEL_2, "row %s[%d] %d vars %g\n", lpp->csts[cst_idx]->name, cst_idx, num_vars, value));
278 matrix_set_row_bulk(lpp->m, cst_idx, var_idx, num_vars, value);
283 void lpp_set_start_value(lpp_t *lpp, int var_idx, double value) {
284 assert(var_idx > 0 && var_idx < lpp->var_next);
285 DBG((dbg, LEVEL_2, "%d %s %g\n", var_idx, lpp->vars[var_idx]->name, value));
286 lpp->vars[var_idx]->value = value;
287 lpp->vars[var_idx]->value_kind = lpp_value_start;
290 lpp_sol_state_t lpp_get_solution(lpp_t *lpp, double *values, int begin, int end) {
293 if (lpp->sol_state < lpp_feasible)
294 return lpp->sol_state;
296 /* here we are feasible or optimal */
297 for (i = 0; i < end - begin + 1; ++i)
298 values[i] = lpp->vars[begin + i]->value;
300 return lpp->sol_state;
303 void lpp_check_startvals(lpp_t *lpp) {
306 for (cst_idx = 1; cst_idx < lpp->cst_next; ++cst_idx) {
308 lpp_name_t *cst = lpp->csts[cst_idx];
309 double cst_val = matrix_get(lpp->m, cst_idx, 0);
312 for (var_idx = 1; var_idx < lpp->var_next; ++var_idx) {
313 if (lpp->vars[var_idx]->value_kind != lpp_value_start)
316 sum += lpp->vars[var_idx]->value *
317 matrix_get(lpp->m, cst_idx, var_idx);
319 switch(cst->type.cst_type) {
322 fprintf(stderr, "constraint %s unsatisfied: %g != %g\n", cst->name, sum, cst_val);
327 fprintf(stderr, "constraint %s unsatisfied: %g > %g\n", cst->name, sum, cst_val);
332 fprintf(stderr, "constraint %s unsatisfied: %g < %g\n", cst->name, sum, cst_val);
336 assert(0 && "unknown constraint type");
342 void lpp_dump(lpp_t *lpp, const char *filename) {
343 FILE *out = fopen(filename, "wt");
344 mps_write_mps(lpp, s_mps_fixed, out);
348 void lpp_set_log(lpp_t *lpp, FILE *log)
354 static const char *lpp_cst_op_to_str(lpp_cst_t cst)
368 void lpp_dump_plain(lpp_t *lpp, FILE *f)
372 for(i = 0; i < lpp->cst_next; ++i) {
373 const matrix_elem_t *elm;
374 lpp_name_t *cst = lpp->csts[i];
376 fprintf(f, "%16s: ", cst->name);
377 matrix_foreach_in_row(lpp->m, cst->nr, elm) {
378 lpp_name_t *var = lpp->vars[elm->col];
379 /* TODO Perhaps better a define LPP_COL_RHS */
381 fprintf(f, "%+4.1f*%-16s ", elm->val, var->name);
384 fprintf(f, "%3s %+4.1f\n",
385 lpp_cst_op_to_str(cst->type.cst_type), matrix_get(lpp->m, cst->nr, 0));
390 * Serialize a lpp to a file descriptor.
391 * @param comm The file descriptor.
392 * @param lpp The lpp.
394 void lpp_serialize(lpp_comm_t *comm, const lpp_t *lpp, int with_names)
398 lpp_writel(comm, with_names);
399 lpp_writel(comm, lpp->cst_next);
400 lpp_writel(comm, lpp->var_next);
401 lpp_writel(comm, lpp->opt_type);
402 lpp_writes(comm, lpp->name);
405 lpp_writel(comm, lpp->set_bound);
406 lpp_writed(comm, lpp->bound);
407 lpp_writed(comm, lpp->time_limit_secs);
408 lpp_writed(comm, lpp->emphasis);
410 for(i = 0; i < lpp->cst_next; ++i) {
411 lpp_name_t *name = lpp->csts[i];
412 lpp_writel(comm, name->nr);
413 lpp_writel(comm, name->value_kind);
414 lpp_writel(comm, name->type.cst_type);
417 lpp_writes(comm, name->name);
420 for(i = 0; i < lpp->var_next; ++i) {
421 lpp_name_t *name = lpp->vars[i];
422 lpp_writel(comm, name->nr);
423 lpp_writel(comm, name->value_kind);
424 lpp_writel(comm, name->type.var_type);
427 lpp_writes(comm, name->name);
431 const matrix_elem_t *elm;
434 matrix_foreach(lpp->m, elm)
437 assert(n == matrix_get_entries(lpp->m));
439 matrix_foreach(lpp->m, elm) {
440 lpp_writel(comm, elm->row);
441 lpp_writel(comm, elm->col);
442 lpp_writed(comm, elm->val);
450 * Deserialize an lpp from a file descriptor.
451 * @param comm The file descriptor.
452 * @return The Problem.
454 lpp_t *lpp_deserialize(lpp_comm_t *comm)
459 lpp_t *lpp = XMALLOCZ(lpp_t);
461 /* read general settings */
462 with_names = lpp_readl(comm);
463 lpp->cst_next = lpp_readl(comm);
464 lpp->var_next = lpp_readl(comm);
465 lpp->opt_type = lpp_readl(comm);
466 lpp->name = lpp_reads(comm);
469 lpp->set_bound = lpp_readl(comm);
470 lpp->bound = lpp_readd(comm);
471 lpp->time_limit_secs = lpp_readd(comm);
472 lpp->emphasis = lpp_readd(comm);
474 lpp->cst_size = lpp->cst_next;
475 lpp->var_size = lpp->var_next;
477 lpp->cst2nr = new_set(cmp_name_t, lpp->cst_next);
478 lpp->var2nr = new_set(cmp_name_t, lpp->var_next);
480 lpp->csts = XMALLOCNZ(lpp_name_t*, lpp->cst_next);
481 lpp->vars = XMALLOCNZ(lpp_name_t*, lpp->var_next);
482 lpp->m = new_matrix(lpp->cst_next, lpp->var_next);
484 for(i = 0; i < lpp->cst_next; ++i) {
485 lpp_name_t name, *res;
487 name.nr = lpp_readl(comm);
488 name.value_kind = lpp_readl(comm);
489 name.type.cst_type = lpp_readl(comm);
492 name.name = lpp_reads(comm);
494 char* buf = XMALLOCN(char, NAMELEN);
495 snprintf(buf, NAMELEN, "c%d\n", name.nr);
499 res = set_insert(lpp->cst2nr, &name, sizeof(name), HASH_NAME_T(&name));
500 lpp->csts[name.nr] = res;
503 for(i = 0; i < lpp->var_next; ++i) {
504 lpp_name_t name, *res;
506 name.nr = lpp_readl(comm);
507 name.value_kind = lpp_readl(comm);
508 name.type.var_type = lpp_readl(comm);
511 name.name = lpp_reads(comm);
513 char* buf = XMALLOCN(char, NAMELEN);
514 snprintf(buf, NAMELEN, "v%d\n", name.nr);
518 res = set_insert(lpp->var2nr, &name, sizeof(name), HASH_NAME_T(&name));
519 lpp->vars[name.nr] = res;
523 for(i = 0; i < n; ++i) {
525 elm.row = lpp_readl(comm);
526 elm.col = lpp_readl(comm);
527 elm.val = lpp_readd(comm);
528 matrix_set(lpp->m, elm.row, elm.col, elm.val);
534 void lpp_serialize_values(lpp_comm_t *comm, const lpp_t *lpp, lpp_value_kind_t value_kind)
538 for(i = 0, n = 0; i < lpp->var_next; ++i)
539 n += lpp->vars[i]->value_kind == value_kind;
541 /* Write the number of values to expect */
544 /* send the values */
545 for(i = 0, n = lpp->var_next; i < n; ++i) {
546 const lpp_name_t *name = lpp->vars[i];
547 if(name->value_kind == value_kind) {
548 lpp_writel(comm, name->nr);
549 lpp_writed(comm, name->value);
554 void lpp_deserialize_values(lpp_comm_t *comm, lpp_t *lpp, lpp_value_kind_t value_kind)
558 /* Get the number of values to read */
561 for(i = 0; i < n; ++i) {
562 int nr = lpp_readl(comm);
563 lpp_name_t *name = lpp->vars[nr];
565 name->value_kind = value_kind;
566 name->value = lpp_readd(comm);
570 void lpp_serialize_stats(lpp_comm_t *comm, const lpp_t *lpp)
572 lpp_writel(comm, lpp->sol_state);
573 lpp_writel(comm, lpp->iterations);
574 lpp_writed(comm, lpp->sol_time);
575 lpp_writed(comm, lpp->objval);
576 lpp_writed(comm, lpp->best_bound);
579 void lpp_deserialize_stats(lpp_comm_t *comm, lpp_t *lpp)
581 lpp->sol_state = lpp_readl(comm);
582 lpp->iterations = lpp_readl(comm);
583 lpp->sol_time = lpp_readd(comm);
584 lpp->objval = lpp_readd(comm);
585 lpp->best_bound = lpp_readd(comm);
588 void lpp_solve(lpp_t *lpp, const char* host, const char* solver)
590 if (host == NULL || strlen(host) == 0) {
591 lpp_solver_func_t* f = lpp_find_solver(solver);
597 lpp_solve_net(lpp, host, solver);