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