add isl_constraint_set_coefficient_val
[platform/upstream/isl.git] / doc / user.pod
1 =head1 Introduction
2
3 C<isl> is a thread-safe C library for manipulating
4 sets and relations of integer points bounded by affine constraints.
5 The descriptions of the sets and relations may involve
6 both parameters and existentially quantified variables.
7 All computations are performed in exact integer arithmetic
8 using C<GMP>.
9 The C<isl> library offers functionality that is similar
10 to that offered by the C<Omega> and C<Omega+> libraries,
11 but the underlying algorithms are in most cases completely different.
12
13 The library is by no means complete and some fairly basic
14 functionality is still missing.
15 Still, even in its current form, the library has been successfully
16 used as a backend polyhedral library for the polyhedral
17 scanner C<CLooG> and as part of an equivalence checker of
18 static affine programs.
19 For bug reports, feature requests and questions,
20 visit the the discussion group at
21 L<http://groups.google.com/group/isl-development>.
22
23 =head2 Backward Incompatible Changes
24
25 =head3 Changes since isl-0.02
26
27 =over
28
29 =item * The old printing functions have been deprecated
30 and replaced by C<isl_printer> functions, see L<Input and Output>.
31
32 =item * Most functions related to dependence analysis have acquired
33 an extra C<must> argument.  To obtain the old behavior, this argument
34 should be given the value 1.  See L<Dependence Analysis>.
35
36 =back
37
38 =head3 Changes since isl-0.03
39
40 =over
41
42 =item * The function C<isl_pw_qpolynomial_fold_add> has been
43 renamed to C<isl_pw_qpolynomial_fold_fold>.
44 Similarly, C<isl_union_pw_qpolynomial_fold_add> has been
45 renamed to C<isl_union_pw_qpolynomial_fold_fold>.
46
47 =back
48
49 =head3 Changes since isl-0.04
50
51 =over
52
53 =item * All header files have been renamed from C<isl_header.h>
54 to C<isl/header.h>.
55
56 =back
57
58 =head3 Changes since isl-0.05
59
60 =over
61
62 =item * The functions C<isl_printer_print_basic_set> and
63 C<isl_printer_print_basic_map> no longer print a newline.
64
65 =item * The functions C<isl_flow_get_no_source>
66 and C<isl_union_map_compute_flow> now return
67 the accesses for which no source could be found instead of
68 the iterations where those accesses occur.
69
70 =item * The functions C<isl_basic_map_identity> and
71 C<isl_map_identity> now take a B<map> space as input.  An old call
72 C<isl_map_identity(space)> can be rewritten to
73 C<isl_map_identity(isl_space_map_from_set(space))>.
74
75 =item * The function C<isl_map_power> no longer takes
76 a parameter position as input.  Instead, the exponent
77 is now expressed as the domain of the resulting relation.
78
79 =back
80
81 =head3 Changes since isl-0.06
82
83 =over
84
85 =item * The format of C<isl_printer_print_qpolynomial>'s
86 C<ISL_FORMAT_ISL> output has changed.
87 Use C<ISL_FORMAT_C> to obtain the old output.
88
89 =item * The C<*_fast_*> functions have been renamed to C<*_plain_*>.
90 Some of the old names have been kept for backward compatibility,
91 but they will be removed in the future.
92
93 =back
94
95 =head3 Changes since isl-0.07
96
97 =over
98
99 =item * The function C<isl_pw_aff_max> has been renamed to
100 C<isl_pw_aff_union_max>.
101 Similarly, the function C<isl_pw_aff_add> has been renamed to
102 C<isl_pw_aff_union_add>.
103
104 =item * The C<isl_dim> type has been renamed to C<isl_space>
105 along with the associated functions.
106 Some of the old names have been kept for backward compatibility,
107 but they will be removed in the future.
108
109 =item * Spaces of maps, sets and parameter domains are now
110 treated differently.  The distinction between map spaces and set spaces
111 has always been made on a conceptual level, but proper use of such spaces
112 was never checked.  Furthermore, up until isl-0.07 there was no way
113 of explicitly creating a parameter space.  These can now be created
114 directly using C<isl_space_params_alloc> or from other spaces using
115 C<isl_space_params>.
116
117 =item * The space in which C<isl_aff>, C<isl_pw_aff>, C<isl_qpolynomial>,
118 C<isl_pw_qpolynomial>, C<isl_qpolynomial_fold> and C<isl_pw_qpolynomial_fold>
119 objects live is now a map space
120 instead of a set space.  This means, for example, that the dimensions
121 of the domain of an C<isl_aff> are now considered to be of type
122 C<isl_dim_in> instead of C<isl_dim_set>.  Extra functions have been
123 added to obtain the domain space.  Some of the constructors still
124 take a domain space and have therefore been renamed.
125
126 =item * The functions C<isl_equality_alloc> and C<isl_inequality_alloc>
127 now take an C<isl_local_space> instead of an C<isl_space>.
128 An C<isl_local_space> can be created from an C<isl_space>
129 using C<isl_local_space_from_space>.
130
131 =item * The C<isl_div> type has been removed.  Functions that used
132 to return an C<isl_div> now return an C<isl_aff>.
133 Note that the space of an C<isl_aff> is that of relation.
134 When replacing a call to C<isl_div_get_coefficient> by a call to
135 C<isl_aff_get_coefficient> any C<isl_dim_set> argument needs
136 to be replaced by C<isl_dim_in>.
137 A call to C<isl_aff_from_div> can be replaced by a call
138 to C<isl_aff_floor>.
139 A call to C<isl_qpolynomial_div(div)> call be replaced by
140 the nested call
141
142         isl_qpolynomial_from_aff(isl_aff_floor(div))
143
144 The function C<isl_constraint_div> has also been renamed
145 to C<isl_constraint_get_div>.
146
147 =item * The C<nparam> argument has been removed from
148 C<isl_map_read_from_str> and similar functions.
149 When reading input in the original PolyLib format,
150 the result will have no parameters.
151 If parameters are expected, the caller may want to perform
152 dimension manipulation on the result.
153
154 =back
155
156 =head3 Changes since isl-0.09
157
158 =over
159
160 =item * The C<schedule_split_parallel> option has been replaced
161 by the C<schedule_split_scaled> option.
162
163 =item * The first argument of C<isl_pw_aff_cond> is now
164 an C<isl_pw_aff> instead of an C<isl_set>.
165 A call C<isl_pw_aff_cond(a, b, c)> can be replaced by
166
167         isl_pw_aff_cond(isl_set_indicator_function(a), b, c)
168
169 =back
170
171 =head3 Changes since isl-0.10
172
173 =over
174
175 =item * The functions C<isl_set_dim_has_lower_bound> and
176 C<isl_set_dim_has_upper_bound> have been renamed to
177 C<isl_set_dim_has_any_lower_bound> and
178 C<isl_set_dim_has_any_upper_bound>.
179 The new C<isl_set_dim_has_lower_bound> and
180 C<isl_set_dim_has_upper_bound> have slightly different meanings.
181
182 =back
183
184 =head1 License
185
186 C<isl> is released under the MIT license.
187
188 =over
189
190 Permission is hereby granted, free of charge, to any person obtaining a copy of
191 this software and associated documentation files (the "Software"), to deal in
192 the Software without restriction, including without limitation the rights to
193 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
194 of the Software, and to permit persons to whom the Software is furnished to do
195 so, subject to the following conditions:
196
197 The above copyright notice and this permission notice shall be included in all
198 copies or substantial portions of the Software.
199
200 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
201 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
202 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
203 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
204 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
205 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
206 SOFTWARE.
207
208 =back
209
210 Note that C<isl> currently requires C<GMP>, which is released
211 under the GNU Lesser General Public License (LGPL).  This means
212 that code linked against C<isl> is also linked against LGPL code.
213
214 =head1 Installation
215
216 The source of C<isl> can be obtained either as a tarball
217 or from the git repository.  Both are available from
218 L<http://freshmeat.net/projects/isl/>.
219 The installation process depends on how you obtained
220 the source.
221
222 =head2 Installation from the git repository
223
224 =over
225
226 =item 1 Clone or update the repository
227
228 The first time the source is obtained, you need to clone
229 the repository.
230
231         git clone git://repo.or.cz/isl.git
232
233 To obtain updates, you need to pull in the latest changes
234
235         git pull
236
237 =item 2 Generate C<configure>
238
239         ./autogen.sh
240
241 =back
242
243 After performing the above steps, continue
244 with the L<Common installation instructions>.
245
246 =head2 Common installation instructions
247
248 =over
249
250 =item 1 Obtain C<GMP>
251
252 Building C<isl> requires C<GMP>, including its headers files.
253 Your distribution may not provide these header files by default
254 and you may need to install a package called C<gmp-devel> or something
255 similar.  Alternatively, C<GMP> can be built from
256 source, available from L<http://gmplib.org/>.
257
258 =item 2 Configure
259
260 C<isl> uses the standard C<autoconf> C<configure> script.
261 To run it, just type
262
263         ./configure
264
265 optionally followed by some configure options.
266 A complete list of options can be obtained by running
267
268         ./configure --help
269
270 Below we discuss some of the more common options.
271
272 C<isl> can optionally use C<piplib>, but no
273 C<piplib> functionality is currently used by default.
274 The C<--with-piplib> option can
275 be used to specify which C<piplib>
276 library to use, either an installed version (C<system>),
277 an externally built version (C<build>)
278 or no version (C<no>).  The option C<build> is mostly useful
279 in C<configure> scripts of larger projects that bundle both C<isl>
280 and C<piplib>.
281
282 =over
283
284 =item C<--prefix>
285
286 Installation prefix for C<isl>
287
288 =item C<--with-gmp-prefix>
289
290 Installation prefix for C<GMP> (architecture-independent files).
291
292 =item C<--with-gmp-exec-prefix>
293
294 Installation prefix for C<GMP> (architecture-dependent files).
295
296 =item C<--with-piplib>
297
298 Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
299
300 =item C<--with-piplib-prefix>
301
302 Installation prefix for C<system> C<piplib> (architecture-independent files).
303
304 =item C<--with-piplib-exec-prefix>
305
306 Installation prefix for C<system> C<piplib> (architecture-dependent files).
307
308 =item C<--with-piplib-builddir>
309
310 Location where C<build> C<piplib> was built.
311
312 =back
313
314 =item 3 Compile
315
316         make
317
318 =item 4 Install (optional)
319
320         make install
321
322 =back
323
324 =head1 Integer Set Library
325
326 =head2 Initialization
327
328 All manipulations of integer sets and relations occur within
329 the context of an C<isl_ctx>.
330 A given C<isl_ctx> can only be used within a single thread.
331 All arguments of a function are required to have been allocated
332 within the same context.
333 There are currently no functions available for moving an object
334 from one C<isl_ctx> to another C<isl_ctx>.  This means that
335 there is currently no way of safely moving an object from one
336 thread to another, unless the whole C<isl_ctx> is moved.
337
338 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
339 freed using C<isl_ctx_free>.
340 All objects allocated within an C<isl_ctx> should be freed
341 before the C<isl_ctx> itself is freed.
342
343         isl_ctx *isl_ctx_alloc();
344         void isl_ctx_free(isl_ctx *ctx);
345
346 =head2 Values
347
348 An C<isl_val> represents an integer value, a rational value
349 or one of three special values, infinity, negative infinity and NaN.
350 Some predefined values can be created using the following functions.
351
352         #include <isl/val.h>
353         __isl_give isl_val *isl_val_zero(isl_ctx *ctx);
354         __isl_give isl_val *isl_val_one(isl_ctx *ctx);
355         __isl_give isl_val *isl_val_nan(isl_ctx *ctx);
356         __isl_give isl_val *isl_val_infty(isl_ctx *ctx);
357         __isl_give isl_val *isl_val_neginfty(isl_ctx *ctx);
358
359 Specific integer values can be created using the following functions.
360
361         #include <isl/val.h>
362         __isl_give isl_val *isl_val_int_from_si(isl_ctx *ctx,
363                 long i);
364         __isl_give isl_val *isl_val_int_from_ui(isl_ctx *ctx,
365                 unsigned long u);
366
367 They can be copied and freed using the following functions.
368
369         #include <isl/val.h>
370         __isl_give isl_val *isl_val_copy(__isl_keep isl_val *v);
371         void *isl_val_free(__isl_take isl_val *v);
372
373 They can be inspected using the following functions.
374
375         #include <isl/val.h>
376         isl_ctx *isl_val_get_ctx(__isl_keep isl_val *val);
377         long isl_val_get_num_si(__isl_keep isl_val *v);
378         long isl_val_get_den_si(__isl_keep isl_val *v);
379         double isl_val_get_d(__isl_keep isl_val *v);
380
381 Note that C<isl_val_get_num_si>, C<isl_val_get_den_si> and
382 C<isl_val_get_d> can only be applied to rational values.
383
384 An C<isl_val> can be modified using the following function.
385
386         #include <isl/val.h>
387         __isl_give isl_val *isl_val_set_si(__isl_take isl_val *v,
388                 long i);
389
390 The following unary properties are defined on C<isl_val>s.
391
392         #include <isl/val.h>
393         int isl_val_sgn(__isl_keep isl_val *v);
394         int isl_val_is_zero(__isl_keep isl_val *v);
395         int isl_val_is_one(__isl_keep isl_val *v);
396         int isl_val_is_negone(__isl_keep isl_val *v);
397         int isl_val_is_nonneg(__isl_keep isl_val *v);
398         int isl_val_is_nonpos(__isl_keep isl_val *v);
399         int isl_val_is_pos(__isl_keep isl_val *v);
400         int isl_val_is_neg(__isl_keep isl_val *v);
401         int isl_val_is_int(__isl_keep isl_val *v);
402         int isl_val_is_rat(__isl_keep isl_val *v);
403         int isl_val_is_nan(__isl_keep isl_val *v);
404         int isl_val_is_infty(__isl_keep isl_val *v);
405         int isl_val_is_neginfty(__isl_keep isl_val *v);
406
407 Note that the sign of NaN is undefined.
408
409 The following binary properties are defined on pairs of C<isl_val>s.
410
411         #include <isl/val.h>
412         int isl_val_lt(__isl_keep isl_val *v1,
413                 __isl_keep isl_val *v2);
414         int isl_val_le(__isl_keep isl_val *v1,
415                 __isl_keep isl_val *v2);
416         int isl_val_gt(__isl_keep isl_val *v1,
417                 __isl_keep isl_val *v2);
418         int isl_val_ge(__isl_keep isl_val *v1,
419                 __isl_keep isl_val *v2);
420         int isl_val_eq(__isl_keep isl_val *v1,
421                 __isl_keep isl_val *v2);
422         int isl_val_ne(__isl_keep isl_val *v1,
423                 __isl_keep isl_val *v2);
424
425 For integer C<isl_val>s we additionally have the following binary property.
426
427         #include <isl/val.h>
428         int isl_val_is_divisible_by(__isl_keep isl_val *v1,
429                 __isl_keep isl_val *v2);
430
431 An C<isl_val> can also be compared to an integer using the following
432 function.  The result is undefined for NaN.
433
434         #include <isl/val.h>
435         int isl_val_cmp_si(__isl_keep isl_val *v, long i);
436
437 The following unary operations are available on C<isl_val>s.
438
439         #include <isl/val.h>
440         __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
441         __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
442         __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
443         __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
444         __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
445
446 The following binary operations are available on C<isl_val>s.
447
448         #include <isl/val.h>
449         __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
450         __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
451         __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
452         __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
453         __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
454         __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
455         __isl_give isl_val *isl_val_min(__isl_take isl_val *v1,
456                 __isl_take isl_val *v2);
457         __isl_give isl_val *isl_val_max(__isl_take isl_val *v1,
458                 __isl_take isl_val *v2);
459         __isl_give isl_val *isl_val_add(__isl_take isl_val *v1,
460                 __isl_take isl_val *v2);
461         __isl_give isl_val *isl_val_add_ui(__isl_take isl_val *v1,
462                 unsigned long v2);
463         __isl_give isl_val *isl_val_sub(__isl_take isl_val *v1,
464                 __isl_take isl_val *v2);
465         __isl_give isl_val *isl_val_sub_ui(__isl_take isl_val *v1,
466                 unsigned long v2);
467         __isl_give isl_val *isl_val_mul(__isl_take isl_val *v1,
468                 __isl_take isl_val *v2);
469         __isl_give isl_val *isl_val_mul_ui(__isl_take isl_val *v1,
470                 unsigned long v2);
471         __isl_give isl_val *isl_val_div(__isl_take isl_val *v1,
472                 __isl_take isl_val *v2);
473
474 On integer values, we additionally have the following operations.
475
476         #include <isl/val.h>
477         __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
478         __isl_give isl_val *isl_val_mod(__isl_take isl_val *v1,
479                 __isl_take isl_val *v2);
480         __isl_give isl_val *isl_val_gcd(__isl_take isl_val *v1,
481                 __isl_take isl_val *v2);
482         __isl_give isl_val *isl_val_gcdext(__isl_take isl_val *v1,
483                 __isl_take isl_val *v2, __isl_give isl_val **x,
484                 __isl_give isl_val **y);
485
486 The function C<isl_val_gcdext> returns the greatest common divisor g
487 of C<v1> and C<v2> as well as two integers C<*x> and C<*y> such
488 that C<*x> * C<v1> + C<*y> * C<v2> = g.
489
490 A value can be read from input using
491
492         #include <isl/val.h>
493         __isl_give isl_val *isl_val_read_from_str(isl_ctx *ctx,
494                 const char *str);
495
496 A value can be printed using
497
498         #include <isl/val.h>
499         __isl_give isl_printer *isl_printer_print_val(
500                 __isl_take isl_printer *p, __isl_keep isl_val *v);
501
502 =head3 GMP specific functions
503
504 These functions are only available if C<isl> has been compiled with C<GMP>
505 support.
506
507 Specific integer and rational values can be created from C<GMP> values using
508 the following functions.
509
510         #include <isl/val_gmp.h>
511         __isl_give isl_val *isl_val_int_from_gmp(isl_ctx *ctx,
512                 mpz_t z);
513         __isl_give isl_val *isl_val_from_gmp(isl_ctx *ctx,
514                 const mpz_t n, const mpz_t d);
515
516 The numerator and denominator of a rational value can be extracted as
517 C<GMP> values using the following functions.
518
519         #include <isl/val_gmp.h>
520         int isl_val_get_num_gmp(__isl_keep isl_val *v, mpz_t z);
521         int isl_val_get_den_gmp(__isl_keep isl_val *v, mpz_t z);
522
523 =head2 Integers (obsolescent)
524
525 All operations on integers, mainly the coefficients
526 of the constraints describing the sets and relations,
527 are performed in exact integer arithmetic using C<GMP>.
528 However, to allow future versions of C<isl> to optionally
529 support fixed integer arithmetic, all calls to C<GMP>
530 are wrapped inside C<isl> specific macros.
531 The basic type is C<isl_int> and the operations below
532 are available on this type.
533 The meanings of these operations are essentially the same
534 as their C<GMP> C<mpz_> counterparts.
535 As always with C<GMP> types, C<isl_int>s need to be
536 initialized with C<isl_int_init> before they can be used
537 and they need to be released with C<isl_int_clear>
538 after the last use.
539 The user should not assume that an C<isl_int> is represented
540 as a C<mpz_t>, but should instead explicitly convert between
541 C<mpz_t>s and C<isl_int>s using C<isl_int_set_gmp> and
542 C<isl_int_get_gmp> whenever a C<mpz_t> is required.
543
544 =over
545
546 =item isl_int_init(i)
547
548 =item isl_int_clear(i)
549
550 =item isl_int_set(r,i)
551
552 =item isl_int_set_si(r,i)
553
554 =item isl_int_set_gmp(r,g)
555
556 =item isl_int_get_gmp(i,g)
557
558 =item isl_int_abs(r,i)
559
560 =item isl_int_neg(r,i)
561
562 =item isl_int_swap(i,j)
563
564 =item isl_int_swap_or_set(i,j)
565
566 =item isl_int_add_ui(r,i,j)
567
568 =item isl_int_sub_ui(r,i,j)
569
570 =item isl_int_add(r,i,j)
571
572 =item isl_int_sub(r,i,j)
573
574 =item isl_int_mul(r,i,j)
575
576 =item isl_int_mul_ui(r,i,j)
577
578 =item isl_int_addmul(r,i,j)
579
580 =item isl_int_submul(r,i,j)
581
582 =item isl_int_gcd(r,i,j)
583
584 =item isl_int_lcm(r,i,j)
585
586 =item isl_int_divexact(r,i,j)
587
588 =item isl_int_cdiv_q(r,i,j)
589
590 =item isl_int_fdiv_q(r,i,j)
591
592 =item isl_int_fdiv_r(r,i,j)
593
594 =item isl_int_fdiv_q_ui(r,i,j)
595
596 =item isl_int_read(r,s)
597
598 =item isl_int_print(out,i,width)
599
600 =item isl_int_sgn(i)
601
602 =item isl_int_cmp(i,j)
603
604 =item isl_int_cmp_si(i,si)
605
606 =item isl_int_eq(i,j)
607
608 =item isl_int_ne(i,j)
609
610 =item isl_int_lt(i,j)
611
612 =item isl_int_le(i,j)
613
614 =item isl_int_gt(i,j)
615
616 =item isl_int_ge(i,j)
617
618 =item isl_int_abs_eq(i,j)
619
620 =item isl_int_abs_ne(i,j)
621
622 =item isl_int_abs_lt(i,j)
623
624 =item isl_int_abs_gt(i,j)
625
626 =item isl_int_abs_ge(i,j)
627
628 =item isl_int_is_zero(i)
629
630 =item isl_int_is_one(i)
631
632 =item isl_int_is_negone(i)
633
634 =item isl_int_is_pos(i)
635
636 =item isl_int_is_neg(i)
637
638 =item isl_int_is_nonpos(i)
639
640 =item isl_int_is_nonneg(i)
641
642 =item isl_int_is_divisible_by(i,j)
643
644 =back
645
646 =head2 Sets and Relations
647
648 C<isl> uses six types of objects for representing sets and relations,
649 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
650 C<isl_union_set> and C<isl_union_map>.
651 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
652 can be described as a conjunction of affine constraints, while
653 C<isl_set> and C<isl_map> represent unions of
654 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
655 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
656 to live in the same space.  C<isl_union_set>s and C<isl_union_map>s
657 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
658 where spaces are considered different if they have a different number
659 of dimensions and/or different names (see L<"Spaces">).
660 The difference between sets and relations (maps) is that sets have
661 one set of variables, while relations have two sets of variables,
662 input variables and output variables.
663
664 =head2 Memory Management
665
666 Since a high-level operation on sets and/or relations usually involves
667 several substeps and since the user is usually not interested in
668 the intermediate results, most functions that return a new object
669 will also release all the objects passed as arguments.
670 If the user still wants to use one or more of these arguments
671 after the function call, she should pass along a copy of the
672 object rather than the object itself.
673 The user is then responsible for making sure that the original
674 object gets used somewhere else or is explicitly freed.
675
676 The arguments and return values of all documented functions are
677 annotated to make clear which arguments are released and which
678 arguments are preserved.  In particular, the following annotations
679 are used
680
681 =over
682
683 =item C<__isl_give>
684
685 C<__isl_give> means that a new object is returned.
686 The user should make sure that the returned pointer is
687 used exactly once as a value for an C<__isl_take> argument.
688 In between, it can be used as a value for as many
689 C<__isl_keep> arguments as the user likes.
690 There is one exception, and that is the case where the
691 pointer returned is C<NULL>.  Is this case, the user
692 is free to use it as an C<__isl_take> argument or not.
693
694 =item C<__isl_take>
695
696 C<__isl_take> means that the object the argument points to
697 is taken over by the function and may no longer be used
698 by the user as an argument to any other function.
699 The pointer value must be one returned by a function
700 returning an C<__isl_give> pointer.
701 If the user passes in a C<NULL> value, then this will
702 be treated as an error in the sense that the function will
703 not perform its usual operation.  However, it will still
704 make sure that all the other C<__isl_take> arguments
705 are released.
706
707 =item C<__isl_keep>
708
709 C<__isl_keep> means that the function will only use the object
710 temporarily.  After the function has finished, the user
711 can still use it as an argument to other functions.
712 A C<NULL> value will be treated in the same way as
713 a C<NULL> value for an C<__isl_take> argument.
714
715 =back
716
717 =head2 Error Handling
718
719 C<isl> supports different ways to react in case a runtime error is triggered.
720 Runtime errors arise, e.g., if a function such as C<isl_map_intersect> is called
721 with two maps that have incompatible spaces. There are three possible ways
722 to react on error: to warn, to continue or to abort.
723
724 The default behavior is to warn. In this mode, C<isl> prints a warning, stores
725 the last error in the corresponding C<isl_ctx> and the function in which the
726 error was triggered returns C<NULL>. An error does not corrupt internal state,
727 such that isl can continue to be used. C<isl> also provides functions to
728 read the last error and to reset the memory that stores the last error. The
729 last error is only stored for information purposes. Its presence does not
730 change the behavior of C<isl>. Hence, resetting an error is not required to
731 continue to use isl, but only to observe new errors.
732
733         #include <isl/ctx.h>
734         enum isl_error isl_ctx_last_error(isl_ctx *ctx);
735         void isl_ctx_reset_error(isl_ctx *ctx);
736
737 Another option is to continue on error. This is similar to warn on error mode,
738 except that C<isl> does not print any warning. This allows a program to
739 implement its own error reporting.
740
741 The last option is to directly abort the execution of the program from within
742 the isl library. This makes it obviously impossible to recover from an error,
743 but it allows to directly spot the error location. By aborting on error,
744 debuggers break at the location the error occurred and can provide a stack
745 trace. Other tools that automatically provide stack traces on abort or that do
746 not want to continue execution after an error was triggered may also prefer to
747 abort on error.
748
749 The on error behavior of isl can be specified by calling
750 C<isl_options_set_on_error> or by setting the command line option
751 C<--isl-on-error>. Valid arguments for the function call are
752 C<ISL_ON_ERROR_WARN>, C<ISL_ON_ERROR_CONTINUE> and C<ISL_ON_ERROR_ABORT>. The
753 choices for the command line option are C<warn>, C<continue> and C<abort>.
754 It is also possible to query the current error mode.
755
756         #include <isl/options.h>
757         int isl_options_set_on_error(isl_ctx *ctx, int val);
758         int isl_options_get_on_error(isl_ctx *ctx);
759
760 =head2 Identifiers
761
762 Identifiers are used to identify both individual dimensions
763 and tuples of dimensions.  They consist of an optional name and an optional
764 user pointer.  The name and the user pointer cannot both be C<NULL>, however.
765 Identifiers with the same name but different pointer values
766 are considered to be distinct.
767 Similarly, identifiers with different names but the same pointer value
768 are also considered to be distinct.
769 Equal identifiers are represented using the same object.
770 Pairs of identifiers can therefore be tested for equality using the
771 C<==> operator.
772 Identifiers can be constructed, copied, freed, inspected and printed
773 using the following functions.
774
775         #include <isl/id.h>
776         __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
777                 __isl_keep const char *name, void *user);
778         __isl_give isl_id *isl_id_set_free_user(
779                 __isl_take isl_id *id,
780                 __isl_give void (*free_user)(void *user));
781         __isl_give isl_id *isl_id_copy(isl_id *id);
782         void *isl_id_free(__isl_take isl_id *id);
783
784         isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
785         void *isl_id_get_user(__isl_keep isl_id *id);
786         __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
787
788         __isl_give isl_printer *isl_printer_print_id(
789                 __isl_take isl_printer *p, __isl_keep isl_id *id);
790
791 The callback set by C<isl_id_set_free_user> is called on the user
792 pointer when the last reference to the C<isl_id> is freed.
793 Note that C<isl_id_get_name> returns a pointer to some internal
794 data structure, so the result can only be used while the
795 corresponding C<isl_id> is alive.
796
797 =head2 Spaces
798
799 Whenever a new set, relation or similiar object is created from scratch,
800 the space in which it lives needs to be specified using an C<isl_space>.
801 Each space involves zero or more parameters and zero, one or two
802 tuples of set or input/output dimensions.  The parameters and dimensions
803 are identified by an C<isl_dim_type> and a position.
804 The type C<isl_dim_param> refers to parameters,
805 the type C<isl_dim_set> refers to set dimensions (for spaces
806 with a single tuple of dimensions) and the types C<isl_dim_in>
807 and C<isl_dim_out> refer to input and output dimensions
808 (for spaces with two tuples of dimensions).
809 Local spaces (see L</"Local Spaces">) also contain dimensions
810 of type C<isl_dim_div>.
811 Note that parameters are only identified by their position within
812 a given object.  Across different objects, parameters are (usually)
813 identified by their names or identifiers.  Only unnamed parameters
814 are identified by their positions across objects.  The use of unnamed
815 parameters is discouraged.
816
817         #include <isl/space.h>
818         __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
819                 unsigned nparam, unsigned n_in, unsigned n_out);
820         __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
821                 unsigned nparam);
822         __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
823                 unsigned nparam, unsigned dim);
824         __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
825         void *isl_space_free(__isl_take isl_space *space);
826         unsigned isl_space_dim(__isl_keep isl_space *space,
827                 enum isl_dim_type type);
828
829 The space used for creating a parameter domain
830 needs to be created using C<isl_space_params_alloc>.
831 For other sets, the space
832 needs to be created using C<isl_space_set_alloc>, while
833 for a relation, the space
834 needs to be created using C<isl_space_alloc>.
835 C<isl_space_dim> can be used
836 to find out the number of dimensions of each type in
837 a space, where type may be
838 C<isl_dim_param>, C<isl_dim_in> (only for relations),
839 C<isl_dim_out> (only for relations), C<isl_dim_set>
840 (only for sets) or C<isl_dim_all>.
841
842 To check whether a given space is that of a set or a map
843 or whether it is a parameter space, use these functions:
844
845         #include <isl/space.h>
846         int isl_space_is_params(__isl_keep isl_space *space);
847         int isl_space_is_set(__isl_keep isl_space *space);
848         int isl_space_is_map(__isl_keep isl_space *space);
849
850 Spaces can be compared using the following functions:
851
852         #include <isl/space.h>
853         int isl_space_is_equal(__isl_keep isl_space *space1,
854                 __isl_keep isl_space *space2);
855         int isl_space_is_domain(__isl_keep isl_space *space1,
856                 __isl_keep isl_space *space2);
857         int isl_space_is_range(__isl_keep isl_space *space1,
858                 __isl_keep isl_space *space2);
859
860 C<isl_space_is_domain> checks whether the first argument is equal
861 to the domain of the second argument.  This requires in particular that
862 the first argument is a set space and that the second argument
863 is a map space.
864
865 It is often useful to create objects that live in the
866 same space as some other object.  This can be accomplished
867 by creating the new objects
868 (see L<Creating New Sets and Relations> or
869 L<Creating New (Piecewise) Quasipolynomials>) based on the space
870 of the original object.
871
872         #include <isl/set.h>
873         __isl_give isl_space *isl_basic_set_get_space(
874                 __isl_keep isl_basic_set *bset);
875         __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
876
877         #include <isl/union_set.h>
878         __isl_give isl_space *isl_union_set_get_space(
879                 __isl_keep isl_union_set *uset);
880
881         #include <isl/map.h>
882         __isl_give isl_space *isl_basic_map_get_space(
883                 __isl_keep isl_basic_map *bmap);
884         __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
885
886         #include <isl/union_map.h>
887         __isl_give isl_space *isl_union_map_get_space(
888                 __isl_keep isl_union_map *umap);
889
890         #include <isl/constraint.h>
891         __isl_give isl_space *isl_constraint_get_space(
892                 __isl_keep isl_constraint *constraint);
893
894         #include <isl/polynomial.h>
895         __isl_give isl_space *isl_qpolynomial_get_domain_space(
896                 __isl_keep isl_qpolynomial *qp);
897         __isl_give isl_space *isl_qpolynomial_get_space(
898                 __isl_keep isl_qpolynomial *qp);
899         __isl_give isl_space *isl_qpolynomial_fold_get_space(
900                 __isl_keep isl_qpolynomial_fold *fold);
901         __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
902                 __isl_keep isl_pw_qpolynomial *pwqp);
903         __isl_give isl_space *isl_pw_qpolynomial_get_space(
904                 __isl_keep isl_pw_qpolynomial *pwqp);
905         __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
906                 __isl_keep isl_pw_qpolynomial_fold *pwf);
907         __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
908                 __isl_keep isl_pw_qpolynomial_fold *pwf);
909         __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
910                 __isl_keep isl_union_pw_qpolynomial *upwqp);
911         __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
912                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
913
914         #include <isl/val.h>
915         __isl_give isl_space *isl_multi_val_get_space(
916                 __isl_keep isl_multi_val *mv);
917
918         #include <isl/aff.h>
919         __isl_give isl_space *isl_aff_get_domain_space(
920                 __isl_keep isl_aff *aff);
921         __isl_give isl_space *isl_aff_get_space(
922                 __isl_keep isl_aff *aff);
923         __isl_give isl_space *isl_pw_aff_get_domain_space(
924                 __isl_keep isl_pw_aff *pwaff);
925         __isl_give isl_space *isl_pw_aff_get_space(
926                 __isl_keep isl_pw_aff *pwaff);
927         __isl_give isl_space *isl_multi_aff_get_domain_space(
928                 __isl_keep isl_multi_aff *maff);
929         __isl_give isl_space *isl_multi_aff_get_space(
930                 __isl_keep isl_multi_aff *maff);
931         __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
932                 __isl_keep isl_pw_multi_aff *pma);
933         __isl_give isl_space *isl_pw_multi_aff_get_space(
934                 __isl_keep isl_pw_multi_aff *pma);
935         __isl_give isl_space *isl_union_pw_multi_aff_get_space(
936                 __isl_keep isl_union_pw_multi_aff *upma);
937         __isl_give isl_space *isl_multi_pw_aff_get_domain_space(
938                 __isl_keep isl_multi_pw_aff *mpa);
939         __isl_give isl_space *isl_multi_pw_aff_get_space(
940                 __isl_keep isl_multi_pw_aff *mpa);
941
942         #include <isl/point.h>
943         __isl_give isl_space *isl_point_get_space(
944                 __isl_keep isl_point *pnt);
945
946 The identifiers or names of the individual dimensions may be set or read off
947 using the following functions.
948
949         #include <isl/space.h>
950         __isl_give isl_space *isl_space_set_dim_id(
951                 __isl_take isl_space *space,
952                 enum isl_dim_type type, unsigned pos,
953                 __isl_take isl_id *id);
954         int isl_space_has_dim_id(__isl_keep isl_space *space,
955                 enum isl_dim_type type, unsigned pos);
956         __isl_give isl_id *isl_space_get_dim_id(
957                 __isl_keep isl_space *space,
958                 enum isl_dim_type type, unsigned pos);
959         __isl_give isl_space *isl_space_set_dim_name(
960                 __isl_take isl_space *space,
961                  enum isl_dim_type type, unsigned pos,
962                  __isl_keep const char *name);
963         int isl_space_has_dim_name(__isl_keep isl_space *space,
964                 enum isl_dim_type type, unsigned pos);
965         __isl_keep const char *isl_space_get_dim_name(
966                 __isl_keep isl_space *space,
967                 enum isl_dim_type type, unsigned pos);
968
969 Note that C<isl_space_get_name> returns a pointer to some internal
970 data structure, so the result can only be used while the
971 corresponding C<isl_space> is alive.
972 Also note that every function that operates on two sets or relations
973 requires that both arguments have the same parameters.  This also
974 means that if one of the arguments has named parameters, then the
975 other needs to have named parameters too and the names need to match.
976 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
977 arguments may have different parameters (as long as they are named),
978 in which case the result will have as parameters the union of the parameters of
979 the arguments.
980
981 Given the identifier or name of a dimension (typically a parameter),
982 its position can be obtained from the following function.
983
984         #include <isl/space.h>
985         int isl_space_find_dim_by_id(__isl_keep isl_space *space,
986                 enum isl_dim_type type, __isl_keep isl_id *id);
987         int isl_space_find_dim_by_name(__isl_keep isl_space *space,
988                 enum isl_dim_type type, const char *name);
989
990 The identifiers or names of entire spaces may be set or read off
991 using the following functions.
992
993         #include <isl/space.h>
994         __isl_give isl_space *isl_space_set_tuple_id(
995                 __isl_take isl_space *space,
996                 enum isl_dim_type type, __isl_take isl_id *id);
997         __isl_give isl_space *isl_space_reset_tuple_id(
998                 __isl_take isl_space *space, enum isl_dim_type type);
999         int isl_space_has_tuple_id(__isl_keep isl_space *space,
1000                 enum isl_dim_type type);
1001         __isl_give isl_id *isl_space_get_tuple_id(
1002                 __isl_keep isl_space *space, enum isl_dim_type type);
1003         __isl_give isl_space *isl_space_set_tuple_name(
1004                 __isl_take isl_space *space,
1005                 enum isl_dim_type type, const char *s);
1006         int isl_space_has_tuple_name(__isl_keep isl_space *space,
1007                 enum isl_dim_type type);
1008         const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
1009                 enum isl_dim_type type);
1010
1011 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
1012 or C<isl_dim_set>.  As with C<isl_space_get_name>,
1013 the C<isl_space_get_tuple_name> function returns a pointer to some internal
1014 data structure.
1015 Binary operations require the corresponding spaces of their arguments
1016 to have the same name.
1017
1018 Spaces can be nested.  In particular, the domain of a set or
1019 the domain or range of a relation can be a nested relation.
1020 The following functions can be used to construct and deconstruct
1021 such nested spaces.
1022
1023         #include <isl/space.h>
1024         int isl_space_is_wrapping(__isl_keep isl_space *space);
1025         __isl_give isl_space *isl_space_wrap(__isl_take isl_space *space);
1026         __isl_give isl_space *isl_space_unwrap(__isl_take isl_space *space);
1027
1028 The input to C<isl_space_is_wrapping> and C<isl_space_unwrap> should
1029 be the space of a set, while that of
1030 C<isl_space_wrap> should be the space of a relation.
1031 Conversely, the output of C<isl_space_unwrap> is the space
1032 of a relation, while that of C<isl_space_wrap> is the space of a set.
1033
1034 Spaces can be created from other spaces
1035 using the following functions.
1036
1037         __isl_give isl_space *isl_space_domain(__isl_take isl_space *space);
1038         __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *space);
1039         __isl_give isl_space *isl_space_range(__isl_take isl_space *space);
1040         __isl_give isl_space *isl_space_from_range(__isl_take isl_space *space);
1041         __isl_give isl_space *isl_space_params(
1042                 __isl_take isl_space *space);
1043         __isl_give isl_space *isl_space_set_from_params(
1044                 __isl_take isl_space *space);
1045         __isl_give isl_space *isl_space_reverse(__isl_take isl_space *space);
1046         __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
1047                 __isl_take isl_space *right);
1048         __isl_give isl_space *isl_space_align_params(
1049                 __isl_take isl_space *space1, __isl_take isl_space *space2)
1050         __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *space,
1051                 enum isl_dim_type type, unsigned pos, unsigned n);
1052         __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *space,
1053                 enum isl_dim_type type, unsigned n);
1054         __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *space,
1055                 enum isl_dim_type type, unsigned first, unsigned n);
1056         __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *space,
1057                 enum isl_dim_type dst_type, unsigned dst_pos,
1058                 enum isl_dim_type src_type, unsigned src_pos,
1059                 unsigned n);
1060         __isl_give isl_space *isl_space_map_from_set(
1061                 __isl_take isl_space *space);
1062         __isl_give isl_space *isl_space_map_from_domain_and_range(
1063                 __isl_take isl_space *domain,
1064                 __isl_take isl_space *range);
1065         __isl_give isl_space *isl_space_zip(__isl_take isl_space *space);
1066         __isl_give isl_space *isl_space_curry(
1067                 __isl_take isl_space *space);
1068         __isl_give isl_space *isl_space_uncurry(
1069                 __isl_take isl_space *space);
1070
1071 Note that if dimensions are added or removed from a space, then
1072 the name and the internal structure are lost.
1073
1074 =head2 Local Spaces
1075
1076 A local space is essentially a space with
1077 zero or more existentially quantified variables.
1078 The local space of a (constraint of a) basic set or relation can be obtained
1079 using the following functions.
1080
1081         #include <isl/constraint.h>
1082         __isl_give isl_local_space *isl_constraint_get_local_space(
1083                 __isl_keep isl_constraint *constraint);
1084
1085         #include <isl/set.h>
1086         __isl_give isl_local_space *isl_basic_set_get_local_space(
1087                 __isl_keep isl_basic_set *bset);
1088
1089         #include <isl/map.h>
1090         __isl_give isl_local_space *isl_basic_map_get_local_space(
1091                 __isl_keep isl_basic_map *bmap);
1092
1093 A new local space can be created from a space using
1094
1095         #include <isl/local_space.h>
1096         __isl_give isl_local_space *isl_local_space_from_space(
1097                 __isl_take isl_space *space);
1098
1099 They can be inspected, modified, copied and freed using the following functions.
1100
1101         #include <isl/local_space.h>
1102         isl_ctx *isl_local_space_get_ctx(
1103                 __isl_keep isl_local_space *ls);
1104         int isl_local_space_is_set(__isl_keep isl_local_space *ls);
1105         int isl_local_space_dim(__isl_keep isl_local_space *ls,
1106                 enum isl_dim_type type);
1107         int isl_local_space_has_dim_id(
1108                 __isl_keep isl_local_space *ls,
1109                 enum isl_dim_type type, unsigned pos);
1110         __isl_give isl_id *isl_local_space_get_dim_id(
1111                 __isl_keep isl_local_space *ls,
1112                 enum isl_dim_type type, unsigned pos);
1113         int isl_local_space_has_dim_name(
1114                 __isl_keep isl_local_space *ls,
1115                 enum isl_dim_type type, unsigned pos)
1116         const char *isl_local_space_get_dim_name(
1117                 __isl_keep isl_local_space *ls,
1118                 enum isl_dim_type type, unsigned pos);
1119         __isl_give isl_local_space *isl_local_space_set_dim_name(
1120                 __isl_take isl_local_space *ls,
1121                 enum isl_dim_type type, unsigned pos, const char *s);
1122         __isl_give isl_local_space *isl_local_space_set_dim_id(
1123                 __isl_take isl_local_space *ls,
1124                 enum isl_dim_type type, unsigned pos,
1125                 __isl_take isl_id *id);
1126         __isl_give isl_space *isl_local_space_get_space(
1127                 __isl_keep isl_local_space *ls);
1128         __isl_give isl_aff *isl_local_space_get_div(
1129                 __isl_keep isl_local_space *ls, int pos);
1130         __isl_give isl_local_space *isl_local_space_copy(
1131                 __isl_keep isl_local_space *ls);
1132         void *isl_local_space_free(__isl_take isl_local_space *ls);
1133
1134 Note that C<isl_local_space_get_div> can only be used on local spaces
1135 of sets.
1136
1137 Two local spaces can be compared using
1138
1139         int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
1140                 __isl_keep isl_local_space *ls2);
1141
1142 Local spaces can be created from other local spaces
1143 using the following functions.
1144
1145         __isl_give isl_local_space *isl_local_space_domain(
1146                 __isl_take isl_local_space *ls);
1147         __isl_give isl_local_space *isl_local_space_range(
1148                 __isl_take isl_local_space *ls);
1149         __isl_give isl_local_space *isl_local_space_from_domain(
1150                 __isl_take isl_local_space *ls);
1151         __isl_give isl_local_space *isl_local_space_intersect(
1152                 __isl_take isl_local_space *ls1,
1153                 __isl_take isl_local_space *ls2);
1154         __isl_give isl_local_space *isl_local_space_add_dims(
1155                 __isl_take isl_local_space *ls,
1156                 enum isl_dim_type type, unsigned n);
1157         __isl_give isl_local_space *isl_local_space_insert_dims(
1158                 __isl_take isl_local_space *ls,
1159                 enum isl_dim_type type, unsigned first, unsigned n);
1160         __isl_give isl_local_space *isl_local_space_drop_dims(
1161                 __isl_take isl_local_space *ls,
1162                 enum isl_dim_type type, unsigned first, unsigned n);
1163
1164 =head2 Input and Output
1165
1166 C<isl> supports its own input/output format, which is similar
1167 to the C<Omega> format, but also supports the C<PolyLib> format
1168 in some cases.
1169
1170 =head3 C<isl> format
1171
1172 The C<isl> format is similar to that of C<Omega>, but has a different
1173 syntax for describing the parameters and allows for the definition
1174 of an existentially quantified variable as the integer division
1175 of an affine expression.
1176 For example, the set of integers C<i> between C<0> and C<n>
1177 such that C<i % 10 <= 6> can be described as
1178
1179         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
1180                                 i - 10 a <= 6) }
1181
1182 A set or relation can have several disjuncts, separated
1183 by the keyword C<or>.  Each disjunct is either a conjunction
1184 of constraints or a projection (C<exists>) of a conjunction
1185 of constraints.  The constraints are separated by the keyword
1186 C<and>.
1187
1188 =head3 C<PolyLib> format
1189
1190 If the represented set is a union, then the first line
1191 contains a single number representing the number of disjuncts.
1192 Otherwise, a line containing the number C<1> is optional.
1193
1194 Each disjunct is represented by a matrix of constraints.
1195 The first line contains two numbers representing
1196 the number of rows and columns,
1197 where the number of rows is equal to the number of constraints
1198 and the number of columns is equal to two plus the number of variables.
1199 The following lines contain the actual rows of the constraint matrix.
1200 In each row, the first column indicates whether the constraint
1201 is an equality (C<0>) or inequality (C<1>).  The final column
1202 corresponds to the constant term.
1203
1204 If the set is parametric, then the coefficients of the parameters
1205 appear in the last columns before the constant column.
1206 The coefficients of any existentially quantified variables appear
1207 between those of the set variables and those of the parameters.
1208
1209 =head3 Extended C<PolyLib> format
1210
1211 The extended C<PolyLib> format is nearly identical to the
1212 C<PolyLib> format.  The only difference is that the line
1213 containing the number of rows and columns of a constraint matrix
1214 also contains four additional numbers:
1215 the number of output dimensions, the number of input dimensions,
1216 the number of local dimensions (i.e., the number of existentially
1217 quantified variables) and the number of parameters.
1218 For sets, the number of ``output'' dimensions is equal
1219 to the number of set dimensions, while the number of ``input''
1220 dimensions is zero.
1221
1222 =head3 Input
1223
1224         #include <isl/set.h>
1225         __isl_give isl_basic_set *isl_basic_set_read_from_file(
1226                 isl_ctx *ctx, FILE *input);
1227         __isl_give isl_basic_set *isl_basic_set_read_from_str(
1228                 isl_ctx *ctx, const char *str);
1229         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
1230                 FILE *input);
1231         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
1232                 const char *str);
1233
1234         #include <isl/map.h>
1235         __isl_give isl_basic_map *isl_basic_map_read_from_file(
1236                 isl_ctx *ctx, FILE *input);
1237         __isl_give isl_basic_map *isl_basic_map_read_from_str(
1238                 isl_ctx *ctx, const char *str);
1239         __isl_give isl_map *isl_map_read_from_file(
1240                 isl_ctx *ctx, FILE *input);
1241         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
1242                 const char *str);
1243
1244         #include <isl/union_set.h>
1245         __isl_give isl_union_set *isl_union_set_read_from_file(
1246                 isl_ctx *ctx, FILE *input);
1247         __isl_give isl_union_set *isl_union_set_read_from_str(
1248                 isl_ctx *ctx, const char *str);
1249
1250         #include <isl/union_map.h>
1251         __isl_give isl_union_map *isl_union_map_read_from_file(
1252                 isl_ctx *ctx, FILE *input);
1253         __isl_give isl_union_map *isl_union_map_read_from_str(
1254                 isl_ctx *ctx, const char *str);
1255
1256 The input format is autodetected and may be either the C<PolyLib> format
1257 or the C<isl> format.
1258
1259 =head3 Output
1260
1261 Before anything can be printed, an C<isl_printer> needs to
1262 be created.
1263
1264         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
1265                 FILE *file);
1266         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
1267         void *isl_printer_free(__isl_take isl_printer *printer);
1268         __isl_give char *isl_printer_get_str(
1269                 __isl_keep isl_printer *printer);
1270
1271 The printer can be inspected using the following functions.
1272
1273         FILE *isl_printer_get_file(
1274                 __isl_keep isl_printer *printer);
1275         int isl_printer_get_output_format(
1276                 __isl_keep isl_printer *p);
1277
1278 The behavior of the printer can be modified in various ways
1279
1280         __isl_give isl_printer *isl_printer_set_output_format(
1281                 __isl_take isl_printer *p, int output_format);
1282         __isl_give isl_printer *isl_printer_set_indent(
1283                 __isl_take isl_printer *p, int indent);
1284         __isl_give isl_printer *isl_printer_indent(
1285                 __isl_take isl_printer *p, int indent);
1286         __isl_give isl_printer *isl_printer_set_prefix(
1287                 __isl_take isl_printer *p, const char *prefix);
1288         __isl_give isl_printer *isl_printer_set_suffix(
1289                 __isl_take isl_printer *p, const char *suffix);
1290
1291 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
1292 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
1293 and defaults to C<ISL_FORMAT_ISL>.
1294 Each line in the output is indented by C<indent> (set by
1295 C<isl_printer_set_indent>) spaces
1296 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
1297 In the C<PolyLib> format output,
1298 the coefficients of the existentially quantified variables
1299 appear between those of the set variables and those
1300 of the parameters.
1301 The function C<isl_printer_indent> increases the indentation
1302 by the specified amount (which may be negative).
1303
1304 To actually print something, use
1305
1306         #include <isl/printer.h>
1307         __isl_give isl_printer *isl_printer_print_double(
1308                 __isl_take isl_printer *p, double d);
1309
1310         #include <isl/set.h>
1311         __isl_give isl_printer *isl_printer_print_basic_set(
1312                 __isl_take isl_printer *printer,
1313                 __isl_keep isl_basic_set *bset);
1314         __isl_give isl_printer *isl_printer_print_set(
1315                 __isl_take isl_printer *printer,
1316                 __isl_keep isl_set *set);
1317
1318         #include <isl/map.h>
1319         __isl_give isl_printer *isl_printer_print_basic_map(
1320                 __isl_take isl_printer *printer,
1321                 __isl_keep isl_basic_map *bmap);
1322         __isl_give isl_printer *isl_printer_print_map(
1323                 __isl_take isl_printer *printer,
1324                 __isl_keep isl_map *map);
1325
1326         #include <isl/union_set.h>
1327         __isl_give isl_printer *isl_printer_print_union_set(
1328                 __isl_take isl_printer *p,
1329                 __isl_keep isl_union_set *uset);
1330
1331         #include <isl/union_map.h>
1332         __isl_give isl_printer *isl_printer_print_union_map(
1333                 __isl_take isl_printer *p,
1334                 __isl_keep isl_union_map *umap);
1335
1336 When called on a file printer, the following function flushes
1337 the file.  When called on a string printer, the buffer is cleared.
1338
1339         __isl_give isl_printer *isl_printer_flush(
1340                 __isl_take isl_printer *p);
1341
1342 =head2 Creating New Sets and Relations
1343
1344 C<isl> has functions for creating some standard sets and relations.
1345
1346 =over
1347
1348 =item * Empty sets and relations
1349
1350         __isl_give isl_basic_set *isl_basic_set_empty(
1351                 __isl_take isl_space *space);
1352         __isl_give isl_basic_map *isl_basic_map_empty(
1353                 __isl_take isl_space *space);
1354         __isl_give isl_set *isl_set_empty(
1355                 __isl_take isl_space *space);
1356         __isl_give isl_map *isl_map_empty(
1357                 __isl_take isl_space *space);
1358         __isl_give isl_union_set *isl_union_set_empty(
1359                 __isl_take isl_space *space);
1360         __isl_give isl_union_map *isl_union_map_empty(
1361                 __isl_take isl_space *space);
1362
1363 For C<isl_union_set>s and C<isl_union_map>s, the space
1364 is only used to specify the parameters.
1365
1366 =item * Universe sets and relations
1367
1368         __isl_give isl_basic_set *isl_basic_set_universe(
1369                 __isl_take isl_space *space);
1370         __isl_give isl_basic_map *isl_basic_map_universe(
1371                 __isl_take isl_space *space);
1372         __isl_give isl_set *isl_set_universe(
1373                 __isl_take isl_space *space);
1374         __isl_give isl_map *isl_map_universe(
1375                 __isl_take isl_space *space);
1376         __isl_give isl_union_set *isl_union_set_universe(
1377                 __isl_take isl_union_set *uset);
1378         __isl_give isl_union_map *isl_union_map_universe(
1379                 __isl_take isl_union_map *umap);
1380
1381 The sets and relations constructed by the functions above
1382 contain all integer values, while those constructed by the
1383 functions below only contain non-negative values.
1384
1385         __isl_give isl_basic_set *isl_basic_set_nat_universe(
1386                 __isl_take isl_space *space);
1387         __isl_give isl_basic_map *isl_basic_map_nat_universe(
1388                 __isl_take isl_space *space);
1389         __isl_give isl_set *isl_set_nat_universe(
1390                 __isl_take isl_space *space);
1391         __isl_give isl_map *isl_map_nat_universe(
1392                 __isl_take isl_space *space);
1393
1394 =item * Identity relations
1395
1396         __isl_give isl_basic_map *isl_basic_map_identity(
1397                 __isl_take isl_space *space);
1398         __isl_give isl_map *isl_map_identity(
1399                 __isl_take isl_space *space);
1400
1401 The number of input and output dimensions in C<space> needs
1402 to be the same.
1403
1404 =item * Lexicographic order
1405
1406         __isl_give isl_map *isl_map_lex_lt(
1407                 __isl_take isl_space *set_space);
1408         __isl_give isl_map *isl_map_lex_le(
1409                 __isl_take isl_space *set_space);
1410         __isl_give isl_map *isl_map_lex_gt(
1411                 __isl_take isl_space *set_space);
1412         __isl_give isl_map *isl_map_lex_ge(
1413                 __isl_take isl_space *set_space);
1414         __isl_give isl_map *isl_map_lex_lt_first(
1415                 __isl_take isl_space *space, unsigned n);
1416         __isl_give isl_map *isl_map_lex_le_first(
1417                 __isl_take isl_space *space, unsigned n);
1418         __isl_give isl_map *isl_map_lex_gt_first(
1419                 __isl_take isl_space *space, unsigned n);
1420         __isl_give isl_map *isl_map_lex_ge_first(
1421                 __isl_take isl_space *space, unsigned n);
1422
1423 The first four functions take a space for a B<set>
1424 and return relations that express that the elements in the domain
1425 are lexicographically less
1426 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1427 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1428 than the elements in the range.
1429 The last four functions take a space for a map
1430 and return relations that express that the first C<n> dimensions
1431 in the domain are lexicographically less
1432 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1433 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1434 than the first C<n> dimensions in the range.
1435
1436 =back
1437
1438 A basic set or relation can be converted to a set or relation
1439 using the following functions.
1440
1441         __isl_give isl_set *isl_set_from_basic_set(
1442                 __isl_take isl_basic_set *bset);
1443         __isl_give isl_map *isl_map_from_basic_map(
1444                 __isl_take isl_basic_map *bmap);
1445
1446 Sets and relations can be converted to union sets and relations
1447 using the following functions.
1448
1449         __isl_give isl_union_set *isl_union_set_from_basic_set(
1450                 __isl_take isl_basic_set *bset);
1451         __isl_give isl_union_map *isl_union_map_from_basic_map(
1452                 __isl_take isl_basic_map *bmap);
1453         __isl_give isl_union_set *isl_union_set_from_set(
1454                 __isl_take isl_set *set);
1455         __isl_give isl_union_map *isl_union_map_from_map(
1456                 __isl_take isl_map *map);
1457
1458 The inverse conversions below can only be used if the input
1459 union set or relation is known to contain elements in exactly one
1460 space.
1461
1462         __isl_give isl_set *isl_set_from_union_set(
1463                 __isl_take isl_union_set *uset);
1464         __isl_give isl_map *isl_map_from_union_map(
1465                 __isl_take isl_union_map *umap);
1466
1467 A zero-dimensional (basic) set can be constructed on a given parameter domain
1468 using the following function.
1469
1470         __isl_give isl_basic_set *isl_basic_set_from_params(
1471                 __isl_take isl_basic_set *bset);
1472         __isl_give isl_set *isl_set_from_params(
1473                 __isl_take isl_set *set);
1474
1475 Sets and relations can be copied and freed again using the following
1476 functions.
1477
1478         __isl_give isl_basic_set *isl_basic_set_copy(
1479                 __isl_keep isl_basic_set *bset);
1480         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1481         __isl_give isl_union_set *isl_union_set_copy(
1482                 __isl_keep isl_union_set *uset);
1483         __isl_give isl_basic_map *isl_basic_map_copy(
1484                 __isl_keep isl_basic_map *bmap);
1485         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1486         __isl_give isl_union_map *isl_union_map_copy(
1487                 __isl_keep isl_union_map *umap);
1488         void *isl_basic_set_free(__isl_take isl_basic_set *bset);
1489         void *isl_set_free(__isl_take isl_set *set);
1490         void *isl_union_set_free(__isl_take isl_union_set *uset);
1491         void *isl_basic_map_free(__isl_take isl_basic_map *bmap);
1492         void *isl_map_free(__isl_take isl_map *map);
1493         void *isl_union_map_free(__isl_take isl_union_map *umap);
1494
1495 Other sets and relations can be constructed by starting
1496 from a universe set or relation, adding equality and/or
1497 inequality constraints and then projecting out the
1498 existentially quantified variables, if any.
1499 Constraints can be constructed, manipulated and
1500 added to (or removed from) (basic) sets and relations
1501 using the following functions.
1502
1503         #include <isl/constraint.h>
1504         __isl_give isl_constraint *isl_equality_alloc(
1505                 __isl_take isl_local_space *ls);
1506         __isl_give isl_constraint *isl_inequality_alloc(
1507                 __isl_take isl_local_space *ls);
1508         __isl_give isl_constraint *isl_constraint_set_constant(
1509                 __isl_take isl_constraint *constraint, isl_int v);
1510         __isl_give isl_constraint *isl_constraint_set_constant_si(
1511                 __isl_take isl_constraint *constraint, int v);
1512         __isl_give isl_constraint *isl_constraint_set_constant_val(
1513                 __isl_take isl_constraint *constraint,
1514                 __isl_take isl_val *v);
1515         __isl_give isl_constraint *isl_constraint_set_coefficient(
1516                 __isl_take isl_constraint *constraint,
1517                 enum isl_dim_type type, int pos, isl_int v);
1518         __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1519                 __isl_take isl_constraint *constraint,
1520                 enum isl_dim_type type, int pos, int v);
1521         __isl_give isl_constraint *
1522         isl_constraint_set_coefficient_val(
1523                 __isl_take isl_constraint *constraint,
1524                 enum isl_dim_type type, int pos, isl_val *v);
1525         __isl_give isl_basic_map *isl_basic_map_add_constraint(
1526                 __isl_take isl_basic_map *bmap,
1527                 __isl_take isl_constraint *constraint);
1528         __isl_give isl_basic_set *isl_basic_set_add_constraint(
1529                 __isl_take isl_basic_set *bset,
1530                 __isl_take isl_constraint *constraint);
1531         __isl_give isl_map *isl_map_add_constraint(
1532                 __isl_take isl_map *map,
1533                 __isl_take isl_constraint *constraint);
1534         __isl_give isl_set *isl_set_add_constraint(
1535                 __isl_take isl_set *set,
1536                 __isl_take isl_constraint *constraint);
1537         __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1538                 __isl_take isl_basic_set *bset,
1539                 __isl_take isl_constraint *constraint);
1540
1541 For example, to create a set containing the even integers
1542 between 10 and 42, you would use the following code.
1543
1544         isl_space *space;
1545         isl_local_space *ls;
1546         isl_constraint *c;
1547         isl_basic_set *bset;
1548
1549         space = isl_space_set_alloc(ctx, 0, 2);
1550         bset = isl_basic_set_universe(isl_space_copy(space));
1551         ls = isl_local_space_from_space(space);
1552
1553         c = isl_equality_alloc(isl_local_space_copy(ls));
1554         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1555         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1556         bset = isl_basic_set_add_constraint(bset, c);
1557
1558         c = isl_inequality_alloc(isl_local_space_copy(ls));
1559         c = isl_constraint_set_constant_si(c, -10);
1560         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1561         bset = isl_basic_set_add_constraint(bset, c);
1562
1563         c = isl_inequality_alloc(ls);
1564         c = isl_constraint_set_constant_si(c, 42);
1565         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1566         bset = isl_basic_set_add_constraint(bset, c);
1567
1568         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1569
1570 Or, alternatively,
1571
1572         isl_basic_set *bset;
1573         bset = isl_basic_set_read_from_str(ctx,
1574                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1575
1576 A basic set or relation can also be constructed from two matrices
1577 describing the equalities and the inequalities.
1578
1579         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1580                 __isl_take isl_space *space,
1581                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1582                 enum isl_dim_type c1,
1583                 enum isl_dim_type c2, enum isl_dim_type c3,
1584                 enum isl_dim_type c4);
1585         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1586                 __isl_take isl_space *space,
1587                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1588                 enum isl_dim_type c1,
1589                 enum isl_dim_type c2, enum isl_dim_type c3,
1590                 enum isl_dim_type c4, enum isl_dim_type c5);
1591
1592 The C<isl_dim_type> arguments indicate the order in which
1593 different kinds of variables appear in the input matrices
1594 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1595 C<isl_dim_set> and C<isl_dim_div> for sets and
1596 of C<isl_dim_cst>, C<isl_dim_param>,
1597 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1598
1599 A (basic or union) set or relation can also be constructed from a
1600 (union) (piecewise) (multiple) affine expression
1601 or a list of affine expressions
1602 (See L<"Piecewise Quasi Affine Expressions"> and
1603 L<"Piecewise Multiple Quasi Affine Expressions">).
1604
1605         __isl_give isl_basic_map *isl_basic_map_from_aff(
1606                 __isl_take isl_aff *aff);
1607         __isl_give isl_map *isl_map_from_aff(
1608                 __isl_take isl_aff *aff);
1609         __isl_give isl_set *isl_set_from_pw_aff(
1610                 __isl_take isl_pw_aff *pwaff);
1611         __isl_give isl_map *isl_map_from_pw_aff(
1612                 __isl_take isl_pw_aff *pwaff);
1613         __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1614                 __isl_take isl_space *domain_space,
1615                 __isl_take isl_aff_list *list);
1616         __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1617                 __isl_take isl_multi_aff *maff)
1618         __isl_give isl_map *isl_map_from_multi_aff(
1619                 __isl_take isl_multi_aff *maff)
1620         __isl_give isl_set *isl_set_from_pw_multi_aff(
1621                 __isl_take isl_pw_multi_aff *pma);
1622         __isl_give isl_map *isl_map_from_pw_multi_aff(
1623                 __isl_take isl_pw_multi_aff *pma);
1624         __isl_give isl_union_map *
1625         isl_union_map_from_union_pw_multi_aff(
1626                 __isl_take isl_union_pw_multi_aff *upma);
1627
1628 The C<domain_dim> argument describes the domain of the resulting
1629 basic relation.  It is required because the C<list> may consist
1630 of zero affine expressions.
1631
1632 =head2 Inspecting Sets and Relations
1633
1634 Usually, the user should not have to care about the actual constraints
1635 of the sets and maps, but should instead apply the abstract operations
1636 explained in the following sections.
1637 Occasionally, however, it may be required to inspect the individual
1638 coefficients of the constraints.  This section explains how to do so.
1639 In these cases, it may also be useful to have C<isl> compute
1640 an explicit representation of the existentially quantified variables.
1641
1642         __isl_give isl_set *isl_set_compute_divs(
1643                 __isl_take isl_set *set);
1644         __isl_give isl_map *isl_map_compute_divs(
1645                 __isl_take isl_map *map);
1646         __isl_give isl_union_set *isl_union_set_compute_divs(
1647                 __isl_take isl_union_set *uset);
1648         __isl_give isl_union_map *isl_union_map_compute_divs(
1649                 __isl_take isl_union_map *umap);
1650
1651 This explicit representation defines the existentially quantified
1652 variables as integer divisions of the other variables, possibly
1653 including earlier existentially quantified variables.
1654 An explicitly represented existentially quantified variable therefore
1655 has a unique value when the values of the other variables are known.
1656 If, furthermore, the same existentials, i.e., existentials
1657 with the same explicit representations, should appear in the
1658 same order in each of the disjuncts of a set or map, then the user should call
1659 either of the following functions.
1660
1661         __isl_give isl_set *isl_set_align_divs(
1662                 __isl_take isl_set *set);
1663         __isl_give isl_map *isl_map_align_divs(
1664                 __isl_take isl_map *map);
1665
1666 Alternatively, the existentially quantified variables can be removed
1667 using the following functions, which compute an overapproximation.
1668
1669         __isl_give isl_basic_set *isl_basic_set_remove_divs(
1670                 __isl_take isl_basic_set *bset);
1671         __isl_give isl_basic_map *isl_basic_map_remove_divs(
1672                 __isl_take isl_basic_map *bmap);
1673         __isl_give isl_set *isl_set_remove_divs(
1674                 __isl_take isl_set *set);
1675         __isl_give isl_map *isl_map_remove_divs(
1676                 __isl_take isl_map *map);
1677
1678 It is also possible to only remove those divs that are defined
1679 in terms of a given range of dimensions or only those for which
1680 no explicit representation is known.
1681
1682         __isl_give isl_basic_set *
1683         isl_basic_set_remove_divs_involving_dims(
1684                 __isl_take isl_basic_set *bset,
1685                 enum isl_dim_type type,
1686                 unsigned first, unsigned n);
1687         __isl_give isl_basic_map *
1688         isl_basic_map_remove_divs_involving_dims(
1689                 __isl_take isl_basic_map *bmap,
1690                 enum isl_dim_type type,
1691                 unsigned first, unsigned n);
1692         __isl_give isl_set *isl_set_remove_divs_involving_dims(
1693                 __isl_take isl_set *set, enum isl_dim_type type,
1694                 unsigned first, unsigned n);
1695         __isl_give isl_map *isl_map_remove_divs_involving_dims(
1696                 __isl_take isl_map *map, enum isl_dim_type type,
1697                 unsigned first, unsigned n);
1698
1699         __isl_give isl_basic_set *
1700         isl_basic_set_remove_unknown_divs(
1701                 __isl_take isl_basic_set *bset);
1702         __isl_give isl_set *isl_set_remove_unknown_divs(
1703                 __isl_take isl_set *set);
1704         __isl_give isl_map *isl_map_remove_unknown_divs(
1705                 __isl_take isl_map *map);
1706
1707 To iterate over all the sets or maps in a union set or map, use
1708
1709         int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1710                 int (*fn)(__isl_take isl_set *set, void *user),
1711                 void *user);
1712         int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1713                 int (*fn)(__isl_take isl_map *map, void *user),
1714                 void *user);
1715
1716 The number of sets or maps in a union set or map can be obtained
1717 from
1718
1719         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1720         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1721
1722 To extract the set or map in a given space from a union, use
1723
1724         __isl_give isl_set *isl_union_set_extract_set(
1725                 __isl_keep isl_union_set *uset,
1726                 __isl_take isl_space *space);
1727         __isl_give isl_map *isl_union_map_extract_map(
1728                 __isl_keep isl_union_map *umap,
1729                 __isl_take isl_space *space);
1730
1731 To iterate over all the basic sets or maps in a set or map, use
1732
1733         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1734                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1735                 void *user);
1736         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1737                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1738                 void *user);
1739
1740 The callback function C<fn> should return 0 if successful and
1741 -1 if an error occurs.  In the latter case, or if any other error
1742 occurs, the above functions will return -1.
1743
1744 It should be noted that C<isl> does not guarantee that
1745 the basic sets or maps passed to C<fn> are disjoint.
1746 If this is required, then the user should call one of
1747 the following functions first.
1748
1749         __isl_give isl_set *isl_set_make_disjoint(
1750                 __isl_take isl_set *set);
1751         __isl_give isl_map *isl_map_make_disjoint(
1752                 __isl_take isl_map *map);
1753
1754 The number of basic sets in a set can be obtained
1755 from
1756
1757         int isl_set_n_basic_set(__isl_keep isl_set *set);
1758
1759 To iterate over the constraints of a basic set or map, use
1760
1761         #include <isl/constraint.h>
1762
1763         int isl_basic_set_n_constraint(
1764                 __isl_keep isl_basic_set *bset);
1765         int isl_basic_set_foreach_constraint(
1766                 __isl_keep isl_basic_set *bset,
1767                 int (*fn)(__isl_take isl_constraint *c, void *user),
1768                 void *user);
1769         int isl_basic_map_foreach_constraint(
1770                 __isl_keep isl_basic_map *bmap,
1771                 int (*fn)(__isl_take isl_constraint *c, void *user),
1772                 void *user);
1773         void *isl_constraint_free(__isl_take isl_constraint *c);
1774
1775 Again, the callback function C<fn> should return 0 if successful and
1776 -1 if an error occurs.  In the latter case, or if any other error
1777 occurs, the above functions will return -1.
1778 The constraint C<c> represents either an equality or an inequality.
1779 Use the following function to find out whether a constraint
1780 represents an equality.  If not, it represents an inequality.
1781
1782         int isl_constraint_is_equality(
1783                 __isl_keep isl_constraint *constraint);
1784
1785 The coefficients of the constraints can be inspected using
1786 the following functions.
1787
1788         int isl_constraint_is_lower_bound(
1789                 __isl_keep isl_constraint *constraint,
1790                 enum isl_dim_type type, unsigned pos);
1791         int isl_constraint_is_upper_bound(
1792                 __isl_keep isl_constraint *constraint,
1793                 enum isl_dim_type type, unsigned pos);
1794         void isl_constraint_get_constant(
1795                 __isl_keep isl_constraint *constraint, isl_int *v);
1796         void isl_constraint_get_coefficient(
1797                 __isl_keep isl_constraint *constraint,
1798                 enum isl_dim_type type, int pos, isl_int *v);
1799         int isl_constraint_involves_dims(
1800                 __isl_keep isl_constraint *constraint,
1801                 enum isl_dim_type type, unsigned first, unsigned n);
1802
1803 The explicit representations of the existentially quantified
1804 variables can be inspected using the following function.
1805 Note that the user is only allowed to use this function
1806 if the inspected set or map is the result of a call
1807 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1808 The existentially quantified variable is equal to the floor
1809 of the returned affine expression.  The affine expression
1810 itself can be inspected using the functions in
1811 L<"Piecewise Quasi Affine Expressions">.
1812
1813         __isl_give isl_aff *isl_constraint_get_div(
1814                 __isl_keep isl_constraint *constraint, int pos);
1815
1816 To obtain the constraints of a basic set or map in matrix
1817 form, use the following functions.
1818
1819         __isl_give isl_mat *isl_basic_set_equalities_matrix(
1820                 __isl_keep isl_basic_set *bset,
1821                 enum isl_dim_type c1, enum isl_dim_type c2,
1822                 enum isl_dim_type c3, enum isl_dim_type c4);
1823         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1824                 __isl_keep isl_basic_set *bset,
1825                 enum isl_dim_type c1, enum isl_dim_type c2,
1826                 enum isl_dim_type c3, enum isl_dim_type c4);
1827         __isl_give isl_mat *isl_basic_map_equalities_matrix(
1828                 __isl_keep isl_basic_map *bmap,
1829                 enum isl_dim_type c1,
1830                 enum isl_dim_type c2, enum isl_dim_type c3,
1831                 enum isl_dim_type c4, enum isl_dim_type c5);
1832         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1833                 __isl_keep isl_basic_map *bmap,
1834                 enum isl_dim_type c1,
1835                 enum isl_dim_type c2, enum isl_dim_type c3,
1836                 enum isl_dim_type c4, enum isl_dim_type c5);
1837
1838 The C<isl_dim_type> arguments dictate the order in which
1839 different kinds of variables appear in the resulting matrix
1840 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1841 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1842
1843 The number of parameters, input, output or set dimensions can
1844 be obtained using the following functions.
1845
1846         unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1847                 enum isl_dim_type type);
1848         unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1849                 enum isl_dim_type type);
1850         unsigned isl_set_dim(__isl_keep isl_set *set,
1851                 enum isl_dim_type type);
1852         unsigned isl_map_dim(__isl_keep isl_map *map,
1853                 enum isl_dim_type type);
1854
1855 To check whether the description of a set or relation depends
1856 on one or more given dimensions, it is not necessary to iterate over all
1857 constraints.  Instead the following functions can be used.
1858
1859         int isl_basic_set_involves_dims(
1860                 __isl_keep isl_basic_set *bset,
1861                 enum isl_dim_type type, unsigned first, unsigned n);
1862         int isl_set_involves_dims(__isl_keep isl_set *set,
1863                 enum isl_dim_type type, unsigned first, unsigned n);
1864         int isl_basic_map_involves_dims(
1865                 __isl_keep isl_basic_map *bmap,
1866                 enum isl_dim_type type, unsigned first, unsigned n);
1867         int isl_map_involves_dims(__isl_keep isl_map *map,
1868                 enum isl_dim_type type, unsigned first, unsigned n);
1869
1870 Similarly, the following functions can be used to check whether
1871 a given dimension is involved in any lower or upper bound.
1872
1873         int isl_set_dim_has_any_lower_bound(__isl_keep isl_set *set,
1874                 enum isl_dim_type type, unsigned pos);
1875         int isl_set_dim_has_any_upper_bound(__isl_keep isl_set *set,
1876                 enum isl_dim_type type, unsigned pos);
1877
1878 Note that these functions return true even if there is a bound on
1879 the dimension on only some of the basic sets of C<set>.
1880 To check if they have a bound for all of the basic sets in C<set>,
1881 use the following functions instead.
1882
1883         int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
1884                 enum isl_dim_type type, unsigned pos);
1885         int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
1886                 enum isl_dim_type type, unsigned pos);
1887
1888 The identifiers or names of the domain and range spaces of a set
1889 or relation can be read off or set using the following functions.
1890
1891         __isl_give isl_set *isl_set_set_tuple_id(
1892                 __isl_take isl_set *set, __isl_take isl_id *id);
1893         __isl_give isl_set *isl_set_reset_tuple_id(
1894                 __isl_take isl_set *set);
1895         int isl_set_has_tuple_id(__isl_keep isl_set *set);
1896         __isl_give isl_id *isl_set_get_tuple_id(
1897                 __isl_keep isl_set *set);
1898         __isl_give isl_map *isl_map_set_tuple_id(
1899                 __isl_take isl_map *map, enum isl_dim_type type,
1900                 __isl_take isl_id *id);
1901         __isl_give isl_map *isl_map_reset_tuple_id(
1902                 __isl_take isl_map *map, enum isl_dim_type type);
1903         int isl_map_has_tuple_id(__isl_keep isl_map *map,
1904                 enum isl_dim_type type);
1905         __isl_give isl_id *isl_map_get_tuple_id(
1906                 __isl_keep isl_map *map, enum isl_dim_type type);
1907
1908         const char *isl_basic_set_get_tuple_name(
1909                 __isl_keep isl_basic_set *bset);
1910         __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1911                 __isl_take isl_basic_set *set, const char *s);
1912         int isl_set_has_tuple_name(__isl_keep isl_set *set);
1913         const char *isl_set_get_tuple_name(
1914                 __isl_keep isl_set *set);
1915         const char *isl_basic_map_get_tuple_name(
1916                 __isl_keep isl_basic_map *bmap,
1917                 enum isl_dim_type type);
1918         __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1919                 __isl_take isl_basic_map *bmap,
1920                 enum isl_dim_type type, const char *s);
1921         int isl_map_has_tuple_name(__isl_keep isl_map *map,
1922                 enum isl_dim_type type);
1923         const char *isl_map_get_tuple_name(
1924                 __isl_keep isl_map *map,
1925                 enum isl_dim_type type);
1926
1927 As with C<isl_space_get_tuple_name>, the value returned points to
1928 an internal data structure.
1929 The identifiers, positions or names of individual dimensions can be
1930 read off using the following functions.
1931
1932         __isl_give isl_id *isl_basic_set_get_dim_id(
1933                 __isl_keep isl_basic_set *bset,
1934                 enum isl_dim_type type, unsigned pos);
1935         __isl_give isl_set *isl_set_set_dim_id(
1936                 __isl_take isl_set *set, enum isl_dim_type type,
1937                 unsigned pos, __isl_take isl_id *id);
1938         int isl_set_has_dim_id(__isl_keep isl_set *set,
1939                 enum isl_dim_type type, unsigned pos);
1940         __isl_give isl_id *isl_set_get_dim_id(
1941                 __isl_keep isl_set *set, enum isl_dim_type type,
1942                 unsigned pos);
1943         int isl_basic_map_has_dim_id(
1944                 __isl_keep isl_basic_map *bmap,
1945                 enum isl_dim_type type, unsigned pos);
1946         __isl_give isl_map *isl_map_set_dim_id(
1947                 __isl_take isl_map *map, enum isl_dim_type type,
1948                 unsigned pos, __isl_take isl_id *id);
1949         int isl_map_has_dim_id(__isl_keep isl_map *map,
1950                 enum isl_dim_type type, unsigned pos);
1951         __isl_give isl_id *isl_map_get_dim_id(
1952                 __isl_keep isl_map *map, enum isl_dim_type type,
1953                 unsigned pos);
1954
1955         int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1956                 enum isl_dim_type type, __isl_keep isl_id *id);
1957         int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1958                 enum isl_dim_type type, __isl_keep isl_id *id);
1959         int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1960                 enum isl_dim_type type, const char *name);
1961         int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1962                 enum isl_dim_type type, const char *name);
1963
1964         const char *isl_constraint_get_dim_name(
1965                 __isl_keep isl_constraint *constraint,
1966                 enum isl_dim_type type, unsigned pos);
1967         const char *isl_basic_set_get_dim_name(
1968                 __isl_keep isl_basic_set *bset,
1969                 enum isl_dim_type type, unsigned pos);
1970         int isl_set_has_dim_name(__isl_keep isl_set *set,
1971                 enum isl_dim_type type, unsigned pos);
1972         const char *isl_set_get_dim_name(
1973                 __isl_keep isl_set *set,
1974                 enum isl_dim_type type, unsigned pos);
1975         const char *isl_basic_map_get_dim_name(
1976                 __isl_keep isl_basic_map *bmap,
1977                 enum isl_dim_type type, unsigned pos);
1978         int isl_map_has_dim_name(__isl_keep isl_map *map,
1979                 enum isl_dim_type type, unsigned pos);
1980         const char *isl_map_get_dim_name(
1981                 __isl_keep isl_map *map,
1982                 enum isl_dim_type type, unsigned pos);
1983
1984 These functions are mostly useful to obtain the identifiers, positions
1985 or names of the parameters.  Identifiers of individual dimensions are
1986 essentially only useful for printing.  They are ignored by all other
1987 operations and may not be preserved across those operations.
1988
1989 =head2 Properties
1990
1991 =head3 Unary Properties
1992
1993 =over
1994
1995 =item * Emptiness
1996
1997 The following functions test whether the given set or relation
1998 contains any integer points.  The ``plain'' variants do not perform
1999 any computations, but simply check if the given set or relation
2000 is already known to be empty.
2001
2002         int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
2003         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
2004         int isl_set_plain_is_empty(__isl_keep isl_set *set);
2005         int isl_set_is_empty(__isl_keep isl_set *set);
2006         int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
2007         int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
2008         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
2009         int isl_map_plain_is_empty(__isl_keep isl_map *map);
2010         int isl_map_is_empty(__isl_keep isl_map *map);
2011         int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
2012
2013 =item * Universality
2014
2015         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
2016         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
2017         int isl_set_plain_is_universe(__isl_keep isl_set *set);
2018
2019 =item * Single-valuedness
2020
2021         int isl_basic_map_is_single_valued(
2022                 __isl_keep isl_basic_map *bmap);
2023         int isl_map_plain_is_single_valued(
2024                 __isl_keep isl_map *map);
2025         int isl_map_is_single_valued(__isl_keep isl_map *map);
2026         int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
2027
2028 =item * Injectivity
2029
2030         int isl_map_plain_is_injective(__isl_keep isl_map *map);
2031         int isl_map_is_injective(__isl_keep isl_map *map);
2032         int isl_union_map_plain_is_injective(
2033                 __isl_keep isl_union_map *umap);
2034         int isl_union_map_is_injective(
2035                 __isl_keep isl_union_map *umap);
2036
2037 =item * Bijectivity
2038
2039         int isl_map_is_bijective(__isl_keep isl_map *map);
2040         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
2041
2042 =item * Position
2043
2044         int isl_basic_map_plain_is_fixed(
2045                 __isl_keep isl_basic_map *bmap,
2046                 enum isl_dim_type type, unsigned pos,
2047                 isl_int *val);
2048         int isl_set_plain_is_fixed(__isl_keep isl_set *set,
2049                 enum isl_dim_type type, unsigned pos,
2050                 isl_int *val);
2051         int isl_map_plain_is_fixed(__isl_keep isl_map *map,
2052                 enum isl_dim_type type, unsigned pos,
2053                 isl_int *val);
2054
2055 Check if the relation obviously lies on a hyperplane where the given dimension
2056 has a fixed value and if so, return that value in C<*val>.
2057
2058 =item * Space
2059
2060 To check whether a set is a parameter domain, use this function:
2061
2062         int isl_set_is_params(__isl_keep isl_set *set);
2063         int isl_union_set_is_params(
2064                 __isl_keep isl_union_set *uset);
2065
2066 =item * Wrapping
2067
2068 The following functions check whether the domain of the given
2069 (basic) set is a wrapped relation.
2070
2071         int isl_basic_set_is_wrapping(
2072                 __isl_keep isl_basic_set *bset);
2073         int isl_set_is_wrapping(__isl_keep isl_set *set);
2074
2075 =item * Internal Product
2076
2077         int isl_basic_map_can_zip(
2078                 __isl_keep isl_basic_map *bmap);
2079         int isl_map_can_zip(__isl_keep isl_map *map);
2080
2081 Check whether the product of domain and range of the given relation
2082 can be computed,
2083 i.e., whether both domain and range are nested relations.
2084
2085 =item * Currying
2086
2087         int isl_basic_map_can_curry(
2088                 __isl_keep isl_basic_map *bmap);
2089         int isl_map_can_curry(__isl_keep isl_map *map);
2090
2091 Check whether the domain of the (basic) relation is a wrapped relation.
2092
2093         int isl_basic_map_can_uncurry(
2094                 __isl_keep isl_basic_map *bmap);
2095         int isl_map_can_uncurry(__isl_keep isl_map *map);
2096
2097 Check whether the range of the (basic) relation is a wrapped relation.
2098
2099 =back
2100
2101 =head3 Binary Properties
2102
2103 =over
2104
2105 =item * Equality
2106
2107         int isl_set_plain_is_equal(__isl_keep isl_set *set1,
2108                 __isl_keep isl_set *set2);
2109         int isl_set_is_equal(__isl_keep isl_set *set1,
2110                 __isl_keep isl_set *set2);
2111         int isl_union_set_is_equal(
2112                 __isl_keep isl_union_set *uset1,
2113                 __isl_keep isl_union_set *uset2);
2114         int isl_basic_map_is_equal(
2115                 __isl_keep isl_basic_map *bmap1,
2116                 __isl_keep isl_basic_map *bmap2);
2117         int isl_map_is_equal(__isl_keep isl_map *map1,
2118                 __isl_keep isl_map *map2);
2119         int isl_map_plain_is_equal(__isl_keep isl_map *map1,
2120                 __isl_keep isl_map *map2);
2121         int isl_union_map_is_equal(
2122                 __isl_keep isl_union_map *umap1,
2123                 __isl_keep isl_union_map *umap2);
2124
2125 =item * Disjointness
2126
2127         int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
2128                 __isl_keep isl_set *set2);
2129         int isl_set_is_disjoint(__isl_keep isl_set *set1,
2130                 __isl_keep isl_set *set2);
2131         int isl_map_is_disjoint(__isl_keep isl_map *map1,
2132                 __isl_keep isl_map *map2);
2133
2134 =item * Subset
2135
2136         int isl_basic_set_is_subset(
2137                 __isl_keep isl_basic_set *bset1,
2138                 __isl_keep isl_basic_set *bset2);
2139         int isl_set_is_subset(__isl_keep isl_set *set1,
2140                 __isl_keep isl_set *set2);
2141         int isl_set_is_strict_subset(
2142                 __isl_keep isl_set *set1,
2143                 __isl_keep isl_set *set2);
2144         int isl_union_set_is_subset(
2145                 __isl_keep isl_union_set *uset1,
2146                 __isl_keep isl_union_set *uset2);
2147         int isl_union_set_is_strict_subset(
2148                 __isl_keep isl_union_set *uset1,
2149                 __isl_keep isl_union_set *uset2);
2150         int isl_basic_map_is_subset(
2151                 __isl_keep isl_basic_map *bmap1,
2152                 __isl_keep isl_basic_map *bmap2);
2153         int isl_basic_map_is_strict_subset(
2154                 __isl_keep isl_basic_map *bmap1,
2155                 __isl_keep isl_basic_map *bmap2);
2156         int isl_map_is_subset(
2157                 __isl_keep isl_map *map1,
2158                 __isl_keep isl_map *map2);
2159         int isl_map_is_strict_subset(
2160                 __isl_keep isl_map *map1,
2161                 __isl_keep isl_map *map2);
2162         int isl_union_map_is_subset(
2163                 __isl_keep isl_union_map *umap1,
2164                 __isl_keep isl_union_map *umap2);
2165         int isl_union_map_is_strict_subset(
2166                 __isl_keep isl_union_map *umap1,
2167                 __isl_keep isl_union_map *umap2);
2168
2169 Check whether the first argument is a (strict) subset of the
2170 second argument.
2171
2172 =item * Order
2173
2174         int isl_set_plain_cmp(__isl_keep isl_set *set1,
2175                 __isl_keep isl_set *set2);
2176
2177 This function is useful for sorting C<isl_set>s.
2178 The order depends on the internal representation of the inputs.
2179 The order is fixed over different calls to the function (assuming
2180 the internal representation of the inputs has not changed), but may
2181 change over different versions of C<isl>.
2182
2183 =back
2184
2185 =head2 Unary Operations
2186
2187 =over
2188
2189 =item * Complement
2190
2191         __isl_give isl_set *isl_set_complement(
2192                 __isl_take isl_set *set);
2193         __isl_give isl_map *isl_map_complement(
2194                 __isl_take isl_map *map);
2195
2196 =item * Inverse map
2197
2198         __isl_give isl_basic_map *isl_basic_map_reverse(
2199                 __isl_take isl_basic_map *bmap);
2200         __isl_give isl_map *isl_map_reverse(
2201                 __isl_take isl_map *map);
2202         __isl_give isl_union_map *isl_union_map_reverse(
2203                 __isl_take isl_union_map *umap);
2204
2205 =item * Projection
2206
2207         __isl_give isl_basic_set *isl_basic_set_project_out(
2208                 __isl_take isl_basic_set *bset,
2209                 enum isl_dim_type type, unsigned first, unsigned n);
2210         __isl_give isl_basic_map *isl_basic_map_project_out(
2211                 __isl_take isl_basic_map *bmap,
2212                 enum isl_dim_type type, unsigned first, unsigned n);
2213         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
2214                 enum isl_dim_type type, unsigned first, unsigned n);
2215         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
2216                 enum isl_dim_type type, unsigned first, unsigned n);
2217         __isl_give isl_basic_set *isl_basic_set_params(
2218                 __isl_take isl_basic_set *bset);
2219         __isl_give isl_basic_set *isl_basic_map_domain(
2220                 __isl_take isl_basic_map *bmap);
2221         __isl_give isl_basic_set *isl_basic_map_range(
2222                 __isl_take isl_basic_map *bmap);
2223         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
2224         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
2225         __isl_give isl_set *isl_map_domain(
2226                 __isl_take isl_map *bmap);
2227         __isl_give isl_set *isl_map_range(
2228                 __isl_take isl_map *map);
2229         __isl_give isl_set *isl_union_set_params(
2230                 __isl_take isl_union_set *uset);
2231         __isl_give isl_set *isl_union_map_params(
2232                 __isl_take isl_union_map *umap);
2233         __isl_give isl_union_set *isl_union_map_domain(
2234                 __isl_take isl_union_map *umap);
2235         __isl_give isl_union_set *isl_union_map_range(
2236                 __isl_take isl_union_map *umap);
2237
2238         __isl_give isl_basic_map *isl_basic_map_domain_map(
2239                 __isl_take isl_basic_map *bmap);
2240         __isl_give isl_basic_map *isl_basic_map_range_map(
2241                 __isl_take isl_basic_map *bmap);
2242         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
2243         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
2244         __isl_give isl_union_map *isl_union_map_domain_map(
2245                 __isl_take isl_union_map *umap);
2246         __isl_give isl_union_map *isl_union_map_range_map(
2247                 __isl_take isl_union_map *umap);
2248
2249 The functions above construct a (basic, regular or union) relation
2250 that maps (a wrapped version of) the input relation to its domain or range.
2251
2252 =item * Elimination
2253
2254         __isl_give isl_basic_set *isl_basic_set_eliminate(
2255                 __isl_take isl_basic_set *bset,
2256                 enum isl_dim_type type,
2257                 unsigned first, unsigned n);
2258         __isl_give isl_set *isl_set_eliminate(
2259                 __isl_take isl_set *set, enum isl_dim_type type,
2260                 unsigned first, unsigned n);
2261         __isl_give isl_basic_map *isl_basic_map_eliminate(
2262                 __isl_take isl_basic_map *bmap,
2263                 enum isl_dim_type type,
2264                 unsigned first, unsigned n);
2265         __isl_give isl_map *isl_map_eliminate(
2266                 __isl_take isl_map *map, enum isl_dim_type type,
2267                 unsigned first, unsigned n);
2268
2269 Eliminate the coefficients for the given dimensions from the constraints,
2270 without removing the dimensions.
2271
2272 =item * Slicing
2273
2274         __isl_give isl_basic_set *isl_basic_set_fix(
2275                 __isl_take isl_basic_set *bset,
2276                 enum isl_dim_type type, unsigned pos,
2277                 isl_int value);
2278         __isl_give isl_basic_set *isl_basic_set_fix_si(
2279                 __isl_take isl_basic_set *bset,
2280                 enum isl_dim_type type, unsigned pos, int value);
2281         __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
2282                 enum isl_dim_type type, unsigned pos,
2283                 isl_int value);
2284         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
2285                 enum isl_dim_type type, unsigned pos, int value);
2286         __isl_give isl_basic_map *isl_basic_map_fix_si(
2287                 __isl_take isl_basic_map *bmap,
2288                 enum isl_dim_type type, unsigned pos, int value);
2289         __isl_give isl_map *isl_map_fix(__isl_take isl_map *map,
2290                 enum isl_dim_type type, unsigned pos,
2291                 isl_int value);
2292         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
2293                 enum isl_dim_type type, unsigned pos, int value);
2294
2295 Intersect the set or relation with the hyperplane where the given
2296 dimension has the fixed given value.
2297
2298         __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
2299                 __isl_take isl_basic_map *bmap,
2300                 enum isl_dim_type type, unsigned pos, int value);
2301         __isl_give isl_basic_map *isl_basic_map_upper_bound_si(
2302                 __isl_take isl_basic_map *bmap,
2303                 enum isl_dim_type type, unsigned pos, int value);
2304         __isl_give isl_set *isl_set_lower_bound(
2305                 __isl_take isl_set *set,
2306                 enum isl_dim_type type, unsigned pos,
2307                 isl_int value);
2308         __isl_give isl_set *isl_set_lower_bound_si(
2309                 __isl_take isl_set *set,
2310                 enum isl_dim_type type, unsigned pos, int value);
2311         __isl_give isl_map *isl_map_lower_bound_si(
2312                 __isl_take isl_map *map,
2313                 enum isl_dim_type type, unsigned pos, int value);
2314         __isl_give isl_set *isl_set_upper_bound(
2315                 __isl_take isl_set *set,
2316                 enum isl_dim_type type, unsigned pos,
2317                 isl_int value);
2318         __isl_give isl_set *isl_set_upper_bound_si(
2319                 __isl_take isl_set *set,
2320                 enum isl_dim_type type, unsigned pos, int value);
2321         __isl_give isl_map *isl_map_upper_bound_si(
2322                 __isl_take isl_map *map,
2323                 enum isl_dim_type type, unsigned pos, int value);
2324
2325 Intersect the set or relation with the half-space where the given
2326 dimension has a value bounded by the fixed given value.
2327
2328         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
2329                 enum isl_dim_type type1, int pos1,
2330                 enum isl_dim_type type2, int pos2);
2331         __isl_give isl_basic_map *isl_basic_map_equate(
2332                 __isl_take isl_basic_map *bmap,
2333                 enum isl_dim_type type1, int pos1,
2334                 enum isl_dim_type type2, int pos2);
2335         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
2336                 enum isl_dim_type type1, int pos1,
2337                 enum isl_dim_type type2, int pos2);
2338
2339 Intersect the set or relation with the hyperplane where the given
2340 dimensions are equal to each other.
2341
2342         __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
2343                 enum isl_dim_type type1, int pos1,
2344                 enum isl_dim_type type2, int pos2);
2345
2346 Intersect the relation with the hyperplane where the given
2347 dimensions have opposite values.
2348
2349         __isl_give isl_basic_map *isl_basic_map_order_ge(
2350                 __isl_take isl_basic_map *bmap,
2351                 enum isl_dim_type type1, int pos1,
2352                 enum isl_dim_type type2, int pos2);
2353         __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
2354                 enum isl_dim_type type1, int pos1,
2355                 enum isl_dim_type type2, int pos2);
2356         __isl_give isl_basic_map *isl_basic_map_order_gt(
2357                 __isl_take isl_basic_map *bmap,
2358                 enum isl_dim_type type1, int pos1,
2359                 enum isl_dim_type type2, int pos2);
2360         __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
2361                 enum isl_dim_type type1, int pos1,
2362                 enum isl_dim_type type2, int pos2);
2363
2364 Intersect the relation with the half-space where the given
2365 dimensions satisfy the given ordering.
2366
2367 =item * Identity
2368
2369         __isl_give isl_map *isl_set_identity(
2370                 __isl_take isl_set *set);
2371         __isl_give isl_union_map *isl_union_set_identity(
2372                 __isl_take isl_union_set *uset);
2373
2374 Construct an identity relation on the given (union) set.
2375
2376 =item * Deltas
2377
2378         __isl_give isl_basic_set *isl_basic_map_deltas(
2379                 __isl_take isl_basic_map *bmap);
2380         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
2381         __isl_give isl_union_set *isl_union_map_deltas(
2382                 __isl_take isl_union_map *umap);
2383
2384 These functions return a (basic) set containing the differences
2385 between image elements and corresponding domain elements in the input.
2386
2387         __isl_give isl_basic_map *isl_basic_map_deltas_map(
2388                 __isl_take isl_basic_map *bmap);
2389         __isl_give isl_map *isl_map_deltas_map(
2390                 __isl_take isl_map *map);
2391         __isl_give isl_union_map *isl_union_map_deltas_map(
2392                 __isl_take isl_union_map *umap);
2393
2394 The functions above construct a (basic, regular or union) relation
2395 that maps (a wrapped version of) the input relation to its delta set.
2396
2397 =item * Coalescing
2398
2399 Simplify the representation of a set or relation by trying
2400 to combine pairs of basic sets or relations into a single
2401 basic set or relation.
2402
2403         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
2404         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
2405         __isl_give isl_union_set *isl_union_set_coalesce(
2406                 __isl_take isl_union_set *uset);
2407         __isl_give isl_union_map *isl_union_map_coalesce(
2408                 __isl_take isl_union_map *umap);
2409
2410 One of the methods for combining pairs of basic sets or relations
2411 can result in coefficients that are much larger than those that appear
2412 in the constraints of the input.  By default, the coefficients are
2413 not allowed to grow larger, but this can be changed by unsetting
2414 the following option.
2415
2416         int isl_options_set_coalesce_bounded_wrapping(
2417                 isl_ctx *ctx, int val);
2418         int isl_options_get_coalesce_bounded_wrapping(
2419                 isl_ctx *ctx);
2420
2421 =item * Detecting equalities
2422
2423         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
2424                 __isl_take isl_basic_set *bset);
2425         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
2426                 __isl_take isl_basic_map *bmap);
2427         __isl_give isl_set *isl_set_detect_equalities(
2428                 __isl_take isl_set *set);
2429         __isl_give isl_map *isl_map_detect_equalities(
2430                 __isl_take isl_map *map);
2431         __isl_give isl_union_set *isl_union_set_detect_equalities(
2432                 __isl_take isl_union_set *uset);
2433         __isl_give isl_union_map *isl_union_map_detect_equalities(
2434                 __isl_take isl_union_map *umap);
2435
2436 Simplify the representation of a set or relation by detecting implicit
2437 equalities.
2438
2439 =item * Removing redundant constraints
2440
2441         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
2442                 __isl_take isl_basic_set *bset);
2443         __isl_give isl_set *isl_set_remove_redundancies(
2444                 __isl_take isl_set *set);
2445         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
2446                 __isl_take isl_basic_map *bmap);
2447         __isl_give isl_map *isl_map_remove_redundancies(
2448                 __isl_take isl_map *map);
2449
2450 =item * Convex hull
2451
2452         __isl_give isl_basic_set *isl_set_convex_hull(
2453                 __isl_take isl_set *set);
2454         __isl_give isl_basic_map *isl_map_convex_hull(
2455                 __isl_take isl_map *map);
2456
2457 If the input set or relation has any existentially quantified
2458 variables, then the result of these operations is currently undefined.
2459
2460 =item * Simple hull
2461
2462         __isl_give isl_basic_set *
2463         isl_set_unshifted_simple_hull(
2464                 __isl_take isl_set *set);
2465         __isl_give isl_basic_map *
2466         isl_map_unshifted_simple_hull(
2467                 __isl_take isl_map *map);
2468         __isl_give isl_basic_set *isl_set_simple_hull(
2469                 __isl_take isl_set *set);
2470         __isl_give isl_basic_map *isl_map_simple_hull(
2471                 __isl_take isl_map *map);
2472         __isl_give isl_union_map *isl_union_map_simple_hull(
2473                 __isl_take isl_union_map *umap);
2474
2475 These functions compute a single basic set or relation
2476 that contains the whole input set or relation.
2477 In particular, the output is described by translates
2478 of the constraints describing the basic sets or relations in the input.
2479 In case of C<isl_set_unshifted_simple_hull>, only the original
2480 constraints are used, without any translation.
2481
2482 =begin latex
2483
2484 (See \autoref{s:simple hull}.)
2485
2486 =end latex
2487
2488 =item * Affine hull
2489
2490         __isl_give isl_basic_set *isl_basic_set_affine_hull(
2491                 __isl_take isl_basic_set *bset);
2492         __isl_give isl_basic_set *isl_set_affine_hull(
2493                 __isl_take isl_set *set);
2494         __isl_give isl_union_set *isl_union_set_affine_hull(
2495                 __isl_take isl_union_set *uset);
2496         __isl_give isl_basic_map *isl_basic_map_affine_hull(
2497                 __isl_take isl_basic_map *bmap);
2498         __isl_give isl_basic_map *isl_map_affine_hull(
2499                 __isl_take isl_map *map);
2500         __isl_give isl_union_map *isl_union_map_affine_hull(
2501                 __isl_take isl_union_map *umap);
2502
2503 In case of union sets and relations, the affine hull is computed
2504 per space.
2505
2506 =item * Polyhedral hull
2507
2508         __isl_give isl_basic_set *isl_set_polyhedral_hull(
2509                 __isl_take isl_set *set);
2510         __isl_give isl_basic_map *isl_map_polyhedral_hull(
2511                 __isl_take isl_map *map);
2512         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2513                 __isl_take isl_union_set *uset);
2514         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2515                 __isl_take isl_union_map *umap);
2516
2517 These functions compute a single basic set or relation
2518 not involving any existentially quantified variables
2519 that contains the whole input set or relation.
2520 In case of union sets and relations, the polyhedral hull is computed
2521 per space.
2522
2523 =item * Other approximations
2524
2525         __isl_give isl_basic_set *
2526         isl_basic_set_drop_constraints_involving_dims(
2527                 __isl_take isl_basic_set *bset,
2528                 enum isl_dim_type type,
2529                 unsigned first, unsigned n);
2530         __isl_give isl_basic_map *
2531         isl_basic_map_drop_constraints_involving_dims(
2532                 __isl_take isl_basic_map *bmap,
2533                 enum isl_dim_type type,
2534                 unsigned first, unsigned n);
2535         __isl_give isl_basic_set *
2536         isl_basic_set_drop_constraints_not_involving_dims(
2537                 __isl_take isl_basic_set *bset,
2538                 enum isl_dim_type type,
2539                 unsigned first, unsigned n);
2540         __isl_give isl_set *
2541         isl_set_drop_constraints_involving_dims(
2542                 __isl_take isl_set *set,
2543                 enum isl_dim_type type,
2544                 unsigned first, unsigned n);
2545         __isl_give isl_map *
2546         isl_map_drop_constraints_involving_dims(
2547                 __isl_take isl_map *map,
2548                 enum isl_dim_type type,
2549                 unsigned first, unsigned n);
2550
2551 These functions drop any constraints (not) involving the specified dimensions.
2552 Note that the result depends on the representation of the input.
2553
2554 =item * Feasibility
2555
2556         __isl_give isl_basic_set *isl_basic_set_sample(
2557                 __isl_take isl_basic_set *bset);
2558         __isl_give isl_basic_set *isl_set_sample(
2559                 __isl_take isl_set *set);
2560         __isl_give isl_basic_map *isl_basic_map_sample(
2561                 __isl_take isl_basic_map *bmap);
2562         __isl_give isl_basic_map *isl_map_sample(
2563                 __isl_take isl_map *map);
2564
2565 If the input (basic) set or relation is non-empty, then return
2566 a singleton subset of the input.  Otherwise, return an empty set.
2567
2568 =item * Optimization
2569
2570         #include <isl/ilp.h>
2571         enum isl_lp_result isl_basic_set_max(
2572                 __isl_keep isl_basic_set *bset,
2573                 __isl_keep isl_aff *obj, isl_int *opt)
2574         enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
2575                 __isl_keep isl_aff *obj, isl_int *opt);
2576         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
2577                 __isl_keep isl_aff *obj, isl_int *opt);
2578
2579 Compute the minimum or maximum of the integer affine expression C<obj>
2580 over the points in C<set>, returning the result in C<opt>.
2581 The return value may be one of C<isl_lp_error>,
2582 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
2583
2584 =item * Parametric optimization
2585
2586         __isl_give isl_pw_aff *isl_set_dim_min(
2587                 __isl_take isl_set *set, int pos);
2588         __isl_give isl_pw_aff *isl_set_dim_max(
2589                 __isl_take isl_set *set, int pos);
2590         __isl_give isl_pw_aff *isl_map_dim_max(
2591                 __isl_take isl_map *map, int pos);
2592
2593 Compute the minimum or maximum of the given set or output dimension
2594 as a function of the parameters (and input dimensions), but independently
2595 of the other set or output dimensions.
2596 For lexicographic optimization, see L<"Lexicographic Optimization">.
2597
2598 =item * Dual
2599
2600 The following functions compute either the set of (rational) coefficient
2601 values of valid constraints for the given set or the set of (rational)
2602 values satisfying the constraints with coefficients from the given set.
2603 Internally, these two sets of functions perform essentially the
2604 same operations, except that the set of coefficients is assumed to
2605 be a cone, while the set of values may be any polyhedron.
2606 The current implementation is based on the Farkas lemma and
2607 Fourier-Motzkin elimination, but this may change or be made optional
2608 in future.  In particular, future implementations may use different
2609 dualization algorithms or skip the elimination step.
2610
2611         __isl_give isl_basic_set *isl_basic_set_coefficients(
2612                 __isl_take isl_basic_set *bset);
2613         __isl_give isl_basic_set *isl_set_coefficients(
2614                 __isl_take isl_set *set);
2615         __isl_give isl_union_set *isl_union_set_coefficients(
2616                 __isl_take isl_union_set *bset);
2617         __isl_give isl_basic_set *isl_basic_set_solutions(
2618                 __isl_take isl_basic_set *bset);
2619         __isl_give isl_basic_set *isl_set_solutions(
2620                 __isl_take isl_set *set);
2621         __isl_give isl_union_set *isl_union_set_solutions(
2622                 __isl_take isl_union_set *bset);
2623
2624 =item * Power
2625
2626         __isl_give isl_map *isl_map_fixed_power(
2627                 __isl_take isl_map *map, isl_int exp);
2628         __isl_give isl_union_map *isl_union_map_fixed_power(
2629                 __isl_take isl_union_map *umap, isl_int exp);
2630
2631 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2632 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2633 of C<map> is computed.
2634
2635         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2636                 int *exact);
2637         __isl_give isl_union_map *isl_union_map_power(
2638                 __isl_take isl_union_map *umap, int *exact);
2639
2640 Compute a parametric representation for all positive powers I<k> of C<map>.
2641 The result maps I<k> to a nested relation corresponding to the
2642 I<k>th power of C<map>.
2643 The result may be an overapproximation.  If the result is known to be exact,
2644 then C<*exact> is set to C<1>.
2645
2646 =item * Transitive closure
2647
2648         __isl_give isl_map *isl_map_transitive_closure(
2649                 __isl_take isl_map *map, int *exact);
2650         __isl_give isl_union_map *isl_union_map_transitive_closure(
2651                 __isl_take isl_union_map *umap, int *exact);
2652
2653 Compute the transitive closure of C<map>.
2654 The result may be an overapproximation.  If the result is known to be exact,
2655 then C<*exact> is set to C<1>.
2656
2657 =item * Reaching path lengths
2658
2659         __isl_give isl_map *isl_map_reaching_path_lengths(
2660                 __isl_take isl_map *map, int *exact);
2661
2662 Compute a relation that maps each element in the range of C<map>
2663 to the lengths of all paths composed of edges in C<map> that
2664 end up in the given element.
2665 The result may be an overapproximation.  If the result is known to be exact,
2666 then C<*exact> is set to C<1>.
2667 To compute the I<maximal> path length, the resulting relation
2668 should be postprocessed by C<isl_map_lexmax>.
2669 In particular, if the input relation is a dependence relation
2670 (mapping sources to sinks), then the maximal path length corresponds
2671 to the free schedule.
2672 Note, however, that C<isl_map_lexmax> expects the maximum to be
2673 finite, so if the path lengths are unbounded (possibly due to
2674 the overapproximation), then you will get an error message.
2675
2676 =item * Wrapping
2677
2678         __isl_give isl_basic_set *isl_basic_map_wrap(
2679                 __isl_take isl_basic_map *bmap);
2680         __isl_give isl_set *isl_map_wrap(
2681                 __isl_take isl_map *map);
2682         __isl_give isl_union_set *isl_union_map_wrap(
2683                 __isl_take isl_union_map *umap);
2684         __isl_give isl_basic_map *isl_basic_set_unwrap(
2685                 __isl_take isl_basic_set *bset);
2686         __isl_give isl_map *isl_set_unwrap(
2687                 __isl_take isl_set *set);
2688         __isl_give isl_union_map *isl_union_set_unwrap(
2689                 __isl_take isl_union_set *uset);
2690
2691 =item * Flattening
2692
2693 Remove any internal structure of domain (and range) of the given
2694 set or relation.  If there is any such internal structure in the input,
2695 then the name of the space is also removed.
2696
2697         __isl_give isl_basic_set *isl_basic_set_flatten(
2698                 __isl_take isl_basic_set *bset);
2699         __isl_give isl_set *isl_set_flatten(
2700                 __isl_take isl_set *set);
2701         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2702                 __isl_take isl_basic_map *bmap);
2703         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2704                 __isl_take isl_basic_map *bmap);
2705         __isl_give isl_map *isl_map_flatten_range(
2706                 __isl_take isl_map *map);
2707         __isl_give isl_map *isl_map_flatten_domain(
2708                 __isl_take isl_map *map);
2709         __isl_give isl_basic_map *isl_basic_map_flatten(
2710                 __isl_take isl_basic_map *bmap);
2711         __isl_give isl_map *isl_map_flatten(
2712                 __isl_take isl_map *map);
2713
2714         __isl_give isl_map *isl_set_flatten_map(
2715                 __isl_take isl_set *set);
2716
2717 The function above constructs a relation
2718 that maps the input set to a flattened version of the set.
2719
2720 =item * Lifting
2721
2722 Lift the input set to a space with extra dimensions corresponding
2723 to the existentially quantified variables in the input.
2724 In particular, the result lives in a wrapped map where the domain
2725 is the original space and the range corresponds to the original
2726 existentially quantified variables.
2727
2728         __isl_give isl_basic_set *isl_basic_set_lift(
2729                 __isl_take isl_basic_set *bset);
2730         __isl_give isl_set *isl_set_lift(
2731                 __isl_take isl_set *set);
2732         __isl_give isl_union_set *isl_union_set_lift(
2733                 __isl_take isl_union_set *uset);
2734
2735 Given a local space that contains the existentially quantified
2736 variables of a set, a basic relation that, when applied to
2737 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2738 can be constructed using the following function.
2739
2740         #include <isl/local_space.h>
2741         __isl_give isl_basic_map *isl_local_space_lifting(
2742                 __isl_take isl_local_space *ls);
2743
2744 =item * Internal Product
2745
2746         __isl_give isl_basic_map *isl_basic_map_zip(
2747                 __isl_take isl_basic_map *bmap);
2748         __isl_give isl_map *isl_map_zip(
2749                 __isl_take isl_map *map);
2750         __isl_give isl_union_map *isl_union_map_zip(
2751                 __isl_take isl_union_map *umap);
2752
2753 Given a relation with nested relations for domain and range,
2754 interchange the range of the domain with the domain of the range.
2755
2756 =item * Currying
2757
2758         __isl_give isl_basic_map *isl_basic_map_curry(
2759                 __isl_take isl_basic_map *bmap);
2760         __isl_give isl_basic_map *isl_basic_map_uncurry(
2761                 __isl_take isl_basic_map *bmap);
2762         __isl_give isl_map *isl_map_curry(
2763                 __isl_take isl_map *map);
2764         __isl_give isl_map *isl_map_uncurry(
2765                 __isl_take isl_map *map);
2766         __isl_give isl_union_map *isl_union_map_curry(
2767                 __isl_take isl_union_map *umap);
2768         __isl_give isl_union_map *isl_union_map_uncurry(
2769                 __isl_take isl_union_map *umap);
2770
2771 Given a relation with a nested relation for domain,
2772 the C<curry> functions
2773 move the range of the nested relation out of the domain
2774 and use it as the domain of a nested relation in the range,
2775 with the original range as range of this nested relation.
2776 The C<uncurry> functions perform the inverse operation.
2777
2778 =item * Aligning parameters
2779
2780         __isl_give isl_basic_set *isl_basic_set_align_params(
2781                 __isl_take isl_basic_set *bset,
2782                 __isl_take isl_space *model);
2783         __isl_give isl_set *isl_set_align_params(
2784                 __isl_take isl_set *set,
2785                 __isl_take isl_space *model);
2786         __isl_give isl_basic_map *isl_basic_map_align_params(
2787                 __isl_take isl_basic_map *bmap,
2788                 __isl_take isl_space *model);
2789         __isl_give isl_map *isl_map_align_params(
2790                 __isl_take isl_map *map,
2791                 __isl_take isl_space *model);
2792
2793 Change the order of the parameters of the given set or relation
2794 such that the first parameters match those of C<model>.
2795 This may involve the introduction of extra parameters.
2796 All parameters need to be named.
2797
2798 =item * Dimension manipulation
2799
2800         __isl_give isl_basic_set *isl_basic_set_add_dims(
2801                 __isl_take isl_basic_set *bset,
2802                 enum isl_dim_type type, unsigned n);
2803         __isl_give isl_set *isl_set_add_dims(
2804                 __isl_take isl_set *set,
2805                 enum isl_dim_type type, unsigned n);
2806         __isl_give isl_map *isl_map_add_dims(
2807                 __isl_take isl_map *map,
2808                 enum isl_dim_type type, unsigned n);
2809         __isl_give isl_basic_set *isl_basic_set_insert_dims(
2810                 __isl_take isl_basic_set *bset,
2811                 enum isl_dim_type type, unsigned pos,
2812                 unsigned n);
2813         __isl_give isl_basic_map *isl_basic_map_insert_dims(
2814                 __isl_take isl_basic_map *bmap,
2815                 enum isl_dim_type type, unsigned pos,
2816                 unsigned n);
2817         __isl_give isl_set *isl_set_insert_dims(
2818                 __isl_take isl_set *set,
2819                 enum isl_dim_type type, unsigned pos, unsigned n);
2820         __isl_give isl_map *isl_map_insert_dims(
2821                 __isl_take isl_map *map,
2822                 enum isl_dim_type type, unsigned pos, unsigned n);
2823         __isl_give isl_basic_set *isl_basic_set_move_dims(
2824                 __isl_take isl_basic_set *bset,
2825                 enum isl_dim_type dst_type, unsigned dst_pos,
2826                 enum isl_dim_type src_type, unsigned src_pos,
2827                 unsigned n);
2828         __isl_give isl_basic_map *isl_basic_map_move_dims(
2829                 __isl_take isl_basic_map *bmap,
2830                 enum isl_dim_type dst_type, unsigned dst_pos,
2831                 enum isl_dim_type src_type, unsigned src_pos,
2832                 unsigned n);
2833         __isl_give isl_set *isl_set_move_dims(
2834                 __isl_take isl_set *set,
2835                 enum isl_dim_type dst_type, unsigned dst_pos,
2836                 enum isl_dim_type src_type, unsigned src_pos,
2837                 unsigned n);
2838         __isl_give isl_map *isl_map_move_dims(
2839                 __isl_take isl_map *map,
2840                 enum isl_dim_type dst_type, unsigned dst_pos,
2841                 enum isl_dim_type src_type, unsigned src_pos,
2842                 unsigned n);
2843
2844 It is usually not advisable to directly change the (input or output)
2845 space of a set or a relation as this removes the name and the internal
2846 structure of the space.  However, the above functions can be useful
2847 to add new parameters, assuming
2848 C<isl_set_align_params> and C<isl_map_align_params>
2849 are not sufficient.
2850
2851 =back
2852
2853 =head2 Binary Operations
2854
2855 The two arguments of a binary operation not only need to live
2856 in the same C<isl_ctx>, they currently also need to have
2857 the same (number of) parameters.
2858
2859 =head3 Basic Operations
2860
2861 =over
2862
2863 =item * Intersection
2864
2865         __isl_give isl_basic_set *isl_basic_set_intersect_params(
2866                 __isl_take isl_basic_set *bset1,
2867                 __isl_take isl_basic_set *bset2);
2868         __isl_give isl_basic_set *isl_basic_set_intersect(
2869                 __isl_take isl_basic_set *bset1,
2870                 __isl_take isl_basic_set *bset2);
2871         __isl_give isl_set *isl_set_intersect_params(
2872                 __isl_take isl_set *set,
2873                 __isl_take isl_set *params);
2874         __isl_give isl_set *isl_set_intersect(
2875                 __isl_take isl_set *set1,
2876                 __isl_take isl_set *set2);
2877         __isl_give isl_union_set *isl_union_set_intersect_params(
2878                 __isl_take isl_union_set *uset,
2879                 __isl_take isl_set *set);
2880         __isl_give isl_union_map *isl_union_map_intersect_params(
2881                 __isl_take isl_union_map *umap,
2882                 __isl_take isl_set *set);
2883         __isl_give isl_union_set *isl_union_set_intersect(
2884                 __isl_take isl_union_set *uset1,
2885                 __isl_take isl_union_set *uset2);
2886         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2887                 __isl_take isl_basic_map *bmap,
2888                 __isl_take isl_basic_set *bset);
2889         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2890                 __isl_take isl_basic_map *bmap,
2891                 __isl_take isl_basic_set *bset);
2892         __isl_give isl_basic_map *isl_basic_map_intersect(
2893                 __isl_take isl_basic_map *bmap1,
2894                 __isl_take isl_basic_map *bmap2);
2895         __isl_give isl_map *isl_map_intersect_params(
2896                 __isl_take isl_map *map,
2897                 __isl_take isl_set *params);
2898         __isl_give isl_map *isl_map_intersect_domain(
2899                 __isl_take isl_map *map,
2900                 __isl_take isl_set *set);
2901         __isl_give isl_map *isl_map_intersect_range(
2902                 __isl_take isl_map *map,
2903                 __isl_take isl_set *set);
2904         __isl_give isl_map *isl_map_intersect(
2905                 __isl_take isl_map *map1,
2906                 __isl_take isl_map *map2);
2907         __isl_give isl_union_map *isl_union_map_intersect_domain(
2908                 __isl_take isl_union_map *umap,
2909                 __isl_take isl_union_set *uset);
2910         __isl_give isl_union_map *isl_union_map_intersect_range(
2911                 __isl_take isl_union_map *umap,
2912                 __isl_take isl_union_set *uset);
2913         __isl_give isl_union_map *isl_union_map_intersect(
2914                 __isl_take isl_union_map *umap1,
2915                 __isl_take isl_union_map *umap2);
2916
2917 The second argument to the C<_params> functions needs to be
2918 a parametric (basic) set.  For the other functions, a parametric set
2919 for either argument is only allowed if the other argument is
2920 a parametric set as well.
2921
2922 =item * Union
2923
2924         __isl_give isl_set *isl_basic_set_union(
2925                 __isl_take isl_basic_set *bset1,
2926                 __isl_take isl_basic_set *bset2);
2927         __isl_give isl_map *isl_basic_map_union(
2928                 __isl_take isl_basic_map *bmap1,
2929                 __isl_take isl_basic_map *bmap2);
2930         __isl_give isl_set *isl_set_union(
2931                 __isl_take isl_set *set1,
2932                 __isl_take isl_set *set2);
2933         __isl_give isl_map *isl_map_union(
2934                 __isl_take isl_map *map1,
2935                 __isl_take isl_map *map2);
2936         __isl_give isl_union_set *isl_union_set_union(
2937                 __isl_take isl_union_set *uset1,
2938                 __isl_take isl_union_set *uset2);
2939         __isl_give isl_union_map *isl_union_map_union(
2940                 __isl_take isl_union_map *umap1,
2941                 __isl_take isl_union_map *umap2);
2942
2943 =item * Set difference
2944
2945         __isl_give isl_set *isl_set_subtract(
2946                 __isl_take isl_set *set1,
2947                 __isl_take isl_set *set2);
2948         __isl_give isl_map *isl_map_subtract(
2949                 __isl_take isl_map *map1,
2950                 __isl_take isl_map *map2);
2951         __isl_give isl_map *isl_map_subtract_domain(
2952                 __isl_take isl_map *map,
2953                 __isl_take isl_set *dom);
2954         __isl_give isl_map *isl_map_subtract_range(
2955                 __isl_take isl_map *map,
2956                 __isl_take isl_set *dom);
2957         __isl_give isl_union_set *isl_union_set_subtract(
2958                 __isl_take isl_union_set *uset1,
2959                 __isl_take isl_union_set *uset2);
2960         __isl_give isl_union_map *isl_union_map_subtract(
2961                 __isl_take isl_union_map *umap1,
2962                 __isl_take isl_union_map *umap2);
2963         __isl_give isl_union_map *isl_union_map_subtract_domain(
2964                 __isl_take isl_union_map *umap,
2965                 __isl_take isl_union_set *dom);
2966         __isl_give isl_union_map *isl_union_map_subtract_range(
2967                 __isl_take isl_union_map *umap,
2968                 __isl_take isl_union_set *dom);
2969
2970 =item * Application
2971
2972         __isl_give isl_basic_set *isl_basic_set_apply(
2973                 __isl_take isl_basic_set *bset,
2974                 __isl_take isl_basic_map *bmap);
2975         __isl_give isl_set *isl_set_apply(
2976                 __isl_take isl_set *set,
2977                 __isl_take isl_map *map);
2978         __isl_give isl_union_set *isl_union_set_apply(
2979                 __isl_take isl_union_set *uset,
2980                 __isl_take isl_union_map *umap);
2981         __isl_give isl_basic_map *isl_basic_map_apply_domain(
2982                 __isl_take isl_basic_map *bmap1,
2983                 __isl_take isl_basic_map *bmap2);
2984         __isl_give isl_basic_map *isl_basic_map_apply_range(
2985                 __isl_take isl_basic_map *bmap1,
2986                 __isl_take isl_basic_map *bmap2);
2987         __isl_give isl_map *isl_map_apply_domain(
2988                 __isl_take isl_map *map1,
2989                 __isl_take isl_map *map2);
2990         __isl_give isl_union_map *isl_union_map_apply_domain(
2991                 __isl_take isl_union_map *umap1,
2992                 __isl_take isl_union_map *umap2);
2993         __isl_give isl_map *isl_map_apply_range(
2994                 __isl_take isl_map *map1,
2995                 __isl_take isl_map *map2);
2996         __isl_give isl_union_map *isl_union_map_apply_range(
2997                 __isl_take isl_union_map *umap1,
2998                 __isl_take isl_union_map *umap2);
2999
3000 =item * Preimage
3001
3002         __isl_give isl_basic_set *
3003         isl_basic_set_preimage_multi_aff(
3004                 __isl_take isl_basic_set *bset,
3005                 __isl_take isl_multi_aff *ma);
3006         __isl_give isl_set *isl_set_preimage_multi_aff(
3007                 __isl_take isl_set *set,
3008                 __isl_take isl_multi_aff *ma);
3009         __isl_give isl_set *isl_set_preimage_pw_multi_aff(
3010                 __isl_take isl_set *set,
3011                 __isl_take isl_pw_multi_aff *pma);
3012         __isl_give isl_map *isl_map_preimage_domain_multi_aff(
3013                 __isl_take isl_map *map,
3014                 __isl_take isl_multi_aff *ma);
3015         __isl_give isl_union_map *
3016         isl_union_map_preimage_domain_multi_aff(
3017                 __isl_take isl_union_map *umap,
3018                 __isl_take isl_multi_aff *ma);
3019
3020 These functions compute the preimage of the given set or map domain under
3021 the given function.  In other words, the expression is plugged
3022 into the set description or into the domain of the map.
3023 Objects of types C<isl_multi_aff> and C<isl_pw_multi_aff> are described in
3024 L</"Piecewise Multiple Quasi Affine Expressions">.
3025
3026 =item * Cartesian Product
3027
3028         __isl_give isl_set *isl_set_product(
3029                 __isl_take isl_set *set1,
3030                 __isl_take isl_set *set2);
3031         __isl_give isl_union_set *isl_union_set_product(
3032                 __isl_take isl_union_set *uset1,
3033                 __isl_take isl_union_set *uset2);
3034         __isl_give isl_basic_map *isl_basic_map_domain_product(
3035                 __isl_take isl_basic_map *bmap1,
3036                 __isl_take isl_basic_map *bmap2);
3037         __isl_give isl_basic_map *isl_basic_map_range_product(
3038                 __isl_take isl_basic_map *bmap1,
3039                 __isl_take isl_basic_map *bmap2);
3040         __isl_give isl_basic_map *isl_basic_map_product(
3041                 __isl_take isl_basic_map *bmap1,
3042                 __isl_take isl_basic_map *bmap2);
3043         __isl_give isl_map *isl_map_domain_product(
3044                 __isl_take isl_map *map1,
3045                 __isl_take isl_map *map2);
3046         __isl_give isl_map *isl_map_range_product(
3047                 __isl_take isl_map *map1,
3048                 __isl_take isl_map *map2);
3049         __isl_give isl_union_map *isl_union_map_domain_product(
3050                 __isl_take isl_union_map *umap1,
3051                 __isl_take isl_union_map *umap2);
3052         __isl_give isl_union_map *isl_union_map_range_product(
3053                 __isl_take isl_union_map *umap1,
3054                 __isl_take isl_union_map *umap2);
3055         __isl_give isl_map *isl_map_product(
3056                 __isl_take isl_map *map1,
3057                 __isl_take isl_map *map2);
3058         __isl_give isl_union_map *isl_union_map_product(
3059                 __isl_take isl_union_map *umap1,
3060                 __isl_take isl_union_map *umap2);
3061
3062 The above functions compute the cross product of the given
3063 sets or relations.  The domains and ranges of the results
3064 are wrapped maps between domains and ranges of the inputs.
3065 To obtain a ``flat'' product, use the following functions
3066 instead.
3067
3068         __isl_give isl_basic_set *isl_basic_set_flat_product(
3069                 __isl_take isl_basic_set *bset1,
3070                 __isl_take isl_basic_set *bset2);
3071         __isl_give isl_set *isl_set_flat_product(
3072                 __isl_take isl_set *set1,
3073                 __isl_take isl_set *set2);
3074         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
3075                 __isl_take isl_basic_map *bmap1,
3076                 __isl_take isl_basic_map *bmap2);
3077         __isl_give isl_map *isl_map_flat_domain_product(
3078                 __isl_take isl_map *map1,
3079                 __isl_take isl_map *map2);
3080         __isl_give isl_map *isl_map_flat_range_product(
3081                 __isl_take isl_map *map1,
3082                 __isl_take isl_map *map2);
3083         __isl_give isl_union_map *isl_union_map_flat_range_product(
3084                 __isl_take isl_union_map *umap1,
3085                 __isl_take isl_union_map *umap2);
3086         __isl_give isl_basic_map *isl_basic_map_flat_product(
3087                 __isl_take isl_basic_map *bmap1,
3088                 __isl_take isl_basic_map *bmap2);
3089         __isl_give isl_map *isl_map_flat_product(
3090                 __isl_take isl_map *map1,
3091                 __isl_take isl_map *map2);
3092
3093 =item * Simplification
3094
3095         __isl_give isl_basic_set *isl_basic_set_gist(
3096                 __isl_take isl_basic_set *bset,
3097                 __isl_take isl_basic_set *context);
3098         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
3099                 __isl_take isl_set *context);
3100         __isl_give isl_set *isl_set_gist_params(
3101                 __isl_take isl_set *set,
3102                 __isl_take isl_set *context);
3103         __isl_give isl_union_set *isl_union_set_gist(
3104                 __isl_take isl_union_set *uset,
3105                 __isl_take isl_union_set *context);
3106         __isl_give isl_union_set *isl_union_set_gist_params(
3107                 __isl_take isl_union_set *uset,
3108                 __isl_take isl_set *set);
3109         __isl_give isl_basic_map *isl_basic_map_gist(
3110                 __isl_take isl_basic_map *bmap,
3111                 __isl_take isl_basic_map *context);
3112         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
3113                 __isl_take isl_map *context);
3114         __isl_give isl_map *isl_map_gist_params(
3115                 __isl_take isl_map *map,
3116                 __isl_take isl_set *context);
3117         __isl_give isl_map *isl_map_gist_domain(
3118                 __isl_take isl_map *map,
3119                 __isl_take isl_set *context);
3120         __isl_give isl_map *isl_map_gist_range(
3121                 __isl_take isl_map *map,
3122                 __isl_take isl_set *context);
3123         __isl_give isl_union_map *isl_union_map_gist(
3124                 __isl_take isl_union_map *umap,
3125                 __isl_take isl_union_map *context);
3126         __isl_give isl_union_map *isl_union_map_gist_params(
3127                 __isl_take isl_union_map *umap,
3128                 __isl_take isl_set *set);
3129         __isl_give isl_union_map *isl_union_map_gist_domain(
3130                 __isl_take isl_union_map *umap,
3131                 __isl_take isl_union_set *uset);
3132         __isl_give isl_union_map *isl_union_map_gist_range(
3133                 __isl_take isl_union_map *umap,
3134                 __isl_take isl_union_set *uset);
3135
3136 The gist operation returns a set or relation that has the
3137 same intersection with the context as the input set or relation.
3138 Any implicit equality in the intersection is made explicit in the result,
3139 while all inequalities that are redundant with respect to the intersection
3140 are removed.
3141 In case of union sets and relations, the gist operation is performed
3142 per space.
3143
3144 =back
3145
3146 =head3 Lexicographic Optimization
3147
3148 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
3149 the following functions
3150 compute a set that contains the lexicographic minimum or maximum
3151 of the elements in C<set> (or C<bset>) for those values of the parameters
3152 that satisfy C<dom>.
3153 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3154 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
3155 has no elements.
3156 In other words, the union of the parameter values
3157 for which the result is non-empty and of C<*empty>
3158 is equal to C<dom>.
3159
3160         __isl_give isl_set *isl_basic_set_partial_lexmin(
3161                 __isl_take isl_basic_set *bset,
3162                 __isl_take isl_basic_set *dom,
3163                 __isl_give isl_set **empty);
3164         __isl_give isl_set *isl_basic_set_partial_lexmax(
3165                 __isl_take isl_basic_set *bset,
3166                 __isl_take isl_basic_set *dom,
3167                 __isl_give isl_set **empty);
3168         __isl_give isl_set *isl_set_partial_lexmin(
3169                 __isl_take isl_set *set, __isl_take isl_set *dom,
3170                 __isl_give isl_set **empty);
3171         __isl_give isl_set *isl_set_partial_lexmax(
3172                 __isl_take isl_set *set, __isl_take isl_set *dom,
3173                 __isl_give isl_set **empty);
3174
3175 Given a (basic) set C<set> (or C<bset>), the following functions simply
3176 return a set containing the lexicographic minimum or maximum
3177 of the elements in C<set> (or C<bset>).
3178 In case of union sets, the optimum is computed per space.
3179
3180         __isl_give isl_set *isl_basic_set_lexmin(
3181                 __isl_take isl_basic_set *bset);
3182         __isl_give isl_set *isl_basic_set_lexmax(
3183                 __isl_take isl_basic_set *bset);
3184         __isl_give isl_set *isl_set_lexmin(
3185                 __isl_take isl_set *set);
3186         __isl_give isl_set *isl_set_lexmax(
3187                 __isl_take isl_set *set);
3188         __isl_give isl_union_set *isl_union_set_lexmin(
3189                 __isl_take isl_union_set *uset);
3190         __isl_give isl_union_set *isl_union_set_lexmax(
3191                 __isl_take isl_union_set *uset);
3192
3193 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
3194 the following functions
3195 compute a relation that maps each element of C<dom>
3196 to the single lexicographic minimum or maximum
3197 of the elements that are associated to that same
3198 element in C<map> (or C<bmap>).
3199 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3200 that contains the elements in C<dom> that do not map
3201 to any elements in C<map> (or C<bmap>).
3202 In other words, the union of the domain of the result and of C<*empty>
3203 is equal to C<dom>.
3204
3205         __isl_give isl_map *isl_basic_map_partial_lexmax(
3206                 __isl_take isl_basic_map *bmap,
3207                 __isl_take isl_basic_set *dom,
3208                 __isl_give isl_set **empty);
3209         __isl_give isl_map *isl_basic_map_partial_lexmin(
3210                 __isl_take isl_basic_map *bmap,
3211                 __isl_take isl_basic_set *dom,
3212                 __isl_give isl_set **empty);
3213         __isl_give isl_map *isl_map_partial_lexmax(
3214                 __isl_take isl_map *map, __isl_take isl_set *dom,
3215                 __isl_give isl_set **empty);
3216         __isl_give isl_map *isl_map_partial_lexmin(
3217                 __isl_take isl_map *map, __isl_take isl_set *dom,
3218                 __isl_give isl_set **empty);
3219
3220 Given a (basic) map C<map> (or C<bmap>), the following functions simply
3221 return a map mapping each element in the domain of
3222 C<map> (or C<bmap>) to the lexicographic minimum or maximum
3223 of all elements associated to that element.
3224 In case of union relations, the optimum is computed per space.
3225
3226         __isl_give isl_map *isl_basic_map_lexmin(
3227                 __isl_take isl_basic_map *bmap);
3228         __isl_give isl_map *isl_basic_map_lexmax(
3229                 __isl_take isl_basic_map *bmap);
3230         __isl_give isl_map *isl_map_lexmin(
3231                 __isl_take isl_map *map);
3232         __isl_give isl_map *isl_map_lexmax(
3233                 __isl_take isl_map *map);
3234         __isl_give isl_union_map *isl_union_map_lexmin(
3235                 __isl_take isl_union_map *umap);
3236         __isl_give isl_union_map *isl_union_map_lexmax(
3237                 __isl_take isl_union_map *umap);
3238
3239 The following functions return their result in the form of
3240 a piecewise multi-affine expression
3241 (See L<"Piecewise Multiple Quasi Affine Expressions">),
3242 but are otherwise equivalent to the corresponding functions
3243 returning a basic set or relation.
3244
3245         __isl_give isl_pw_multi_aff *
3246         isl_basic_map_lexmin_pw_multi_aff(
3247                 __isl_take isl_basic_map *bmap);
3248         __isl_give isl_pw_multi_aff *
3249         isl_basic_set_partial_lexmin_pw_multi_aff(
3250                 __isl_take isl_basic_set *bset,
3251                 __isl_take isl_basic_set *dom,
3252                 __isl_give isl_set **empty);
3253         __isl_give isl_pw_multi_aff *
3254         isl_basic_set_partial_lexmax_pw_multi_aff(
3255                 __isl_take isl_basic_set *bset,
3256                 __isl_take isl_basic_set *dom,
3257                 __isl_give isl_set **empty);
3258         __isl_give isl_pw_multi_aff *
3259         isl_basic_map_partial_lexmin_pw_multi_aff(
3260                 __isl_take isl_basic_map *bmap,
3261                 __isl_take isl_basic_set *dom,
3262                 __isl_give isl_set **empty);
3263         __isl_give isl_pw_multi_aff *
3264         isl_basic_map_partial_lexmax_pw_multi_aff(
3265                 __isl_take isl_basic_map *bmap,
3266                 __isl_take isl_basic_set *dom,
3267                 __isl_give isl_set **empty);
3268         __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
3269                 __isl_take isl_set *set);
3270         __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
3271                 __isl_take isl_set *set);
3272         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
3273                 __isl_take isl_map *map);
3274         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
3275                 __isl_take isl_map *map);
3276
3277 =head2 Lists
3278
3279 Lists are defined over several element types, including
3280 C<isl_val>, C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_constraint>,
3281 C<isl_basic_set>, C<isl_set>, C<isl_ast_expr> and C<isl_ast_node>.
3282 Here we take lists of C<isl_set>s as an example.
3283 Lists can be created, copied, modified and freed using the following functions.
3284
3285         #include <isl/list.h>
3286         __isl_give isl_set_list *isl_set_list_from_set(
3287                 __isl_take isl_set *el);
3288         __isl_give isl_set_list *isl_set_list_alloc(
3289                 isl_ctx *ctx, int n);
3290         __isl_give isl_set_list *isl_set_list_copy(
3291                 __isl_keep isl_set_list *list);
3292         __isl_give isl_set_list *isl_set_list_insert(
3293                 __isl_take isl_set_list *list, unsigned pos,
3294                 __isl_take isl_set *el);
3295         __isl_give isl_set_list *isl_set_list_add(
3296                 __isl_take isl_set_list *list,
3297                 __isl_take isl_set *el);
3298         __isl_give isl_set_list *isl_set_list_drop(
3299                 __isl_take isl_set_list *list,
3300                 unsigned first, unsigned n);
3301         __isl_give isl_set_list *isl_set_list_set_set(
3302                 __isl_take isl_set_list *list, int index,
3303                 __isl_take isl_set *set);
3304         __isl_give isl_set_list *isl_set_list_concat(
3305                 __isl_take isl_set_list *list1,
3306                 __isl_take isl_set_list *list2);
3307         __isl_give isl_set_list *isl_set_list_sort(
3308                 __isl_take isl_set_list *list,
3309                 int (*cmp)(__isl_keep isl_set *a,
3310                         __isl_keep isl_set *b, void *user),
3311                 void *user);
3312         void *isl_set_list_free(__isl_take isl_set_list *list);
3313
3314 C<isl_set_list_alloc> creates an empty list with a capacity for
3315 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
3316 element.
3317
3318 Lists can be inspected using the following functions.
3319
3320         #include <isl/list.h>
3321         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
3322         int isl_set_list_n_set(__isl_keep isl_set_list *list);
3323         __isl_give isl_set *isl_set_list_get_set(
3324                 __isl_keep isl_set_list *list, int index);
3325         int isl_set_list_foreach(__isl_keep isl_set_list *list,
3326                 int (*fn)(__isl_take isl_set *el, void *user),
3327                 void *user);
3328         int isl_set_list_foreach_scc(__isl_keep isl_set_list *list,
3329                 int (*follows)(__isl_keep isl_set *a,
3330                         __isl_keep isl_set *b, void *user),
3331                 void *follows_user
3332                 int (*fn)(__isl_take isl_set *el, void *user),
3333                 void *fn_user);
3334
3335 The function C<isl_set_list_foreach_scc> calls C<fn> on each of the
3336 strongly connected components of the graph with as vertices the elements
3337 of C<list> and a directed edge from vertex C<b> to vertex C<a>
3338 iff C<follows(a, b)> returns C<1>.  The callbacks C<follows> and C<fn>
3339 should return C<-1> on error.
3340
3341 Lists can be printed using
3342
3343         #include <isl/list.h>
3344         __isl_give isl_printer *isl_printer_print_set_list(
3345                 __isl_take isl_printer *p,
3346                 __isl_keep isl_set_list *list);
3347
3348 =head2 Multiple Values
3349
3350 An C<isl_multi_val> object represents a sequence of zero or more values,
3351 living in a set space.
3352
3353 An C<isl_multi_val> can be constructed from an C<isl_val_list>
3354 using the following function
3355
3356         #include <isl/val.h>
3357         __isl_give isl_multi_val *isl_multi_val_from_val_list(
3358                 __isl_take isl_space *space,
3359                 __isl_take isl_val_list *list);
3360
3361 The zero multiple value (with value zero for each set dimension)
3362 can be created using the following function.
3363
3364         #include <isl/val.h>
3365         __isl_give isl_multi_val *isl_multi_val_zero(
3366                 __isl_take isl_space *space);
3367
3368 Multiple values can be copied and freed using
3369
3370         #include <isl/val.h>
3371         __isl_give isl_multi_val *isl_multi_val_copy(
3372                 __isl_keep isl_multi_val *mv);
3373         void *isl_multi_val_free(__isl_take isl_multi_val *mv);
3374
3375 They can be inspected using
3376
3377         #include <isl/val.h>
3378         isl_ctx *isl_multi_val_get_ctx(
3379                 __isl_keep isl_multi_val *mv);
3380         unsigned isl_multi_val_dim(__isl_keep isl_multi_val *mv,
3381                 enum isl_dim_type type);
3382         __isl_give isl_val *isl_multi_val_get_val(
3383                 __isl_keep isl_multi_val *mv, int pos);
3384         const char *isl_multi_val_get_tuple_name(
3385                 __isl_keep isl_multi_val *mv,
3386                 enum isl_dim_type type);
3387
3388 They can be modified using
3389
3390         #include <isl/val.h>
3391         __isl_give isl_multi_val *isl_multi_val_set_val(
3392                 __isl_take isl_multi_val *mv, int pos,
3393                 __isl_take isl_val *val);
3394         __isl_give isl_multi_val *isl_multi_val_set_dim_name(
3395                 __isl_take isl_multi_val *mv,
3396                 enum isl_dim_type type, unsigned pos, const char *s);
3397         __isl_give isl_multi_val *isl_multi_val_set_tuple_name(
3398                 __isl_take isl_multi_val *mv,
3399                 enum isl_dim_type type, const char *s);
3400         __isl_give isl_multi_val *isl_multi_val_set_tuple_id(
3401                 __isl_take isl_multi_val *mv,
3402                 enum isl_dim_type type, __isl_take isl_id *id);
3403
3404         __isl_give isl_multi_val *isl_multi_val_insert_dims(
3405                 __isl_take isl_multi_val *mv,
3406                 enum isl_dim_type type, unsigned first, unsigned n);
3407         __isl_give isl_multi_val *isl_multi_val_add_dims(
3408                 __isl_take isl_multi_val *mv,
3409                 enum isl_dim_type type, unsigned n);
3410         __isl_give isl_multi_val *isl_multi_val_drop_dims(
3411                 __isl_take isl_multi_val *mv,
3412                 enum isl_dim_type type, unsigned first, unsigned n);
3413
3414 Operations include
3415
3416         #include <isl/val.h>
3417         __isl_give isl_multi_val *isl_multi_val_align_params(
3418                 __isl_take isl_multi_val *mv,
3419                 __isl_take isl_space *model);
3420         __isl_give isl_multi_val *isl_multi_val_range_splice(
3421                 __isl_take isl_multi_val *mv1, unsigned pos,
3422                 __isl_take isl_multi_val *mv2);
3423         __isl_give isl_multi_val *isl_multi_val_range_product(
3424                 __isl_take isl_multi_val *mv1,
3425                 __isl_take isl_multi_val *mv2);
3426         __isl_give isl_multi_val *isl_multi_val_flat_range_product(
3427                 __isl_take isl_multi_val *mv1,
3428                 __isl_take isl_multi_aff *mv2);
3429         __isl_give isl_multi_val *isl_multi_val_add_val(
3430                 __isl_take isl_multi_val *mv,
3431                 __isl_take isl_val *v);
3432         __isl_give isl_multi_val *isl_multi_val_mod_val(
3433                 __isl_take isl_multi_val *mv,
3434                 __isl_take isl_val *v);
3435
3436 =head2 Vectors
3437
3438 Vectors can be created, copied and freed using the following functions.
3439
3440         #include <isl/vec.h>
3441         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
3442                 unsigned size);
3443         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
3444         void *isl_vec_free(__isl_take isl_vec *vec);
3445
3446 Note that the elements of a newly created vector may have arbitrary values.
3447 The elements can be changed and inspected using the following functions.
3448
3449         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
3450         int isl_vec_size(__isl_keep isl_vec *vec);
3451         int isl_vec_get_element(__isl_keep isl_vec *vec,
3452                 int pos, isl_int *v);
3453         __isl_give isl_val *isl_vec_get_element_val(
3454                 __isl_keep isl_vec *vec, int pos);
3455         __isl_give isl_vec *isl_vec_set_element(
3456                 __isl_take isl_vec *vec, int pos, isl_int v);
3457         __isl_give isl_vec *isl_vec_set_element_si(
3458                 __isl_take isl_vec *vec, int pos, int v);
3459         __isl_give isl_vec *isl_vec_set_element_val(
3460                 __isl_take isl_vec *vec, int pos,
3461                 __isl_take isl_val *v);
3462         __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec,
3463                 isl_int v);
3464         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
3465                 int v);
3466         __isl_give isl_vec *isl_vec_set_val(
3467                 __isl_take isl_vec *vec, __isl_take isl_val *v);
3468         __isl_give isl_vec *isl_vec_fdiv_r(__isl_take isl_vec *vec,
3469                 isl_int m);
3470
3471 C<isl_vec_get_element> will return a negative value if anything went wrong.
3472 In that case, the value of C<*v> is undefined.
3473
3474 The following function can be used to concatenate two vectors.
3475
3476         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
3477                 __isl_take isl_vec *vec2);
3478
3479 =head2 Matrices
3480
3481 Matrices can be created, copied and freed using the following functions.
3482
3483         #include <isl/mat.h>
3484         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
3485                 unsigned n_row, unsigned n_col);
3486         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
3487         void *isl_mat_free(__isl_take isl_mat *mat);
3488
3489 Note that the elements of a newly created matrix may have arbitrary values.
3490 The elements can be changed and inspected using the following functions.
3491
3492         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
3493         int isl_mat_rows(__isl_keep isl_mat *mat);
3494         int isl_mat_cols(__isl_keep isl_mat *mat);
3495         int isl_mat_get_element(__isl_keep isl_mat *mat,
3496                 int row, int col, isl_int *v);
3497         __isl_give isl_val *isl_mat_get_element_val(
3498                 __isl_keep isl_mat *mat, int row, int col);
3499         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
3500                 int row, int col, isl_int v);
3501         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
3502                 int row, int col, int v);
3503         __isl_give isl_mat *isl_mat_set_element_val(
3504                 __isl_take isl_mat *mat, int row, int col,
3505                 __isl_take isl_val *v);
3506
3507 C<isl_mat_get_element> will return a negative value if anything went wrong.
3508 In that case, the value of C<*v> is undefined.
3509
3510 The following function can be used to compute the (right) inverse
3511 of a matrix, i.e., a matrix such that the product of the original
3512 and the inverse (in that order) is a multiple of the identity matrix.
3513 The input matrix is assumed to be of full row-rank.
3514
3515         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
3516
3517 The following function can be used to compute the (right) kernel
3518 (or null space) of a matrix, i.e., a matrix such that the product of
3519 the original and the kernel (in that order) is the zero matrix.
3520
3521         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
3522
3523 =head2 Piecewise Quasi Affine Expressions
3524
3525 The zero quasi affine expression or the quasi affine expression
3526 that is equal to a specified dimension on a given domain can be created using
3527
3528         __isl_give isl_aff *isl_aff_zero_on_domain(
3529                 __isl_take isl_local_space *ls);
3530         __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
3531                 __isl_take isl_local_space *ls);
3532         __isl_give isl_aff *isl_aff_var_on_domain(
3533                 __isl_take isl_local_space *ls,
3534                 enum isl_dim_type type, unsigned pos);
3535         __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
3536                 __isl_take isl_local_space *ls,
3537                 enum isl_dim_type type, unsigned pos);
3538
3539 Note that the space in which the resulting objects live is a map space
3540 with the given space as domain and a one-dimensional range.
3541
3542 An empty piecewise quasi affine expression (one with no cells)
3543 or a piecewise quasi affine expression with a single cell can
3544 be created using the following functions.
3545
3546         #include <isl/aff.h>
3547         __isl_give isl_pw_aff *isl_pw_aff_empty(
3548                 __isl_take isl_space *space);
3549         __isl_give isl_pw_aff *isl_pw_aff_alloc(
3550                 __isl_take isl_set *set, __isl_take isl_aff *aff);
3551         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
3552                 __isl_take isl_aff *aff);
3553
3554 A piecewise quasi affine expression that is equal to 1 on a set
3555 and 0 outside the set can be created using the following function.
3556
3557         #include <isl/aff.h>
3558         __isl_give isl_pw_aff *isl_set_indicator_function(
3559                 __isl_take isl_set *set);
3560
3561 Quasi affine expressions can be copied and freed using
3562
3563         #include <isl/aff.h>
3564         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
3565         void *isl_aff_free(__isl_take isl_aff *aff);
3566
3567         __isl_give isl_pw_aff *isl_pw_aff_copy(
3568                 __isl_keep isl_pw_aff *pwaff);
3569         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
3570
3571 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
3572 using the following function.  The constraint is required to have
3573 a non-zero coefficient for the specified dimension.
3574
3575         #include <isl/constraint.h>
3576         __isl_give isl_aff *isl_constraint_get_bound(
3577                 __isl_keep isl_constraint *constraint,
3578                 enum isl_dim_type type, int pos);
3579
3580 The entire affine expression of the constraint can also be extracted
3581 using the following function.
3582
3583         #include <isl/constraint.h>
3584         __isl_give isl_aff *isl_constraint_get_aff(
3585                 __isl_keep isl_constraint *constraint);
3586
3587 Conversely, an equality constraint equating
3588 the affine expression to zero or an inequality constraint enforcing
3589 the affine expression to be non-negative, can be constructed using
3590
3591         __isl_give isl_constraint *isl_equality_from_aff(
3592                 __isl_take isl_aff *aff);
3593         __isl_give isl_constraint *isl_inequality_from_aff(
3594                 __isl_take isl_aff *aff);
3595
3596 The expression can be inspected using
3597
3598         #include <isl/aff.h>
3599         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
3600         int isl_aff_dim(__isl_keep isl_aff *aff,
3601                 enum isl_dim_type type);
3602         __isl_give isl_local_space *isl_aff_get_domain_local_space(
3603                 __isl_keep isl_aff *aff);
3604         __isl_give isl_local_space *isl_aff_get_local_space(
3605                 __isl_keep isl_aff *aff);
3606         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3607                 enum isl_dim_type type, unsigned pos);
3608         const char *isl_pw_aff_get_dim_name(
3609                 __isl_keep isl_pw_aff *pa,
3610                 enum isl_dim_type type, unsigned pos);
3611         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3612                 enum isl_dim_type type, unsigned pos);
3613         __isl_give isl_id *isl_pw_aff_get_dim_id(
3614                 __isl_keep isl_pw_aff *pa,
3615                 enum isl_dim_type type, unsigned pos);
3616         __isl_give isl_id *isl_pw_aff_get_tuple_id(
3617                 __isl_keep isl_pw_aff *pa,
3618                 enum isl_dim_type type);
3619         int isl_aff_get_constant(__isl_keep isl_aff *aff,
3620                 isl_int *v);
3621         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
3622                 enum isl_dim_type type, int pos, isl_int *v);
3623         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
3624                 isl_int *v);
3625         __isl_give isl_aff *isl_aff_get_div(
3626                 __isl_keep isl_aff *aff, int pos);
3627
3628         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3629         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3630                 int (*fn)(__isl_take isl_set *set,
3631                           __isl_take isl_aff *aff,
3632                           void *user), void *user);
3633
3634         int isl_aff_is_cst(__isl_keep isl_aff *aff);
3635         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3636
3637         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3638                 enum isl_dim_type type, unsigned first, unsigned n);
3639         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3640                 enum isl_dim_type type, unsigned first, unsigned n);
3641
3642         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3643         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3644                 enum isl_dim_type type);
3645         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3646
3647 It can be modified using
3648
3649         #include <isl/aff.h>
3650         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3651                 __isl_take isl_pw_aff *pwaff,
3652                 enum isl_dim_type type, __isl_take isl_id *id);
3653         __isl_give isl_aff *isl_aff_set_dim_name(
3654                 __isl_take isl_aff *aff, enum isl_dim_type type,
3655                 unsigned pos, const char *s);
3656         __isl_give isl_aff *isl_aff_set_dim_id(
3657                 __isl_take isl_aff *aff, enum isl_dim_type type,
3658                 unsigned pos, __isl_take isl_id *id);
3659         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3660                 __isl_take isl_pw_aff *pma,
3661                 enum isl_dim_type type, unsigned pos,
3662                 __isl_take isl_id *id);
3663         __isl_give isl_aff *isl_aff_set_constant(
3664                 __isl_take isl_aff *aff, isl_int v);
3665         __isl_give isl_aff *isl_aff_set_constant_si(
3666                 __isl_take isl_aff *aff, int v);
3667         __isl_give isl_aff *isl_aff_set_coefficient(
3668                 __isl_take isl_aff *aff,
3669                 enum isl_dim_type type, int pos, isl_int v);
3670         __isl_give isl_aff *isl_aff_set_coefficient_si(
3671                 __isl_take isl_aff *aff,
3672                 enum isl_dim_type type, int pos, int v);
3673         __isl_give isl_aff *isl_aff_set_denominator(
3674                 __isl_take isl_aff *aff, isl_int v);
3675
3676         __isl_give isl_aff *isl_aff_add_constant(
3677                 __isl_take isl_aff *aff, isl_int v);
3678         __isl_give isl_aff *isl_aff_add_constant_si(
3679                 __isl_take isl_aff *aff, int v);
3680         __isl_give isl_aff *isl_aff_add_constant_num(
3681                 __isl_take isl_aff *aff, isl_int v);
3682         __isl_give isl_aff *isl_aff_add_constant_num_si(
3683                 __isl_take isl_aff *aff, int v);
3684         __isl_give isl_aff *isl_aff_add_coefficient(
3685                 __isl_take isl_aff *aff,
3686                 enum isl_dim_type type, int pos, isl_int v);
3687         __isl_give isl_aff *isl_aff_add_coefficient_si(
3688                 __isl_take isl_aff *aff,
3689                 enum isl_dim_type type, int pos, int v);
3690
3691         __isl_give isl_aff *isl_aff_insert_dims(
3692                 __isl_take isl_aff *aff,
3693                 enum isl_dim_type type, unsigned first, unsigned n);
3694         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3695                 __isl_take isl_pw_aff *pwaff,
3696                 enum isl_dim_type type, unsigned first, unsigned n);
3697         __isl_give isl_aff *isl_aff_add_dims(
3698                 __isl_take isl_aff *aff,
3699                 enum isl_dim_type type, unsigned n);
3700         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3701                 __isl_take isl_pw_aff *pwaff,
3702                 enum isl_dim_type type, unsigned n);
3703         __isl_give isl_aff *isl_aff_drop_dims(
3704                 __isl_take isl_aff *aff,
3705                 enum isl_dim_type type, unsigned first, unsigned n);
3706         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
3707                 __isl_take isl_pw_aff *pwaff,
3708                 enum isl_dim_type type, unsigned first, unsigned n);
3709
3710 Note that the C<set_constant> and C<set_coefficient> functions
3711 set the I<numerator> of the constant or coefficient, while
3712 C<add_constant> and C<add_coefficient> add an integer value to
3713 the possibly rational constant or coefficient.
3714 The C<add_constant_num> functions add an integer value to
3715 the numerator.
3716
3717 To check whether an affine expressions is obviously zero
3718 or obviously equal to some other affine expression, use
3719
3720         #include <isl/aff.h>
3721         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3722         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3723                 __isl_keep isl_aff *aff2);
3724         int isl_pw_aff_plain_is_equal(
3725                 __isl_keep isl_pw_aff *pwaff1,
3726                 __isl_keep isl_pw_aff *pwaff2);
3727
3728 Operations include
3729
3730         #include <isl/aff.h>
3731         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
3732                 __isl_take isl_aff *aff2);
3733         __isl_give isl_pw_aff *isl_pw_aff_add(
3734                 __isl_take isl_pw_aff *pwaff1,
3735                 __isl_take isl_pw_aff *pwaff2);
3736         __isl_give isl_pw_aff *isl_pw_aff_min(
3737                 __isl_take isl_pw_aff *pwaff1,
3738                 __isl_take isl_pw_aff *pwaff2);
3739         __isl_give isl_pw_aff *isl_pw_aff_max(
3740                 __isl_take isl_pw_aff *pwaff1,
3741                 __isl_take isl_pw_aff *pwaff2);
3742         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
3743                 __isl_take isl_aff *aff2);
3744         __isl_give isl_pw_aff *isl_pw_aff_sub(
3745                 __isl_take isl_pw_aff *pwaff1,
3746                 __isl_take isl_pw_aff *pwaff2);
3747         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
3748         __isl_give isl_pw_aff *isl_pw_aff_neg(
3749                 __isl_take isl_pw_aff *pwaff);
3750         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
3751         __isl_give isl_pw_aff *isl_pw_aff_ceil(
3752                 __isl_take isl_pw_aff *pwaff);
3753         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
3754         __isl_give isl_pw_aff *isl_pw_aff_floor(
3755                 __isl_take isl_pw_aff *pwaff);
3756         __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
3757                 isl_int mod);
3758         __isl_give isl_pw_aff *isl_pw_aff_mod(
3759                 __isl_take isl_pw_aff *pwaff, isl_int mod);
3760         __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
3761                 isl_int f);
3762         __isl_give isl_pw_aff *isl_pw_aff_scale(
3763                 __isl_take isl_pw_aff *pwaff, isl_int f);
3764         __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
3765                 isl_int f);
3766         __isl_give isl_aff *isl_aff_scale_down_ui(
3767                 __isl_take isl_aff *aff, unsigned f);
3768         __isl_give isl_pw_aff *isl_pw_aff_scale_down(
3769                 __isl_take isl_pw_aff *pwaff, isl_int f);
3770
3771         __isl_give isl_pw_aff *isl_pw_aff_list_min(
3772                 __isl_take isl_pw_aff_list *list);
3773         __isl_give isl_pw_aff *isl_pw_aff_list_max(
3774                 __isl_take isl_pw_aff_list *list);
3775
3776         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
3777                 __isl_take isl_pw_aff *pwqp);
3778
3779         __isl_give isl_aff *isl_aff_align_params(
3780                 __isl_take isl_aff *aff,
3781                 __isl_take isl_space *model);
3782         __isl_give isl_pw_aff *isl_pw_aff_align_params(
3783                 __isl_take isl_pw_aff *pwaff,
3784                 __isl_take isl_space *model);
3785
3786         __isl_give isl_aff *isl_aff_project_domain_on_params(
3787                 __isl_take isl_aff *aff);
3788
3789         __isl_give isl_aff *isl_aff_gist_params(
3790                 __isl_take isl_aff *aff,
3791                 __isl_take isl_set *context);
3792         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
3793                 __isl_take isl_set *context);
3794         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
3795                 __isl_take isl_pw_aff *pwaff,
3796                 __isl_take isl_set *context);
3797         __isl_give isl_pw_aff *isl_pw_aff_gist(
3798                 __isl_take isl_pw_aff *pwaff,
3799                 __isl_take isl_set *context);
3800
3801         __isl_give isl_set *isl_pw_aff_domain(
3802                 __isl_take isl_pw_aff *pwaff);
3803         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
3804                 __isl_take isl_pw_aff *pa,
3805                 __isl_take isl_set *set);
3806         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
3807                 __isl_take isl_pw_aff *pa,
3808                 __isl_take isl_set *set);
3809
3810         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3811                 __isl_take isl_aff *aff2);
3812         __isl_give isl_aff *isl_aff_div(__isl_take isl_aff *aff1,
3813                 __isl_take isl_aff *aff2);
3814         __isl_give isl_pw_aff *isl_pw_aff_mul(
3815                 __isl_take isl_pw_aff *pwaff1,
3816                 __isl_take isl_pw_aff *pwaff2);
3817         __isl_give isl_pw_aff *isl_pw_aff_div(
3818                 __isl_take isl_pw_aff *pa1,
3819                 __isl_take isl_pw_aff *pa2);
3820         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
3821                 __isl_take isl_pw_aff *pa1,
3822                 __isl_take isl_pw_aff *pa2);
3823         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
3824                 __isl_take isl_pw_aff *pa1,
3825                 __isl_take isl_pw_aff *pa2);
3826
3827 When multiplying two affine expressions, at least one of the two needs
3828 to be a constant.  Similarly, when dividing an affine expression by another,
3829 the second expression needs to be a constant.
3830 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
3831 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
3832 remainder.
3833
3834         #include <isl/aff.h>
3835         __isl_give isl_aff *isl_aff_pullback_multi_aff(
3836                 __isl_take isl_aff *aff,
3837                 __isl_take isl_multi_aff *ma);
3838         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
3839                 __isl_take isl_pw_aff *pa,
3840                 __isl_take isl_multi_aff *ma);
3841         __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
3842                 __isl_take isl_pw_aff *pa,
3843                 __isl_take isl_pw_multi_aff *pma);
3844
3845 These functions precompose the input expression by the given
3846 C<isl_multi_aff> or C<isl_pw_multi_aff>.  In other words,
3847 the C<isl_multi_aff> or C<isl_pw_multi_aff> is plugged
3848 into the (piecewise) affine expression.
3849 Objects of type C<isl_multi_aff> are described in
3850 L</"Piecewise Multiple Quasi Affine Expressions">.
3851
3852         #include <isl/aff.h>
3853         __isl_give isl_basic_set *isl_aff_zero_basic_set(
3854                 __isl_take isl_aff *aff);
3855         __isl_give isl_basic_set *isl_aff_neg_basic_set(
3856                 __isl_take isl_aff *aff);
3857         __isl_give isl_basic_set *isl_aff_le_basic_set(
3858                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3859         __isl_give isl_basic_set *isl_aff_ge_basic_set(
3860                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3861         __isl_give isl_set *isl_pw_aff_eq_set(
3862                 __isl_take isl_pw_aff *pwaff1,
3863                 __isl_take isl_pw_aff *pwaff2);
3864         __isl_give isl_set *isl_pw_aff_ne_set(
3865                 __isl_take isl_pw_aff *pwaff1,
3866                 __isl_take isl_pw_aff *pwaff2);
3867         __isl_give isl_set *isl_pw_aff_le_set(
3868                 __isl_take isl_pw_aff *pwaff1,
3869                 __isl_take isl_pw_aff *pwaff2);
3870         __isl_give isl_set *isl_pw_aff_lt_set(
3871                 __isl_take isl_pw_aff *pwaff1,
3872                 __isl_take isl_pw_aff *pwaff2);
3873         __isl_give isl_set *isl_pw_aff_ge_set(
3874                 __isl_take isl_pw_aff *pwaff1,
3875                 __isl_take isl_pw_aff *pwaff2);
3876         __isl_give isl_set *isl_pw_aff_gt_set(
3877                 __isl_take isl_pw_aff *pwaff1,
3878                 __isl_take isl_pw_aff *pwaff2);
3879
3880         __isl_give isl_set *isl_pw_aff_list_eq_set(
3881                 __isl_take isl_pw_aff_list *list1,
3882                 __isl_take isl_pw_aff_list *list2);
3883         __isl_give isl_set *isl_pw_aff_list_ne_set(
3884                 __isl_take isl_pw_aff_list *list1,
3885                 __isl_take isl_pw_aff_list *list2);
3886         __isl_give isl_set *isl_pw_aff_list_le_set(
3887                 __isl_take isl_pw_aff_list *list1,
3888                 __isl_take isl_pw_aff_list *list2);
3889         __isl_give isl_set *isl_pw_aff_list_lt_set(
3890                 __isl_take isl_pw_aff_list *list1,
3891                 __isl_take isl_pw_aff_list *list2);
3892         __isl_give isl_set *isl_pw_aff_list_ge_set(
3893                 __isl_take isl_pw_aff_list *list1,
3894                 __isl_take isl_pw_aff_list *list2);
3895         __isl_give isl_set *isl_pw_aff_list_gt_set(
3896                 __isl_take isl_pw_aff_list *list1,
3897                 __isl_take isl_pw_aff_list *list2);
3898
3899 The function C<isl_aff_neg_basic_set> returns a basic set
3900 containing those elements in the domain space
3901 of C<aff> where C<aff> is negative.
3902 The function C<isl_aff_ge_basic_set> returns a basic set
3903 containing those elements in the shared space
3904 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3905 The function C<isl_pw_aff_ge_set> returns a set
3906 containing those elements in the shared domain
3907 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3908 The functions operating on C<isl_pw_aff_list> apply the corresponding
3909 C<isl_pw_aff> function to each pair of elements in the two lists.
3910
3911         #include <isl/aff.h>
3912         __isl_give isl_set *isl_pw_aff_nonneg_set(
3913                 __isl_take isl_pw_aff *pwaff);
3914         __isl_give isl_set *isl_pw_aff_zero_set(
3915                 __isl_take isl_pw_aff *pwaff);
3916         __isl_give isl_set *isl_pw_aff_non_zero_set(
3917                 __isl_take isl_pw_aff *pwaff);
3918
3919 The function C<isl_pw_aff_nonneg_set> returns a set
3920 containing those elements in the domain
3921 of C<pwaff> where C<pwaff> is non-negative.
3922
3923         #include <isl/aff.h>
3924         __isl_give isl_pw_aff *isl_pw_aff_cond(
3925                 __isl_take isl_pw_aff *cond,
3926                 __isl_take isl_pw_aff *pwaff_true,
3927                 __isl_take isl_pw_aff *pwaff_false);
3928
3929 The function C<isl_pw_aff_cond> performs a conditional operator
3930 and returns an expression that is equal to C<pwaff_true>
3931 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
3932 where C<cond> is zero.
3933
3934         #include <isl/aff.h>
3935         __isl_give isl_pw_aff *isl_pw_aff_union_min(
3936                 __isl_take isl_pw_aff *pwaff1,
3937                 __isl_take isl_pw_aff *pwaff2);
3938         __isl_give isl_pw_aff *isl_pw_aff_union_max(
3939                 __isl_take isl_pw_aff *pwaff1,
3940                 __isl_take isl_pw_aff *pwaff2);
3941         __isl_give isl_pw_aff *isl_pw_aff_union_add(
3942                 __isl_take isl_pw_aff *pwaff1,
3943                 __isl_take isl_pw_aff *pwaff2);
3944
3945 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3946 expression with a domain that is the union of those of C<pwaff1> and
3947 C<pwaff2> and such that on each cell, the quasi-affine expression is
3948 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
3949 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
3950 associated expression is the defined one.
3951
3952 An expression can be read from input using
3953
3954         #include <isl/aff.h>
3955         __isl_give isl_aff *isl_aff_read_from_str(
3956                 isl_ctx *ctx, const char *str);
3957         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3958                 isl_ctx *ctx, const char *str);
3959
3960 An expression can be printed using
3961
3962         #include <isl/aff.h>
3963         __isl_give isl_printer *isl_printer_print_aff(
3964                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3965
3966         __isl_give isl_printer *isl_printer_print_pw_aff(
3967                 __isl_take isl_printer *p,
3968                 __isl_keep isl_pw_aff *pwaff);
3969
3970 =head2 Piecewise Multiple Quasi Affine Expressions
3971
3972 An C<isl_multi_aff> object represents a sequence of
3973 zero or more affine expressions, all defined on the same domain space.
3974 Similarly, an C<isl_multi_pw_aff> object represents a sequence of
3975 zero or more piecewise affine expressions.
3976
3977 An C<isl_multi_aff> can be constructed from a single
3978 C<isl_aff> or an C<isl_aff_list> using the
3979 following functions.  Similarly for C<isl_multi_pw_aff>.
3980
3981         #include <isl/aff.h>
3982         __isl_give isl_multi_aff *isl_multi_aff_from_aff(
3983                 __isl_take isl_aff *aff);
3984         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
3985                 __isl_take isl_pw_aff *pa);
3986         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
3987                 __isl_take isl_space *space,
3988                 __isl_take isl_aff_list *list);
3989
3990 An empty piecewise multiple quasi affine expression (one with no cells),
3991 the zero piecewise multiple quasi affine expression (with value zero
3992 for each output dimension),
3993 a piecewise multiple quasi affine expression with a single cell (with
3994 either a universe or a specified domain) or
3995 a zero-dimensional piecewise multiple quasi affine expression
3996 on a given domain
3997 can be created using the following functions.
3998
3999         #include <isl/aff.h>
4000         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
4001                 __isl_take isl_space *space);
4002         __isl_give isl_multi_aff *isl_multi_aff_zero(
4003                 __isl_take isl_space *space);
4004         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
4005                 __isl_take isl_space *space);
4006         __isl_give isl_multi_aff *isl_multi_aff_identity(
4007                 __isl_take isl_space *space);
4008         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
4009                 __isl_take isl_space *space);
4010         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
4011                 __isl_take isl_space *space);
4012         __isl_give isl_pw_multi_aff *
4013         isl_pw_multi_aff_from_multi_aff(
4014                 __isl_take isl_multi_aff *ma);
4015         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
4016                 __isl_take isl_set *set,
4017                 __isl_take isl_multi_aff *maff);
4018         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
4019                 __isl_take isl_set *set);
4020
4021         __isl_give isl_union_pw_multi_aff *
4022         isl_union_pw_multi_aff_empty(
4023                 __isl_take isl_space *space);
4024         __isl_give isl_union_pw_multi_aff *
4025         isl_union_pw_multi_aff_add_pw_multi_aff(
4026                 __isl_take isl_union_pw_multi_aff *upma,
4027                 __isl_take isl_pw_multi_aff *pma);
4028         __isl_give isl_union_pw_multi_aff *
4029         isl_union_pw_multi_aff_from_domain(
4030                 __isl_take isl_union_set *uset);
4031
4032 A piecewise multiple quasi affine expression can also be initialized
4033 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
4034 and the C<isl_map> is single-valued.
4035 In case of a conversion from an C<isl_union_set> or an C<isl_union_map>
4036 to an C<isl_union_pw_multi_aff>, these properties need to hold in each space.
4037
4038         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
4039                 __isl_take isl_set *set);
4040         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
4041                 __isl_take isl_map *map);
4042
4043         __isl_give isl_union_pw_multi_aff *
4044         isl_union_pw_multi_aff_from_union_set(
4045                 __isl_take isl_union_set *uset);
4046         __isl_give isl_union_pw_multi_aff *
4047         isl_union_pw_multi_aff_from_union_map(
4048                 __isl_take isl_union_map *umap);
4049
4050 Multiple quasi affine expressions can be copied and freed using
4051
4052         #include <isl/aff.h>
4053         __isl_give isl_multi_aff *isl_multi_aff_copy(
4054                 __isl_keep isl_multi_aff *maff);
4055         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
4056
4057         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
4058                 __isl_keep isl_pw_multi_aff *pma);
4059         void *isl_pw_multi_aff_free(
4060                 __isl_take isl_pw_multi_aff *pma);
4061
4062         __isl_give isl_union_pw_multi_aff *
4063         isl_union_pw_multi_aff_copy(
4064                 __isl_keep isl_union_pw_multi_aff *upma);
4065         void *isl_union_pw_multi_aff_free(
4066                 __isl_take isl_union_pw_multi_aff *upma);
4067
4068         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
4069                 __isl_keep isl_multi_pw_aff *mpa);
4070         void *isl_multi_pw_aff_free(
4071                 __isl_take isl_multi_pw_aff *mpa);
4072
4073 The expression can be inspected using
4074
4075         #include <isl/aff.h>
4076         isl_ctx *isl_multi_aff_get_ctx(
4077                 __isl_keep isl_multi_aff *maff);
4078         isl_ctx *isl_pw_multi_aff_get_ctx(
4079                 __isl_keep isl_pw_multi_aff *pma);
4080         isl_ctx *isl_union_pw_multi_aff_get_ctx(
4081                 __isl_keep isl_union_pw_multi_aff *upma);
4082         isl_ctx *isl_multi_pw_aff_get_ctx(
4083                 __isl_keep isl_multi_pw_aff *mpa);
4084         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
4085                 enum isl_dim_type type);
4086         unsigned isl_pw_multi_aff_dim(
4087                 __isl_keep isl_pw_multi_aff *pma,
4088                 enum isl_dim_type type);
4089         unsigned isl_multi_pw_aff_dim(
4090                 __isl_keep isl_multi_pw_aff *mpa,
4091                 enum isl_dim_type type);
4092         __isl_give isl_aff *isl_multi_aff_get_aff(
4093                 __isl_keep isl_multi_aff *multi, int pos);
4094         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
4095                 __isl_keep isl_pw_multi_aff *pma, int pos);
4096         __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
4097                 __isl_keep isl_multi_pw_aff *mpa, int pos);
4098         const char *isl_pw_multi_aff_get_dim_name(
4099                 __isl_keep isl_pw_multi_aff *pma,
4100                 enum isl_dim_type type, unsigned pos);
4101         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
4102                 __isl_keep isl_pw_multi_aff *pma,
4103                 enum isl_dim_type type, unsigned pos);
4104         const char *isl_multi_aff_get_tuple_name(
4105                 __isl_keep isl_multi_aff *multi,
4106                 enum isl_dim_type type);
4107         int isl_pw_multi_aff_has_tuple_name(
4108                 __isl_keep isl_pw_multi_aff *pma,
4109                 enum isl_dim_type type);
4110         const char *isl_pw_multi_aff_get_tuple_name(
4111                 __isl_keep isl_pw_multi_aff *pma,
4112                 enum isl_dim_type type);
4113         int isl_pw_multi_aff_has_tuple_id(
4114                 __isl_keep isl_pw_multi_aff *pma,
4115                 enum isl_dim_type type);
4116         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
4117                 __isl_keep isl_pw_multi_aff *pma,
4118                 enum isl_dim_type type);
4119
4120         int isl_pw_multi_aff_foreach_piece(
4121                 __isl_keep isl_pw_multi_aff *pma,
4122                 int (*fn)(__isl_take isl_set *set,
4123                             __isl_take isl_multi_aff *maff,
4124                             void *user), void *user);
4125
4126         int isl_union_pw_multi_aff_foreach_pw_multi_aff(
4127                 __isl_keep isl_union_pw_multi_aff *upma,
4128                 int (*fn)(__isl_take isl_pw_multi_aff *pma,
4129                             void *user), void *user);
4130
4131 It can be modified using
4132
4133         #include <isl/aff.h>
4134         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
4135                 __isl_take isl_multi_aff *multi, int pos,
4136                 __isl_take isl_aff *aff);
4137         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
4138                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
4139                 __isl_take isl_pw_aff *pa);
4140         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
4141                 __isl_take isl_multi_aff *maff,
4142                 enum isl_dim_type type, unsigned pos, const char *s);
4143         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
4144                 __isl_take isl_multi_aff *maff,
4145                 enum isl_dim_type type, const char *s);
4146         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
4147                 __isl_take isl_multi_aff *maff,
4148                 enum isl_dim_type type, __isl_take isl_id *id);
4149         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
4150                 __isl_take isl_pw_multi_aff *pma,
4151                 enum isl_dim_type type, __isl_take isl_id *id);
4152
4153         __isl_give isl_multi_pw_aff *
4154         isl_multi_pw_aff_set_dim_name(
4155                 __isl_take isl_multi_pw_aff *mpa,
4156                 enum isl_dim_type type, unsigned pos, const char *s);
4157         __isl_give isl_multi_pw_aff *
4158         isl_multi_pw_aff_set_tuple_name(
4159                 __isl_take isl_multi_pw_aff *mpa,
4160                 enum isl_dim_type type, const char *s);
4161
4162         __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
4163                 __isl_take isl_multi_aff *ma,
4164                 enum isl_dim_type type, unsigned first, unsigned n);
4165         __isl_give isl_multi_aff *isl_multi_aff_add_dims(
4166                 __isl_take isl_multi_aff *ma,
4167                 enum isl_dim_type type, unsigned n);
4168         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
4169                 __isl_take isl_multi_aff *maff,
4170                 enum isl_dim_type type, unsigned first, unsigned n);
4171         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
4172                 __isl_take isl_pw_multi_aff *pma,
4173                 enum isl_dim_type type, unsigned first, unsigned n);
4174
4175         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
4176                 __isl_take isl_multi_pw_aff *mpa,
4177                 enum isl_dim_type type, unsigned first, unsigned n);
4178         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
4179                 __isl_take isl_multi_pw_aff *mpa,
4180                 enum isl_dim_type type, unsigned n);
4181
4182 To check whether two multiple affine expressions are
4183 obviously equal to each other, use
4184
4185         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
4186                 __isl_keep isl_multi_aff *maff2);
4187         int isl_pw_multi_aff_plain_is_equal(
4188                 __isl_keep isl_pw_multi_aff *pma1,
4189                 __isl_keep isl_pw_multi_aff *pma2);
4190
4191 Operations include
4192
4193         #include <isl/aff.h>
4194         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
4195                 __isl_take isl_pw_multi_aff *pma1,
4196                 __isl_take isl_pw_multi_aff *pma2);
4197         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
4198                 __isl_take isl_pw_multi_aff *pma1,
4199                 __isl_take isl_pw_multi_aff *pma2);
4200         __isl_give isl_multi_aff *isl_multi_aff_add(
4201                 __isl_take isl_multi_aff *maff1,
4202                 __isl_take isl_multi_aff *maff2);
4203         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
4204                 __isl_take isl_pw_multi_aff *pma1,
4205                 __isl_take isl_pw_multi_aff *pma2);
4206         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
4207                 __isl_take isl_union_pw_multi_aff *upma1,
4208                 __isl_take isl_union_pw_multi_aff *upma2);
4209         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
4210                 __isl_take isl_pw_multi_aff *pma1,
4211                 __isl_take isl_pw_multi_aff *pma2);
4212         __isl_give isl_multi_aff *isl_multi_aff_sub(
4213                 __isl_take isl_multi_aff *ma1,
4214                 __isl_take isl_multi_aff *ma2);
4215         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
4216                 __isl_take isl_pw_multi_aff *pma1,
4217                 __isl_take isl_pw_multi_aff *pma2);
4218         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_sub(
4219                 __isl_take isl_union_pw_multi_aff *upma1,
4220                 __isl_take isl_union_pw_multi_aff *upma2);
4221
4222 C<isl_multi_aff_sub> subtracts the second argument from the first.
4223
4224         __isl_give isl_multi_aff *isl_multi_aff_scale(
4225                 __isl_take isl_multi_aff *maff,
4226                 isl_int f);
4227         __isl_give isl_multi_aff *isl_multi_aff_scale_vec(
4228                 __isl_take isl_multi_aff *ma,
4229                 __isl_take isl_vec *v);
4230         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_vec(
4231                 __isl_take isl_pw_multi_aff *pma,
4232                 __isl_take isl_vec *v);
4233         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_scale_vec(
4234                 __isl_take isl_union_pw_multi_aff *upma,
4235                 __isl_take isl_vec *v);
4236
4237 C<isl_multi_aff_scale_vec> scales the first elements of C<ma>
4238 by the corresponding elements of C<v>.
4239
4240         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
4241                 __isl_take isl_pw_multi_aff *pma,
4242                 __isl_take isl_set *set);
4243         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
4244                 __isl_take isl_pw_multi_aff *pma,
4245                 __isl_take isl_set *set);
4246         __isl_give isl_union_pw_multi_aff *
4247         isl_union_pw_multi_aff_intersect_domain(
4248                 __isl_take isl_union_pw_multi_aff *upma,
4249                 __isl_take isl_union_set *uset);
4250         __isl_give isl_multi_aff *isl_multi_aff_lift(
4251                 __isl_take isl_multi_aff *maff,
4252                 __isl_give isl_local_space **ls);
4253         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
4254                 __isl_take isl_pw_multi_aff *pma);
4255         __isl_give isl_multi_aff *isl_multi_aff_align_params(
4256                 __isl_take isl_multi_aff *multi,
4257                 __isl_take isl_space *model);
4258         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
4259                 __isl_take isl_pw_multi_aff *pma,
4260                 __isl_take isl_space *model);
4261         __isl_give isl_pw_multi_aff *
4262         isl_pw_multi_aff_project_domain_on_params(
4263                 __isl_take isl_pw_multi_aff *pma);
4264         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
4265                 __isl_take isl_multi_aff *maff,
4266                 __isl_take isl_set *context);
4267         __isl_give isl_multi_aff *isl_multi_aff_gist(
4268                 __isl_take isl_multi_aff *maff,
4269                 __isl_take isl_set *context);
4270         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
4271                 __isl_take isl_pw_multi_aff *pma,
4272                 __isl_take isl_set *set);
4273         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
4274                 __isl_take isl_pw_multi_aff *pma,
4275                 __isl_take isl_set *set);
4276         __isl_give isl_set *isl_pw_multi_aff_domain(
4277                 __isl_take isl_pw_multi_aff *pma);
4278         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
4279                 __isl_take isl_union_pw_multi_aff *upma);
4280         __isl_give isl_multi_aff *isl_multi_aff_range_splice(
4281                 __isl_take isl_multi_aff *ma1, unsigned pos,
4282                 __isl_take isl_multi_aff *ma2);
4283         __isl_give isl_multi_aff *isl_multi_aff_splice(
4284                 __isl_take isl_multi_aff *ma1,
4285                 unsigned in_pos, unsigned out_pos,
4286                 __isl_take isl_multi_aff *ma2);
4287         __isl_give isl_multi_aff *isl_multi_aff_range_product(
4288                 __isl_take isl_multi_aff *ma1,
4289                 __isl_take isl_multi_aff *ma2);
4290         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
4291                 __isl_take isl_multi_aff *ma1,
4292                 __isl_take isl_multi_aff *ma2);
4293         __isl_give isl_multi_aff *isl_multi_aff_product(
4294                 __isl_take isl_multi_aff *ma1,
4295                 __isl_take isl_multi_aff *ma2);
4296         __isl_give isl_pw_multi_aff *
4297         isl_pw_multi_aff_range_product(
4298                 __isl_take isl_pw_multi_aff *pma1,
4299                 __isl_take isl_pw_multi_aff *pma2);
4300         __isl_give isl_pw_multi_aff *
4301         isl_pw_multi_aff_flat_range_product(
4302                 __isl_take isl_pw_multi_aff *pma1,
4303                 __isl_take isl_pw_multi_aff *pma2);
4304         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
4305                 __isl_take isl_pw_multi_aff *pma1,
4306                 __isl_take isl_pw_multi_aff *pma2);
4307         __isl_give isl_union_pw_multi_aff *
4308         isl_union_pw_multi_aff_flat_range_product(
4309                 __isl_take isl_union_pw_multi_aff *upma1,
4310                 __isl_take isl_union_pw_multi_aff *upma2);
4311         __isl_give isl_multi_pw_aff *
4312         isl_multi_pw_aff_range_splice(
4313                 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
4314                 __isl_take isl_multi_pw_aff *mpa2);
4315         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
4316                 __isl_take isl_multi_pw_aff *mpa1,
4317                 unsigned in_pos, unsigned out_pos,
4318                 __isl_take isl_multi_pw_aff *mpa2);
4319         __isl_give isl_multi_pw_aff *
4320         isl_multi_pw_aff_range_product(
4321                 __isl_take isl_multi_pw_aff *mpa1,
4322                 __isl_take isl_multi_pw_aff *mpa2);
4323         __isl_give isl_multi_pw_aff *
4324         isl_multi_pw_aff_flat_range_product(
4325                 __isl_take isl_multi_pw_aff *mpa1,
4326                 __isl_take isl_multi_pw_aff *mpa2);
4327
4328 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
4329 then it is assigned the local space that lies at the basis of
4330 the lifting applied.
4331
4332         #include <isl/aff.h>
4333         __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
4334                 __isl_take isl_multi_aff *ma1,
4335                 __isl_take isl_multi_aff *ma2);
4336         __isl_give isl_pw_multi_aff *
4337         isl_pw_multi_aff_pullback_multi_aff(
4338                 __isl_take isl_pw_multi_aff *pma,
4339                 __isl_take isl_multi_aff *ma);
4340         __isl_give isl_pw_multi_aff *
4341         isl_pw_multi_aff_pullback_pw_multi_aff(
4342                 __isl_take isl_pw_multi_aff *pma1,
4343                 __isl_take isl_pw_multi_aff *pma2);
4344
4345 The function C<isl_multi_aff_pullback_multi_aff> precomposes C<ma1> by C<ma2>.
4346 In other words, C<ma2> is plugged
4347 into C<ma1>.
4348
4349         __isl_give isl_set *isl_multi_aff_lex_le_set(
4350                 __isl_take isl_multi_aff *ma1,
4351                 __isl_take isl_multi_aff *ma2);
4352         __isl_give isl_set *isl_multi_aff_lex_ge_set(
4353                 __isl_take isl_multi_aff *ma1,
4354                 __isl_take isl_multi_aff *ma2);
4355
4356 The function C<isl_multi_aff_lex_le_set> returns a set
4357 containing those elements in the shared domain space
4358 where C<ma1> is lexicographically smaller than or
4359 equal to C<ma2>.
4360
4361 An expression can be read from input using
4362
4363         #include <isl/aff.h>
4364         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
4365                 isl_ctx *ctx, const char *str);
4366         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
4367                 isl_ctx *ctx, const char *str);
4368         __isl_give isl_union_pw_multi_aff *
4369         isl_union_pw_multi_aff_read_from_str(
4370                 isl_ctx *ctx, const char *str);
4371
4372 An expression can be printed using
4373
4374         #include <isl/aff.h>
4375         __isl_give isl_printer *isl_printer_print_multi_aff(
4376                 __isl_take isl_printer *p,
4377                 __isl_keep isl_multi_aff *maff);
4378         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
4379                 __isl_take isl_printer *p,
4380                 __isl_keep isl_pw_multi_aff *pma);
4381         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
4382                 __isl_take isl_printer *p,
4383                 __isl_keep isl_union_pw_multi_aff *upma);
4384         __isl_give isl_printer *isl_printer_print_multi_pw_aff(
4385                 __isl_take isl_printer *p,
4386                 __isl_keep isl_multi_pw_aff *mpa);
4387
4388 =head2 Points
4389
4390 Points are elements of a set.  They can be used to construct
4391 simple sets (boxes) or they can be used to represent the
4392 individual elements of a set.
4393 The zero point (the origin) can be created using
4394
4395         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
4396
4397 The coordinates of a point can be inspected, set and changed
4398 using
4399
4400         int isl_point_get_coordinate(__isl_keep isl_point *pnt,
4401                 enum isl_dim_type type, int pos, isl_int *v);
4402         __isl_give isl_val *isl_point_get_coordinate_val(
4403                 __isl_keep isl_point *pnt,
4404                 enum isl_dim_type type, int pos);
4405         __isl_give isl_point *isl_point_set_coordinate(
4406                 __isl_take isl_point *pnt,
4407                 enum isl_dim_type type, int pos, isl_int v);
4408         __isl_give isl_point *isl_point_set_coordinate_val(
4409                 __isl_take isl_point *pnt,
4410                 enum isl_dim_type type, int pos,
4411                 __isl_take isl_val *v);
4412
4413         __isl_give isl_point *isl_point_add_ui(
4414                 __isl_take isl_point *pnt,
4415                 enum isl_dim_type type, int pos, unsigned val);
4416         __isl_give isl_point *isl_point_sub_ui(
4417                 __isl_take isl_point *pnt,
4418                 enum isl_dim_type type, int pos, unsigned val);
4419
4420 Other properties can be obtained using
4421
4422         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
4423
4424 Points can be copied or freed using
4425
4426         __isl_give isl_point *isl_point_copy(
4427                 __isl_keep isl_point *pnt);
4428         void isl_point_free(__isl_take isl_point *pnt);
4429
4430 A singleton set can be created from a point using
4431
4432         __isl_give isl_basic_set *isl_basic_set_from_point(
4433                 __isl_take isl_point *pnt);
4434         __isl_give isl_set *isl_set_from_point(
4435                 __isl_take isl_point *pnt);
4436
4437 and a box can be created from two opposite extremal points using
4438
4439         __isl_give isl_basic_set *isl_basic_set_box_from_points(
4440                 __isl_take isl_point *pnt1,
4441                 __isl_take isl_point *pnt2);
4442         __isl_give isl_set *isl_set_box_from_points(
4443                 __isl_take isl_point *pnt1,
4444                 __isl_take isl_point *pnt2);
4445
4446 All elements of a B<bounded> (union) set can be enumerated using
4447 the following functions.
4448
4449         int isl_set_foreach_point(__isl_keep isl_set *set,
4450                 int (*fn)(__isl_take isl_point *pnt, void *user),
4451                 void *user);
4452         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
4453                 int (*fn)(__isl_take isl_point *pnt, void *user),
4454                 void *user);
4455
4456 The function C<fn> is called for each integer point in
4457 C<set> with as second argument the last argument of
4458 the C<isl_set_foreach_point> call.  The function C<fn>
4459 should return C<0> on success and C<-1> on failure.
4460 In the latter case, C<isl_set_foreach_point> will stop
4461 enumerating and return C<-1> as well.
4462 If the enumeration is performed successfully and to completion,
4463 then C<isl_set_foreach_point> returns C<0>.
4464
4465 To obtain a single point of a (basic) set, use
4466
4467         __isl_give isl_point *isl_basic_set_sample_point(
4468                 __isl_take isl_basic_set *bset);
4469         __isl_give isl_point *isl_set_sample_point(
4470                 __isl_take isl_set *set);
4471
4472 If C<set> does not contain any (integer) points, then the
4473 resulting point will be ``void'', a property that can be
4474 tested using
4475
4476         int isl_point_is_void(__isl_keep isl_point *pnt);
4477
4478 =head2 Piecewise Quasipolynomials
4479
4480 A piecewise quasipolynomial is a particular kind of function that maps
4481 a parametric point to a rational value.
4482 More specifically, a quasipolynomial is a polynomial expression in greatest
4483 integer parts of affine expressions of parameters and variables.
4484 A piecewise quasipolynomial is a subdivision of a given parametric
4485 domain into disjoint cells with a quasipolynomial associated to
4486 each cell.  The value of the piecewise quasipolynomial at a given
4487 point is the value of the quasipolynomial associated to the cell
4488 that contains the point.  Outside of the union of cells,
4489 the value is assumed to be zero.
4490 For example, the piecewise quasipolynomial
4491
4492         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
4493
4494 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
4495 A given piecewise quasipolynomial has a fixed domain dimension.
4496 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
4497 defined over different domains.
4498 Piecewise quasipolynomials are mainly used by the C<barvinok>
4499 library for representing the number of elements in a parametric set or map.
4500 For example, the piecewise quasipolynomial above represents
4501 the number of points in the map
4502
4503         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
4504
4505 =head3 Input and Output
4506
4507 Piecewise quasipolynomials can be read from input using
4508
4509         __isl_give isl_union_pw_qpolynomial *
4510         isl_union_pw_qpolynomial_read_from_str(
4511                 isl_ctx *ctx, const char *str);
4512
4513 Quasipolynomials and piecewise quasipolynomials can be printed
4514 using the following functions.
4515
4516         __isl_give isl_printer *isl_printer_print_qpolynomial(
4517                 __isl_take isl_printer *p,
4518                 __isl_keep isl_qpolynomial *qp);
4519
4520         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
4521                 __isl_take isl_printer *p,
4522                 __isl_keep isl_pw_qpolynomial *pwqp);
4523
4524         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
4525                 __isl_take isl_printer *p,
4526                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4527
4528 The output format of the printer
4529 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4530 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
4531 is supported.
4532 In case of printing in C<ISL_FORMAT_C>, the user may want
4533 to set the names of all dimensions
4534
4535         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
4536                 __isl_take isl_qpolynomial *qp,
4537                 enum isl_dim_type type, unsigned pos,
4538                 const char *s);
4539         __isl_give isl_pw_qpolynomial *
4540         isl_pw_qpolynomial_set_dim_name(
4541                 __isl_take isl_pw_qpolynomial *pwqp,
4542                 enum isl_dim_type type, unsigned pos,
4543                 const char *s);
4544
4545 =head3 Creating New (Piecewise) Quasipolynomials
4546
4547 Some simple quasipolynomials can be created using the following functions.
4548 More complicated quasipolynomials can be created by applying
4549 operations such as addition and multiplication
4550 on the resulting quasipolynomials
4551
4552         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
4553                 __isl_take isl_space *domain);
4554         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
4555                 __isl_take isl_space *domain);
4556         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
4557                 __isl_take isl_space *domain);
4558         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
4559                 __isl_take isl_space *domain);
4560         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
4561                 __isl_take isl_space *domain);
4562         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
4563                 __isl_take isl_space *domain,
4564                 const isl_int n, const isl_int d);
4565         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
4566                 __isl_take isl_space *domain,
4567                 enum isl_dim_type type, unsigned pos);
4568         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
4569                 __isl_take isl_aff *aff);
4570
4571 Note that the space in which a quasipolynomial lives is a map space
4572 with a one-dimensional range.  The C<domain> argument in some of
4573 the functions above corresponds to the domain of this map space.
4574
4575 The zero piecewise quasipolynomial or a piecewise quasipolynomial
4576 with a single cell can be created using the following functions.
4577 Multiple of these single cell piecewise quasipolynomials can
4578 be combined to create more complicated piecewise quasipolynomials.
4579
4580         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
4581                 __isl_take isl_space *space);
4582         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
4583                 __isl_take isl_set *set,
4584                 __isl_take isl_qpolynomial *qp);
4585         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
4586                 __isl_take isl_qpolynomial *qp);
4587         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
4588                 __isl_take isl_pw_aff *pwaff);
4589
4590         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
4591                 __isl_take isl_space *space);
4592         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
4593                 __isl_take isl_pw_qpolynomial *pwqp);
4594         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
4595                 __isl_take isl_union_pw_qpolynomial *upwqp,
4596                 __isl_take isl_pw_qpolynomial *pwqp);
4597
4598 Quasipolynomials can be copied and freed again using the following
4599 functions.
4600
4601         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
4602                 __isl_keep isl_qpolynomial *qp);
4603         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
4604
4605         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
4606                 __isl_keep isl_pw_qpolynomial *pwqp);
4607         void *isl_pw_qpolynomial_free(
4608                 __isl_take isl_pw_qpolynomial *pwqp);
4609
4610         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
4611                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4612         void *isl_union_pw_qpolynomial_free(
4613                 __isl_take isl_union_pw_qpolynomial *upwqp);
4614
4615 =head3 Inspecting (Piecewise) Quasipolynomials
4616
4617 To iterate over all piecewise quasipolynomials in a union
4618 piecewise quasipolynomial, use the following function
4619
4620         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
4621                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4622                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
4623                 void *user);
4624
4625 To extract the piecewise quasipolynomial in a given space from a union, use
4626
4627         __isl_give isl_pw_qpolynomial *
4628         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
4629                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4630                 __isl_take isl_space *space);
4631
4632 To iterate over the cells in a piecewise quasipolynomial,
4633 use either of the following two functions
4634
4635         int isl_pw_qpolynomial_foreach_piece(
4636                 __isl_keep isl_pw_qpolynomial *pwqp,
4637                 int (*fn)(__isl_take isl_set *set,
4638                           __isl_take isl_qpolynomial *qp,
4639                           void *user), void *user);
4640         int isl_pw_qpolynomial_foreach_lifted_piece(
4641                 __isl_keep isl_pw_qpolynomial *pwqp,
4642                 int (*fn)(__isl_take isl_set *set,
4643                           __isl_take isl_qpolynomial *qp,
4644                           void *user), void *user);
4645
4646 As usual, the function C<fn> should return C<0> on success
4647 and C<-1> on failure.  The difference between
4648 C<isl_pw_qpolynomial_foreach_piece> and
4649 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
4650 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
4651 compute unique representations for all existentially quantified
4652 variables and then turn these existentially quantified variables
4653 into extra set variables, adapting the associated quasipolynomial
4654 accordingly.  This means that the C<set> passed to C<fn>
4655 will not have any existentially quantified variables, but that
4656 the dimensions of the sets may be different for different
4657 invocations of C<fn>.
4658
4659 To iterate over all terms in a quasipolynomial,
4660 use
4661
4662         int isl_qpolynomial_foreach_term(
4663                 __isl_keep isl_qpolynomial *qp,
4664                 int (*fn)(__isl_take isl_term *term,
4665                           void *user), void *user);
4666
4667 The terms themselves can be inspected and freed using
4668 these functions
4669
4670         unsigned isl_term_dim(__isl_keep isl_term *term,
4671                 enum isl_dim_type type);
4672         void isl_term_get_num(__isl_keep isl_term *term,
4673                 isl_int *n);
4674         void isl_term_get_den(__isl_keep isl_term *term,
4675                 isl_int *d);
4676         int isl_term_get_exp(__isl_keep isl_term *term,
4677                 enum isl_dim_type type, unsigned pos);
4678         __isl_give isl_aff *isl_term_get_div(
4679                 __isl_keep isl_term *term, unsigned pos);
4680         void isl_term_free(__isl_take isl_term *term);
4681
4682 Each term is a product of parameters, set variables and
4683 integer divisions.  The function C<isl_term_get_exp>
4684 returns the exponent of a given dimensions in the given term.
4685 The C<isl_int>s in the arguments of C<isl_term_get_num>
4686 and C<isl_term_get_den> need to have been initialized
4687 using C<isl_int_init> before calling these functions.
4688
4689 =head3 Properties of (Piecewise) Quasipolynomials
4690
4691 To check whether a quasipolynomial is actually a constant,
4692 use the following function.
4693
4694         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
4695                 isl_int *n, isl_int *d);
4696
4697 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
4698 then the numerator and denominator of the constant
4699 are returned in C<*n> and C<*d>, respectively.
4700
4701 To check whether two union piecewise quasipolynomials are
4702 obviously equal, use
4703
4704         int isl_union_pw_qpolynomial_plain_is_equal(
4705                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
4706                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
4707
4708 =head3 Operations on (Piecewise) Quasipolynomials
4709
4710         __isl_give isl_qpolynomial *isl_qpolynomial_scale(
4711                 __isl_take isl_qpolynomial *qp, isl_int v);
4712         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
4713                 __isl_take isl_qpolynomial *qp);
4714         __isl_give isl_qpolynomial *isl_qpolynomial_add(
4715                 __isl_take isl_qpolynomial *qp1,
4716                 __isl_take isl_qpolynomial *qp2);
4717         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
4718                 __isl_take isl_qpolynomial *qp1,
4719                 __isl_take isl_qpolynomial *qp2);
4720         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
4721                 __isl_take isl_qpolynomial *qp1,
4722                 __isl_take isl_qpolynomial *qp2);
4723         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
4724                 __isl_take isl_qpolynomial *qp, unsigned exponent);
4725
4726         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
4727                 __isl_take isl_pw_qpolynomial *pwqp1,
4728                 __isl_take isl_pw_qpolynomial *pwqp2);
4729         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
4730                 __isl_take isl_pw_qpolynomial *pwqp1,
4731                 __isl_take isl_pw_qpolynomial *pwqp2);
4732         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
4733                 __isl_take isl_pw_qpolynomial *pwqp1,
4734                 __isl_take isl_pw_qpolynomial *pwqp2);
4735         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
4736                 __isl_take isl_pw_qpolynomial *pwqp);
4737         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
4738                 __isl_take isl_pw_qpolynomial *pwqp1,
4739                 __isl_take isl_pw_qpolynomial *pwqp2);
4740         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
4741                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
4742
4743         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
4744                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4745                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4746         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
4747                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4748                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4749         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
4750                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4751                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4752
4753         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
4754                 __isl_take isl_pw_qpolynomial *pwqp,
4755                 __isl_take isl_point *pnt);
4756
4757         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
4758                 __isl_take isl_union_pw_qpolynomial *upwqp,
4759                 __isl_take isl_point *pnt);
4760
4761         __isl_give isl_set *isl_pw_qpolynomial_domain(
4762                 __isl_take isl_pw_qpolynomial *pwqp);
4763         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
4764                 __isl_take isl_pw_qpolynomial *pwpq,
4765                 __isl_take isl_set *set);
4766         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
4767                 __isl_take isl_pw_qpolynomial *pwpq,
4768                 __isl_take isl_set *set);
4769
4770         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4771                 __isl_take isl_union_pw_qpolynomial *upwqp);
4772         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
4773                 __isl_take isl_union_pw_qpolynomial *upwpq,
4774                 __isl_take isl_union_set *uset);
4775         __isl_give isl_union_pw_qpolynomial *
4776         isl_union_pw_qpolynomial_intersect_params(
4777                 __isl_take isl_union_pw_qpolynomial *upwpq,
4778                 __isl_take isl_set *set);
4779
4780         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
4781                 __isl_take isl_qpolynomial *qp,
4782                 __isl_take isl_space *model);
4783
4784         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
4785                 __isl_take isl_qpolynomial *qp);
4786         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
4787                 __isl_take isl_pw_qpolynomial *pwqp);
4788
4789         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
4790                 __isl_take isl_union_pw_qpolynomial *upwqp);
4791
4792         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
4793                 __isl_take isl_qpolynomial *qp,
4794                 __isl_take isl_set *context);
4795         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
4796                 __isl_take isl_qpolynomial *qp,
4797                 __isl_take isl_set *context);
4798
4799         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
4800                 __isl_take isl_pw_qpolynomial *pwqp,
4801                 __isl_take isl_set *context);
4802         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
4803                 __isl_take isl_pw_qpolynomial *pwqp,
4804                 __isl_take isl_set *context);
4805
4806         __isl_give isl_union_pw_qpolynomial *
4807         isl_union_pw_qpolynomial_gist_params(
4808                 __isl_take isl_union_pw_qpolynomial *upwqp,
4809                 __isl_take isl_set *context);
4810         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
4811                 __isl_take isl_union_pw_qpolynomial *upwqp,
4812                 __isl_take isl_union_set *context);
4813
4814 The gist operation applies the gist operation to each of
4815 the cells in the domain of the input piecewise quasipolynomial.
4816 The context is also exploited
4817 to simplify the quasipolynomials associated to each cell.
4818
4819         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4820                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4821         __isl_give isl_union_pw_qpolynomial *
4822         isl_union_pw_qpolynomial_to_polynomial(
4823                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4824
4825 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
4826 the polynomial will be an overapproximation.  If C<sign> is negative,
4827 it will be an underapproximation.  If C<sign> is zero, the approximation
4828 will lie somewhere in between.
4829
4830 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
4831
4832 A piecewise quasipolynomial reduction is a piecewise
4833 reduction (or fold) of quasipolynomials.
4834 In particular, the reduction can be maximum or a minimum.
4835 The objects are mainly used to represent the result of
4836 an upper or lower bound on a quasipolynomial over its domain,
4837 i.e., as the result of the following function.
4838
4839         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
4840                 __isl_take isl_pw_qpolynomial *pwqp,
4841                 enum isl_fold type, int *tight);
4842
4843         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
4844                 __isl_take isl_union_pw_qpolynomial *upwqp,
4845                 enum isl_fold type, int *tight);
4846
4847 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
4848 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
4849 is the returned bound is known be tight, i.e., for each value
4850 of the parameters there is at least
4851 one element in the domain that reaches the bound.
4852 If the domain of C<pwqp> is not wrapping, then the bound is computed
4853 over all elements in that domain and the result has a purely parametric
4854 domain.  If the domain of C<pwqp> is wrapping, then the bound is
4855 computed over the range of the wrapped relation.  The domain of the
4856 wrapped relation becomes the domain of the result.
4857
4858 A (piecewise) quasipolynomial reduction can be copied or freed using the
4859 following functions.
4860
4861         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
4862                 __isl_keep isl_qpolynomial_fold *fold);
4863         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
4864                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4865         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
4866                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4867         void isl_qpolynomial_fold_free(
4868                 __isl_take isl_qpolynomial_fold *fold);
4869         void *isl_pw_qpolynomial_fold_free(
4870                 __isl_take isl_pw_qpolynomial_fold *pwf);
4871         void *isl_union_pw_qpolynomial_fold_free(
4872                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4873
4874 =head3 Printing Piecewise Quasipolynomial Reductions
4875
4876 Piecewise quasipolynomial reductions can be printed
4877 using the following function.
4878
4879         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
4880                 __isl_take isl_printer *p,
4881                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4882         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
4883                 __isl_take isl_printer *p,
4884                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4885
4886 For C<isl_printer_print_pw_qpolynomial_fold>,
4887 output format of the printer
4888 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4889 For C<isl_printer_print_union_pw_qpolynomial_fold>,
4890 output format of the printer
4891 needs to be set to C<ISL_FORMAT_ISL>.
4892 In case of printing in C<ISL_FORMAT_C>, the user may want
4893 to set the names of all dimensions
4894
4895         __isl_give isl_pw_qpolynomial_fold *
4896         isl_pw_qpolynomial_fold_set_dim_name(
4897                 __isl_take isl_pw_qpolynomial_fold *pwf,
4898                 enum isl_dim_type type, unsigned pos,
4899                 const char *s);
4900
4901 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
4902
4903 To iterate over all piecewise quasipolynomial reductions in a union
4904 piecewise quasipolynomial reduction, use the following function
4905
4906         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
4907                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
4908                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
4909                             void *user), void *user);
4910
4911 To iterate over the cells in a piecewise quasipolynomial reduction,
4912 use either of the following two functions
4913
4914         int isl_pw_qpolynomial_fold_foreach_piece(
4915                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4916                 int (*fn)(__isl_take isl_set *set,
4917                           __isl_take isl_qpolynomial_fold *fold,
4918                           void *user), void *user);
4919         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
4920                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4921                 int (*fn)(__isl_take isl_set *set,
4922                           __isl_take isl_qpolynomial_fold *fold,
4923                           void *user), void *user);
4924
4925 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
4926 of the difference between these two functions.
4927
4928 To iterate over all quasipolynomials in a reduction, use
4929
4930         int isl_qpolynomial_fold_foreach_qpolynomial(
4931                 __isl_keep isl_qpolynomial_fold *fold,
4932                 int (*fn)(__isl_take isl_qpolynomial *qp,
4933                           void *user), void *user);
4934
4935 =head3 Properties of Piecewise Quasipolynomial Reductions
4936
4937 To check whether two union piecewise quasipolynomial reductions are
4938 obviously equal, use
4939
4940         int isl_union_pw_qpolynomial_fold_plain_is_equal(
4941                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
4942                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
4943
4944 =head3 Operations on Piecewise Quasipolynomial Reductions
4945
4946         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
4947                 __isl_take isl_qpolynomial_fold *fold, isl_int v);
4948
4949         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
4950                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4951                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4952
4953         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
4954                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4955                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4956
4957         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
4958                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
4959                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
4960
4961         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
4962                 __isl_take isl_pw_qpolynomial_fold *pwf,
4963                 __isl_take isl_point *pnt);
4964
4965         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
4966                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4967                 __isl_take isl_point *pnt);
4968
4969         __isl_give isl_pw_qpolynomial_fold *
4970         isl_pw_qpolynomial_fold_intersect_params(
4971                 __isl_take isl_pw_qpolynomial_fold *pwf,
4972                 __isl_take isl_set *set);
4973
4974         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
4975                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4976         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
4977                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4978                 __isl_take isl_union_set *uset);
4979         __isl_give isl_union_pw_qpolynomial_fold *
4980         isl_union_pw_qpolynomial_fold_intersect_params(
4981                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4982                 __isl_take isl_set *set);
4983
4984         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
4985                 __isl_take isl_pw_qpolynomial_fold *pwf);
4986
4987         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
4988                 __isl_take isl_pw_qpolynomial_fold *pwf);
4989
4990         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
4991                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4992
4993         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
4994                 __isl_take isl_qpolynomial_fold *fold,
4995                 __isl_take isl_set *context);
4996         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
4997                 __isl_take isl_qpolynomial_fold *fold,
4998                 __isl_take isl_set *context);
4999
5000         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
5001                 __isl_take isl_pw_qpolynomial_fold *pwf,
5002                 __isl_take isl_set *context);
5003         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
5004                 __isl_take isl_pw_qpolynomial_fold *pwf,
5005                 __isl_take isl_set *context);
5006
5007         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
5008                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5009                 __isl_take isl_union_set *context);
5010         __isl_give isl_union_pw_qpolynomial_fold *
5011         isl_union_pw_qpolynomial_fold_gist_params(
5012                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5013                 __isl_take isl_set *context);
5014
5015 The gist operation applies the gist operation to each of
5016 the cells in the domain of the input piecewise quasipolynomial reduction.
5017 In future, the operation will also exploit the context
5018 to simplify the quasipolynomial reductions associated to each cell.
5019
5020         __isl_give isl_pw_qpolynomial_fold *
5021         isl_set_apply_pw_qpolynomial_fold(
5022                 __isl_take isl_set *set,
5023                 __isl_take isl_pw_qpolynomial_fold *pwf,
5024                 int *tight);
5025         __isl_give isl_pw_qpolynomial_fold *
5026         isl_map_apply_pw_qpolynomial_fold(
5027                 __isl_take isl_map *map,
5028                 __isl_take isl_pw_qpolynomial_fold *pwf,
5029                 int *tight);
5030         __isl_give isl_union_pw_qpolynomial_fold *
5031         isl_union_set_apply_union_pw_qpolynomial_fold(
5032                 __isl_take isl_union_set *uset,
5033                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5034                 int *tight);
5035         __isl_give isl_union_pw_qpolynomial_fold *
5036         isl_union_map_apply_union_pw_qpolynomial_fold(
5037                 __isl_take isl_union_map *umap,
5038                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5039                 int *tight);
5040
5041 The functions taking a map
5042 compose the given map with the given piecewise quasipolynomial reduction.
5043 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
5044 over all elements in the intersection of the range of the map
5045 and the domain of the piecewise quasipolynomial reduction
5046 as a function of an element in the domain of the map.
5047 The functions taking a set compute a bound over all elements in the
5048 intersection of the set and the domain of the
5049 piecewise quasipolynomial reduction.
5050
5051 =head2 Parametric Vertex Enumeration
5052
5053 The parametric vertex enumeration described in this section
5054 is mainly intended to be used internally and by the C<barvinok>
5055 library.
5056
5057         #include <isl/vertices.h>
5058         __isl_give isl_vertices *isl_basic_set_compute_vertices(
5059                 __isl_keep isl_basic_set *bset);
5060
5061 The function C<isl_basic_set_compute_vertices> performs the
5062 actual computation of the parametric vertices and the chamber
5063 decomposition and store the result in an C<isl_vertices> object.
5064 This information can be queried by either iterating over all
5065 the vertices or iterating over all the chambers or cells
5066 and then iterating over all vertices that are active on the chamber.
5067
5068         int isl_vertices_foreach_vertex(
5069                 __isl_keep isl_vertices *vertices,
5070                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5071                 void *user);
5072
5073         int isl_vertices_foreach_cell(
5074                 __isl_keep isl_vertices *vertices,
5075                 int (*fn)(__isl_take isl_cell *cell, void *user),
5076                 void *user);
5077         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
5078                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5079                 void *user);
5080
5081 Other operations that can be performed on an C<isl_vertices> object are
5082 the following.
5083
5084         isl_ctx *isl_vertices_get_ctx(
5085                 __isl_keep isl_vertices *vertices);
5086         int isl_vertices_get_n_vertices(
5087                 __isl_keep isl_vertices *vertices);
5088         void isl_vertices_free(__isl_take isl_vertices *vertices);
5089
5090 Vertices can be inspected and destroyed using the following functions.
5091
5092         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
5093         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
5094         __isl_give isl_basic_set *isl_vertex_get_domain(
5095                 __isl_keep isl_vertex *vertex);
5096         __isl_give isl_basic_set *isl_vertex_get_expr(
5097                 __isl_keep isl_vertex *vertex);
5098         void isl_vertex_free(__isl_take isl_vertex *vertex);
5099
5100 C<isl_vertex_get_expr> returns a singleton parametric set describing
5101 the vertex, while C<isl_vertex_get_domain> returns the activity domain
5102 of the vertex.
5103 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
5104 B<rational> basic sets, so they should mainly be used for inspection
5105 and should not be mixed with integer sets.
5106
5107 Chambers can be inspected and destroyed using the following functions.
5108
5109         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
5110         __isl_give isl_basic_set *isl_cell_get_domain(
5111                 __isl_keep isl_cell *cell);
5112         void isl_cell_free(__isl_take isl_cell *cell);
5113
5114 =head1 Polyhedral Compilation Library
5115
5116 This section collects functionality in C<isl> that has been specifically
5117 designed for use during polyhedral compilation.
5118
5119 =head2 Dependence Analysis
5120
5121 C<isl> contains specialized functionality for performing
5122 array dataflow analysis.  That is, given a I<sink> access relation
5123 and a collection of possible I<source> access relations,
5124 C<isl> can compute relations that describe
5125 for each iteration of the sink access, which iteration
5126 of which of the source access relations was the last
5127 to access the same data element before the given iteration
5128 of the sink access.
5129 The resulting dependence relations map source iterations
5130 to the corresponding sink iterations.
5131 To compute standard flow dependences, the sink should be
5132 a read, while the sources should be writes.
5133 If any of the source accesses are marked as being I<may>
5134 accesses, then there will be a dependence from the last
5135 I<must> access B<and> from any I<may> access that follows
5136 this last I<must> access.
5137 In particular, if I<all> sources are I<may> accesses,
5138 then memory based dependence analysis is performed.
5139 If, on the other hand, all sources are I<must> accesses,
5140 then value based dependence analysis is performed.
5141
5142         #include <isl/flow.h>
5143
5144         typedef int (*isl_access_level_before)(void *first, void *second);
5145
5146         __isl_give isl_access_info *isl_access_info_alloc(
5147                 __isl_take isl_map *sink,
5148                 void *sink_user, isl_access_level_before fn,
5149                 int max_source);
5150         __isl_give isl_access_info *isl_access_info_add_source(
5151                 __isl_take isl_access_info *acc,
5152                 __isl_take isl_map *source, int must,
5153                 void *source_user);
5154         void *isl_access_info_free(__isl_take isl_access_info *acc);
5155
5156         __isl_give isl_flow *isl_access_info_compute_flow(
5157                 __isl_take isl_access_info *acc);
5158
5159         int isl_flow_foreach(__isl_keep isl_flow *deps,
5160                 int (*fn)(__isl_take isl_map *dep, int must,
5161                           void *dep_user, void *user),
5162                 void *user);
5163         __isl_give isl_map *isl_flow_get_no_source(
5164                 __isl_keep isl_flow *deps, int must);
5165         void isl_flow_free(__isl_take isl_flow *deps);
5166
5167 The function C<isl_access_info_compute_flow> performs the actual
5168 dependence analysis.  The other functions are used to construct
5169 the input for this function or to read off the output.
5170
5171 The input is collected in an C<isl_access_info>, which can
5172 be created through a call to C<isl_access_info_alloc>.
5173 The arguments to this functions are the sink access relation
5174 C<sink>, a token C<sink_user> used to identify the sink
5175 access to the user, a callback function for specifying the
5176 relative order of source and sink accesses, and the number
5177 of source access relations that will be added.
5178 The callback function has type C<int (*)(void *first, void *second)>.
5179 The function is called with two user supplied tokens identifying
5180 either a source or the sink and it should return the shared nesting
5181 level and the relative order of the two accesses.
5182 In particular, let I<n> be the number of loops shared by
5183 the two accesses.  If C<first> precedes C<second> textually,
5184 then the function should return I<2 * n + 1>; otherwise,
5185 it should return I<2 * n>.
5186 The sources can be added to the C<isl_access_info> by performing
5187 (at most) C<max_source> calls to C<isl_access_info_add_source>.
5188 C<must> indicates whether the source is a I<must> access
5189 or a I<may> access.  Note that a multi-valued access relation
5190 should only be marked I<must> if every iteration in the domain
5191 of the relation accesses I<all> elements in its image.
5192 The C<source_user> token is again used to identify
5193 the source access.  The range of the source access relation
5194 C<source> should have the same dimension as the range
5195 of the sink access relation.
5196 The C<isl_access_info_free> function should usually not be
5197 called explicitly, because it is called implicitly by
5198 C<isl_access_info_compute_flow>.
5199
5200 The result of the dependence analysis is collected in an
5201 C<isl_flow>.  There may be elements of
5202 the sink access for which no preceding source access could be
5203 found or for which all preceding sources are I<may> accesses.
5204 The relations containing these elements can be obtained through
5205 calls to C<isl_flow_get_no_source>, the first with C<must> set
5206 and the second with C<must> unset.
5207 In the case of standard flow dependence analysis,
5208 with the sink a read and the sources I<must> writes,
5209 the first relation corresponds to the reads from uninitialized
5210 array elements and the second relation is empty.
5211 The actual flow dependences can be extracted using
5212 C<isl_flow_foreach>.  This function will call the user-specified
5213 callback function C<fn> for each B<non-empty> dependence between
5214 a source and the sink.  The callback function is called
5215 with four arguments, the actual flow dependence relation
5216 mapping source iterations to sink iterations, a boolean that
5217 indicates whether it is a I<must> or I<may> dependence, a token
5218 identifying the source and an additional C<void *> with value
5219 equal to the third argument of the C<isl_flow_foreach> call.
5220 A dependence is marked I<must> if it originates from a I<must>
5221 source and if it is not followed by any I<may> sources.
5222
5223 After finishing with an C<isl_flow>, the user should call
5224 C<isl_flow_free> to free all associated memory.
5225
5226 A higher-level interface to dependence analysis is provided
5227 by the following function.
5228
5229         #include <isl/flow.h>
5230
5231         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
5232                 __isl_take isl_union_map *must_source,
5233                 __isl_take isl_union_map *may_source,
5234                 __isl_take isl_union_map *schedule,
5235                 __isl_give isl_union_map **must_dep,
5236                 __isl_give isl_union_map **may_dep,
5237                 __isl_give isl_union_map **must_no_source,
5238                 __isl_give isl_union_map **may_no_source);
5239
5240 The arrays are identified by the tuple names of the ranges
5241 of the accesses.  The iteration domains by the tuple names
5242 of the domains of the accesses and of the schedule.
5243 The relative order of the iteration domains is given by the
5244 schedule.  The relations returned through C<must_no_source>
5245 and C<may_no_source> are subsets of C<sink>.
5246 Any of C<must_dep>, C<may_dep>, C<must_no_source>
5247 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
5248 any of the other arguments is treated as an error.
5249
5250 =head3 Interaction with Dependence Analysis
5251
5252 During the dependence analysis, we frequently need to perform
5253 the following operation.  Given a relation between sink iterations
5254 and potential source iterations from a particular source domain,
5255 what is the last potential source iteration corresponding to each
5256 sink iteration.  It can sometimes be convenient to adjust
5257 the set of potential source iterations before or after each such operation.
5258 The prototypical example is fuzzy array dataflow analysis,
5259 where we need to analyze if, based on data-dependent constraints,
5260 the sink iteration can ever be executed without one or more of
5261 the corresponding potential source iterations being executed.
5262 If so, we can introduce extra parameters and select an unknown
5263 but fixed source iteration from the potential source iterations.
5264 To be able to perform such manipulations, C<isl> provides the following
5265 function.
5266
5267         #include <isl/flow.h>
5268
5269         typedef __isl_give isl_restriction *(*isl_access_restrict)(
5270                 __isl_keep isl_map *source_map,
5271                 __isl_keep isl_set *sink, void *source_user,
5272                 void *user);
5273         __isl_give isl_access_info *isl_access_info_set_restrict(
5274                 __isl_take isl_access_info *acc,
5275                 isl_access_restrict fn, void *user);
5276
5277 The function C<isl_access_info_set_restrict> should be called
5278 before calling C<isl_access_info_compute_flow> and registers a callback function
5279 that will be called any time C<isl> is about to compute the last
5280 potential source.  The first argument is the (reverse) proto-dependence,
5281 mapping sink iterations to potential source iterations.
5282 The second argument represents the sink iterations for which
5283 we want to compute the last source iteration.
5284 The third argument is the token corresponding to the source
5285 and the final argument is the token passed to C<isl_access_info_set_restrict>.
5286 The callback is expected to return a restriction on either the input or
5287 the output of the operation computing the last potential source.
5288 If the input needs to be restricted then restrictions are needed
5289 for both the source and the sink iterations.  The sink iterations
5290 and the potential source iterations will be intersected with these sets.
5291 If the output needs to be restricted then only a restriction on the source
5292 iterations is required.
5293 If any error occurs, the callback should return C<NULL>.
5294 An C<isl_restriction> object can be created, freed and inspected
5295 using the following functions.
5296
5297         #include <isl/flow.h>
5298
5299         __isl_give isl_restriction *isl_restriction_input(
5300                 __isl_take isl_set *source_restr,
5301                 __isl_take isl_set *sink_restr);
5302         __isl_give isl_restriction *isl_restriction_output(
5303                 __isl_take isl_set *source_restr);
5304         __isl_give isl_restriction *isl_restriction_none(
5305                 __isl_take isl_map *source_map);
5306         __isl_give isl_restriction *isl_restriction_empty(
5307                 __isl_take isl_map *source_map);
5308         void *isl_restriction_free(
5309                 __isl_take isl_restriction *restr);
5310         isl_ctx *isl_restriction_get_ctx(
5311                 __isl_keep isl_restriction *restr);
5312
5313 C<isl_restriction_none> and C<isl_restriction_empty> are special
5314 cases of C<isl_restriction_input>.  C<isl_restriction_none>
5315 is essentially equivalent to
5316
5317         isl_restriction_input(isl_set_universe(
5318             isl_space_range(isl_map_get_space(source_map))),
5319                             isl_set_universe(
5320             isl_space_domain(isl_map_get_space(source_map))));
5321
5322 whereas C<isl_restriction_empty> is essentially equivalent to
5323
5324         isl_restriction_input(isl_set_empty(
5325             isl_space_range(isl_map_get_space(source_map))),
5326                             isl_set_universe(
5327             isl_space_domain(isl_map_get_space(source_map))));
5328
5329 =head2 Scheduling
5330
5331 B<The functionality described in this section is fairly new
5332 and may be subject to change.>
5333
5334 The following function can be used to compute a schedule
5335 for a union of domains.
5336 By default, the algorithm used to construct the schedule is similar
5337 to that of C<Pluto>.
5338 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
5339 be selected.
5340 The generated schedule respects all C<validity> dependences.
5341 That is, all dependence distances over these dependences in the
5342 scheduled space are lexicographically positive.
5343 The default algorithm tries to minimize the dependence distances over
5344 C<proximity> dependences.
5345 Moreover, it tries to obtain sequences (bands) of schedule dimensions
5346 for groups of domains where the dependence distances have only
5347 non-negative values.
5348 When using Feautrier's algorithm, the C<proximity> dependence
5349 distances are only minimized during the extension to a
5350 full-dimensional schedule.
5351
5352         #include <isl/schedule.h>
5353         __isl_give isl_schedule *isl_union_set_compute_schedule(
5354                 __isl_take isl_union_set *domain,
5355                 __isl_take isl_union_map *validity,
5356                 __isl_take isl_union_map *proximity);
5357         void *isl_schedule_free(__isl_take isl_schedule *sched);
5358
5359 A mapping from the domains to the scheduled space can be obtained
5360 from an C<isl_schedule> using the following function.
5361
5362         __isl_give isl_union_map *isl_schedule_get_map(
5363                 __isl_keep isl_schedule *sched);
5364
5365 A representation of the schedule can be printed using
5366          
5367         __isl_give isl_printer *isl_printer_print_schedule(
5368                 __isl_take isl_printer *p,
5369                 __isl_keep isl_schedule *schedule);
5370
5371 A representation of the schedule as a forest of bands can be obtained
5372 using the following function.
5373
5374         __isl_give isl_band_list *isl_schedule_get_band_forest(
5375                 __isl_keep isl_schedule *schedule);
5376
5377 The individual bands can be visited in depth-first post-order
5378 using the following function.
5379
5380         #include <isl/schedule.h>
5381         int isl_schedule_foreach_band(
5382                 __isl_keep isl_schedule *sched,
5383                 int (*fn)(__isl_keep isl_band *band, void *user),
5384                 void *user);
5385
5386 The list can be manipulated as explained in L<"Lists">.
5387 The bands inside the list can be copied and freed using the following
5388 functions.
5389
5390         #include <isl/band.h>
5391         __isl_give isl_band *isl_band_copy(
5392                 __isl_keep isl_band *band);
5393         void *isl_band_free(__isl_take isl_band *band);
5394
5395 Each band contains zero or more scheduling dimensions.
5396 These are referred to as the members of the band.
5397 The section of the schedule that corresponds to the band is
5398 referred to as the partial schedule of the band.
5399 For those nodes that participate in a band, the outer scheduling
5400 dimensions form the prefix schedule, while the inner scheduling
5401 dimensions form the suffix schedule.
5402 That is, if we take a cut of the band forest, then the union of
5403 the concatenations of the prefix, partial and suffix schedules of
5404 each band in the cut is equal to the entire schedule (modulo
5405 some possible padding at the end with zero scheduling dimensions).
5406 The properties of a band can be inspected using the following functions.
5407
5408         #include <isl/band.h>
5409         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
5410
5411         int isl_band_has_children(__isl_keep isl_band *band);
5412         __isl_give isl_band_list *isl_band_get_children(
5413                 __isl_keep isl_band *band);
5414
5415         __isl_give isl_union_map *isl_band_get_prefix_schedule(
5416                 __isl_keep isl_band *band);
5417         __isl_give isl_union_map *isl_band_get_partial_schedule(
5418                 __isl_keep isl_band *band);
5419         __isl_give isl_union_map *isl_band_get_suffix_schedule(
5420                 __isl_keep isl_band *band);
5421
5422         int isl_band_n_member(__isl_keep isl_band *band);
5423         int isl_band_member_is_zero_distance(
5424                 __isl_keep isl_band *band, int pos);
5425
5426         int isl_band_list_foreach_band(
5427                 __isl_keep isl_band_list *list,
5428                 int (*fn)(__isl_keep isl_band *band, void *user),
5429                 void *user);
5430
5431 Note that a scheduling dimension is considered to be ``zero
5432 distance'' if it does not carry any proximity dependences
5433 within its band.
5434 That is, if the dependence distances of the proximity
5435 dependences are all zero in that direction (for fixed
5436 iterations of outer bands).
5437 Like C<isl_schedule_foreach_band>,
5438 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
5439 in depth-first post-order.
5440
5441 A band can be tiled using the following function.
5442
5443         #include <isl/band.h>
5444         int isl_band_tile(__isl_keep isl_band *band,
5445                 __isl_take isl_vec *sizes);
5446
5447         int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
5448                 int val);
5449         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
5450         int isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
5451                 int val);
5452         int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
5453
5454 The C<isl_band_tile> function tiles the band using the given tile sizes
5455 inside its schedule.
5456 A new child band is created to represent the point loops and it is
5457 inserted between the modified band and its children.
5458 The C<tile_scale_tile_loops> option specifies whether the tile
5459 loops iterators should be scaled by the tile sizes.
5460 If the C<tile_shift_point_loops> option is set, then the point loops
5461 are shifted to start at zero.
5462
5463 A band can be split into two nested bands using the following function.
5464
5465         int isl_band_split(__isl_keep isl_band *band, int pos);
5466
5467 The resulting outer band contains the first C<pos> dimensions of C<band>
5468 while the inner band contains the remaining dimensions.
5469
5470 A representation of the band can be printed using
5471
5472         #include <isl/band.h>
5473         __isl_give isl_printer *isl_printer_print_band(
5474                 __isl_take isl_printer *p,
5475                 __isl_keep isl_band *band);
5476
5477 =head3 Options
5478
5479         #include <isl/schedule.h>
5480         int isl_options_set_schedule_max_coefficient(
5481                 isl_ctx *ctx, int val);
5482         int isl_options_get_schedule_max_coefficient(
5483                 isl_ctx *ctx);
5484         int isl_options_set_schedule_max_constant_term(
5485                 isl_ctx *ctx, int val);
5486         int isl_options_get_schedule_max_constant_term(
5487                 isl_ctx *ctx);
5488         int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
5489         int isl_options_get_schedule_fuse(isl_ctx *ctx);
5490         int isl_options_set_schedule_maximize_band_depth(
5491                 isl_ctx *ctx, int val);
5492         int isl_options_get_schedule_maximize_band_depth(
5493                 isl_ctx *ctx);
5494         int isl_options_set_schedule_outer_zero_distance(
5495                 isl_ctx *ctx, int val);
5496         int isl_options_get_schedule_outer_zero_distance(
5497                 isl_ctx *ctx);
5498         int isl_options_set_schedule_split_scaled(
5499                 isl_ctx *ctx, int val);
5500         int isl_options_get_schedule_split_scaled(
5501                 isl_ctx *ctx);
5502         int isl_options_set_schedule_algorithm(
5503                 isl_ctx *ctx, int val);
5504         int isl_options_get_schedule_algorithm(
5505                 isl_ctx *ctx);
5506         int isl_options_set_schedule_separate_components(
5507                 isl_ctx *ctx, int val);
5508         int isl_options_get_schedule_separate_components(
5509                 isl_ctx *ctx);
5510
5511 =over
5512
5513 =item * schedule_max_coefficient
5514
5515 This option enforces that the coefficients for variable and parameter
5516 dimensions in the calculated schedule are not larger than the specified value.
5517 This option can significantly increase the speed of the scheduling calculation
5518 and may also prevent fusing of unrelated dimensions. A value of -1 means that
5519 this option does not introduce bounds on the variable or parameter
5520 coefficients.
5521
5522 =item * schedule_max_constant_term
5523
5524 This option enforces that the constant coefficients in the calculated schedule
5525 are not larger than the maximal constant term. This option can significantly
5526 increase the speed of the scheduling calculation and may also prevent fusing of
5527 unrelated dimensions. A value of -1 means that this option does not introduce
5528 bounds on the constant coefficients.
5529
5530 =item * schedule_fuse
5531
5532 This option controls the level of fusion.
5533 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
5534 resulting schedule will be distributed as much as possible.
5535 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
5536 try to fuse loops in the resulting schedule.
5537
5538 =item * schedule_maximize_band_depth
5539
5540 If this option is set, we do not split bands at the point
5541 where we detect splitting is necessary. Instead, we
5542 backtrack and split bands as early as possible. This
5543 reduces the number of splits and maximizes the width of
5544 the bands. Wider bands give more possibilities for tiling.
5545 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
5546 then bands will be split as early as possible, even if there is no need.
5547 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
5548
5549 =item * schedule_outer_zero_distance
5550
5551 If this option is set, then we try to construct schedules
5552 where the outermost scheduling dimension in each band
5553 results in a zero dependence distance over the proximity
5554 dependences.
5555
5556 =item * schedule_split_scaled
5557
5558 If this option is set, then we try to construct schedules in which the
5559 constant term is split off from the linear part if the linear parts of
5560 the scheduling rows for all nodes in the graphs have a common non-trivial
5561 divisor.
5562 The constant term is then placed in a separate band and the linear
5563 part is reduced.
5564
5565 =item * schedule_algorithm
5566
5567 Selects the scheduling algorithm to be used.
5568 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
5569 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
5570
5571 =item * schedule_separate_components
5572
5573 If at any point the dependence graph contains any (weakly connected) components,
5574 then these components are scheduled separately.
5575 If this option is not set, then some iterations of the domains
5576 in these components may be scheduled together.
5577 If this option is set, then the components are given consecutive
5578 schedules.
5579
5580 =back
5581
5582 =head2 AST Generation
5583
5584 This section describes the C<isl> functionality for generating
5585 ASTs that visit all the elements
5586 in a domain in an order specified by a schedule.
5587 In particular, given a C<isl_union_map>, an AST is generated
5588 that visits all the elements in the domain of the C<isl_union_map>
5589 according to the lexicographic order of the corresponding image
5590 element(s).  If the range of the C<isl_union_map> consists of
5591 elements in more than one space, then each of these spaces is handled
5592 separately in an arbitrary order.
5593 It should be noted that the image elements only specify the I<order>
5594 in which the corresponding domain elements should be visited.
5595 No direct relation between the image elements and the loop iterators
5596 in the generated AST should be assumed.
5597
5598 Each AST is generated within a build.  The initial build
5599 simply specifies the constraints on the parameters (if any)
5600 and can be created, inspected, copied and freed using the following functions.
5601
5602         #include <isl/ast_build.h>
5603         __isl_give isl_ast_build *isl_ast_build_from_context(
5604                 __isl_take isl_set *set);
5605         isl_ctx *isl_ast_build_get_ctx(
5606                 __isl_keep isl_ast_build *build);
5607         __isl_give isl_ast_build *isl_ast_build_copy(
5608                 __isl_keep isl_ast_build *build);
5609         void *isl_ast_build_free(
5610                 __isl_take isl_ast_build *build);
5611
5612 The C<set> argument is usually a parameter set with zero or more parameters.
5613 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
5614 and L</"Fine-grained Control over AST Generation">.
5615 Finally, the AST itself can be constructed using the following
5616 function.
5617
5618         #include <isl/ast_build.h>
5619         __isl_give isl_ast_node *isl_ast_build_ast_from_schedule(
5620                 __isl_keep isl_ast_build *build,
5621                 __isl_take isl_union_map *schedule);
5622
5623 =head3 Inspecting the AST
5624
5625 The basic properties of an AST node can be obtained as follows.
5626
5627         #include <isl/ast.h>
5628         isl_ctx *isl_ast_node_get_ctx(
5629                 __isl_keep isl_ast_node *node);
5630         enum isl_ast_node_type isl_ast_node_get_type(
5631                 __isl_keep isl_ast_node *node);
5632
5633 The type of an AST node is one of
5634 C<isl_ast_node_for>,
5635 C<isl_ast_node_if>,
5636 C<isl_ast_node_block> or
5637 C<isl_ast_node_user>.
5638 An C<isl_ast_node_for> represents a for node.
5639 An C<isl_ast_node_if> represents an if node.
5640 An C<isl_ast_node_block> represents a compound node.
5641 An C<isl_ast_node_user> represents an expression statement.
5642 An expression statement typically corresponds to a domain element, i.e.,
5643 one of the elements that is visited by the AST.
5644
5645 Each type of node has its own additional properties.
5646
5647         #include <isl/ast.h>
5648         __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
5649                 __isl_keep isl_ast_node *node);
5650         __isl_give isl_ast_expr *isl_ast_node_for_get_init(
5651                 __isl_keep isl_ast_node *node);
5652         __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
5653                 __isl_keep isl_ast_node *node);
5654         __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
5655                 __isl_keep isl_ast_node *node);
5656         __isl_give isl_ast_node *isl_ast_node_for_get_body(
5657                 __isl_keep isl_ast_node *node);
5658         int isl_ast_node_for_is_degenerate(
5659                 __isl_keep isl_ast_node *node);
5660
5661 An C<isl_ast_for> is considered degenerate if it is known to execute
5662 exactly once.
5663
5664         #include <isl/ast.h>
5665         __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
5666                 __isl_keep isl_ast_node *node);
5667         __isl_give isl_ast_node *isl_ast_node_if_get_then(
5668                 __isl_keep isl_ast_node *node);
5669         int isl_ast_node_if_has_else(
5670                 __isl_keep isl_ast_node *node);
5671         __isl_give isl_ast_node *isl_ast_node_if_get_else(
5672                 __isl_keep isl_ast_node *node);
5673
5674         __isl_give isl_ast_node_list *
5675         isl_ast_node_block_get_children(
5676                 __isl_keep isl_ast_node *node);
5677
5678         __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
5679                 __isl_keep isl_ast_node *node);
5680
5681 Each of the returned C<isl_ast_expr>s can in turn be inspected using
5682 the following functions.
5683
5684         #include <isl/ast.h>
5685         isl_ctx *isl_ast_expr_get_ctx(
5686                 __isl_keep isl_ast_expr *expr);
5687         enum isl_ast_expr_type isl_ast_expr_get_type(
5688                 __isl_keep isl_ast_expr *expr);
5689
5690 The type of an AST expression is one of
5691 C<isl_ast_expr_op>,
5692 C<isl_ast_expr_id> or
5693 C<isl_ast_expr_int>.
5694 An C<isl_ast_expr_op> represents the result of an operation.
5695 An C<isl_ast_expr_id> represents an identifier.
5696 An C<isl_ast_expr_int> represents an integer value.
5697
5698 Each type of expression has its own additional properties.
5699
5700         #include <isl/ast.h>
5701         enum isl_ast_op_type isl_ast_expr_get_op_type(
5702                 __isl_keep isl_ast_expr *expr);
5703         int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
5704         __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
5705                 __isl_keep isl_ast_expr *expr, int pos);
5706         int isl_ast_node_foreach_ast_op_type(
5707                 __isl_keep isl_ast_node *node,
5708                 int (*fn)(enum isl_ast_op_type type, void *user),
5709                 void *user);
5710
5711 C<isl_ast_expr_get_op_type> returns the type of the operation
5712 performed.  C<isl_ast_expr_get_op_n_arg> returns the number of
5713 arguments.  C<isl_ast_expr_get_op_arg> returns the specified
5714 argument.
5715 C<isl_ast_node_foreach_ast_op_type> calls C<fn> for each distinct
5716 C<isl_ast_op_type> that appears in C<node>.
5717 The operation type is one of the following.
5718
5719 =over
5720
5721 =item C<isl_ast_op_and>
5722
5723 Logical I<and> of two arguments.
5724 Both arguments can be evaluated.
5725
5726 =item C<isl_ast_op_and_then>
5727
5728 Logical I<and> of two arguments.
5729 The second argument can only be evaluated if the first evaluates to true.
5730
5731 =item C<isl_ast_op_or>
5732
5733 Logical I<or> of two arguments.
5734 Both arguments can be evaluated.
5735
5736 =item C<isl_ast_op_or_else>
5737
5738 Logical I<or> of two arguments.
5739 The second argument can only be evaluated if the first evaluates to false.
5740
5741 =item C<isl_ast_op_max>
5742
5743 Maximum of two or more arguments.
5744
5745 =item C<isl_ast_op_min>
5746
5747 Minimum of two or more arguments.
5748
5749 =item C<isl_ast_op_minus>
5750
5751 Change sign.
5752
5753 =item C<isl_ast_op_add>
5754
5755 Sum of two arguments.
5756
5757 =item C<isl_ast_op_sub>
5758
5759 Difference of two arguments.
5760
5761 =item C<isl_ast_op_mul>
5762
5763 Product of two arguments.
5764
5765 =item C<isl_ast_op_div>
5766
5767 Exact division.  That is, the result is known to be an integer.
5768
5769 =item C<isl_ast_op_fdiv_q>
5770
5771 Result of integer division, rounded towards negative
5772 infinity.
5773
5774 =item C<isl_ast_op_pdiv_q>
5775
5776 Result of integer division, where dividend is known to be non-negative.
5777
5778 =item C<isl_ast_op_pdiv_r>
5779
5780 Remainder of integer division, where dividend is known to be non-negative.
5781
5782 =item C<isl_ast_op_cond>
5783
5784 Conditional operator defined on three arguments.
5785 If the first argument evaluates to true, then the result
5786 is equal to the second argument.  Otherwise, the result
5787 is equal to the third argument.
5788 The second and third argument may only be evaluated if
5789 the first argument evaluates to true and false, respectively.
5790 Corresponds to C<a ? b : c> in C.
5791
5792 =item C<isl_ast_op_select>
5793
5794 Conditional operator defined on three arguments.
5795 If the first argument evaluates to true, then the result
5796 is equal to the second argument.  Otherwise, the result
5797 is equal to the third argument.
5798 The second and third argument may be evaluated independently
5799 of the value of the first argument.
5800 Corresponds to C<a * b + (1 - a) * c> in C.
5801
5802 =item C<isl_ast_op_eq>
5803
5804 Equality relation.
5805
5806 =item C<isl_ast_op_le>
5807
5808 Less than or equal relation.
5809
5810 =item C<isl_ast_op_lt>
5811
5812 Less than relation.
5813
5814 =item C<isl_ast_op_ge>
5815
5816 Greater than or equal relation.
5817
5818 =item C<isl_ast_op_gt>
5819
5820 Greater than relation.
5821
5822 =item C<isl_ast_op_call>
5823
5824 A function call.
5825 The number of arguments of the C<isl_ast_expr> is one more than
5826 the number of arguments in the function call, the first argument
5827 representing the function being called.
5828
5829 =back
5830
5831         #include <isl/ast.h>
5832         __isl_give isl_id *isl_ast_expr_get_id(
5833                 __isl_keep isl_ast_expr *expr);
5834
5835 Return the identifier represented by the AST expression.
5836
5837         #include <isl/ast.h>
5838         int isl_ast_expr_get_int(__isl_keep isl_ast_expr *expr,
5839                 isl_int *v);
5840
5841 Return the integer represented by the AST expression.
5842 Note that the integer is returned through the C<v> argument.
5843 The return value of the function itself indicates whether the
5844 operation was performed successfully.
5845
5846 =head3 Manipulating and printing the AST
5847
5848 AST nodes can be copied and freed using the following functions.
5849
5850         #include <isl/ast.h>
5851         __isl_give isl_ast_node *isl_ast_node_copy(
5852                 __isl_keep isl_ast_node *node);
5853         void *isl_ast_node_free(__isl_take isl_ast_node *node);
5854
5855 AST expressions can be copied and freed using the following functions.
5856
5857         #include <isl/ast.h>
5858         __isl_give isl_ast_expr *isl_ast_expr_copy(
5859                 __isl_keep isl_ast_expr *expr);
5860         void *isl_ast_expr_free(__isl_take isl_ast_expr *expr);
5861
5862 New AST expressions can be created either directly or within
5863 the context of an C<isl_ast_build>.
5864
5865         #include <isl/ast.h>
5866         __isl_give isl_ast_expr *isl_ast_expr_from_id(
5867                 __isl_take isl_id *id);
5868         __isl_give isl_ast_expr *isl_ast_expr_neg(
5869                 __isl_take isl_ast_expr *expr);
5870         __isl_give isl_ast_expr *isl_ast_expr_add(
5871                 __isl_take isl_ast_expr *expr1,
5872                 __isl_take isl_ast_expr *expr2);
5873         __isl_give isl_ast_expr *isl_ast_expr_sub(
5874                 __isl_take isl_ast_expr *expr1,
5875                 __isl_take isl_ast_expr *expr2);
5876         __isl_give isl_ast_expr *isl_ast_expr_mul(
5877                 __isl_take isl_ast_expr *expr1,
5878                 __isl_take isl_ast_expr *expr2);
5879         __isl_give isl_ast_expr *isl_ast_expr_div(
5880                 __isl_take isl_ast_expr *expr1,
5881                 __isl_take isl_ast_expr *expr2);
5882         __isl_give isl_ast_expr *isl_ast_expr_and(
5883                 __isl_take isl_ast_expr *expr1,
5884                 __isl_take isl_ast_expr *expr2)
5885         __isl_give isl_ast_expr *isl_ast_expr_or(
5886                 __isl_take isl_ast_expr *expr1,
5887                 __isl_take isl_ast_expr *expr2)
5888
5889         #include <isl/ast_build.h>
5890         __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
5891                 __isl_keep isl_ast_build *build,
5892                 __isl_take isl_pw_aff *pa);
5893         __isl_give isl_ast_expr *
5894         isl_ast_build_call_from_pw_multi_aff(
5895                 __isl_keep isl_ast_build *build,
5896                 __isl_take isl_pw_multi_aff *pma);
5897
5898 The domains of C<pa> and C<pma> should correspond
5899 to the schedule space of C<build>.
5900 The tuple id of C<pma> is used as the function being called.
5901
5902 User specified data can be attached to an C<isl_ast_node> and obtained
5903 from the same C<isl_ast_node> using the following functions.
5904
5905         #include <isl/ast.h>
5906         __isl_give isl_ast_node *isl_ast_node_set_annotation(
5907                 __isl_take isl_ast_node *node,
5908                 __isl_take isl_id *annotation);
5909         __isl_give isl_id *isl_ast_node_get_annotation(
5910                 __isl_keep isl_ast_node *node);
5911
5912 Basic printing can be performed using the following functions.
5913
5914         #include <isl/ast.h>
5915         __isl_give isl_printer *isl_printer_print_ast_expr(
5916                 __isl_take isl_printer *p,
5917                 __isl_keep isl_ast_expr *expr);
5918         __isl_give isl_printer *isl_printer_print_ast_node(
5919                 __isl_take isl_printer *p,
5920                 __isl_keep isl_ast_node *node);
5921
5922 More advanced printing can be performed using the following functions.
5923
5924         #include <isl/ast.h>
5925         __isl_give isl_printer *isl_ast_op_type_print_macro(
5926                 enum isl_ast_op_type type,
5927                 __isl_take isl_printer *p);
5928         __isl_give isl_printer *isl_ast_node_print_macros(
5929                 __isl_keep isl_ast_node *node,
5930                 __isl_take isl_printer *p);
5931         __isl_give isl_printer *isl_ast_node_print(
5932                 __isl_keep isl_ast_node *node,
5933                 __isl_take isl_printer *p,
5934                 __isl_take isl_ast_print_options *options);
5935         __isl_give isl_printer *isl_ast_node_for_print(
5936                 __isl_keep isl_ast_node *node,
5937                 __isl_take isl_printer *p,
5938                 __isl_take isl_ast_print_options *options);
5939         __isl_give isl_printer *isl_ast_node_if_print(
5940                 __isl_keep isl_ast_node *node,
5941                 __isl_take isl_printer *p,
5942                 __isl_take isl_ast_print_options *options);
5943
5944 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
5945 C<isl> may print out an AST that makes use of macros such
5946 as C<floord>, C<min> and C<max>.
5947 C<isl_ast_op_type_print_macro> prints out the macro
5948 corresponding to a specific C<isl_ast_op_type>.
5949 C<isl_ast_node_print_macros> scans the C<isl_ast_node>
5950 for expressions where these macros would be used and prints
5951 out the required macro definitions.
5952 Essentially, C<isl_ast_node_print_macros> calls
5953 C<isl_ast_node_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
5954 as function argument.
5955 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
5956 C<isl_ast_node_if_print> print an C<isl_ast_node>
5957 in C<ISL_FORMAT_C>, but allow for some extra control
5958 through an C<isl_ast_print_options> object.
5959 This object can be created using the following functions.
5960
5961         #include <isl/ast.h>
5962         __isl_give isl_ast_print_options *
5963         isl_ast_print_options_alloc(isl_ctx *ctx);
5964         __isl_give isl_ast_print_options *
5965         isl_ast_print_options_copy(
5966                 __isl_keep isl_ast_print_options *options);
5967         void *isl_ast_print_options_free(
5968                 __isl_take isl_ast_print_options *options);
5969
5970         __isl_give isl_ast_print_options *
5971         isl_ast_print_options_set_print_user(
5972                 __isl_take isl_ast_print_options *options,
5973                 __isl_give isl_printer *(*print_user)(
5974                         __isl_take isl_printer *p,
5975                         __isl_take isl_ast_print_options *options,
5976                         __isl_keep isl_ast_node *node, void *user),
5977                 void *user);
5978         __isl_give isl_ast_print_options *
5979         isl_ast_print_options_set_print_for(
5980                 __isl_take isl_ast_print_options *options,
5981                 __isl_give isl_printer *(*print_for)(
5982                         __isl_take isl_printer *p,
5983                         __isl_take isl_ast_print_options *options,
5984                         __isl_keep isl_ast_node *node, void *user),
5985                 void *user);
5986
5987 The callback set by C<isl_ast_print_options_set_print_user>
5988 is called whenever a node of type C<isl_ast_node_user> needs to
5989 be printed.
5990 The callback set by C<isl_ast_print_options_set_print_for>
5991 is called whenever a node of type C<isl_ast_node_for> needs to
5992 be printed.
5993 Note that C<isl_ast_node_for_print> will I<not> call the
5994 callback set by C<isl_ast_print_options_set_print_for> on the node
5995 on which C<isl_ast_node_for_print> is called, but only on nested
5996 nodes of type C<isl_ast_node_for>.  It is therefore safe to
5997 call C<isl_ast_node_for_print> from within the callback set by
5998 C<isl_ast_print_options_set_print_for>.
5999
6000 The following option determines the type to be used for iterators
6001 while printing the AST.
6002
6003         int isl_options_set_ast_iterator_type(
6004                 isl_ctx *ctx, const char *val);
6005         const char *isl_options_get_ast_iterator_type(
6006                 isl_ctx *ctx);
6007
6008 =head3 Options
6009
6010         #include <isl/ast_build.h>
6011         int isl_options_set_ast_build_atomic_upper_bound(
6012                 isl_ctx *ctx, int val);
6013         int isl_options_get_ast_build_atomic_upper_bound(
6014                 isl_ctx *ctx);
6015         int isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
6016                 int val);
6017         int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
6018         int isl_options_set_ast_build_exploit_nested_bounds(
6019                 isl_ctx *ctx, int val);
6020         int isl_options_get_ast_build_exploit_nested_bounds(
6021                 isl_ctx *ctx);
6022         int isl_options_set_ast_build_group_coscheduled(
6023                 isl_ctx *ctx, int val);
6024         int isl_options_get_ast_build_group_coscheduled(
6025                 isl_ctx *ctx);
6026         int isl_options_set_ast_build_scale_strides(
6027                 isl_ctx *ctx, int val);
6028         int isl_options_get_ast_build_scale_strides(
6029                 isl_ctx *ctx);
6030         int isl_options_set_ast_build_allow_else(isl_ctx *ctx,
6031                 int val);
6032         int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
6033         int isl_options_set_ast_build_allow_or(isl_ctx *ctx,
6034                 int val);
6035         int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
6036
6037 =over
6038
6039 =item * ast_build_atomic_upper_bound
6040
6041 Generate loop upper bounds that consist of the current loop iterator,
6042 an operator and an expression not involving the iterator.
6043 If this option is not set, then the current loop iterator may appear
6044 several times in the upper bound.
6045 For example, when this option is turned off, AST generation
6046 for the schedule
6047
6048         [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
6049
6050 produces
6051
6052         for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
6053           A(c0);
6054
6055 When the option is turned on, the following AST is generated
6056
6057         for (int c0 = 0; c0 <= min(100, n); c0 += 1)
6058           A(c0);
6059
6060 =item * ast_build_prefer_pdiv
6061
6062 If this option is turned off, then the AST generation will
6063 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
6064 operators, but no C<isl_ast_op_pdiv_q> or
6065 C<isl_ast_op_pdiv_r> operators.
6066 If this options is turned on, then C<isl> will try to convert
6067 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
6068 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
6069
6070 =item * ast_build_exploit_nested_bounds
6071
6072 Simplify conditions based on bounds of nested for loops.
6073 In particular, remove conditions that are implied by the fact
6074 that one or more nested loops have at least one iteration,
6075 meaning that the upper bound is at least as large as the lower bound.
6076 For example, when this option is turned off, AST generation
6077 for the schedule
6078
6079         [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
6080                                         0 <= j <= M }
6081
6082 produces
6083
6084         if (M >= 0)
6085           for (int c0 = 0; c0 <= N; c0 += 1)
6086             for (int c1 = 0; c1 <= M; c1 += 1)
6087               A(c0, c1);
6088
6089 When the option is turned on, the following AST is generated
6090
6091         for (int c0 = 0; c0 <= N; c0 += 1)
6092           for (int c1 = 0; c1 <= M; c1 += 1)
6093             A(c0, c1);
6094
6095 =item * ast_build_group_coscheduled
6096
6097 If two domain elements are assigned the same schedule point, then
6098 they may be executed in any order and they may even appear in different
6099 loops.  If this options is set, then the AST generator will make
6100 sure that coscheduled domain elements do not appear in separate parts
6101 of the AST.  This is useful in case of nested AST generation
6102 if the outer AST generation is given only part of a schedule
6103 and the inner AST generation should handle the domains that are
6104 coscheduled by this initial part of the schedule together.
6105 For example if an AST is generated for a schedule
6106
6107         { A[i] -> [0]; B[i] -> [0] }
6108
6109 then the C<isl_ast_build_set_create_leaf> callback described
6110 below may get called twice, once for each domain.
6111 Setting this option ensures that the callback is only called once
6112 on both domains together.
6113
6114 =item * ast_build_separation_bounds
6115
6116 This option specifies which bounds to use during separation.
6117 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
6118 then all (possibly implicit) bounds on the current dimension will
6119 be used during separation.
6120 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
6121 then only those bounds that are explicitly available will
6122 be used during separation.
6123
6124 =item * ast_build_scale_strides
6125
6126 This option specifies whether the AST generator is allowed
6127 to scale down iterators of strided loops.
6128
6129 =item * ast_build_allow_else
6130
6131 This option specifies whether the AST generator is allowed
6132 to construct if statements with else branches.
6133
6134 =item * ast_build_allow_or
6135
6136 This option specifies whether the AST generator is allowed
6137 to construct if conditions with disjunctions.
6138
6139 =back
6140
6141 =head3 Fine-grained Control over AST Generation
6142
6143 Besides specifying the constraints on the parameters,
6144 an C<isl_ast_build> object can be used to control
6145 various aspects of the AST generation process.
6146 The most prominent way of control is through ``options'',
6147 which can be set using the following function.
6148
6149         #include <isl/ast_build.h>
6150         __isl_give isl_ast_build *
6151         isl_ast_build_set_options(
6152                 __isl_take isl_ast_build *control,
6153                 __isl_take isl_union_map *options);
6154
6155 The options are encoded in an <isl_union_map>.
6156 The domain of this union relation refers to the schedule domain,
6157 i.e., the range of the schedule passed to C<isl_ast_build_ast_from_schedule>.
6158 In the case of nested AST generation (see L</"Nested AST Generation">),
6159 the domain of C<options> should refer to the extra piece of the schedule.
6160 That is, it should be equal to the range of the wrapped relation in the
6161 range of the schedule.
6162 The range of the options can consist of elements in one or more spaces,
6163 the names of which determine the effect of the option.
6164 The values of the range typically also refer to the schedule dimension
6165 to which the option applies.  In case of nested AST generation
6166 (see L</"Nested AST Generation">), these values refer to the position
6167 of the schedule dimension within the innermost AST generation.
6168 The constraints on the domain elements of
6169 the option should only refer to this dimension and earlier dimensions.
6170 We consider the following spaces.
6171
6172 =over
6173
6174 =item C<separation_class>
6175
6176 This space is a wrapped relation between two one dimensional spaces.
6177 The input space represents the schedule dimension to which the option
6178 applies and the output space represents the separation class.
6179 While constructing a loop corresponding to the specified schedule
6180 dimension(s), the AST generator will try to generate separate loops
6181 for domain elements that are assigned different classes.
6182 If only some of the elements are assigned a class, then those elements
6183 that are not assigned any class will be treated as belonging to a class
6184 that is separate from the explicitly assigned classes.
6185 The typical use case for this option is to separate full tiles from
6186 partial tiles.
6187 The other options, described below, are applied after the separation
6188 into classes.
6189
6190 As an example, consider the separation into full and partial tiles
6191 of a tiling of a triangular domain.
6192 Take, for example, the domain
6193
6194         { A[i,j] : 0 <= i,j and i + j <= 100 }
6195
6196 and a tiling into tiles of 10 by 10.  The input to the AST generator
6197 is then the schedule
6198
6199         { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
6200                                                 i + j <= 100 }
6201
6202 Without any options, the following AST is generated
6203
6204         for (int c0 = 0; c0 <= 10; c0 += 1)
6205           for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6206             for (int c2 = 10 * c0;
6207                  c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6208                  c2 += 1)
6209               for (int c3 = 10 * c1;
6210                    c3 <= min(10 * c1 + 9, -c2 + 100);
6211                    c3 += 1)
6212                 A(c2, c3);
6213
6214 Separation into full and partial tiles can be obtained by assigning
6215 a class, say C<0>, to the full tiles.  The full tiles are represented by those
6216 values of the first and second schedule dimensions for which there are
6217 values of the third and fourth dimensions to cover an entire tile.
6218 That is, we need to specify the following option
6219
6220         { [a,b,c,d] -> separation_class[[0]->[0]] :
6221                 exists b': 0 <= 10a,10b' and
6222                            10a+9+10b'+9 <= 100;
6223           [a,b,c,d] -> separation_class[[1]->[0]] :
6224                 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
6225
6226 which simplifies to
6227
6228         { [a, b, c, d] -> separation_class[[1] -> [0]] :
6229                 a >= 0 and b >= 0 and b <= 8 - a;
6230           [a, b, c, d] -> separation_class[[0] -> [0]] :
6231                 a >= 0 and a <= 8 }
6232
6233 With this option, the generated AST is as follows
6234
6235         {
6236           for (int c0 = 0; c0 <= 8; c0 += 1) {
6237             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
6238               for (int c2 = 10 * c0;
6239                    c2 <= 10 * c0 + 9; c2 += 1)
6240                 for (int c3 = 10 * c1;
6241                      c3 <= 10 * c1 + 9; c3 += 1)
6242                   A(c2, c3);
6243             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
6244               for (int c2 = 10 * c0;
6245                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6246                    c2 += 1)
6247                 for (int c3 = 10 * c1;
6248                      c3 <= min(-c2 + 100, 10 * c1 + 9);
6249                      c3 += 1)
6250                   A(c2, c3);
6251           }
6252           for (int c0 = 9; c0 <= 10; c0 += 1)
6253             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6254               for (int c2 = 10 * c0;
6255                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6256                    c2 += 1)
6257                 for (int c3 = 10 * c1;
6258                      c3 <= min(10 * c1 + 9, -c2 + 100);
6259                      c3 += 1)
6260                   A(c2, c3);
6261         }
6262
6263 =item C<separate>
6264
6265 This is a single-dimensional space representing the schedule dimension(s)
6266 to which ``separation'' should be applied.  Separation tries to split
6267 a loop into several pieces if this can avoid the generation of guards
6268 inside the loop.
6269 See also the C<atomic> option.
6270
6271 =item C<atomic>
6272
6273 This is a single-dimensional space representing the schedule dimension(s)
6274 for which the domains should be considered ``atomic''.  That is, the
6275 AST generator will make sure that any given domain space will only appear
6276 in a single loop at the specified level.
6277
6278 Consider the following schedule
6279
6280         { a[i] -> [i] : 0 <= i < 10;
6281           b[i] -> [i+1] : 0 <= i < 10 }
6282
6283 If the following option is specified
6284
6285         { [i] -> separate[x] }
6286
6287 then the following AST will be generated
6288
6289         {
6290           a(0);
6291           for (int c0 = 1; c0 <= 9; c0 += 1) {
6292             a(c0);
6293             b(c0 - 1);
6294           }
6295           b(9);
6296         }
6297
6298 If, on the other hand, the following option is specified
6299
6300         { [i] -> atomic[x] }
6301
6302 then the following AST will be generated
6303
6304         for (int c0 = 0; c0 <= 10; c0 += 1) {
6305           if (c0 <= 9)
6306             a(c0);
6307           if (c0 >= 1)
6308             b(c0 - 1);
6309         }
6310
6311 If neither C<atomic> nor C<separate> is specified, then the AST generator
6312 may produce either of these two results or some intermediate form.
6313
6314 =item C<unroll>
6315
6316 This is a single-dimensional space representing the schedule dimension(s)
6317 that should be I<completely> unrolled.
6318 To obtain a partial unrolling, the user should apply an additional
6319 strip-mining to the schedule and fully unroll the inner loop.
6320
6321 =back
6322
6323 Additional control is available through the following functions.
6324
6325         #include <isl/ast_build.h>
6326         __isl_give isl_ast_build *
6327         isl_ast_build_set_iterators(
6328                 __isl_take isl_ast_build *control,
6329                 __isl_take isl_id_list *iterators);
6330
6331 The function C<isl_ast_build_set_iterators> allows the user to
6332 specify a list of iterator C<isl_id>s to be used as iterators.
6333 If the input schedule is injective, then
6334 the number of elements in this list should be as large as the dimension
6335 of the schedule space, but no direct correspondence should be assumed
6336 between dimensions and elements.
6337 If the input schedule is not injective, then an additional number
6338 of C<isl_id>s equal to the largest dimension of the input domains
6339 may be required.
6340 If the number of provided C<isl_id>s is insufficient, then additional
6341 names are automatically generated.
6342
6343         #include <isl/ast_build.h>
6344         __isl_give isl_ast_build *
6345         isl_ast_build_set_create_leaf(
6346                 __isl_take isl_ast_build *control,
6347                 __isl_give isl_ast_node *(*fn)(
6348                         __isl_take isl_ast_build *build,
6349                         void *user), void *user);
6350
6351 The
6352 C<isl_ast_build_set_create_leaf> function allows for the
6353 specification of a callback that should be called whenever the AST
6354 generator arrives at an element of the schedule domain.
6355 The callback should return an AST node that should be inserted
6356 at the corresponding position of the AST.  The default action (when
6357 the callback is not set) is to continue generating parts of the AST to scan
6358 all the domain elements associated to the schedule domain element
6359 and to insert user nodes, ``calling'' the domain element, for each of them.
6360 The C<build> argument contains the current state of the C<isl_ast_build>.
6361 To ease nested AST generation (see L</"Nested AST Generation">),
6362 all control information that is
6363 specific to the current AST generation such as the options and
6364 the callbacks has been removed from this C<isl_ast_build>.
6365 The callback would typically return the result of a nested
6366 AST generation or a
6367 user defined node created using the following function.
6368
6369         #include <isl/ast.h>
6370         __isl_give isl_ast_node *isl_ast_node_alloc_user(
6371                 __isl_take isl_ast_expr *expr);
6372
6373         #include <isl/ast_build.h>
6374         __isl_give isl_ast_build *
6375         isl_ast_build_set_at_each_domain(
6376                 __isl_take isl_ast_build *build,
6377                 __isl_give isl_ast_node *(*fn)(
6378                         __isl_take isl_ast_node *node,
6379                         __isl_keep isl_ast_build *build,
6380                         void *user), void *user);
6381         __isl_give isl_ast_build *
6382         isl_ast_build_set_before_each_for(
6383                 __isl_take isl_ast_build *build,
6384                 __isl_give isl_id *(*fn)(
6385                         __isl_keep isl_ast_build *build,
6386                         void *user), void *user);
6387         __isl_give isl_ast_build *
6388         isl_ast_build_set_after_each_for(
6389                 __isl_take isl_ast_build *build,
6390                 __isl_give isl_ast_node *(*fn)(
6391                         __isl_take isl_ast_node *node,
6392                         __isl_keep isl_ast_build *build,
6393                         void *user), void *user);
6394
6395 The callback set by C<isl_ast_build_set_at_each_domain> will
6396 be called for each domain AST node.
6397 The callbacks set by C<isl_ast_build_set_before_each_for>
6398 and C<isl_ast_build_set_after_each_for> will be called
6399 for each for AST node.  The first will be called in depth-first
6400 pre-order, while the second will be called in depth-first post-order.
6401 Since C<isl_ast_build_set_before_each_for> is called before the for
6402 node is actually constructed, it is only passed an C<isl_ast_build>.
6403 The returned C<isl_id> will be added as an annotation (using
6404 C<isl_ast_node_set_annotation>) to the constructed for node.
6405 In particular, if the user has also specified an C<after_each_for>
6406 callback, then the annotation can be retrieved from the node passed to
6407 that callback using C<isl_ast_node_get_annotation>.
6408 All callbacks should C<NULL> on failure.
6409 The given C<isl_ast_build> can be used to create new
6410 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
6411 or C<isl_ast_build_call_from_pw_multi_aff>.
6412
6413 =head3 Nested AST Generation
6414
6415 C<isl> allows the user to create an AST within the context
6416 of another AST.  These nested ASTs are created using the
6417 same C<isl_ast_build_ast_from_schedule> function that is used to create the
6418 outer AST.  The C<build> argument should be an C<isl_ast_build>
6419 passed to a callback set by
6420 C<isl_ast_build_set_create_leaf>.
6421 The space of the range of the C<schedule> argument should refer
6422 to this build.  In particular, the space should be a wrapped
6423 relation and the domain of this wrapped relation should be the
6424 same as that of the range of the schedule returned by
6425 C<isl_ast_build_get_schedule> below.
6426 In practice, the new schedule is typically
6427 created by calling C<isl_union_map_range_product> on the old schedule
6428 and some extra piece of the schedule.
6429 The space of the schedule domain is also available from
6430 the C<isl_ast_build>.
6431
6432         #include <isl/ast_build.h>
6433         __isl_give isl_union_map *isl_ast_build_get_schedule(
6434                 __isl_keep isl_ast_build *build);
6435         __isl_give isl_space *isl_ast_build_get_schedule_space(
6436                 __isl_keep isl_ast_build *build);
6437         __isl_give isl_ast_build *isl_ast_build_restrict(
6438                 __isl_take isl_ast_build *build,
6439                 __isl_take isl_set *set);
6440
6441 The C<isl_ast_build_get_schedule> function returns a (partial)
6442 schedule for the domains elements for which part of the AST still needs to
6443 be generated in the current build.
6444 In particular, the domain elements are mapped to those iterations of the loops
6445 enclosing the current point of the AST generation inside which
6446 the domain elements are executed.
6447 No direct correspondence between
6448 the input schedule and this schedule should be assumed.
6449 The space obtained from C<isl_ast_build_get_schedule_space> can be used
6450 to create a set for C<isl_ast_build_restrict> to intersect
6451 with the current build.  In particular, the set passed to
6452 C<isl_ast_build_restrict> can have additional parameters.
6453 The ids of the set dimensions in the space returned by
6454 C<isl_ast_build_get_schedule_space> correspond to the
6455 iterators of the already generated loops.
6456 The user should not rely on the ids of the output dimensions
6457 of the relations in the union relation returned by
6458 C<isl_ast_build_get_schedule> having any particular value.
6459
6460 =head1 Applications
6461
6462 Although C<isl> is mainly meant to be used as a library,
6463 it also contains some basic applications that use some
6464 of the functionality of C<isl>.
6465 The input may be specified in either the L<isl format>
6466 or the L<PolyLib format>.
6467
6468 =head2 C<isl_polyhedron_sample>
6469
6470 C<isl_polyhedron_sample> takes a polyhedron as input and prints
6471 an integer element of the polyhedron, if there is any.
6472 The first column in the output is the denominator and is always
6473 equal to 1.  If the polyhedron contains no integer points,
6474 then a vector of length zero is printed.
6475
6476 =head2 C<isl_pip>
6477
6478 C<isl_pip> takes the same input as the C<example> program
6479 from the C<piplib> distribution, i.e., a set of constraints
6480 on the parameters, a line containing only -1 and finally a set
6481 of constraints on a parametric polyhedron.
6482 The coefficients of the parameters appear in the last columns
6483 (but before the final constant column).
6484 The output is the lexicographic minimum of the parametric polyhedron.
6485 As C<isl> currently does not have its own output format, the output
6486 is just a dump of the internal state.
6487
6488 =head2 C<isl_polyhedron_minimize>
6489
6490 C<isl_polyhedron_minimize> computes the minimum of some linear
6491 or affine objective function over the integer points in a polyhedron.
6492 If an affine objective function
6493 is given, then the constant should appear in the last column.
6494
6495 =head2 C<isl_polytope_scan>
6496
6497 Given a polytope, C<isl_polytope_scan> prints
6498 all integer points in the polytope.
6499
6500 =head2 C<isl_codegen>
6501
6502 Given a schedule, a context set and an options relation,
6503 C<isl_codegen> prints out an AST that scans the domain elements
6504 of the schedule in the order of their image(s) taking into account
6505 the constraints in the context set.