include/isl_map.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_MAP_H
  11 #define ISL_MAP_H
  12
  13 #include <stdio.h>
  14
  15 #include <isl_int.h>
  16 #include <isl_ctx.h>
  17 #include <isl_blk.h>
  18 #include <isl_dim.h>
  19 #include <isl_vec.h>
  20 #include <isl_mat.h>
  21 #include <isl_printer.h>
  22
  23 #if defined(__cplusplus)
  24 extern "C" {
  25 #endif
  26
  27 /* General notes:
  28  *
  29  * All structures are reference counted to allow reuse without duplication.
  30  * A *_copy operation will increase the reference count, while a *_free
  31  * operation will decrease the reference count and only actually release
  32  * the structures when the reference count drops to zero.
  33  *
  34  * Functions that return an isa structure will in general _destroy_
  35  * all argument isa structures (the obvious execption begin the _copy
  36  * functions).  A pointer passed to such a function may therefore
  37  * never be used after the function call.  If you want to keep a
  38  * reference to the old structure(s), use the appropriate _copy function.
  39  */
  40
  41 /* A "basic map" is a relation between two sets of variables,
  42  * called the "in" and "out" variables.
  43  *
  44  * It is implemented as a set with two extra fields:
  45  * n_in is the number of in variables
  46  * n_out is the number of out variables
  47  * n_in + n_out should be equal to set.dim
  48  */
  49 struct isl_dim;
  50 struct isl_basic_map {
  51         int ref;
  52 #define ISL_BASIC_MAP_FINAL             (1 << 0)
  53 #define ISL_BASIC_MAP_EMPTY             (1 << 1)
  54 #define ISL_BASIC_MAP_NO_IMPLICIT       (1 << 2)
  55 #define ISL_BASIC_MAP_NO_REDUNDANT      (1 << 3)
  56 #define ISL_BASIC_MAP_RATIONAL          (1 << 4)
  57 #define ISL_BASIC_MAP_NORMALIZED        (1 << 5)
  58 #define ISL_BASIC_MAP_NORMALIZED_DIVS   (1 << 6)
  59 #define ISL_BASIC_MAP_ALL_EQUALITIES    (1 << 7)
  60         unsigned flags;
  61
  62         struct isl_ctx *ctx;
  63
  64         struct isl_dim *dim;
  65         unsigned extra;
  66
  67         unsigned n_eq;
  68         unsigned n_ineq;
  69
  70         size_t c_size;
  71         isl_int **eq;
  72         isl_int **ineq;
  73
  74         unsigned n_div;
  75
  76         isl_int **div;
  77
  78         struct isl_vec *sample;
  79
  80         struct isl_blk block;
  81         struct isl_blk block2;
  82 };
  83 typedef struct isl_basic_map isl_basic_map;
  84 struct isl_basic_set;
  85 typedef struct isl_basic_set isl_basic_set;
  86
  87 /* A "map" is a (disjoint) union of basic maps.
  88  *
  89  * Currently, the isl_set structure is identical to the isl_map structure
  90  * and the library depends on this correspondence internally.
  91  * However, users should not depend on this correspondence.
  92  */
  93 struct isl_map {
  94         int ref;
  95 #define ISL_MAP_DISJOINT                (1 << 0)
  96 #define ISL_MAP_NORMALIZED              (1 << 1)
  97         unsigned flags;
  98
  99         struct isl_ctx *ctx;
 100
 101         struct isl_dim *dim;
 102
 103         int n;
 104
 105         size_t size;
 106         struct isl_basic_map *p[1];
 107 };
 108 typedef struct isl_map isl_map;
 109 struct isl_set;
 110 typedef struct isl_set isl_set;
 111
 112 unsigned isl_basic_map_n_in(const struct isl_basic_map *bmap);
 113 unsigned isl_basic_map_n_out(const struct isl_basic_map *bmap);
 114 unsigned isl_basic_map_n_param(const struct isl_basic_map *bmap);
 115 unsigned isl_basic_map_n_div(const struct isl_basic_map *bmap);
 116 unsigned isl_basic_map_total_dim(const struct isl_basic_map *bmap);
 117 unsigned isl_basic_map_dim(const struct isl_basic_map *bmap,
 118                                 enum isl_dim_type type);
 119
 120 unsigned isl_map_n_in(const struct isl_map *map);
 121 unsigned isl_map_n_out(const struct isl_map *map);
 122 unsigned isl_map_n_param(const struct isl_map *map);
 123 unsigned isl_map_dim(const struct isl_map *map, enum isl_dim_type type);
 124
 125 __isl_give isl_dim *isl_basic_map_get_dim(__isl_keep isl_basic_map *bmap);
 126 __isl_give isl_dim *isl_map_get_dim(__isl_keep isl_map *map);
 127
 128 __isl_give isl_basic_map *isl_basic_map_set_dim_name(
 129         __isl_take isl_basic_map *bmap,
 130         enum isl_dim_type type, unsigned pos, const char *s);
 131 __isl_give isl_map *isl_map_set_dim_name(__isl_take isl_map *map,
 132         enum isl_dim_type type, unsigned pos, const char *s);
 133
 134 int isl_basic_map_is_rational(__isl_keep isl_basic_map *bmap);
 135
 136 struct isl_basic_map *isl_basic_map_alloc(struct isl_ctx *ctx,
 137                 unsigned nparam, unsigned in, unsigned out, unsigned extra,
 138                 unsigned n_eq, unsigned n_ineq);
 139 __isl_give isl_basic_map *isl_basic_map_identity(__isl_take isl_dim *set_dim);
 140 struct isl_basic_map *isl_basic_map_identity_like(struct isl_basic_map *model);
 141 struct isl_basic_map *isl_basic_map_finalize(struct isl_basic_map *bmap);
 142 void isl_basic_map_free(__isl_take isl_basic_map *bmap);
 143 __isl_give isl_basic_map *isl_basic_map_copy(__isl_keep isl_basic_map *bmap);
 144 struct isl_basic_map *isl_basic_map_extend(struct isl_basic_map *base,
 145                 unsigned nparam, unsigned n_in, unsigned n_out, unsigned extra,
 146                 unsigned n_eq, unsigned n_ineq);
 147 struct isl_basic_map *isl_basic_map_extend_constraints(
 148                 struct isl_basic_map *base, unsigned n_eq, unsigned n_ineq);
 149 struct isl_basic_map *isl_basic_map_equal(
 150                 struct isl_dim *dim, unsigned n_equal);
 151 struct isl_basic_map *isl_basic_map_less_at(struct isl_dim *dim, unsigned pos);
 152 struct isl_basic_map *isl_basic_map_more_at(struct isl_dim *dim, unsigned pos);
 153 __isl_give isl_basic_map *isl_basic_map_empty(__isl_take isl_dim *dim);
 154 struct isl_basic_map *isl_basic_map_empty_like(struct isl_basic_map *model);
 155 struct isl_basic_map *isl_basic_map_empty_like_map(struct isl_map *model);
 156 __isl_give isl_basic_map *isl_basic_map_universe(__isl_take isl_dim *dim);
 157 __isl_give isl_basic_map *isl_basic_map_universe_like(
 158                 __isl_keep isl_basic_map *bmap);
 159 __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
 160         __isl_take isl_basic_map *bmap);
 161 __isl_give isl_basic_map *isl_map_simple_hull(__isl_take isl_map *map);
 162
 163 __isl_give isl_basic_map *isl_basic_map_intersect_domain(
 164                 __isl_take isl_basic_map *bmap,
 165                 __isl_take isl_basic_set *bset);
 166 __isl_give isl_basic_map *isl_basic_map_intersect_range(
 167                 __isl_take isl_basic_map *bmap,
 168                 __isl_take isl_basic_set *bset);
 169 __isl_give isl_basic_map *isl_basic_map_intersect(
 170                 __isl_take isl_basic_map *bmap1,
 171                 __isl_take isl_basic_map *bmap2);
 172 __isl_give isl_map *isl_basic_map_union(
 173                 __isl_take isl_basic_map *bmap1,
 174                 __isl_take isl_basic_map *bmap2);
 175 __isl_give isl_basic_map *isl_basic_map_apply_domain(
 176                 __isl_take isl_basic_map *bmap1,
 177                 __isl_take isl_basic_map *bmap2);
 178 __isl_give isl_basic_map *isl_basic_map_apply_range(
 179                 __isl_take isl_basic_map *bmap1,
 180                 __isl_take isl_basic_map *bmap2);
 181 __isl_give isl_basic_map *isl_basic_map_affine_hull(
 182                 __isl_take isl_basic_map *bmap);
 183 __isl_give isl_basic_map *isl_basic_map_reverse(__isl_take isl_basic_map *bmap);
 184 __isl_give isl_basic_set *isl_basic_map_domain(__isl_take isl_basic_map *bmap);
 185 __isl_give isl_basic_set *isl_basic_map_range(__isl_take isl_basic_map *bmap);
 186 struct isl_basic_map *isl_basic_map_remove(struct isl_basic_map *bmap,
 187         enum isl_dim_type type, unsigned first, unsigned n);
 188 struct isl_basic_map *isl_basic_map_from_basic_set(struct isl_basic_set *bset,
 189                 struct isl_dim *dim);
 190 struct isl_basic_set *isl_basic_set_from_basic_map(struct isl_basic_map *bmap);
 191 __isl_give isl_basic_map *isl_basic_map_sample(__isl_take isl_basic_map *bmap);
 192 struct isl_basic_map *isl_basic_map_simplify(struct isl_basic_map *bmap);
 193 struct isl_basic_map *isl_basic_map_detect_equalities(
 194                                                 struct isl_basic_map *bmap);
 195 __isl_give isl_basic_map *isl_basic_map_read_from_file(isl_ctx *ctx,
 196                 FILE *input, int nparam);
 197 __isl_give isl_basic_map *isl_basic_map_read_from_str(isl_ctx *ctx,
 198                 const char *str, int nparam);
 199 __isl_give isl_map *isl_map_read_from_file(struct isl_ctx *ctx,
 200                 FILE *input, int nparam);
 201 __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
 202                 const char *str, int nparam);
 203 void isl_basic_map_print(__isl_keep isl_basic_map *bmap, FILE *out, int indent,
 204         const char *prefix, const char *suffix, unsigned output_format);
 205 void isl_map_print(__isl_keep isl_map *map, FILE *out, int indent,
 206         unsigned output_format);
 207 __isl_give isl_printer *isl_printer_print_basic_map(
 208         __isl_take isl_printer *printer, __isl_keep isl_basic_map *bmap);
 209 __isl_give isl_printer *isl_printer_print_map(__isl_take isl_printer *printer,
 210         __isl_keep isl_map *map);
 211 struct isl_basic_map *isl_basic_map_fix_si(struct isl_basic_map *bmap,
 212                 enum isl_dim_type type, unsigned pos, int value);
 213 __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
 214                 __isl_take isl_basic_map *bmap,
 215                 enum isl_dim_type type, unsigned pos, int value);
 216
 217 struct isl_basic_map *isl_basic_map_sum(
 218                 struct isl_basic_map *bmap1, struct isl_basic_map *bmap2);
 219 struct isl_basic_map *isl_basic_map_neg(struct isl_basic_map *bmap);
 220 struct isl_basic_map *isl_basic_map_floordiv(struct isl_basic_map *bmap,
 221                 isl_int d);
 222
 223 struct isl_map *isl_map_sum(struct isl_map *map1, struct isl_map *map2);
 224 struct isl_map *isl_map_neg(struct isl_map *map);
 225 struct isl_map *isl_map_floordiv(struct isl_map *map, isl_int d);
 226
 227 int isl_basic_map_is_equal(
 228                 __isl_keep isl_basic_map *bmap1,
 229                 __isl_keep isl_basic_map *bmap2);
 230
 231 __isl_give isl_map *isl_basic_map_partial_lexmax(
 232                 __isl_take isl_basic_map *bmap, __isl_take isl_basic_set *dom,
 233                 __isl_give isl_set **empty);
 234 __isl_give isl_map *isl_basic_map_partial_lexmin(
 235                 __isl_take isl_basic_map *bmap, __isl_take isl_basic_set *dom,
 236                 __isl_give isl_set **empty);
 237 __isl_give isl_map *isl_map_partial_lexmax(
 238                 __isl_take isl_map *map, __isl_take isl_set *dom,
 239                 __isl_give isl_set **empty);
 240 __isl_give isl_map *isl_map_partial_lexmin(
 241                 __isl_take isl_map *map, __isl_take isl_set *dom,
 242                 __isl_give isl_set **empty);
 243 __isl_give isl_map *isl_basic_map_lexmin(__isl_take isl_basic_map *bmap);
 244 __isl_give isl_map *isl_basic_map_lexmax(__isl_take isl_basic_map *bmap);
 245 __isl_give isl_map *isl_map_lexmin(__isl_take isl_map *map);
 246 __isl_give isl_map *isl_map_lexmax(__isl_take isl_map *map);
 247 int isl_basic_map_foreach_lexmin(__isl_keep isl_basic_map *bmap,
 248         int (*fn)(__isl_take isl_basic_set *dom, __isl_take isl_mat *map,
 249                   void *user),
 250         void *user);
 251
 252 void isl_basic_map_dump(__isl_keep isl_basic_map *bmap, FILE *out, int indent);
 253
 254 struct isl_basic_map *isl_map_copy_basic_map(struct isl_map *map);
 255 __isl_give isl_map *isl_map_drop_basic_map(__isl_take isl_map *map,
 256                                                 __isl_keep isl_basic_map *bmap);
 257
 258 int isl_basic_map_fast_is_fixed(struct isl_basic_map *bmap,
 259         enum isl_dim_type type, unsigned pos, isl_int *val);
 260
 261 int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
 262 int isl_basic_map_fast_is_empty(__isl_keep isl_basic_map *bmap);
 263 int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
 264 int isl_basic_map_is_subset(__isl_keep isl_basic_map *bmap1,
 265                 __isl_keep isl_basic_map *bmap2);
 266 int isl_basic_map_is_strict_subset(__isl_keep isl_basic_map *bmap1,
 267                 __isl_keep isl_basic_map *bmap2);
 268
 269 struct isl_map *isl_map_alloc(struct isl_ctx *ctx,
 270                 unsigned nparam, unsigned in, unsigned out, int n,
 271                 unsigned flags);
 272 __isl_give isl_map *isl_map_universe(__isl_take isl_dim *dim);
 273 __isl_give isl_map *isl_map_empty(__isl_take isl_dim *dim);
 274 struct isl_map *isl_map_empty_like(struct isl_map *model);
 275 struct isl_map *isl_map_empty_like_basic_map(struct isl_basic_map *model);
 276 struct isl_map *isl_map_dup(struct isl_map *map);
 277 __isl_give isl_map *isl_map_add_basic_map(__isl_take isl_map *map,
 278                                                 __isl_take isl_basic_map *bmap);
 279 __isl_give isl_map *isl_map_identity(__isl_take isl_dim *set_dim);
 280 struct isl_map *isl_map_identity_like(struct isl_map *model);
 281 struct isl_map *isl_map_identity_like_basic_map(struct isl_basic_map *model);
 282 __isl_give isl_map *isl_map_lex_lt_first(__isl_take isl_dim *dim, unsigned n);
 283 __isl_give isl_map *isl_map_lex_le_first(__isl_take isl_dim *dim, unsigned n);
 284 __isl_give isl_map *isl_map_lex_lt(__isl_take isl_dim *set_dim);
 285 __isl_give isl_map *isl_map_lex_le(__isl_take isl_dim *set_dim);
 286 __isl_give isl_map *isl_map_lex_gt_first(__isl_take isl_dim *dim, unsigned n);
 287 __isl_give isl_map *isl_map_lex_ge_first(__isl_take isl_dim *dim, unsigned n);
 288 __isl_give isl_map *isl_map_lex_gt(__isl_take isl_dim *set_dim);
 289 __isl_give isl_map *isl_map_lex_ge(__isl_take isl_dim *set_dim);
 290 struct isl_map *isl_map_finalize(struct isl_map *map);
 291 void isl_map_free(__isl_take isl_map *map);
 292 __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
 293 struct isl_map *isl_map_extend(struct isl_map *base,
 294                 unsigned nparam, unsigned n_in, unsigned n_out);
 295 __isl_give isl_map *isl_map_reverse(__isl_take isl_map *map);
 296 __isl_give isl_map *isl_map_union(
 297                 __isl_take isl_map *map1,
 298                 __isl_take isl_map *map2);
 299 struct isl_map *isl_map_union_disjoint(
 300                         struct isl_map *map1, struct isl_map *map2);
 301 __isl_give isl_map *isl_map_intersect_domain(
 302                 __isl_take isl_map *map,
 303                 __isl_take isl_set *set);
 304 __isl_give isl_map *isl_map_intersect_range(
 305                 __isl_take isl_map *map,
 306                 __isl_take isl_set *set);
 307 __isl_give isl_map *isl_map_apply_domain(
 308                 __isl_take isl_map *map1,
 309                 __isl_take isl_map *map2);
 310 __isl_give isl_map *isl_map_apply_range(
 311                 __isl_take isl_map *map1,
 312                 __isl_take isl_map *map2);
 313 struct isl_map *isl_map_product(struct isl_map *map1, struct isl_map *map2);
 314 __isl_give isl_map *isl_map_intersect(__isl_take isl_map *map1,
 315                                       __isl_take isl_map *map2);
 316 __isl_give isl_map *isl_map_subtract(
 317                 __isl_take isl_map *map1,
 318                 __isl_take isl_map *map2);
 319 struct isl_map *isl_map_fix_input_si(struct isl_map *map,
 320                 unsigned input, int value);
 321 struct isl_map *isl_map_fix_si(struct isl_map *map,
 322                 enum isl_dim_type type, unsigned pos, int value);
 323 __isl_give isl_map *isl_map_lower_bound_si(__isl_take isl_map *map,
 324                 enum isl_dim_type type, unsigned pos, int value);
 325 __isl_give isl_basic_set *isl_basic_map_deltas(__isl_take isl_basic_map *bmap);
 326 __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
 327 struct isl_map *isl_map_detect_equalities(struct isl_map *map);
 328 __isl_give isl_basic_map *isl_map_affine_hull(__isl_take isl_map *map);
 329 __isl_give isl_basic_map *isl_map_convex_hull(__isl_take isl_map *map);
 330 __isl_give isl_basic_map *isl_basic_map_add(__isl_take isl_basic_map *bmap,
 331                 enum isl_dim_type type, unsigned n);
 332 __isl_give isl_map *isl_map_add(__isl_take isl_map *map,
 333                 enum isl_dim_type type, unsigned n);
 334 __isl_give isl_map *isl_map_insert(__isl_take isl_map *map,
 335                 enum isl_dim_type type, unsigned pos, unsigned n);
 336 __isl_give isl_map *isl_map_move_dims(__isl_take isl_map *map,
 337         enum isl_dim_type dst_type, unsigned dst_pos,
 338         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
 339 __isl_give isl_basic_map *isl_basic_map_project_out(
 340                 __isl_take isl_basic_map *bmap,
 341                 enum isl_dim_type type, unsigned first, unsigned n);
 342 __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
 343                 enum isl_dim_type type, unsigned first, unsigned n);
 344 struct isl_map *isl_map_remove(struct isl_map *map,
 345         enum isl_dim_type type, unsigned first, unsigned n);
 346 struct isl_map *isl_map_remove_inputs(struct isl_map *map,
 347         unsigned first, unsigned n);
 348
 349 __isl_give isl_set *isl_map_domain(__isl_take isl_map *bmap);
 350 __isl_give isl_set *isl_map_range(__isl_take isl_map *map);
 351 __isl_give isl_map *isl_map_from_basic_map(__isl_take isl_basic_map *bmap);
 352 __isl_give isl_map *isl_map_from_domain(__isl_take isl_set *set);
 353 struct isl_map *isl_map_from_range(struct isl_set *set);
 354 __isl_give isl_map *isl_map_from_domain_and_range(__isl_take isl_set *domain,
 355         __isl_take isl_set *range);
 356 struct isl_map *isl_map_from_set(struct isl_set *set, struct isl_dim *dim);
 357 struct isl_set *isl_set_from_map(struct isl_map *map);
 358 __isl_give isl_basic_map *isl_map_sample(__isl_take isl_map *map);
 359
 360 int isl_map_fast_is_empty(__isl_keep isl_map *map);
 361 int isl_map_fast_is_universe(__isl_keep isl_map *map);
 362 int isl_map_is_empty(__isl_keep isl_map *map);
 363 int isl_map_is_subset(__isl_keep isl_map *map1, __isl_keep isl_map *map2);
 364 int isl_map_is_strict_subset(__isl_keep isl_map *map1, __isl_keep isl_map *map2);
 365 int isl_map_is_equal(__isl_keep isl_map *map1, __isl_keep isl_map *map2);
 366 int isl_map_is_single_valued(__isl_keep isl_map *map);
 367 int isl_map_is_translation(__isl_keep isl_map *map);
 368
 369 __isl_give isl_map *isl_map_make_disjoint(__isl_take isl_map *map);
 370 __isl_give isl_map *isl_basic_map_compute_divs(__isl_take isl_basic_map *bmap);
 371 __isl_give isl_map *isl_map_compute_divs(__isl_take isl_map *map);
 372 __isl_give isl_map *isl_map_align_divs(__isl_take isl_map *map);
 373
 374 void isl_map_dump(__isl_keep isl_map *map, FILE *out, int indent);
 375
 376 int isl_map_fast_input_is_fixed(struct isl_map *map,
 377                 unsigned in, isl_int *val);
 378 int isl_map_fast_is_fixed(struct isl_map *map,
 379         enum isl_dim_type type, unsigned pos, isl_int *val);
 380
 381 __isl_give isl_basic_map *isl_basic_map_gist(__isl_take isl_basic_map *bmap,
 382         __isl_take isl_basic_map *context);
 383 __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
 384         __isl_take isl_map *context);
 385 __isl_give isl_map *isl_map_gist_basic_map(__isl_take isl_map *map,
 386         __isl_take isl_basic_map *context);
 387
 388 __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
 389
 390 int isl_map_fast_is_equal(__isl_keep isl_map *map1, __isl_keep isl_map *map2);
 391
 392 int isl_map_foreach_basic_map(__isl_keep isl_map *map,
 393         int (*fn)(__isl_take isl_basic_map *bmap, void *user), void *user);
 394
 395 __isl_give isl_map *isl_set_lifting(__isl_take isl_set *set);
 396
 397 __isl_give isl_map *isl_map_power(__isl_take isl_map *map, unsigned param,
 398         int *exact);
 399 __isl_give isl_map *isl_map_transitive_closure(__isl_take isl_map *map,
 400         int *exact);
 401
 402 #if defined(__cplusplus)
 403 }
 404 #endif
 405
 406 #endif