isl_tab.h

   1 #ifndef ISL_TAB_H
   2 #define ISL_TAB_H
   3
   4 #include "isl_lp.h"
   5 #include "isl_map.h"
   6 #include "isl_mat.h"
   7
   8 struct isl_tab_var {
   9         int index;
  10         unsigned is_row : 1;
  11         unsigned is_nonneg : 1;
  12         unsigned is_zero : 1;
  13         unsigned is_redundant : 1;
  14         unsigned marked : 1;
  15         unsigned frozen : 1;
  16 };
  17
  18 enum isl_tab_undo_type {
  19         isl_tab_undo_bottom,
  20         isl_tab_undo_empty,
  21         isl_tab_undo_nonneg,
  22         isl_tab_undo_redundant,
  23         isl_tab_undo_zero,
  24         isl_tab_undo_allocate,
  25         isl_tab_undo_relax,
  26         isl_tab_undo_saved_basis,
  27 };
  28
  29 union isl_tab_undo_val {
  30         int             var_index;
  31         int             *col_var;
  32 };
  33
  34 struct isl_tab_undo {
  35         enum isl_tab_undo_type  type;
  36         union isl_tab_undo_val  u;
  37         struct isl_tab_undo     *next;
  38 };
  39
  40 /* The tableau maintains equality relations.
  41  * Each column and each row is associated to a variable or a constraint.
  42  * The "value" of an inequality constraint is the value of the corresponding
  43  * slack variable.
  44  * The "row_var" and "col_var" arrays map column and row indices
  45  * to indices in the "var" and "con" arrays.  The elements of these
  46  * arrays maintain extra information about the variables and the constraints.
  47  * Each row expresses the corresponding row variable as an affine expression
  48  * of the column variables.
  49  * The first two columns in the matrix contain the common denominator of
  50  * the row and the numerator of the constant term.  The third column
  51  * in the matrix is called column 0 with respect to the col_var array.
  52  * The sample value of the tableau is the value that assigns zero
  53  * to all the column variables and the constant term of each affine
  54  * expression to the corresponding row variable.
  55  * The operations on the tableau maintain the property that the sample
  56  * value satisfies the non-negativity constraints (usually on the slack
  57  * variables).
  58  *
  59  * The first n_dead column variables have their values fixed to zero.
  60  * The corresponding tab_vars are flagged "is_zero".
  61  * Some of the rows that have have zero coefficients in all but
  62  * the dead columns are also flagged "is_zero".
  63  *
  64  * The first n_redundant rows correspond to inequality constraints
  65  * that are always satisfied for any value satisfying the non-redundant
  66  * rows.  The corresponding tab_vars are flagged "is_redundant".
  67  * A row variable that is flagged "is_zero" is also flagged "is_redundant"
  68  * since the constraint has been reduced to 0 = 0 and is therefore always
  69  * satisfied.
  70  *
  71  * There are "n_var" variables in total.  The first "n_param" of these
  72  * are called parameters and the last "n_div" of these are called divs.
  73  * The basic tableau operations makes no distinction between different
  74  * kinds of variables.
  75  *
  76  * Dead columns and redundant rows are detected on the fly.
  77  * However, the basic operations do not ensure that all dead columns
  78  * or all redundant rows are detected.
  79  * isl_tab_detect_equalities and isl_tab_detect_redundant can be used
  80  * to perform and exhaustive search for dead columns and redundant rows.
  81  */
  82 struct isl_tab {
  83         struct isl_mat *mat;
  84
  85         unsigned n_row;
  86         unsigned n_col;
  87         unsigned n_dead;
  88         unsigned n_redundant;
  89
  90         unsigned n_var;
  91         unsigned n_param;
  92         unsigned n_div;
  93         unsigned n_con;
  94         unsigned n_eq;
  95         unsigned max_con;
  96         struct isl_tab_var *var;
  97         struct isl_tab_var *con;
  98         int *row_var;   /* v >= 0 -> var v;     v < 0 -> con ~v */
  99         int *col_var;   /* v >= 0 -> var v;     v < 0 -> con ~v */
 100
 101         struct isl_tab_undo bottom;
 102         struct isl_tab_undo *top;
 103
 104         struct isl_vec *dual;
 105
 106         unsigned need_undo : 1;
 107         unsigned rational : 1;
 108         unsigned empty : 1;
 109         unsigned in_undo : 1;
 110 };
 111
 112 struct isl_tab *isl_tab_alloc(struct isl_ctx *ctx,
 113         unsigned n_row, unsigned n_var);
 114 void isl_tab_free(struct isl_tab *tab);
 115
 116 struct isl_tab *isl_tab_from_basic_map(struct isl_basic_map *bmap);
 117 struct isl_tab *isl_tab_from_basic_set(struct isl_basic_set *bset);
 118 struct isl_tab *isl_tab_from_recession_cone(struct isl_basic_map *bmap);
 119 int isl_tab_cone_is_bounded(struct isl_tab *tab);
 120 struct isl_basic_map *isl_basic_map_update_from_tab(struct isl_basic_map *bmap,
 121         struct isl_tab *tab);
 122 struct isl_basic_set *isl_basic_set_update_from_tab(struct isl_basic_set *bset,
 123         struct isl_tab *tab);
 124 struct isl_tab *isl_tab_detect_equalities(struct isl_tab *tab);
 125 struct isl_tab *isl_tab_detect_redundant(struct isl_tab *tab);
 126 #define ISL_TAB_SAVE_DUAL       (1 << 0)
 127 enum isl_lp_result isl_tab_min(struct isl_tab *tab,
 128         isl_int *f, isl_int denom, isl_int *opt, isl_int *opt_denom,
 129         unsigned flags);
 130
 131 struct isl_tab *isl_tab_extend(struct isl_tab *tab, unsigned n_new);
 132 struct isl_tab *isl_tab_add_ineq(struct isl_tab *tab, isl_int *ineq);
 133 struct isl_tab *isl_tab_add_valid_eq(struct isl_tab *tab, isl_int *eq);
 134
 135 int isl_tab_is_equality(struct isl_tab *tab, int con);
 136 int isl_tab_is_redundant(struct isl_tab *tab, int con);
 137
 138 int isl_tab_sample_is_integer(struct isl_tab *tab);
 139 struct isl_vec *isl_tab_get_sample_value(struct isl_tab *tab);
 140
 141 enum isl_ineq_type {
 142         isl_ineq_error = -1,
 143         isl_ineq_redundant,
 144         isl_ineq_separate,
 145         isl_ineq_cut,
 146         isl_ineq_adj_eq,
 147         isl_ineq_adj_ineq,
 148 };
 149
 150 enum isl_ineq_type isl_tab_ineq_type(struct isl_tab *tab, isl_int *ineq);
 151
 152 struct isl_tab_undo *isl_tab_snap(struct isl_tab *tab);
 153 int isl_tab_rollback(struct isl_tab *tab, struct isl_tab_undo *snap);
 154
 155 struct isl_tab *isl_tab_relax(struct isl_tab *tab, int con);
 156 struct isl_tab *isl_tab_select_facet(struct isl_tab *tab, int con);
 157
 158 void isl_tab_dump(struct isl_tab *tab, FILE *out, int indent);
 159
 160 /* private */
 161
 162 struct isl_tab_var *isl_tab_var_from_row(struct isl_tab *tab, int i);
 163 int isl_tab_mark_redundant(struct isl_tab *tab, int row);
 164 struct isl_tab *isl_tab_mark_empty(struct isl_tab *tab);
 165 struct isl_tab *isl_tab_dup(struct isl_tab *tab);
 166 int isl_tab_extend_cons(struct isl_tab *tab, unsigned n_new);
 167 int isl_tab_allocate_con(struct isl_tab *tab);
 168 void isl_tab_pivot(struct isl_tab *tab, int row, int col);
 169 int isl_tab_add_row(struct isl_tab *tab, isl_int *line);
 170 int isl_tab_row_is_redundant(struct isl_tab *tab, int row);
 171 int isl_tab_min_at_most_neg_one(struct isl_tab *tab, struct isl_tab_var *var);
 172
 173 void isl_tab_push(struct isl_tab *tab, enum isl_tab_undo_type type);
 174 void isl_tab_push_var(struct isl_tab *tab,
 175         enum isl_tab_undo_type type, struct isl_tab_var *var);
 176 void isl_tab_push_basis(struct isl_tab *tab);
 177
 178 #endif