include/isl_map.h

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