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 *lpp_new(const char *name, lpp_opt_t opt_type)
72 return lpp_new_userdef(name, opt_type, 64, 64, 2.0);
75 lpp_t *lpp_new_userdef(const char *name, lpp_opt_t opt_type,
76 int estimated_vars, int estimated_csts,
82 dbg = firm_dbg_register("lpp");
83 lpp = XMALLOCZ(lpp_t);
84 obstack_init(&lpp->obst);
86 lpp->name = obst_xstrdup(&lpp->obst, name);
87 lpp->opt_type = opt_type;
88 lpp->grow_factor = grow_factor;
89 lpp->cst2nr = new_set(cmp_name_t, estimated_csts);
90 lpp->var2nr = new_set(cmp_name_t, estimated_vars);
91 lpp->cst_size = estimated_csts;
92 lpp->var_size = estimated_vars;
93 lpp->csts = XMALLOCNZ(lpp_name_t *, estimated_csts);
94 lpp->vars = XMALLOCNZ(lpp_name_t *, estimated_vars);
95 lpp->m = new_matrix(estimated_csts, estimated_vars);
96 lpp->emphasis = lpp_balanced;
97 idx = lpp_add_cst(lpp, "obj", lpp_objective, 0);
99 idx = lpp_add_var(lpp, "rhs", lpp_rhs, 0);
105 void lpp_free_matrix(lpp_t *lpp)
111 void lpp_free(lpp_t *lpp)
113 obstack_free(&lpp->obst, NULL);
115 del_set(lpp->cst2nr);
116 del_set(lpp->var2nr);
118 /* matrix might have been already deleted */
128 double lpp_get_fix_costs(lpp_t *lpp)
130 return matrix_get(lpp->m, 0, 0);
133 void lpp_set_fix_costs(lpp_t *lpp, double value)
135 matrix_set(lpp->m, 0, 0, value);
138 static int name2nr(set *where, const char *name)
140 lpp_name_t find, *found;
142 found = set_find(where, &find, sizeof(find), HASH_NAME_T(&find));
143 return (found ? found->nr : -1);
146 static int cst_nr(const lpp_t *lpp, const char *name)
148 return name2nr(lpp->cst2nr, name);
151 static int var_nr(const lpp_t *lpp, const char *name)
153 return name2nr(lpp->var2nr, name);
156 static inline char *get_next_name(lpp_t *lpp)
158 char *res = obstack_alloc(&lpp->obst, 12);
159 snprintf(res, 12, "_%u", lpp->next_name_number++);
163 int lpp_add_cst(lpp_t *lpp, const char *cst_name, lpp_cst_t cst_type, double rhs)
165 lpp_name_t n, *inner;
167 DBG((dbg, LEVEL_2, "%s %d %g\n", cst_name, cst_type, rhs));
169 if (cst_name && cst_name[0] == '_')
170 return ERR_NAME_NOT_ALLOWED;
173 n.name = obst_xstrdup(&lpp->obst, cst_name);
175 n.name = get_next_name(lpp);
178 inner = set_insert(lpp->cst2nr, &n, sizeof(n), HASH_NAME_T(&n));
181 if (inner->nr == -1) {
182 inner->value_kind = lpp_none;
184 inner->nr = lpp->cst_next;
185 inner->type.cst_type = cst_type;
187 if (lpp->cst_next == lpp->cst_size) {
188 lpp->cst_size = (int)((double)lpp->cst_size * lpp->grow_factor) + 1;
189 lpp->csts = XREALLOC(lpp->csts, lpp_name_t *, lpp->cst_size);
192 lpp->csts[lpp->cst_next] = inner;
194 matrix_set(lpp->m, inner->nr, 0, rhs);
201 int lpp_add_cst_uniq(lpp_t *lpp, const char *cst_name, lpp_cst_t cst_type, double rhs)
208 assert(!set_find(lpp->cst2nr, &n, sizeof(n), HASH_NAME_T(&n)) &&
209 "constraint already exists");
211 return lpp_add_cst(lpp, cst_name, cst_type, rhs);
214 int lpp_get_cst_idx(lpp_t *lpp, const char *cst_name)
216 DBG((dbg, LEVEL_2, "%s --> %d\n", cst_name, cst_nr(lpp, cst_name)));
217 return cst_nr(lpp, cst_name);
220 void lpp_get_cst_name(lpp_t *lpp, int index, char *buf, size_t buf_size)
222 DBG((dbg, LEVEL_2, "%d --> %s\n", index, lpp->csts[index]->name));
223 strncpy(buf, lpp->csts[index]->name, buf_size);
226 int lpp_add_var_default(lpp_t *lpp, const char *var_name, lpp_var_t var_type, double obj, double startval)
230 val = lpp_add_var(lpp, var_name, var_type, obj);
231 lpp_set_start_value(lpp, val, startval);
236 int lpp_add_var(lpp_t *lpp, const char *var_name, lpp_var_t var_type, double obj)
238 lpp_name_t n, *inner;
240 DBG((dbg, LEVEL_2, "%s %d %g\n", var_name, var_type, obj));
242 assert(var_type != lpp_invalid && "invalid is for internal use only");
244 if (var_name && var_name[0] == '_')
245 return ERR_NAME_NOT_ALLOWED;
248 n.name = obst_xstrdup(&lpp->obst, var_name);
250 n.name = get_next_name(lpp);
253 inner = set_insert(lpp->var2nr, &n, sizeof(n), HASH_NAME_T(&n));
256 if (inner->nr == -1) {
257 inner->nr = lpp->var_next;
258 inner->value_kind = 0;
260 inner->type.var_type = var_type;
262 if (lpp->var_next == lpp->var_size) {
263 lpp->var_size = (int)((double)lpp->var_size * lpp->grow_factor) + 1;
264 lpp->vars = XREALLOC(lpp->vars, lpp_name_t *, lpp->var_size);
267 lpp->vars[lpp->var_next] = inner;
269 matrix_set(lpp->m, 0, inner->nr, obj);
276 int lpp_get_var_idx(lpp_t *lpp, const char *var_name)
278 DBG((dbg, LEVEL_2, "%s --> %d\n", var_name, var_nr(lpp, var_name)));
279 return var_nr(lpp, var_name);
282 void lpp_get_var_name(lpp_t *lpp, int index, char *buf, size_t buf_size)
284 DBG((dbg, LEVEL_2, "%d --> %s\n", index, lpp->vars[index]->name));
285 strncpy(buf, lpp->vars[index]->name, buf_size);
288 int lpp_set_factor(lpp_t *lpp, const char *cst_name, const char *var_name, double value)
292 cst = cst_nr(lpp, cst_name);
293 var = var_nr(lpp, var_name);
294 assert(cst != -1 && var != -1);
295 DBG((dbg, LEVEL_2, "%s[%d] %s[%d] %g\n", cst_name, cst, var_name, var, value));
296 matrix_set(lpp->m, cst, var, value);
301 int lpp_set_factor_fast(lpp_t *lpp, int cst_idx, int var_idx, double value)
303 assert(cst_idx >= 0 && var_idx >= 0);
304 assert(cst_idx < lpp->cst_next && var_idx < lpp->var_next);
305 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));
306 matrix_set(lpp->m, cst_idx, var_idx, value);
311 int lpp_set_factor_fast_bulk(lpp_t *lpp, int cst_idx, int *var_idx, int num_vars, double value)
313 assert(cst_idx >= 0 && cst_idx < lpp->cst_next);
314 assert(num_vars < lpp->var_next);
315 DBG((dbg, LEVEL_2, "row %s[%d] %d vars %g\n", lpp->csts[cst_idx]->name, cst_idx, num_vars, value));
316 matrix_set_row_bulk(lpp->m, cst_idx, var_idx, num_vars, value);
321 void lpp_set_start_value(lpp_t *lpp, int var_idx, double value)
323 assert(var_idx > 0 && var_idx < lpp->var_next);
324 DBG((dbg, LEVEL_2, "%d %s %g\n", var_idx, lpp->vars[var_idx]->name, value));
325 lpp->vars[var_idx]->value = value;
326 lpp->vars[var_idx]->value_kind = lpp_value_start;
329 lpp_sol_state_t lpp_get_solution(lpp_t *lpp, double *values, int begin, int end)
333 if (lpp->sol_state < lpp_feasible)
334 return lpp->sol_state;
336 /* here we are feasible or optimal */
337 for (i = 0; i < end - begin + 1; ++i)
338 values[i] = lpp->vars[begin + i]->value;
340 return lpp->sol_state;
343 void lpp_check_startvals(lpp_t *lpp)
347 for (cst_idx = 1; cst_idx < lpp->cst_next; ++cst_idx) {
349 lpp_name_t *cst = lpp->csts[cst_idx];
350 double cst_val = matrix_get(lpp->m, cst_idx, 0);
353 for (var_idx = 1; var_idx < lpp->var_next; ++var_idx) {
354 if (lpp->vars[var_idx]->value_kind != lpp_value_start)
357 sum += lpp->vars[var_idx]->value *
358 matrix_get(lpp->m, cst_idx, var_idx);
360 switch(cst->type.cst_type) {
363 fprintf(stderr, "constraint %s unsatisfied: %g != %g\n", cst->name, sum, cst_val);
368 fprintf(stderr, "constraint %s unsatisfied: %g >= %g\n", cst->name, sum, cst_val);
371 case lpp_greater_equal:
373 fprintf(stderr, "constraint %s unsatisfied: %g <= %g\n", cst->name, sum, cst_val);
377 assert(0 && "unknown constraint type");
383 void lpp_dump(lpp_t *lpp, const char *filename)
385 FILE *out = fopen(filename, "wt");
386 mps_write_mps(lpp, s_mps_fixed, out);
390 void lpp_set_log(lpp_t *lpp, FILE *log)
396 static const char *lpp_cst_op_to_str(lpp_cst_t cst)
403 case lpp_greater_equal:
410 void lpp_dump_plain(lpp_t *lpp, FILE *f)
414 for(i = 0; i < lpp->cst_next; ++i) {
415 const matrix_elem_t *elm;
416 lpp_name_t *cst = lpp->csts[i];
418 fprintf(f, "%16s: ", cst->name);
419 matrix_foreach_in_row(lpp->m, cst->nr, elm) {
420 lpp_name_t *var = lpp->vars[elm->col];
421 /* TODO Perhaps better a define LPP_COL_RHS */
423 fprintf(f, "%+4.1f*%-16s ", elm->val, var->name);
426 fprintf(f, "%3s %+4.1f\n",
427 lpp_cst_op_to_str(cst->type.cst_type), matrix_get(lpp->m, cst->nr, 0));
432 * Serialize a lpp to a file descriptor.
433 * @param comm The file descriptor.
434 * @param lpp The lpp.
436 void lpp_serialize(lpp_comm_t *comm, const lpp_t *lpp, int with_names)
440 lpp_writel(comm, with_names);
441 lpp_writel(comm, lpp->cst_next);
442 lpp_writel(comm, lpp->var_next);
443 lpp_writel(comm, lpp->opt_type);
444 lpp_writes(comm, lpp->name);
447 lpp_writel(comm, lpp->set_bound);
448 lpp_writed(comm, lpp->bound);
449 lpp_writed(comm, lpp->time_limit_secs);
450 lpp_writed(comm, lpp->emphasis);
452 for(i = 0; i < lpp->cst_next; ++i) {
453 lpp_name_t *name = lpp->csts[i];
454 lpp_writel(comm, name->nr);
455 lpp_writel(comm, name->value_kind);
456 lpp_writel(comm, name->type.cst_type);
459 lpp_writes(comm, name->name);
462 for(i = 0; i < lpp->var_next; ++i) {
463 lpp_name_t *name = lpp->vars[i];
464 lpp_writel(comm, name->nr);
465 lpp_writel(comm, name->value_kind);
466 lpp_writel(comm, name->type.var_type);
469 lpp_writes(comm, name->name);
473 const matrix_elem_t *elm;
476 matrix_foreach(lpp->m, elm)
479 assert(n == matrix_get_entries(lpp->m));
481 matrix_foreach(lpp->m, elm) {
482 lpp_writel(comm, elm->row);
483 lpp_writel(comm, elm->col);
484 lpp_writed(comm, elm->val);
490 * Deserialize an lpp from a file descriptor.
491 * @param comm The file descriptor.
492 * @return The Problem.
494 lpp_t *lpp_deserialize(lpp_comm_t *comm)
499 lpp_t *lpp = XMALLOCZ(lpp_t);
501 /* read general settings */
502 with_names = lpp_readl(comm);
503 lpp->cst_next = lpp_readl(comm);
504 lpp->var_next = lpp_readl(comm);
505 lpp->opt_type = lpp_readl(comm);
506 lpp->name = lpp_reads(comm);
509 lpp->set_bound = lpp_readl(comm);
510 lpp->bound = lpp_readd(comm);
511 lpp->time_limit_secs = lpp_readd(comm);
512 lpp->emphasis = lpp_readd(comm);
514 lpp->cst_size = lpp->cst_next;
515 lpp->var_size = lpp->var_next;
517 lpp->cst2nr = new_set(cmp_name_t, lpp->cst_next);
518 lpp->var2nr = new_set(cmp_name_t, lpp->var_next);
520 lpp->csts = XMALLOCNZ(lpp_name_t*, lpp->cst_next);
521 lpp->vars = XMALLOCNZ(lpp_name_t*, lpp->var_next);
522 lpp->m = new_matrix(lpp->cst_next, lpp->var_next);
524 for(i = 0; i < lpp->cst_next; ++i) {
525 lpp_name_t name, *res;
527 name.nr = lpp_readl(comm);
528 name.value_kind = lpp_readl(comm);
529 name.type.cst_type = lpp_readl(comm);
532 name.name = lpp_reads(comm);
534 char* buf = XMALLOCN(char, 32);
535 snprintf(buf, 32, "c%d\n", name.nr);
539 res = set_insert(lpp->cst2nr, &name, sizeof(name), HASH_NAME_T(&name));
540 lpp->csts[name.nr] = res;
543 for(i = 0; i < lpp->var_next; ++i) {
544 lpp_name_t name, *res;
546 name.nr = lpp_readl(comm);
547 name.value_kind = lpp_readl(comm);
548 name.type.var_type = lpp_readl(comm);
551 name.name = lpp_reads(comm);
553 char* buf = XMALLOCN(char, 32);
554 snprintf(buf, 32, "v%d\n", name.nr);
558 res = set_insert(lpp->var2nr, &name, sizeof(name), HASH_NAME_T(&name));
559 lpp->vars[name.nr] = res;
563 for(i = 0; i < n; ++i) {
565 elm.row = lpp_readl(comm);
566 elm.col = lpp_readl(comm);
567 elm.val = lpp_readd(comm);
568 matrix_set(lpp->m, elm.row, elm.col, elm.val);
574 void lpp_serialize_values(lpp_comm_t *comm, const lpp_t *lpp, lpp_value_kind_t value_kind)
578 for(i = 0, n = 0; i < lpp->var_next; ++i)
579 n += lpp->vars[i]->value_kind == value_kind;
581 /* Write the number of values to expect */
584 /* send the values */
585 for(i = 0, n = lpp->var_next; i < n; ++i) {
586 const lpp_name_t *name = lpp->vars[i];
587 if(name->value_kind == value_kind) {
588 lpp_writel(comm, name->nr);
589 lpp_writed(comm, name->value);
594 void lpp_deserialize_values(lpp_comm_t *comm, lpp_t *lpp, lpp_value_kind_t value_kind)
598 /* Get the number of values to read */
601 for(i = 0; i < n; ++i) {
602 int nr = lpp_readl(comm);
603 lpp_name_t *name = lpp->vars[nr];
605 name->value_kind = value_kind;
606 name->value = lpp_readd(comm);
610 void lpp_serialize_stats(lpp_comm_t *comm, const lpp_t *lpp)
612 lpp_writel(comm, lpp->sol_state);
613 lpp_writel(comm, lpp->iterations);
614 lpp_writed(comm, lpp->sol_time);
615 lpp_writed(comm, lpp->objval);
616 lpp_writed(comm, lpp->best_bound);
619 void lpp_deserialize_stats(lpp_comm_t *comm, lpp_t *lpp)
621 lpp->sol_state = lpp_readl(comm);
622 lpp->iterations = lpp_readl(comm);
623 lpp->sol_time = lpp_readd(comm);
624 lpp->objval = lpp_readd(comm);
625 lpp->best_bound = lpp_readd(comm);
628 void lpp_solve(lpp_t *lpp, const char* host, const char* solver)
630 if (host == NULL || strlen(host) == 0) {
631 lpp_solver_func_t* f = lpp_find_solver(solver);
635 lpp_solve_net(lpp, host, solver);