2 * Copyright (C) 2005-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @author Daniel Grund
36 #include "sp_matrix.h"
40 #include "lpp_solvers.h"
43 #define HASH_NAME_T(n) HASH_STR((n)->name, strlen((n)->name))
45 static firm_dbg_module_t *dbg = NULL;
47 static inline char *obst_xstrdup(struct obstack *obst, const char *str)
49 return obstack_copy0(obst, str, strlen(str));
52 static int cmp_name_t(const void *x, const void *y, size_t size)
54 const lpp_name_t *n = x;
55 const lpp_name_t *m = y;
57 return strcmp(n->name, m->name);
61 * Update statistic information about matrix usage.
63 static void update_stats(lpp_t *lpp)
65 lpp->n_elems = matrix_get_entries(lpp->m);
66 lpp->matrix_mem = lpp->n_elems * matrix_get_elem_size();
67 lpp->density = (double)lpp->n_elems / (double)(lpp->cst_next * lpp->var_next) * 100.0;
70 lpp_t *new_lpp(const char *name, lpp_opt_t opt_type)
72 return new_lpp_userdef(name, opt_type, 64, 64, 2.0);
75 lpp_t *new_lpp_userdef(const char *name, lpp_opt_t opt_type,
76 int estimated_vars, int estimated_csts, double grow_factor)
81 dbg = firm_dbg_register("lpp");
82 lpp = XMALLOCZ(lpp_t);
83 obstack_init(&lpp->obst);
85 lpp->name = obst_xstrdup(&lpp->obst, name);
86 lpp->opt_type = opt_type;
87 lpp->grow_factor = grow_factor;
88 lpp->cst2nr = new_set(cmp_name_t, estimated_csts);
89 lpp->var2nr = new_set(cmp_name_t, estimated_vars);
90 lpp->cst_size = estimated_csts;
91 lpp->var_size = estimated_vars;
92 lpp->csts = XMALLOCNZ(lpp_name_t *, estimated_csts);
93 lpp->vars = XMALLOCNZ(lpp_name_t *, estimated_vars);
94 lpp->m = new_matrix(estimated_csts, estimated_vars);
95 lpp->emphasis = lpp_balanced;
96 idx = lpp_add_cst(lpp, "obj", lpp_objective, 0);
98 idx = lpp_add_var(lpp, "rhs", lpp_rhs, 0);
104 void free_lpp_matrix(lpp_t *lpp)
110 void free_lpp(lpp_t *lpp)
112 obstack_free(&lpp->obst, NULL);
114 del_set(lpp->cst2nr);
115 del_set(lpp->var2nr);
117 /* matrix might have been already deleted */
127 double lpp_get_fix_costs(lpp_t *lpp)
129 return matrix_get(lpp->m, 0, 0);
132 void lpp_set_fix_costs(lpp_t *lpp, double value)
134 matrix_set(lpp->m, 0, 0, value);
137 static int name2nr(set *where, const char *name)
139 lpp_name_t find, *found;
141 found = set_find(where, &find, sizeof(find), HASH_NAME_T(&find));
142 return (found ? found->nr : -1);
145 static int cst_nr(const lpp_t *lpp, const char *name)
147 return name2nr(lpp->cst2nr, name);
150 static int var_nr(const lpp_t *lpp, const char *name)
152 return name2nr(lpp->var2nr, name);
155 static inline char *get_next_name(lpp_t *lpp)
157 char *res = obstack_alloc(&lpp->obst, 12);
158 snprintf(res, 12, "_%u", lpp->next_name_number++);
162 int lpp_add_cst(lpp_t *lpp, const char *cst_name, lpp_cst_t cst_type, double rhs)
164 lpp_name_t n, *inner;
166 DBG((dbg, LEVEL_2, "%s %d %g\n", cst_name, cst_type, rhs));
168 if (cst_name && cst_name[0] == '_')
169 return ERR_NAME_NOT_ALLOWED;
172 n.name = obst_xstrdup(&lpp->obst, cst_name);
174 n.name = get_next_name(lpp);
177 inner = set_insert(lpp->cst2nr, &n, sizeof(n), HASH_NAME_T(&n));
180 if (inner->nr == -1) {
181 inner->value_kind = lpp_none;
183 inner->nr = lpp->cst_next;
184 inner->type.cst_type = cst_type;
186 if (lpp->cst_next == lpp->cst_size) {
187 lpp->cst_size = (int)((double)lpp->cst_size * lpp->grow_factor) + 1;
188 lpp->csts = XREALLOC(lpp->csts, lpp_name_t *, lpp->cst_size);
191 lpp->csts[lpp->cst_next] = inner;
193 matrix_set(lpp->m, inner->nr, 0, rhs);
200 int lpp_add_cst_uniq(lpp_t *lpp, const char *cst_name, lpp_cst_t cst_type, double rhs)
207 assert(!set_find(lpp->cst2nr, &n, sizeof(n), HASH_NAME_T(&n)) &&
208 "constraint already exists");
210 return lpp_add_cst(lpp, cst_name, cst_type, rhs);
213 int lpp_get_cst_idx(lpp_t *lpp, const char *cst_name)
215 DBG((dbg, LEVEL_2, "%s --> %d\n", cst_name, cst_nr(lpp, cst_name)));
216 return cst_nr(lpp, cst_name);
219 void lpp_get_cst_name(lpp_t *lpp, int index, char *buf, size_t buf_size)
221 DBG((dbg, LEVEL_2, "%d --> %s\n", index, lpp->csts[index]->name));
222 strncpy(buf, lpp->csts[index]->name, buf_size);
225 int lpp_add_var_default(lpp_t *lpp, const char *var_name, lpp_var_t var_type, double obj, double startval)
229 val = lpp_add_var(lpp, var_name, var_type, obj);
230 lpp_set_start_value(lpp, val, startval);
235 int lpp_add_var(lpp_t *lpp, const char *var_name, lpp_var_t var_type, double obj)
237 lpp_name_t n, *inner;
239 DBG((dbg, LEVEL_2, "%s %d %g\n", var_name, var_type, obj));
241 assert(var_type != lpp_invalid && "invalid is for internal use only");
243 if (var_name && var_name[0] == '_')
244 return ERR_NAME_NOT_ALLOWED;
247 n.name = obst_xstrdup(&lpp->obst, var_name);
249 n.name = get_next_name(lpp);
252 inner = set_insert(lpp->var2nr, &n, sizeof(n), HASH_NAME_T(&n));
255 if (inner->nr == -1) {
256 inner->nr = lpp->var_next;
257 inner->value_kind = 0;
259 inner->type.var_type = var_type;
261 if (lpp->var_next == lpp->var_size) {
262 lpp->var_size = (int)((double)lpp->var_size * lpp->grow_factor) + 1;
263 lpp->vars = XREALLOC(lpp->vars, lpp_name_t *, lpp->var_size);
266 lpp->vars[lpp->var_next] = inner;
268 matrix_set(lpp->m, 0, inner->nr, obj);
275 int lpp_get_var_idx(lpp_t *lpp, const char *var_name)
277 DBG((dbg, LEVEL_2, "%s --> %d\n", var_name, var_nr(lpp, var_name)));
278 return var_nr(lpp, var_name);
281 void lpp_get_var_name(lpp_t *lpp, int index, char *buf, size_t buf_size)
283 DBG((dbg, LEVEL_2, "%d --> %s\n", index, lpp->vars[index]->name));
284 strncpy(buf, lpp->vars[index]->name, buf_size);
287 int lpp_set_factor(lpp_t *lpp, const char *cst_name, const char *var_name, double value)
291 cst = cst_nr(lpp, cst_name);
292 var = var_nr(lpp, var_name);
293 assert(cst != -1 && var != -1);
294 DBG((dbg, LEVEL_2, "%s[%d] %s[%d] %g\n", cst_name, cst, var_name, var, value));
295 matrix_set(lpp->m, cst, var, value);
300 int lpp_set_factor_fast(lpp_t *lpp, int cst_idx, int var_idx, double value)
302 assert(cst_idx >= 0 && var_idx >= 0);
303 assert(cst_idx < lpp->cst_next && var_idx < lpp->var_next);
304 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));
305 matrix_set(lpp->m, cst_idx, var_idx, value);
310 int lpp_set_factor_fast_bulk(lpp_t *lpp, int cst_idx, int *var_idx, int num_vars, double value)
312 assert(cst_idx >= 0 && cst_idx < lpp->cst_next);
313 assert(num_vars < lpp->var_next);
314 DBG((dbg, LEVEL_2, "row %s[%d] %d vars %g\n", lpp->csts[cst_idx]->name, cst_idx, num_vars, value));
315 matrix_set_row_bulk(lpp->m, cst_idx, var_idx, num_vars, value);
320 void lpp_set_start_value(lpp_t *lpp, int var_idx, double value)
322 assert(var_idx > 0 && var_idx < lpp->var_next);
323 DBG((dbg, LEVEL_2, "%d %s %g\n", var_idx, lpp->vars[var_idx]->name, value));
324 lpp->vars[var_idx]->value = value;
325 lpp->vars[var_idx]->value_kind = lpp_value_start;
328 lpp_sol_state_t lpp_get_solution(lpp_t *lpp, double *values, int begin, int end)
332 if (lpp->sol_state < lpp_feasible)
333 return lpp->sol_state;
335 /* here we are feasible or optimal */
336 for (i = 0; i < end - begin + 1; ++i)
337 values[i] = lpp->vars[begin + i]->value;
339 return lpp->sol_state;
342 void lpp_check_startvals(lpp_t *lpp)
346 for (cst_idx = 1; cst_idx < lpp->cst_next; ++cst_idx) {
348 lpp_name_t *cst = lpp->csts[cst_idx];
349 double cst_val = matrix_get(lpp->m, cst_idx, 0);
352 for (var_idx = 1; var_idx < lpp->var_next; ++var_idx) {
353 if (lpp->vars[var_idx]->value_kind != lpp_value_start)
356 sum += lpp->vars[var_idx]->value *
357 matrix_get(lpp->m, cst_idx, var_idx);
359 switch(cst->type.cst_type) {
362 fprintf(stderr, "constraint %s unsatisfied: %g != %g\n", cst->name, sum, cst_val);
367 fprintf(stderr, "constraint %s unsatisfied: %g > %g\n", cst->name, sum, cst_val);
372 fprintf(stderr, "constraint %s unsatisfied: %g < %g\n", cst->name, sum, cst_val);
376 assert(0 && "unknown constraint type");
382 void lpp_dump(lpp_t *lpp, const char *filename)
384 FILE *out = fopen(filename, "wt");
385 mps_write_mps(lpp, s_mps_fixed, out);
389 void lpp_set_log(lpp_t *lpp, FILE *log)
395 static const char *lpp_cst_op_to_str(lpp_cst_t cst)
409 void lpp_dump_plain(lpp_t *lpp, FILE *f)
413 for(i = 0; i < lpp->cst_next; ++i) {
414 const matrix_elem_t *elm;
415 lpp_name_t *cst = lpp->csts[i];
417 fprintf(f, "%16s: ", cst->name);
418 matrix_foreach_in_row(lpp->m, cst->nr, elm) {
419 lpp_name_t *var = lpp->vars[elm->col];
420 /* TODO Perhaps better a define LPP_COL_RHS */
422 fprintf(f, "%+4.1f*%-16s ", elm->val, var->name);
425 fprintf(f, "%3s %+4.1f\n",
426 lpp_cst_op_to_str(cst->type.cst_type), matrix_get(lpp->m, cst->nr, 0));
431 * Serialize a lpp to a file descriptor.
432 * @param comm The file descriptor.
433 * @param lpp The lpp.
435 void lpp_serialize(lpp_comm_t *comm, const lpp_t *lpp, int with_names)
439 lpp_writel(comm, with_names);
440 lpp_writel(comm, lpp->cst_next);
441 lpp_writel(comm, lpp->var_next);
442 lpp_writel(comm, lpp->opt_type);
443 lpp_writes(comm, lpp->name);
446 lpp_writel(comm, lpp->set_bound);
447 lpp_writed(comm, lpp->bound);
448 lpp_writed(comm, lpp->time_limit_secs);
449 lpp_writed(comm, lpp->emphasis);
451 for(i = 0; i < lpp->cst_next; ++i) {
452 lpp_name_t *name = lpp->csts[i];
453 lpp_writel(comm, name->nr);
454 lpp_writel(comm, name->value_kind);
455 lpp_writel(comm, name->type.cst_type);
458 lpp_writes(comm, name->name);
461 for(i = 0; i < lpp->var_next; ++i) {
462 lpp_name_t *name = lpp->vars[i];
463 lpp_writel(comm, name->nr);
464 lpp_writel(comm, name->value_kind);
465 lpp_writel(comm, name->type.var_type);
468 lpp_writes(comm, name->name);
472 const matrix_elem_t *elm;
475 matrix_foreach(lpp->m, elm)
478 assert(n == matrix_get_entries(lpp->m));
480 matrix_foreach(lpp->m, elm) {
481 lpp_writel(comm, elm->row);
482 lpp_writel(comm, elm->col);
483 lpp_writed(comm, elm->val);
489 * Deserialize an lpp from a file descriptor.
490 * @param comm The file descriptor.
491 * @return The Problem.
493 lpp_t *lpp_deserialize(lpp_comm_t *comm)
498 lpp_t *lpp = XMALLOCZ(lpp_t);
500 /* read general settings */
501 with_names = lpp_readl(comm);
502 lpp->cst_next = lpp_readl(comm);
503 lpp->var_next = lpp_readl(comm);
504 lpp->opt_type = lpp_readl(comm);
505 lpp->name = lpp_reads(comm);
508 lpp->set_bound = lpp_readl(comm);
509 lpp->bound = lpp_readd(comm);
510 lpp->time_limit_secs = lpp_readd(comm);
511 lpp->emphasis = lpp_readd(comm);
513 lpp->cst_size = lpp->cst_next;
514 lpp->var_size = lpp->var_next;
516 lpp->cst2nr = new_set(cmp_name_t, lpp->cst_next);
517 lpp->var2nr = new_set(cmp_name_t, lpp->var_next);
519 lpp->csts = XMALLOCNZ(lpp_name_t*, lpp->cst_next);
520 lpp->vars = XMALLOCNZ(lpp_name_t*, lpp->var_next);
521 lpp->m = new_matrix(lpp->cst_next, lpp->var_next);
523 for(i = 0; i < lpp->cst_next; ++i) {
524 lpp_name_t name, *res;
526 name.nr = lpp_readl(comm);
527 name.value_kind = lpp_readl(comm);
528 name.type.cst_type = lpp_readl(comm);
531 name.name = lpp_reads(comm);
533 char* buf = XMALLOCN(char, 32);
534 snprintf(buf, 32, "c%d\n", name.nr);
538 res = set_insert(lpp->cst2nr, &name, sizeof(name), HASH_NAME_T(&name));
539 lpp->csts[name.nr] = res;
542 for(i = 0; i < lpp->var_next; ++i) {
543 lpp_name_t name, *res;
545 name.nr = lpp_readl(comm);
546 name.value_kind = lpp_readl(comm);
547 name.type.var_type = lpp_readl(comm);
550 name.name = lpp_reads(comm);
552 char* buf = XMALLOCN(char, 32);
553 snprintf(buf, 32, "v%d\n", name.nr);
557 res = set_insert(lpp->var2nr, &name, sizeof(name), HASH_NAME_T(&name));
558 lpp->vars[name.nr] = res;
562 for(i = 0; i < n; ++i) {
564 elm.row = lpp_readl(comm);
565 elm.col = lpp_readl(comm);
566 elm.val = lpp_readd(comm);
567 matrix_set(lpp->m, elm.row, elm.col, elm.val);
573 void lpp_serialize_values(lpp_comm_t *comm, const lpp_t *lpp, lpp_value_kind_t value_kind)
577 for(i = 0, n = 0; i < lpp->var_next; ++i)
578 n += lpp->vars[i]->value_kind == value_kind;
580 /* Write the number of values to expect */
583 /* send the values */
584 for(i = 0, n = lpp->var_next; i < n; ++i) {
585 const lpp_name_t *name = lpp->vars[i];
586 if(name->value_kind == value_kind) {
587 lpp_writel(comm, name->nr);
588 lpp_writed(comm, name->value);
593 void lpp_deserialize_values(lpp_comm_t *comm, lpp_t *lpp, lpp_value_kind_t value_kind)
597 /* Get the number of values to read */
600 for(i = 0; i < n; ++i) {
601 int nr = lpp_readl(comm);
602 lpp_name_t *name = lpp->vars[nr];
604 name->value_kind = value_kind;
605 name->value = lpp_readd(comm);
609 void lpp_serialize_stats(lpp_comm_t *comm, const lpp_t *lpp)
611 lpp_writel(comm, lpp->sol_state);
612 lpp_writel(comm, lpp->iterations);
613 lpp_writed(comm, lpp->sol_time);
614 lpp_writed(comm, lpp->objval);
615 lpp_writed(comm, lpp->best_bound);
618 void lpp_deserialize_stats(lpp_comm_t *comm, lpp_t *lpp)
620 lpp->sol_state = lpp_readl(comm);
621 lpp->iterations = lpp_readl(comm);
622 lpp->sol_time = lpp_readd(comm);
623 lpp->objval = lpp_readd(comm);
624 lpp->best_bound = lpp_readd(comm);
627 void lpp_solve(lpp_t *lpp, const char* host, const char* solver)
629 if (host == NULL || strlen(host) == 0) {
630 lpp_solver_func_t* f = lpp_find_solver(solver);
634 lpp_solve_net(lpp, host, solver);