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_basic_map {
  37         int ref;
  38 #define ISL_BASIC_MAP_FINAL             (1 << 0)
  39 #define ISL_BASIC_MAP_EMPTY             (1 << 1)
  40         unsigned flags;
  41
  42         unsigned nparam;
  43         unsigned n_in;
  44         unsigned n_out;
  45         unsigned extra;
  46
  47         unsigned n_eq;
  48         unsigned n_ineq;
  49
  50         size_t c_size;
  51         isl_int **eq;
  52         isl_int **ineq;
  53
  54         unsigned n_div;
  55
  56         isl_int **div;
  57
  58         struct isl_blk block;
  59         struct isl_blk block2;
  60 };
  61 struct isl_basic_set;
  62
  63 /* A "map" is a (disjoint) union of basic maps.
  64  *
  65  * Currently, the isl_set structure is identical to the isl_map structure
  66  * and the library depends on this correspondence internally.
  67  * However, users should not depend on this correspondence.
  68  */
  69 struct isl_map {
  70         int ref;
  71 #define ISL_MAP_DISJOINT                (1 << 0)
  72         unsigned flags;
  73
  74         unsigned nparam;
  75         unsigned n_in;
  76         unsigned n_out;
  77
  78         int n;
  79
  80         size_t size;
  81         struct isl_basic_map *p[0];
  82 };
  83 struct isl_set;
  84
  85 struct isl_basic_map *isl_basic_map_alloc(struct isl_ctx *ctx,
  86                 unsigned nparam, unsigned in, unsigned out, unsigned extra,
  87                 unsigned n_eq, unsigned n_ineq);
  88 struct isl_basic_map *isl_basic_map_identity(struct isl_ctx *ctx,
  89                 unsigned nparam, unsigned dim);
  90 struct isl_basic_map *isl_basic_map_finalize(struct isl_ctx *ctx,
  91                 struct isl_basic_map *bmap);
  92 void isl_basic_map_free(struct isl_ctx *ctx, struct isl_basic_map *bmap);
  93 struct isl_basic_map *isl_basic_map_copy(struct isl_ctx *ctx,
  94                                         struct isl_basic_map *bmap);
  95 struct isl_basic_map *isl_basic_map_extend(struct isl_ctx *ctx,
  96                 struct isl_basic_map *base,
  97                 unsigned nparam, unsigned n_in, unsigned n_out, unsigned extra,
  98                 unsigned n_eq, unsigned n_ineq);
  99 struct isl_basic_map *isl_basic_map_equal(struct isl_ctx *ctx,
 100                 unsigned nparam, unsigned in, unsigned out, unsigned n_equal);
 101 struct isl_basic_map *isl_basic_map_less_at(struct isl_ctx *ctx,
 102                 unsigned nparam, unsigned in, unsigned out, unsigned pos);
 103 struct isl_basic_map *isl_basic_map_more_at(struct isl_ctx *ctx,
 104                 unsigned nparam, unsigned in, unsigned out, unsigned pos);
 105 struct isl_basic_map *isl_basic_map_empty(struct isl_ctx *ctx,
 106                 unsigned nparam, unsigned in, unsigned out);
 107
 108 struct isl_basic_map *isl_basic_map_intersect_domain(
 109                 struct isl_ctx *ctx, struct isl_basic_map *bmap,
 110                 struct isl_basic_set *bset);
 111 struct isl_basic_map *isl_basic_map_intersect(
 112                 struct isl_ctx *ctx, struct isl_basic_map *bmap1,
 113                 struct isl_basic_map *bmap2);
 114 struct isl_map *isl_basic_map_union(
 115                 struct isl_ctx *ctx, struct isl_basic_map *bmap1,
 116                 struct isl_basic_map *bmap2);
 117 struct isl_basic_map *isl_basic_map_apply_domain(
 118                 struct isl_ctx *ctx, struct isl_basic_map *bmap1,
 119                 struct isl_basic_map *bmap2);
 120 struct isl_basic_map *isl_basic_map_apply_range(
 121                 struct isl_ctx *ctx, struct isl_basic_map *bmap1,
 122                 struct isl_basic_map *bmap2);
 123 struct isl_basic_map *isl_basic_map_reverse(struct isl_ctx *ctx,
 124                 struct isl_basic_map *bmap);
 125 struct isl_basic_set *isl_basic_map_domain(struct isl_ctx *ctx,
 126                 struct isl_basic_map *bmap);
 127 struct isl_basic_set *isl_basic_map_range(struct isl_ctx *ctx,
 128                 struct isl_basic_map *bmap);
 129 struct isl_basic_map *isl_basic_map_from_basic_set(
 130                 struct isl_ctx *ctx, struct isl_basic_set *bset,
 131                 unsigned n_in, unsigned n_out);
 132 struct isl_basic_set *isl_basic_set_from_basic_map(
 133                 struct isl_ctx *ctx, struct isl_basic_map *bmap);
 134 struct isl_basic_map *isl_basic_map_simplify(
 135                 struct isl_ctx *ctx, struct isl_basic_map *bmap);
 136
 137 struct isl_map *isl_basic_map_lexmax(struct isl_ctx *ctx,
 138                 struct isl_basic_map *bmap, struct isl_basic_set *dom,
 139                 struct isl_set **empty);
 140 struct isl_map *isl_basic_map_lexmin(struct isl_ctx *ctx,
 141                 struct isl_basic_map *bmap, struct isl_basic_set *dom,
 142                 struct isl_set **empty);
 143
 144 void isl_basic_map_dump(struct isl_ctx *ctx, struct isl_basic_map *bmap,
 145                                 FILE *out, int indent);
 146
 147 int isl_basic_map_is_empty(struct isl_ctx *ctx,
 148                 struct isl_basic_map *bmap);
 149 int isl_basic_map_is_subset(struct isl_ctx *ctx,
 150                 struct isl_basic_map *bmap1,
 151                 struct isl_basic_map *bmap2);
 152 int isl_basic_map_is_strict_subset(struct isl_ctx *ctx,
 153                 struct isl_basic_map *bmap1,
 154                 struct isl_basic_map *bmap2);
 155
 156 struct isl_map *isl_map_alloc(struct isl_ctx *ctx,
 157                 unsigned nparam, unsigned in, unsigned out, int n,
 158                 unsigned flags);
 159 struct isl_map *isl_map_empty(struct isl_ctx *ctx,
 160                 unsigned nparam, unsigned in, unsigned out);
 161 struct isl_map *isl_map_dup(struct isl_ctx *ctx, struct isl_map *map);
 162 struct isl_map *isl_map_add(struct isl_ctx *ctx, struct isl_map *map,
 163                                 struct isl_basic_map *bmap);
 164 struct isl_map *isl_map_identity(struct isl_ctx *ctx,
 165                 unsigned nparam, unsigned dim);
 166 struct isl_map *isl_map_finalize(struct isl_ctx *ctx, struct isl_map *map);
 167 void isl_map_free(struct isl_ctx *ctx, struct isl_map *map);
 168 struct isl_map *isl_map_copy(struct isl_ctx *ctx, struct isl_map *map);
 169 struct isl_map *isl_map_extend(struct isl_ctx *ctx, struct isl_map *base,
 170                 unsigned nparam, unsigned n_in, unsigned n_out);
 171 struct isl_map *isl_map_reverse(struct isl_ctx *ctx, struct isl_map *map);
 172 struct isl_map *isl_map_union(struct isl_ctx *ctx,
 173                         struct isl_map *map1, struct isl_map *map2);
 174 struct isl_map *isl_map_union_disjoint(struct isl_ctx *ctx,
 175                         struct isl_map *map1, struct isl_map *map2);
 176 struct isl_map *isl_map_intersect_domain(
 177                 struct isl_ctx *ctx, struct isl_map *map,
 178                 struct isl_set *set);
 179 struct isl_map *isl_map_intersect_range(
 180                 struct isl_ctx *ctx, struct isl_map *map,
 181                 struct isl_set *set);
 182 struct isl_map *isl_map_apply_domain(
 183                 struct isl_ctx *ctx, struct isl_map *map1,
 184                 struct isl_map *map2);
 185 struct isl_map *isl_map_apply_range(
 186                 struct isl_ctx *ctx, struct isl_map *map1,
 187                 struct isl_map *map2);
 188 struct isl_map *isl_map_intersect(struct isl_ctx *ctx, struct isl_map *map1,
 189                 struct isl_map *map2);
 190 struct isl_map *isl_map_subtract(struct isl_ctx *ctx, struct isl_map *map1,
 191                 struct isl_map *map2);
 192 struct isl_map *isl_map_fix_input_si(struct isl_ctx *ctx, struct isl_map *map,
 193                 unsigned input, int value);
 194 struct isl_basic_set *isl_basic_map_deltas(struct isl_ctx *ctx,
 195                                 struct isl_basic_map *bmap);
 196 struct isl_set *isl_map_range(struct isl_ctx *ctx, struct isl_map *map);
 197 struct isl_basic_map *isl_map_affine_hull(struct isl_ctx *ctx,
 198                 struct isl_map *map);
 199
 200 struct isl_set *isl_map_domain(struct isl_ctx *ctx, struct isl_map *bmap);
 201 struct isl_map *isl_map_from_basic_map(struct isl_ctx *ctx,
 202                                 struct isl_basic_map *bmap);
 203 struct isl_map *isl_map_from_set(
 204                 struct isl_ctx *ctx, struct isl_set *set,
 205                 unsigned n_in, unsigned n_out);
 206
 207 int isl_map_is_empty(struct isl_ctx *ctx, struct isl_map *map);
 208 int isl_map_is_subset(struct isl_ctx *ctx, struct isl_map *map1,
 209                 struct isl_map *map2);
 210 int isl_map_is_equal(struct isl_ctx *ctx,
 211                 struct isl_map *map1, struct isl_map *map2);
 212
 213 void isl_map_dump(struct isl_ctx *ctx, struct isl_map *map, FILE *out,
 214                   int indent);
 215
 216 #if defined(__cplusplus)
 217 }
 218 #endif
 219
 220 #endif