add isl_dim_align_params
[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
15 #if defined(__cplusplus)
16 extern "C" {
17 #endif
18
19 struct isl_dim;
20 typedef struct isl_dim isl_dim;
21
22 enum isl_dim_type {
23         isl_dim_cst,
24         isl_dim_param,
25         isl_dim_in,
26         isl_dim_out,
27         isl_dim_set = isl_dim_out,
28         isl_dim_div,
29         isl_dim_all
30 };
31
32 isl_ctx *isl_dim_get_ctx(__isl_keep isl_dim *dim);
33 __isl_give isl_dim *isl_dim_alloc(isl_ctx *ctx,
34                         unsigned nparam, unsigned n_in, unsigned n_out);
35 __isl_give isl_dim *isl_dim_set_alloc(isl_ctx *ctx,
36                         unsigned nparam, unsigned dim);
37 __isl_give isl_dim *isl_dim_copy(__isl_keep isl_dim *dim);
38 struct isl_dim *isl_dim_cow(struct isl_dim *dim);
39 void isl_dim_free(__isl_take isl_dim *dim);
40
41 __isl_give isl_dim *isl_dim_set_tuple_name(__isl_take isl_dim *dim,
42         enum isl_dim_type type, const char *s);
43 const char *isl_dim_get_tuple_name(__isl_keep isl_dim *dim,
44                                  enum isl_dim_type type);
45
46 __isl_give isl_dim *isl_dim_set_name(__isl_take isl_dim *dim,
47                                  enum isl_dim_type type, unsigned pos,
48                                  __isl_keep const char *name);
49 __isl_keep const char *isl_dim_get_name(__isl_keep isl_dim *dim,
50                                  enum isl_dim_type type, unsigned pos);
51
52 struct isl_dim *isl_dim_extend(struct isl_dim *dim,
53                         unsigned nparam, unsigned n_in, unsigned n_out);
54 __isl_give isl_dim *isl_dim_add(__isl_take isl_dim *dim, enum isl_dim_type type,
55                 unsigned n);
56 __isl_give isl_dim *isl_dim_move(__isl_take isl_dim *dim,
57         enum isl_dim_type dst_type, unsigned dst_pos,
58         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
59 __isl_give isl_dim *isl_dim_insert(__isl_take isl_dim *dim,
60         enum isl_dim_type type, unsigned pos, unsigned n);
61 __isl_give isl_dim *isl_dim_join(__isl_take isl_dim *left,
62         __isl_take isl_dim *right);
63 struct isl_dim *isl_dim_product(struct isl_dim *left, struct isl_dim *right);
64 __isl_give isl_dim *isl_dim_range_product(__isl_take isl_dim *left,
65         __isl_take isl_dim *right);
66 __isl_give isl_dim *isl_dim_map_from_set(__isl_take isl_dim *dim);
67 __isl_give isl_dim *isl_dim_reverse(__isl_take isl_dim *dim);
68 __isl_give isl_dim *isl_dim_drop(__isl_take isl_dim *dim,
69         enum isl_dim_type type, unsigned first, unsigned num);
70 struct isl_dim *isl_dim_drop_inputs(struct isl_dim *dim,
71                 unsigned first, unsigned n);
72 struct isl_dim *isl_dim_drop_outputs(struct isl_dim *dim,
73                 unsigned first, unsigned n);
74 __isl_give isl_dim *isl_dim_domain(__isl_take isl_dim *dim);
75 __isl_give isl_dim *isl_dim_from_domain(__isl_take isl_dim *dim);
76 __isl_give isl_dim *isl_dim_range(__isl_take isl_dim *dim);
77 __isl_give isl_dim *isl_dim_from_range(__isl_take isl_dim *dim);
78 struct isl_dim *isl_dim_underlying(struct isl_dim *dim, unsigned n_div);
79
80 __isl_give isl_dim *isl_dim_align_params(__isl_take isl_dim *dim1,
81         __isl_take isl_dim *dim2);
82
83 int isl_dim_is_wrapping(__isl_keep isl_dim *dim);
84 __isl_give isl_dim *isl_dim_wrap(__isl_take isl_dim *dim);
85 __isl_give isl_dim *isl_dim_unwrap(__isl_take isl_dim *dim);
86
87 int isl_dim_can_zip(__isl_keep isl_dim *dim);
88 __isl_give isl_dim *isl_dim_zip(__isl_take isl_dim *dim);
89
90 int isl_dim_equal(struct isl_dim *dim1, struct isl_dim *dim2);
91 int isl_dim_match(struct isl_dim *dim1, enum isl_dim_type dim1_type,
92                 struct isl_dim *dim2, enum isl_dim_type dim2_type);
93 int isl_dim_tuple_match(__isl_keep isl_dim *dim1, enum isl_dim_type dim1_type,
94                         __isl_keep isl_dim *dim2, enum isl_dim_type dim2_type);
95 int isl_dim_compatible(struct isl_dim *dim1, struct isl_dim *dim2);
96 unsigned isl_dim_size(__isl_keep isl_dim *dim, enum isl_dim_type type);
97 unsigned isl_dim_total(struct isl_dim *dim);
98
99 #if defined(__cplusplus)
100 }
101 #endif
102
103 #endif