include/isl_set.h

   1 /*
   2  * Copyright 2008-2009 Katholieke Universiteit Leuven
   3  *
   4  * Use of this software is governed by the GNU LGPLv2.1 license
   5  *
   6  * Written by Sven Verdoolaege, K.U.Leuven, Departement
   7  * Computerwetenschappen, Celestijnenlaan 200A, B-3001 Leuven, Belgium
   8  */
   9
  10 #ifndef ISL_SET_H
  11 #define ISL_SET_H
  12
  13 #include "isl_map.h"
  14 #include "isl_list.h"
  15 #include <isl_point.h>
  16
  17 #if defined(__cplusplus)
  18 extern "C" {
  19 #endif
  20
  21 /* A "basic set" is a basic map with a zero-dimensional
  22  * domain.
  23  */
  24 struct isl_basic_set {
  25         int ref;
  26 #define ISL_BASIC_SET_FINAL             (1 << 0)
  27 #define ISL_BASIC_SET_EMPTY             (1 << 1)
  28 #define ISL_BASIC_SET_NO_IMPLICIT       (1 << 2)
  29 #define ISL_BASIC_SET_NO_REDUNDANT      (1 << 3)
  30 #define ISL_BASIC_SET_RATIONAL          (1 << 4)
  31 #define ISL_BASIC_SET_NORMALIZED        (1 << 5)
  32 #define ISL_BASIC_SET_NORMALIZED_DIVS   (1 << 6)
  33 #define ISL_BASIC_SET_ALL_EQUALITIES    (1 << 7)
  34         unsigned flags;
  35
  36         struct isl_ctx *ctx;
  37
  38         struct isl_dim *dim;
  39         unsigned extra;
  40
  41         unsigned n_eq;
  42         unsigned n_ineq;
  43
  44         size_t c_size;
  45         isl_int **eq;
  46         isl_int **ineq;
  47
  48         unsigned n_div;
  49
  50         isl_int **div;
  51
  52         struct isl_vec *sample;
  53
  54         struct isl_blk block;
  55         struct isl_blk block2;
  56 };
  57
  58 /* A "set" is a (possibly disjoint) union of basic sets.
  59  *
  60  * See the documentation of isl_map.
  61  */
  62 struct isl_set {
  63         int ref;
  64 #define ISL_SET_DISJOINT                (1 << 0)
  65 #define ISL_SET_NORMALIZED              (1 << 1)
  66         unsigned flags;
  67
  68         struct isl_ctx *ctx;
  69
  70         struct isl_dim *dim;
  71
  72         int n;
  73
  74         size_t size;
  75         struct isl_basic_set *p[1];
  76 };
  77
  78 unsigned isl_basic_set_n_dim(const struct isl_basic_set *bset);
  79 unsigned isl_basic_set_n_param(const struct isl_basic_set *bset);
  80 unsigned isl_basic_set_total_dim(const struct isl_basic_set *bset);
  81 unsigned isl_basic_set_dim(const struct isl_basic_set *bset,
  82                                 enum isl_dim_type type);
  83
  84 unsigned isl_set_n_dim(const struct isl_set *set);
  85 unsigned isl_set_n_param(const struct isl_set *set);
  86 unsigned isl_set_dim(const struct isl_set *set, enum isl_dim_type type);
  87
  88 isl_ctx *isl_basic_set_get_ctx(__isl_keep isl_basic_set *bset);
  89 isl_ctx *isl_set_get_ctx(__isl_keep isl_set *set);
  90 __isl_give isl_dim *isl_basic_set_get_dim(__isl_keep isl_basic_set *bset);
  91 __isl_give isl_dim *isl_set_get_dim(__isl_keep isl_set *set);
  92
  93 const char *isl_set_get_tuple_name(__isl_keep isl_set *set);
  94 __isl_give isl_set *isl_set_set_tuple_name(__isl_take isl_set *set,
  95         const char *s);
  96 __isl_give isl_basic_set *isl_basic_set_set_dim_name(
  97         __isl_take isl_basic_set *bset,
  98         enum isl_dim_type type, unsigned pos, const char *s);
  99 const char *isl_set_get_dim_name(__isl_keep isl_set *set,
 100         enum isl_dim_type type, unsigned pos);
 101 __isl_give isl_set *isl_set_set_dim_name(__isl_take isl_set *set,
 102         enum isl_dim_type type, unsigned pos, const char *s);
 103
 104 struct isl_basic_set *isl_basic_set_alloc(struct isl_ctx *ctx,
 105                 unsigned nparam, unsigned dim, unsigned extra,
 106                 unsigned n_eq, unsigned n_ineq);
 107 struct isl_basic_set *isl_basic_set_extend(struct isl_basic_set *base,
 108                 unsigned nparam, unsigned dim, unsigned extra,
 109                 unsigned n_eq, unsigned n_ineq);
 110 struct isl_basic_set *isl_basic_set_extend_constraints(
 111                 struct isl_basic_set *base, unsigned n_eq, unsigned n_ineq);
 112 struct isl_basic_set *isl_basic_set_finalize(struct isl_basic_set *bset);
 113 void isl_basic_set_free(__isl_take isl_basic_set *bset);
 114 __isl_give isl_basic_set *isl_basic_set_copy(__isl_keep isl_basic_set *bset);
 115 struct isl_basic_set *isl_basic_set_dup(struct isl_basic_set *bset);
 116 __isl_give isl_basic_set *isl_basic_set_empty(__isl_take isl_dim *dim);
 117 struct isl_basic_set *isl_basic_set_empty_like(struct isl_basic_set *bset);
 118 __isl_give isl_basic_set *isl_basic_set_universe(__isl_take isl_dim *dim);
 119 struct isl_basic_set *isl_basic_set_universe_like(struct isl_basic_set *bset);
 120 __isl_give isl_basic_set *isl_basic_set_universe_like_set(
 121         __isl_keep isl_set *model);
 122 struct isl_basic_set *isl_basic_set_interval(struct isl_ctx *ctx,
 123         isl_int min, isl_int max);
 124 struct isl_basic_set *isl_basic_set_positive_orthant(struct isl_dim *dims);
 125 void isl_basic_set_dump(__isl_keep isl_basic_set *bset,
 126                                 FILE *out, int indent);
 127 struct isl_basic_set *isl_basic_set_swap_vars(
 128                 struct isl_basic_set *bset, unsigned n);
 129 __isl_give isl_basic_set *isl_basic_set_intersect(
 130                 __isl_take isl_basic_set *bset1,
 131                 __isl_take isl_basic_set *bset2);
 132 __isl_give isl_basic_set *isl_basic_set_apply(
 133                 __isl_take isl_basic_set *bset,
 134                 __isl_take isl_basic_map *bmap);
 135 __isl_give isl_basic_set *isl_basic_set_affine_hull(
 136                 __isl_take isl_basic_set *bset);
 137 __isl_give isl_basic_set *isl_basic_set_remove(__isl_take isl_basic_set *bset,
 138         enum isl_dim_type type, unsigned first, unsigned n);
 139 struct isl_basic_set *isl_basic_set_simplify(struct isl_basic_set *bset);
 140 __isl_give isl_basic_set *isl_basic_set_detect_equalities(
 141                                                 __isl_take isl_basic_set *bset);
 142 struct isl_basic_set *isl_basic_set_product(struct isl_basic_set_list *list);
 143
 144 __isl_give isl_basic_set *isl_basic_set_read_from_file(isl_ctx *ctx,
 145                 FILE *input, int nparam);
 146 __isl_give isl_basic_set *isl_basic_set_read_from_str(isl_ctx *ctx,
 147                 const char *str, int nparam);
 148 __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
 149                 FILE *input, int nparam);
 150 __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
 151                 const char *str, int nparam);
 152 __isl_give isl_printer *isl_printer_print_basic_set(
 153         __isl_take isl_printer *printer, __isl_keep isl_basic_set *bset);
 154 __isl_give isl_printer *isl_printer_print_set(__isl_take isl_printer *printer,
 155         __isl_keep isl_set *map);
 156 void isl_basic_set_print(__isl_keep isl_basic_set *bset, FILE *out, int indent,
 157         const char *prefix, const char *suffix, unsigned output_format);
 158 void isl_set_print(__isl_keep struct isl_set *set, FILE *out, int indent,
 159         unsigned output_format);
 160 __isl_give isl_basic_set *isl_basic_set_fix(__isl_take isl_basic_set *bset,
 161                 enum isl_dim_type type, unsigned pos, isl_int value);
 162 struct isl_basic_set *isl_basic_set_fix_si(struct isl_basic_set *bset,
 163                 enum isl_dim_type type, unsigned pos, int value);
 164 __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
 165                 enum isl_dim_type type, unsigned pos, int value);
 166 __isl_give isl_set *isl_set_lower_bound_si(__isl_take isl_set *set,
 167                 enum isl_dim_type type, unsigned pos, int value);
 168
 169 struct isl_basic_set *isl_basic_set_from_underlying_set(
 170         struct isl_basic_set *bset, struct isl_basic_set *like);
 171 struct isl_set *isl_set_from_underlying_set(
 172         struct isl_set *set, struct isl_basic_set *like);
 173 struct isl_set *isl_set_to_underlying_set(struct isl_set *set);
 174
 175 int isl_basic_set_is_equal(
 176                 struct isl_basic_set *bset1, struct isl_basic_set *bset2);
 177
 178 __isl_give isl_set *isl_basic_set_partial_lexmin(
 179                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
 180                 __isl_give isl_set **empty);
 181 __isl_give isl_set *isl_basic_set_partial_lexmax(
 182                 __isl_take isl_basic_set *bset, __isl_take isl_basic_set *dom,
 183                 __isl_give isl_set **empty);
 184 __isl_give isl_set *isl_set_partial_lexmin(
 185                 __isl_take isl_set *set, __isl_take isl_set *dom,
 186                 __isl_give isl_set **empty);
 187 __isl_give isl_set *isl_set_partial_lexmax(
 188                 __isl_take isl_set *set, __isl_take isl_set *dom,
 189                 __isl_give isl_set **empty);
 190 __isl_give isl_set *isl_basic_set_lexmin(__isl_take isl_basic_set *bset);
 191 __isl_give isl_set *isl_basic_set_lexmax(__isl_take isl_basic_set *bset);
 192 __isl_give isl_set *isl_set_lexmin(__isl_take isl_set *set);
 193 __isl_give isl_set *isl_set_lexmax(__isl_take isl_set *set);
 194 __isl_give isl_set *isl_basic_set_union(
 195                 __isl_take isl_basic_set *bset1,
 196                 __isl_take isl_basic_set *bset2);
 197
 198 int isl_basic_set_compare_at(struct isl_basic_set *bset1,
 199         struct isl_basic_set *bset2, int pos);
 200 int isl_set_follows_at(__isl_keep isl_set *set1,
 201         __isl_keep isl_set *set2, int pos);
 202
 203 int isl_basic_set_dims_get_sign(__isl_keep isl_basic_set *bset,
 204         enum isl_dim_type type, unsigned pos, unsigned n, int *signs);
 205
 206 int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
 207 int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
 208 int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
 209 int isl_basic_set_is_bounded(__isl_keep isl_basic_set *bset);
 210
 211 struct isl_set *isl_set_alloc(struct isl_ctx *ctx,
 212                 unsigned nparam, unsigned dim, int n, unsigned flags);
 213 struct isl_set *isl_set_extend(struct isl_set *base,
 214                 unsigned nparam, unsigned dim);
 215 __isl_give isl_set *isl_set_empty(__isl_take isl_dim *dim);
 216 struct isl_set *isl_set_empty_like(struct isl_set *set);
 217 __isl_give isl_set *isl_set_universe(__isl_take isl_dim *dim);
 218 __isl_give isl_set *isl_set_universe_like(__isl_keep isl_set *model);
 219 __isl_give isl_set *isl_set_add_basic_set(__isl_take isl_set *set,
 220                                                 __isl_take isl_basic_set *bset);
 221 struct isl_set *isl_set_finalize(struct isl_set *set);
 222 __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
 223 void isl_set_free(__isl_take isl_set *set);
 224 struct isl_set *isl_set_dup(struct isl_set *set);
 225 __isl_give isl_set *isl_set_from_basic_set(__isl_take isl_basic_set *bset);
 226 __isl_give isl_basic_set *isl_set_sample(__isl_take isl_set *set);
 227 __isl_give isl_point *isl_basic_set_sample_point(__isl_take isl_basic_set *bset);
 228 __isl_give isl_point *isl_set_sample_point(__isl_take isl_set *set);
 229 __isl_give isl_set *isl_set_detect_equalities(__isl_take isl_set *set);
 230 __isl_give isl_basic_set *isl_set_affine_hull(__isl_take isl_set *set);
 231 __isl_give isl_basic_set *isl_set_convex_hull(__isl_take isl_set *set);
 232 __isl_give isl_basic_set *isl_set_simple_hull(__isl_take isl_set *set);
 233 struct isl_basic_set *isl_set_bounded_simple_hull(struct isl_set *set);
 234 __isl_give isl_set *isl_set_recession_cone(__isl_take isl_set *set);
 235
 236 struct isl_set *isl_set_union_disjoint(
 237                         struct isl_set *set1, struct isl_set *set2);
 238 __isl_give isl_set *isl_set_union(
 239                 __isl_take isl_set *set1,
 240                 __isl_take isl_set *set2);
 241 struct isl_set *isl_set_product(struct isl_set *set1, struct isl_set *set2);
 242 __isl_give isl_set *isl_set_flat_product(__isl_take isl_set *set1,
 243         __isl_take isl_set *set2);
 244 __isl_give isl_set *isl_set_intersect(
 245                 __isl_take isl_set *set1,
 246                 __isl_take isl_set *set2);
 247 __isl_give isl_set *isl_set_subtract(
 248                 __isl_take isl_set *set1,
 249                 __isl_take isl_set *set2);
 250 __isl_give isl_set *isl_set_complement(__isl_take isl_set *set);
 251 __isl_give isl_set *isl_set_apply(
 252                 __isl_take isl_set *set,
 253                 __isl_take isl_map *map);
 254 __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
 255                 enum isl_dim_type type, unsigned pos, isl_int value);
 256 struct isl_set *isl_set_fix_dim_si(struct isl_set *set,
 257                 unsigned dim, int value);
 258 struct isl_set *isl_set_lower_bound_dim(struct isl_set *set,
 259                 unsigned dim, isl_int value);
 260 __isl_give isl_set *isl_set_insert(__isl_take isl_set *set,
 261                 enum isl_dim_type type, unsigned pos, unsigned n);
 262 __isl_give isl_basic_set *isl_basic_set_add(__isl_take isl_basic_set *bset,
 263                 enum isl_dim_type type, unsigned n);
 264 __isl_give isl_set *isl_set_add_dims(__isl_take isl_set *set,
 265                 enum isl_dim_type type, unsigned n);
 266 __isl_give isl_basic_set *isl_basic_set_move_dims(__isl_take isl_basic_set *bset,
 267         enum isl_dim_type dst_type, unsigned dst_pos,
 268         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
 269 __isl_give isl_set *isl_set_move_dims(__isl_take isl_set *set,
 270         enum isl_dim_type dst_type, unsigned dst_pos,
 271         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
 272 __isl_give isl_basic_set *isl_basic_set_project_out(
 273                 __isl_take isl_basic_set *bset,
 274                 enum isl_dim_type type, unsigned first, unsigned n);
 275 __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
 276                 enum isl_dim_type type, unsigned first, unsigned n);
 277 struct isl_basic_set *isl_basic_set_remove_dims(struct isl_basic_set *bset,
 278                 unsigned first, unsigned n);
 279 __isl_give isl_basic_set *isl_basic_set_remove_divs(
 280         __isl_take isl_basic_set *bset);
 281 struct isl_set *isl_set_eliminate_dims(struct isl_set *set,
 282                 unsigned first, unsigned n);
 283 __isl_give isl_set *isl_set_remove(__isl_take isl_set *bset,
 284         enum isl_dim_type type, unsigned first, unsigned n);
 285 struct isl_set *isl_set_remove_dims(struct isl_set *set,
 286                 unsigned first, unsigned n);
 287 __isl_give isl_set *isl_set_remove_divs(__isl_take isl_set *set);
 288 __isl_give isl_set *isl_set_split_dims(__isl_take isl_set *set,
 289         enum isl_dim_type type, unsigned first, unsigned n);
 290
 291 void isl_set_dump(__isl_keep isl_set *set, FILE *out, int indent);
 292 struct isl_set *isl_set_swap_vars(struct isl_set *set, unsigned n);
 293 int isl_set_fast_is_empty(__isl_keep isl_set *set);
 294 int isl_set_fast_is_universe(__isl_keep isl_set *set);
 295 int isl_set_is_empty(__isl_keep isl_set *set);
 296 int isl_set_is_bounded(__isl_keep isl_set *set);
 297 int isl_set_is_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
 298 int isl_set_is_strict_subset(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
 299 int isl_set_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
 300 int isl_set_is_singleton(__isl_keep isl_set *set);
 301 int isl_set_is_box(__isl_keep isl_set *set);
 302 int isl_set_has_equal_dim(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
 303
 304 __isl_give isl_set *isl_set_sum(__isl_take isl_set *set1,
 305         __isl_take isl_set *set2);
 306 __isl_give isl_set *isl_set_neg(__isl_take isl_set *set);
 307
 308 __isl_give isl_set *isl_set_make_disjoint(__isl_take isl_set *set);
 309 struct isl_set *isl_basic_set_compute_divs(struct isl_basic_set *bset);
 310 __isl_give isl_set *isl_set_compute_divs(__isl_take isl_set *set);
 311 __isl_give isl_set *isl_set_align_divs(__isl_take isl_set *set);
 312
 313 struct isl_basic_set *isl_set_copy_basic_set(struct isl_set *set);
 314 struct isl_set *isl_set_drop_basic_set(struct isl_set *set,
 315                                                 struct isl_basic_set *bset);
 316
 317 int isl_basic_set_fast_dim_is_fixed(struct isl_basic_set *bset, unsigned dim,
 318         isl_int *val);
 319
 320 int isl_set_fast_dim_is_fixed(struct isl_set *set, unsigned dim, isl_int *val);
 321 int isl_set_fast_dim_has_fixed_lower_bound(struct isl_set *set,
 322         unsigned dim, isl_int *val);
 323 int isl_set_dim_is_bounded(__isl_keep isl_set *set,
 324         enum isl_dim_type type, unsigned pos);
 325
 326 __isl_give isl_basic_set *isl_basic_set_gist(__isl_take isl_basic_set *bset,
 327                                             __isl_take isl_basic_set *context);
 328 __isl_give isl_set *isl_set_gist_basic_set(__isl_take isl_set *set,
 329         __isl_take isl_basic_set *context);
 330 __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
 331         __isl_take isl_set *context);
 332 int isl_basic_set_dim_residue_class(struct isl_basic_set *bset,
 333         int pos, isl_int *modulo, isl_int *residue);
 334 int isl_set_dim_residue_class(struct isl_set *set,
 335         int pos, isl_int *modulo, isl_int *residue);
 336
 337 __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
 338
 339 int isl_set_fast_is_equal(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
 340 int isl_set_fast_is_disjoint(__isl_keep isl_set *set1, __isl_keep isl_set *set2);
 341
 342 uint32_t isl_set_get_hash(struct isl_set *set);
 343
 344 int isl_set_dim_is_unique(struct isl_set *set, unsigned dim);
 345
 346 int isl_set_n_basic_set(__isl_keep isl_set *set);
 347 int isl_set_foreach_basic_set(__isl_keep isl_set *set,
 348         int (*fn)(__isl_take isl_basic_set *bset, void *user), void *user);
 349
 350 int isl_set_foreach_point(__isl_keep isl_set *set,
 351         int (*fn)(__isl_take isl_point *pnt, void *user), void *user);
 352 int isl_set_count(__isl_keep isl_set *set, isl_int *count);
 353 int isl_set_count_upto(__isl_keep isl_set *set, isl_int max, isl_int *count);
 354
 355 __isl_give isl_set *isl_set_from_point(__isl_take isl_point *pnt);
 356 __isl_give isl_set *isl_set_box_from_points(__isl_take isl_point *pnt1,
 357         __isl_take isl_point *pnt2);
 358
 359 __isl_give isl_basic_set *isl_basic_set_lift(__isl_take isl_basic_set *bset);
 360 __isl_give isl_set *isl_set_lift(__isl_take isl_set *set);
 361
 362 __isl_give isl_map *isl_set_lex_le_set(__isl_take isl_set *set1,
 363         __isl_take isl_set *set2);
 364 __isl_give isl_map *isl_set_lex_lt_set(__isl_take isl_set *set1,
 365         __isl_take isl_set *set2);
 366 __isl_give isl_map *isl_set_lex_ge_set(__isl_take isl_set *set1,
 367         __isl_take isl_set *set2);
 368 __isl_give isl_map *isl_set_lex_gt_set(__isl_take isl_set *set1,
 369         __isl_take isl_set *set2);
 370
 371 int isl_set_size(__isl_keep isl_set *set);
 372
 373 __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
 374         __isl_take isl_dim *dim,
 375         __isl_take isl_mat *eq, __isl_take isl_mat *ineq, enum isl_dim_type c1,
 376         enum isl_dim_type c2, enum isl_dim_type c3, enum isl_dim_type c4);
 377
 378 __isl_give isl_mat *isl_basic_set_reduced_basis(__isl_keep isl_basic_set *bset);
 379
 380 #if defined(__cplusplus)
 381 }
 382 #endif
 383
 384 #endif