add isl_*_has_tuple_id
[platform/upstream/isl.git] / include / isl / dim.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_DIM_H
11 #define ISL_DIM_H
12
13 #include <isl/ctx.h>
14 #include <isl/id.h>
15 #include <isl/printer.h>
16
17 #if defined(__cplusplus)
18 extern "C" {
19 #endif
20
21 struct isl_dim;
22 typedef struct isl_dim isl_dim;
23
24 enum isl_dim_type {
25         isl_dim_cst,
26         isl_dim_param,
27         isl_dim_in,
28         isl_dim_out,
29         isl_dim_set = isl_dim_out,
30         isl_dim_div,
31         isl_dim_all
32 };
33
34 isl_ctx *isl_dim_get_ctx(__isl_keep isl_dim *dim);
35 __isl_give isl_dim *isl_dim_alloc(isl_ctx *ctx,
36                         unsigned nparam, unsigned n_in, unsigned n_out);
37 __isl_give isl_dim *isl_dim_set_alloc(isl_ctx *ctx,
38                         unsigned nparam, unsigned dim);
39 __isl_give isl_dim *isl_dim_copy(__isl_keep isl_dim *dim);
40 struct isl_dim *isl_dim_cow(struct isl_dim *dim);
41 void isl_dim_free(__isl_take isl_dim *dim);
42
43 __isl_give isl_dim *isl_dim_set_tuple_name(__isl_take isl_dim *dim,
44         enum isl_dim_type type, const char *s);
45 const char *isl_dim_get_tuple_name(__isl_keep isl_dim *dim,
46                                  enum isl_dim_type type);
47 __isl_give isl_dim *isl_dim_set_tuple_id(__isl_take isl_dim *dim,
48         enum isl_dim_type type, __isl_take isl_id *id);
49 __isl_give isl_dim *isl_dim_reset_tuple_id(__isl_take isl_dim *dim,
50         enum isl_dim_type type);
51 int isl_dim_has_tuple_id(__isl_keep isl_dim *dim, enum isl_dim_type type);
52 __isl_give isl_id *isl_dim_get_tuple_id(__isl_keep isl_dim *dim,
53         enum isl_dim_type type);
54
55 __isl_give isl_dim *isl_dim_set_dim_id(__isl_take isl_dim *dim,
56         enum isl_dim_type type, unsigned pos, __isl_take isl_id *id);
57 int isl_dim_has_dim_id(__isl_keep isl_dim *dim,
58         enum isl_dim_type type, unsigned pos);
59 __isl_give isl_id *isl_dim_get_dim_id(__isl_keep isl_dim *dim,
60         enum isl_dim_type type, unsigned pos);
61
62 int isl_dim_find_dim_by_id(__isl_keep isl_dim *dim, enum isl_dim_type type,
63         __isl_keep isl_id *id);
64
65 __isl_give isl_dim *isl_dim_set_name(__isl_take isl_dim *dim,
66                                  enum isl_dim_type type, unsigned pos,
67                                  __isl_keep const char *name);
68 __isl_keep const char *isl_dim_get_name(__isl_keep isl_dim *dim,
69                                  enum isl_dim_type type, unsigned pos);
70
71 struct isl_dim *isl_dim_extend(struct isl_dim *dim,
72                         unsigned nparam, unsigned n_in, unsigned n_out);
73 __isl_give isl_dim *isl_dim_add(__isl_take isl_dim *dim, enum isl_dim_type type,
74                 unsigned n);
75 __isl_give isl_dim *isl_dim_move(__isl_take isl_dim *dim,
76         enum isl_dim_type dst_type, unsigned dst_pos,
77         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
78 __isl_give isl_dim *isl_dim_insert(__isl_take isl_dim *dim,
79         enum isl_dim_type type, unsigned pos, unsigned n);
80 __isl_give isl_dim *isl_dim_join(__isl_take isl_dim *left,
81         __isl_take isl_dim *right);
82 struct isl_dim *isl_dim_product(struct isl_dim *left, struct isl_dim *right);
83 __isl_give isl_dim *isl_dim_range_product(__isl_take isl_dim *left,
84         __isl_take isl_dim *right);
85 __isl_give isl_dim *isl_dim_map_from_set(__isl_take isl_dim *dim);
86 __isl_give isl_dim *isl_dim_reverse(__isl_take isl_dim *dim);
87 __isl_give isl_dim *isl_dim_drop(__isl_take isl_dim *dim,
88         enum isl_dim_type type, unsigned first, unsigned num);
89 struct isl_dim *isl_dim_drop_inputs(struct isl_dim *dim,
90                 unsigned first, unsigned n);
91 struct isl_dim *isl_dim_drop_outputs(struct isl_dim *dim,
92                 unsigned first, unsigned n);
93 __isl_give isl_dim *isl_dim_domain(__isl_take isl_dim *dim);
94 __isl_give isl_dim *isl_dim_from_domain(__isl_take isl_dim *dim);
95 __isl_give isl_dim *isl_dim_range(__isl_take isl_dim *dim);
96 __isl_give isl_dim *isl_dim_from_range(__isl_take isl_dim *dim);
97 struct isl_dim *isl_dim_underlying(struct isl_dim *dim, unsigned n_div);
98
99 __isl_give isl_dim *isl_dim_align_params(__isl_take isl_dim *dim1,
100         __isl_take isl_dim *dim2);
101
102 int isl_dim_is_wrapping(__isl_keep isl_dim *dim);
103 __isl_give isl_dim *isl_dim_wrap(__isl_take isl_dim *dim);
104 __isl_give isl_dim *isl_dim_unwrap(__isl_take isl_dim *dim);
105
106 int isl_dim_can_zip(__isl_keep isl_dim *dim);
107 __isl_give isl_dim *isl_dim_zip(__isl_take isl_dim *dim);
108
109 int isl_dim_equal(struct isl_dim *dim1, struct isl_dim *dim2);
110 int isl_dim_match(struct isl_dim *dim1, enum isl_dim_type dim1_type,
111                 struct isl_dim *dim2, enum isl_dim_type dim2_type);
112 int isl_dim_tuple_match(__isl_keep isl_dim *dim1, enum isl_dim_type dim1_type,
113                         __isl_keep isl_dim *dim2, enum isl_dim_type dim2_type);
114 int isl_dim_compatible(struct isl_dim *dim1, struct isl_dim *dim2);
115 unsigned isl_dim_size(__isl_keep isl_dim *dim, enum isl_dim_type type);
116 unsigned isl_dim_total(struct isl_dim *dim);
117
118 __isl_give isl_printer *isl_printer_print_dim(__isl_take isl_printer *p,
119         __isl_keep isl_dim *dim);
120 void isl_dim_dump(__isl_keep isl_dim *dim);
121
122 #if defined(__cplusplus)
123 }
124 #endif
125
126 #endif