add isl_aff_scale_down_val
[platform/upstream/isl.git] / include / isl / space.h
1 /*
2  * Copyright 2008-2009 Katholieke Universiteit Leuven
3  *
4  * Use of this software is governed by the MIT license
5  *
6  * Written by Sven Verdoolaege, K.U.Leuven, Departement
7  * Computerwetenschappen, Celestijnenlaan 200A, B-3001 Leuven, Belgium
8  */
9
10 #ifndef ISL_SPACE_H
11 #define ISL_SPACE_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_space;
22 typedef struct isl_space isl_space;
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_space_get_ctx(__isl_keep isl_space *dim);
35 __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
36                         unsigned nparam, unsigned n_in, unsigned n_out);
37 __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
38                         unsigned nparam, unsigned dim);
39 __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx, unsigned nparam);
40 __isl_give isl_space *isl_space_copy(__isl_keep isl_space *dim);
41 void *isl_space_free(__isl_take isl_space *dim);
42
43 int isl_space_is_params(__isl_keep isl_space *space);
44 int isl_space_is_set(__isl_keep isl_space *space);
45 int isl_space_is_map(__isl_keep isl_space *space);
46
47 __isl_give isl_space *isl_space_set_tuple_name(__isl_take isl_space *dim,
48         enum isl_dim_type type, const char *s);
49 int isl_space_has_tuple_name(__isl_keep isl_space *space,
50         enum isl_dim_type type);
51 const char *isl_space_get_tuple_name(__isl_keep isl_space *dim,
52                                  enum isl_dim_type type);
53 __isl_give isl_space *isl_space_set_tuple_id(__isl_take isl_space *dim,
54         enum isl_dim_type type, __isl_take isl_id *id);
55 __isl_give isl_space *isl_space_reset_tuple_id(__isl_take isl_space *dim,
56         enum isl_dim_type type);
57 int isl_space_has_tuple_id(__isl_keep isl_space *dim, enum isl_dim_type type);
58 __isl_give isl_id *isl_space_get_tuple_id(__isl_keep isl_space *dim,
59         enum isl_dim_type type);
60
61 __isl_give isl_space *isl_space_set_dim_id(__isl_take isl_space *dim,
62         enum isl_dim_type type, unsigned pos, __isl_take isl_id *id);
63 int isl_space_has_dim_id(__isl_keep isl_space *dim,
64         enum isl_dim_type type, unsigned pos);
65 __isl_give isl_id *isl_space_get_dim_id(__isl_keep isl_space *dim,
66         enum isl_dim_type type, unsigned pos);
67
68 int isl_space_find_dim_by_id(__isl_keep isl_space *dim, enum isl_dim_type type,
69         __isl_keep isl_id *id);
70 int isl_space_find_dim_by_name(__isl_keep isl_space *space,
71         enum isl_dim_type type, const char *name);
72
73 int isl_space_has_dim_name(__isl_keep isl_space *space,
74         enum isl_dim_type type, unsigned pos);
75 __isl_give isl_space *isl_space_set_dim_name(__isl_take isl_space *dim,
76                                  enum isl_dim_type type, unsigned pos,
77                                  __isl_keep const char *name);
78 __isl_keep const char *isl_space_get_dim_name(__isl_keep isl_space *dim,
79                                  enum isl_dim_type type, unsigned pos);
80
81 __isl_give isl_space *isl_space_extend(__isl_take isl_space *dim,
82                         unsigned nparam, unsigned n_in, unsigned n_out);
83 __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *dim, enum isl_dim_type type,
84                 unsigned n);
85 __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *dim,
86         enum isl_dim_type dst_type, unsigned dst_pos,
87         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
88 __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *dim,
89         enum isl_dim_type type, unsigned pos, unsigned n);
90 __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
91         __isl_take isl_space *right);
92 __isl_give isl_space *isl_space_product(__isl_take isl_space *left,
93         __isl_take isl_space *right);
94 __isl_give isl_space *isl_space_domain_product(__isl_take isl_space *left,
95         __isl_take isl_space *right);
96 __isl_give isl_space *isl_space_range_product(__isl_take isl_space *left,
97         __isl_take isl_space *right);
98 __isl_give isl_space *isl_space_map_from_set(__isl_take isl_space *dim);
99 __isl_give isl_space *isl_space_map_from_domain_and_range(
100         __isl_take isl_space *domain, __isl_take isl_space *range);
101 __isl_give isl_space *isl_space_reverse(__isl_take isl_space *dim);
102 __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *dim,
103         enum isl_dim_type type, unsigned first, unsigned num);
104 __isl_give isl_space *isl_space_drop_inputs(__isl_take isl_space *dim,
105                 unsigned first, unsigned n);
106 __isl_give isl_space *isl_space_drop_outputs(__isl_take isl_space *dim,
107                 unsigned first, unsigned n);
108 __isl_give isl_space *isl_space_domain(__isl_take isl_space *dim);
109 __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *dim);
110 __isl_give isl_space *isl_space_range(__isl_take isl_space *dim);
111 __isl_give isl_space *isl_space_from_range(__isl_take isl_space *dim);
112 __isl_give isl_space *isl_space_params(__isl_take isl_space *space);
113 __isl_give isl_space *isl_space_set_from_params(__isl_take isl_space *space);
114
115 __isl_give isl_space *isl_space_align_params(__isl_take isl_space *dim1,
116         __isl_take isl_space *dim2);
117
118 int isl_space_is_wrapping(__isl_keep isl_space *dim);
119 __isl_give isl_space *isl_space_wrap(__isl_take isl_space *dim);
120 __isl_give isl_space *isl_space_unwrap(__isl_take isl_space *dim);
121
122 int isl_space_can_zip(__isl_keep isl_space *dim);
123 __isl_give isl_space *isl_space_zip(__isl_take isl_space *dim);
124
125 int isl_space_can_curry(__isl_keep isl_space *space);
126 __isl_give isl_space *isl_space_curry(__isl_take isl_space *space);
127
128 int isl_space_can_uncurry(__isl_keep isl_space *space);
129 __isl_give isl_space *isl_space_uncurry(__isl_take isl_space *space);
130
131 int isl_space_is_domain(__isl_keep isl_space *space1,
132         __isl_keep isl_space *space2);
133 int isl_space_is_range(__isl_keep isl_space *space1,
134         __isl_keep isl_space *space2);
135 int isl_space_is_equal(__isl_keep isl_space *space1,
136         __isl_keep isl_space *space2);
137 int isl_space_match(__isl_keep isl_space *dim1, enum isl_dim_type dim1_type,
138         __isl_keep isl_space *dim2, enum isl_dim_type dim2_type);
139 int isl_space_tuple_match(__isl_keep isl_space *dim1, enum isl_dim_type dim1_type,
140                         __isl_keep isl_space *dim2, enum isl_dim_type dim2_type);
141 int isl_space_compatible(__isl_keep isl_space *dim1,
142         __isl_keep isl_space *dim2);
143 unsigned isl_space_dim(__isl_keep isl_space *dim, enum isl_dim_type type);
144
145 __isl_give isl_printer *isl_printer_print_space(__isl_take isl_printer *p,
146         __isl_keep isl_space *dim);
147 void isl_space_dump(__isl_keep isl_space *dim);
148
149 #if defined(__cplusplus)
150 }
151 #endif
152
153 #endif