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
  10 #if defined(__cplusplus)
  11 extern "C" {
  12 #endif
  13
  14 /* General notes:
  15  *
  16  * All structures are reference counted to allow reuse without duplication.
  17  * A *_copy operation will increase the reference count, while a *_free
  18  * operation will decrease the reference count and only actually release
  19  * the structures when the reference count drops to zero.
  20  *
  21  * Functions that return an isa structure will in general _destroy_
  22  * all argument isa structures (the obvious execption begin the _copy
  23  * functions).  A pointer passed to such a function may therefore
  24  * never be used after the function call.  If you want to keep a
  25  * reference to the old structure(s), use the appropriate _copy function.
  26  */
  27
  28 /* A "basic map" is a relation between two sets of variables,
  29  * called the "in" and "out" variables.
  30  *
  31  * It is implemented as a set with two extra fields:
  32  * n_in is the number of in variables
  33  * n_out is the number of out variables
  34  * n_in + n_out should be equal to set.dim
  35  */
  36 struct isl_vec;
  37 struct isl_basic_map {
  38         int ref;
  39 #define ISL_BASIC_MAP_FINAL             (1 << 0)
  40 #define ISL_BASIC_MAP_EMPTY             (1 << 1)
  41 #define ISL_BASIC_MAP_NO_IMPLICIT       (1 << 2)
  42 #define ISL_BASIC_MAP_NO_REDUNDANT      (1 << 3)
  43 #define ISL_BASIC_MAP_RATIONAL          (1 << 4)
  44         unsigned flags;
  45
  46         unsigned nparam;
  47         unsigned n_in;
  48         unsigned n_out;
  49         unsigned extra;
  50
  51         unsigned n_eq;
  52         unsigned n_ineq;
  53
  54         size_t c_size;
  55         isl_int **eq;
  56         isl_int **ineq;
  57
  58         unsigned n_div;
  59
  60         isl_int **div;
  61
  62         struct isl_vec *sample;
  63
  64         struct isl_blk block;
  65         struct isl_blk block2;
  66 };
  67 struct isl_basic_set;
  68
  69 /* A "map" is a (disjoint) union of basic maps.
  70  *
  71  * Currently, the isl_set structure is identical to the isl_map structure
  72  * and the library depends on this correspondence internally.
  73  * However, users should not depend on this correspondence.
  74  */
  75 struct isl_map {
  76         int ref;
  77 #define ISL_MAP_DISJOINT                (1 << 0)
  78         unsigned flags;
  79
  80         unsigned nparam;
  81         unsigned n_in;
  82         unsigned n_out;
  83
  84         int n;
  85
  86         size_t size;
  87         struct isl_basic_map *p[0];
  88 };
  89 struct isl_set;
  90
  91 struct isl_basic_map *isl_basic_map_alloc(struct isl_ctx *ctx,
  92                 unsigned nparam, unsigned in, unsigned out, unsigned extra,
  93                 unsigned n_eq, unsigned n_ineq);
  94 struct isl_basic_map *isl_basic_map_identity(struct isl_ctx *ctx,
  95                 unsigned nparam, unsigned dim);
  96 struct isl_basic_map *isl_basic_map_finalize(struct isl_ctx *ctx,
  97                 struct isl_basic_map *bmap);
  98 void isl_basic_map_free(struct isl_ctx *ctx, struct isl_basic_map *bmap);
  99 struct isl_basic_map *isl_basic_map_copy(struct isl_ctx *ctx,
 100                                         struct isl_basic_map *bmap);
 101 struct isl_basic_map *isl_basic_map_extend(struct isl_ctx *ctx,
 102                 struct isl_basic_map *base,
 103                 unsigned nparam, unsigned n_in, unsigned n_out, unsigned extra,
 104                 unsigned n_eq, unsigned n_ineq);
 105 struct isl_basic_map *isl_basic_map_equal(struct isl_ctx *ctx,
 106                 unsigned nparam, unsigned in, unsigned out, unsigned n_equal);
 107 struct isl_basic_map *isl_basic_map_less_at(struct isl_ctx *ctx,
 108                 unsigned nparam, unsigned in, unsigned out, unsigned pos);
 109 struct isl_basic_map *isl_basic_map_more_at(struct isl_ctx *ctx,
 110                 unsigned nparam, unsigned in, unsigned out, unsigned pos);
 111 struct isl_basic_map *isl_basic_map_empty(struct isl_ctx *ctx,
 112                 unsigned nparam, unsigned in, unsigned out);
 113 struct isl_basic_map *isl_basic_map_universe(struct isl_ctx *ctx,
 114                 unsigned nparam, unsigned in, unsigned out);
 115
 116 struct isl_basic_map *isl_basic_map_intersect_domain(
 117                 struct isl_ctx *ctx, struct isl_basic_map *bmap,
 118                 struct isl_basic_set *bset);
 119 struct isl_basic_map *isl_basic_map_intersect(
 120                 struct isl_ctx *ctx, struct isl_basic_map *bmap1,
 121                 struct isl_basic_map *bmap2);
 122 struct isl_map *isl_basic_map_union(
 123                 struct isl_ctx *ctx, struct isl_basic_map *bmap1,
 124                 struct isl_basic_map *bmap2);
 125 struct isl_basic_map *isl_basic_map_apply_domain(
 126                 struct isl_ctx *ctx, struct isl_basic_map *bmap1,
 127                 struct isl_basic_map *bmap2);
 128 struct isl_basic_map *isl_basic_map_apply_range(
 129                 struct isl_ctx *ctx, struct isl_basic_map *bmap1,
 130                 struct isl_basic_map *bmap2);
 131 struct isl_basic_map *isl_basic_map_reverse(struct isl_ctx *ctx,
 132                 struct isl_basic_map *bmap);
 133 struct isl_basic_set *isl_basic_map_domain(struct isl_ctx *ctx,
 134                 struct isl_basic_map *bmap);
 135 struct isl_basic_set *isl_basic_map_range(struct isl_ctx *ctx,
 136                 struct isl_basic_map *bmap);
 137 struct isl_basic_map *isl_basic_map_from_basic_set(
 138                 struct isl_ctx *ctx, struct isl_basic_set *bset,
 139                 unsigned n_in, unsigned n_out);
 140 struct isl_basic_set *isl_basic_set_from_basic_map(
 141                 struct isl_ctx *ctx, struct isl_basic_map *bmap);
 142 struct isl_basic_map *isl_basic_map_simplify(
 143                 struct isl_ctx *ctx, struct isl_basic_map *bmap);
 144 #define ISL_FORMAT_POLYLIB      1
 145 #define ISL_FORMAT_OMEGA        2
 146 struct isl_basic_map *isl_basic_map_read_from_file(struct isl_ctx *ctx,
 147                 FILE *input, unsigned nparam, unsigned input_format);
 148
 149 struct isl_map *isl_basic_map_lexmax(struct isl_ctx *ctx,
 150                 struct isl_basic_map *bmap, struct isl_basic_set *dom,
 151                 struct isl_set **empty);
 152 struct isl_map *isl_basic_map_lexmin(struct isl_ctx *ctx,
 153                 struct isl_basic_map *bmap, struct isl_basic_set *dom,
 154                 struct isl_set **empty);
 155
 156 void isl_basic_map_dump(struct isl_ctx *ctx, struct isl_basic_map *bmap,
 157                                 FILE *out, int indent);
 158
 159 int isl_basic_map_is_universe(struct isl_ctx *ctx,
 160                 struct isl_basic_map *bmap);
 161 int isl_basic_map_is_empty(struct isl_ctx *ctx,
 162                 struct isl_basic_map *bmap);
 163 int isl_basic_map_is_subset(struct isl_ctx *ctx,
 164                 struct isl_basic_map *bmap1,
 165                 struct isl_basic_map *bmap2);
 166 int isl_basic_map_is_strict_subset(struct isl_ctx *ctx,
 167                 struct isl_basic_map *bmap1,
 168                 struct isl_basic_map *bmap2);
 169
 170 struct isl_map *isl_map_alloc(struct isl_ctx *ctx,
 171                 unsigned nparam, unsigned in, unsigned out, int n,
 172                 unsigned flags);
 173 struct isl_map *isl_map_empty(struct isl_ctx *ctx,
 174                 unsigned nparam, unsigned in, unsigned out);
 175 struct isl_map *isl_map_dup(struct isl_ctx *ctx, struct isl_map *map);
 176 struct isl_map *isl_map_add(struct isl_ctx *ctx, struct isl_map *map,
 177                                 struct isl_basic_map *bmap);
 178 struct isl_map *isl_map_identity(struct isl_ctx *ctx,
 179                 unsigned nparam, unsigned dim);
 180 struct isl_map *isl_map_finalize(struct isl_ctx *ctx, struct isl_map *map);
 181 void isl_map_free(struct isl_ctx *ctx, struct isl_map *map);
 182 struct isl_map *isl_map_copy(struct isl_ctx *ctx, struct isl_map *map);
 183 struct isl_map *isl_map_extend(struct isl_ctx *ctx, struct isl_map *base,
 184                 unsigned nparam, unsigned n_in, unsigned n_out);
 185 struct isl_map *isl_map_reverse(struct isl_ctx *ctx, struct isl_map *map);
 186 struct isl_map *isl_map_union(struct isl_ctx *ctx,
 187                         struct isl_map *map1, struct isl_map *map2);
 188 struct isl_map *isl_map_union_disjoint(struct isl_ctx *ctx,
 189                         struct isl_map *map1, struct isl_map *map2);
 190 struct isl_map *isl_map_intersect_domain(
 191                 struct isl_ctx *ctx, struct isl_map *map,
 192                 struct isl_set *set);
 193 struct isl_map *isl_map_intersect_range(
 194                 struct isl_ctx *ctx, struct isl_map *map,
 195                 struct isl_set *set);
 196 struct isl_map *isl_map_apply_domain(
 197                 struct isl_ctx *ctx, struct isl_map *map1,
 198                 struct isl_map *map2);
 199 struct isl_map *isl_map_apply_range(
 200                 struct isl_ctx *ctx, struct isl_map *map1,
 201                 struct isl_map *map2);
 202 struct isl_map *isl_map_intersect(struct isl_ctx *ctx, struct isl_map *map1,
 203                 struct isl_map *map2);
 204 struct isl_map *isl_map_subtract(struct isl_ctx *ctx, struct isl_map *map1,
 205                 struct isl_map *map2);
 206 struct isl_map *isl_map_fix_input_si(struct isl_ctx *ctx, struct isl_map *map,
 207                 unsigned input, int value);
 208 struct isl_basic_set *isl_basic_map_deltas(struct isl_ctx *ctx,
 209                                 struct isl_basic_map *bmap);
 210 struct isl_set *isl_map_range(struct isl_ctx *ctx, struct isl_map *map);
 211 struct isl_basic_map *isl_map_affine_hull(struct isl_ctx *ctx,
 212                 struct isl_map *map);
 213
 214 struct isl_set *isl_map_domain(struct isl_ctx *ctx, struct isl_map *bmap);
 215 struct isl_map *isl_map_from_basic_map(struct isl_ctx *ctx,
 216                                 struct isl_basic_map *bmap);
 217 struct isl_map *isl_map_from_set(
 218                 struct isl_ctx *ctx, struct isl_set *set,
 219                 unsigned n_in, unsigned n_out);
 220
 221 int isl_map_is_empty(struct isl_ctx *ctx, struct isl_map *map);
 222 int isl_map_is_subset(struct isl_ctx *ctx, struct isl_map *map1,
 223                 struct isl_map *map2);
 224 int isl_map_is_equal(struct isl_ctx *ctx,
 225                 struct isl_map *map1, struct isl_map *map2);
 226
 227 void isl_map_dump(struct isl_ctx *ctx, struct isl_map *map, FILE *out,
 228                   int indent);
 229
 230 #if defined(__cplusplus)
 231 }
 232 #endif
 233
 234 #endif