add isl_vec_set_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_coefficient(
1513                 __isl_take isl_constraint *constraint,
1514                 enum isl_dim_type type, int pos, isl_int v);
1515         __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1516                 __isl_take isl_constraint *constraint,
1517                 enum isl_dim_type type, int pos, int v);
1518         __isl_give isl_basic_map *isl_basic_map_add_constraint(
1519                 __isl_take isl_basic_map *bmap,
1520                 __isl_take isl_constraint *constraint);
1521         __isl_give isl_basic_set *isl_basic_set_add_constraint(
1522                 __isl_take isl_basic_set *bset,
1523                 __isl_take isl_constraint *constraint);
1524         __isl_give isl_map *isl_map_add_constraint(
1525                 __isl_take isl_map *map,
1526                 __isl_take isl_constraint *constraint);
1527         __isl_give isl_set *isl_set_add_constraint(
1528                 __isl_take isl_set *set,
1529                 __isl_take isl_constraint *constraint);
1530         __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1531                 __isl_take isl_basic_set *bset,
1532                 __isl_take isl_constraint *constraint);
1533
1534 For example, to create a set containing the even integers
1535 between 10 and 42, you would use the following code.
1536
1537         isl_space *space;
1538         isl_local_space *ls;
1539         isl_constraint *c;
1540         isl_basic_set *bset;
1541
1542         space = isl_space_set_alloc(ctx, 0, 2);
1543         bset = isl_basic_set_universe(isl_space_copy(space));
1544         ls = isl_local_space_from_space(space);
1545
1546         c = isl_equality_alloc(isl_local_space_copy(ls));
1547         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1548         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1549         bset = isl_basic_set_add_constraint(bset, c);
1550
1551         c = isl_inequality_alloc(isl_local_space_copy(ls));
1552         c = isl_constraint_set_constant_si(c, -10);
1553         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1554         bset = isl_basic_set_add_constraint(bset, c);
1555
1556         c = isl_inequality_alloc(ls);
1557         c = isl_constraint_set_constant_si(c, 42);
1558         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1559         bset = isl_basic_set_add_constraint(bset, c);
1560
1561         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1562
1563 Or, alternatively,
1564
1565         isl_basic_set *bset;
1566         bset = isl_basic_set_read_from_str(ctx,
1567                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1568
1569 A basic set or relation can also be constructed from two matrices
1570 describing the equalities and the inequalities.
1571
1572         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1573                 __isl_take isl_space *space,
1574                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1575                 enum isl_dim_type c1,
1576                 enum isl_dim_type c2, enum isl_dim_type c3,
1577                 enum isl_dim_type c4);
1578         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1579                 __isl_take isl_space *space,
1580                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1581                 enum isl_dim_type c1,
1582                 enum isl_dim_type c2, enum isl_dim_type c3,
1583                 enum isl_dim_type c4, enum isl_dim_type c5);
1584
1585 The C<isl_dim_type> arguments indicate the order in which
1586 different kinds of variables appear in the input matrices
1587 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1588 C<isl_dim_set> and C<isl_dim_div> for sets and
1589 of C<isl_dim_cst>, C<isl_dim_param>,
1590 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1591
1592 A (basic or union) set or relation can also be constructed from a
1593 (union) (piecewise) (multiple) affine expression
1594 or a list of affine expressions
1595 (See L<"Piecewise Quasi Affine Expressions"> and
1596 L<"Piecewise Multiple Quasi Affine Expressions">).
1597
1598         __isl_give isl_basic_map *isl_basic_map_from_aff(
1599                 __isl_take isl_aff *aff);
1600         __isl_give isl_map *isl_map_from_aff(
1601                 __isl_take isl_aff *aff);
1602         __isl_give isl_set *isl_set_from_pw_aff(
1603                 __isl_take isl_pw_aff *pwaff);
1604         __isl_give isl_map *isl_map_from_pw_aff(
1605                 __isl_take isl_pw_aff *pwaff);
1606         __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1607                 __isl_take isl_space *domain_space,
1608                 __isl_take isl_aff_list *list);
1609         __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1610                 __isl_take isl_multi_aff *maff)
1611         __isl_give isl_map *isl_map_from_multi_aff(
1612                 __isl_take isl_multi_aff *maff)
1613         __isl_give isl_set *isl_set_from_pw_multi_aff(
1614                 __isl_take isl_pw_multi_aff *pma);
1615         __isl_give isl_map *isl_map_from_pw_multi_aff(
1616                 __isl_take isl_pw_multi_aff *pma);
1617         __isl_give isl_union_map *
1618         isl_union_map_from_union_pw_multi_aff(
1619                 __isl_take isl_union_pw_multi_aff *upma);
1620
1621 The C<domain_dim> argument describes the domain of the resulting
1622 basic relation.  It is required because the C<list> may consist
1623 of zero affine expressions.
1624
1625 =head2 Inspecting Sets and Relations
1626
1627 Usually, the user should not have to care about the actual constraints
1628 of the sets and maps, but should instead apply the abstract operations
1629 explained in the following sections.
1630 Occasionally, however, it may be required to inspect the individual
1631 coefficients of the constraints.  This section explains how to do so.
1632 In these cases, it may also be useful to have C<isl> compute
1633 an explicit representation of the existentially quantified variables.
1634
1635         __isl_give isl_set *isl_set_compute_divs(
1636                 __isl_take isl_set *set);
1637         __isl_give isl_map *isl_map_compute_divs(
1638                 __isl_take isl_map *map);
1639         __isl_give isl_union_set *isl_union_set_compute_divs(
1640                 __isl_take isl_union_set *uset);
1641         __isl_give isl_union_map *isl_union_map_compute_divs(
1642                 __isl_take isl_union_map *umap);
1643
1644 This explicit representation defines the existentially quantified
1645 variables as integer divisions of the other variables, possibly
1646 including earlier existentially quantified variables.
1647 An explicitly represented existentially quantified variable therefore
1648 has a unique value when the values of the other variables are known.
1649 If, furthermore, the same existentials, i.e., existentials
1650 with the same explicit representations, should appear in the
1651 same order in each of the disjuncts of a set or map, then the user should call
1652 either of the following functions.
1653
1654         __isl_give isl_set *isl_set_align_divs(
1655                 __isl_take isl_set *set);
1656         __isl_give isl_map *isl_map_align_divs(
1657                 __isl_take isl_map *map);
1658
1659 Alternatively, the existentially quantified variables can be removed
1660 using the following functions, which compute an overapproximation.
1661
1662         __isl_give isl_basic_set *isl_basic_set_remove_divs(
1663                 __isl_take isl_basic_set *bset);
1664         __isl_give isl_basic_map *isl_basic_map_remove_divs(
1665                 __isl_take isl_basic_map *bmap);
1666         __isl_give isl_set *isl_set_remove_divs(
1667                 __isl_take isl_set *set);
1668         __isl_give isl_map *isl_map_remove_divs(
1669                 __isl_take isl_map *map);
1670
1671 It is also possible to only remove those divs that are defined
1672 in terms of a given range of dimensions or only those for which
1673 no explicit representation is known.
1674
1675         __isl_give isl_basic_set *
1676         isl_basic_set_remove_divs_involving_dims(
1677                 __isl_take isl_basic_set *bset,
1678                 enum isl_dim_type type,
1679                 unsigned first, unsigned n);
1680         __isl_give isl_basic_map *
1681         isl_basic_map_remove_divs_involving_dims(
1682                 __isl_take isl_basic_map *bmap,
1683                 enum isl_dim_type type,
1684                 unsigned first, unsigned n);
1685         __isl_give isl_set *isl_set_remove_divs_involving_dims(
1686                 __isl_take isl_set *set, enum isl_dim_type type,
1687                 unsigned first, unsigned n);
1688         __isl_give isl_map *isl_map_remove_divs_involving_dims(
1689                 __isl_take isl_map *map, enum isl_dim_type type,
1690                 unsigned first, unsigned n);
1691
1692         __isl_give isl_basic_set *
1693         isl_basic_set_remove_unknown_divs(
1694                 __isl_take isl_basic_set *bset);
1695         __isl_give isl_set *isl_set_remove_unknown_divs(
1696                 __isl_take isl_set *set);
1697         __isl_give isl_map *isl_map_remove_unknown_divs(
1698                 __isl_take isl_map *map);
1699
1700 To iterate over all the sets or maps in a union set or map, use
1701
1702         int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1703                 int (*fn)(__isl_take isl_set *set, void *user),
1704                 void *user);
1705         int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1706                 int (*fn)(__isl_take isl_map *map, void *user),
1707                 void *user);
1708
1709 The number of sets or maps in a union set or map can be obtained
1710 from
1711
1712         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1713         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1714
1715 To extract the set or map in a given space from a union, use
1716
1717         __isl_give isl_set *isl_union_set_extract_set(
1718                 __isl_keep isl_union_set *uset,
1719                 __isl_take isl_space *space);
1720         __isl_give isl_map *isl_union_map_extract_map(
1721                 __isl_keep isl_union_map *umap,
1722                 __isl_take isl_space *space);
1723
1724 To iterate over all the basic sets or maps in a set or map, use
1725
1726         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1727                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1728                 void *user);
1729         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1730                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1731                 void *user);
1732
1733 The callback function C<fn> should return 0 if successful and
1734 -1 if an error occurs.  In the latter case, or if any other error
1735 occurs, the above functions will return -1.
1736
1737 It should be noted that C<isl> does not guarantee that
1738 the basic sets or maps passed to C<fn> are disjoint.
1739 If this is required, then the user should call one of
1740 the following functions first.
1741
1742         __isl_give isl_set *isl_set_make_disjoint(
1743                 __isl_take isl_set *set);
1744         __isl_give isl_map *isl_map_make_disjoint(
1745                 __isl_take isl_map *map);
1746
1747 The number of basic sets in a set can be obtained
1748 from
1749
1750         int isl_set_n_basic_set(__isl_keep isl_set *set);
1751
1752 To iterate over the constraints of a basic set or map, use
1753
1754         #include <isl/constraint.h>
1755
1756         int isl_basic_set_n_constraint(
1757                 __isl_keep isl_basic_set *bset);
1758         int isl_basic_set_foreach_constraint(
1759                 __isl_keep isl_basic_set *bset,
1760                 int (*fn)(__isl_take isl_constraint *c, void *user),
1761                 void *user);
1762         int isl_basic_map_foreach_constraint(
1763                 __isl_keep isl_basic_map *bmap,
1764                 int (*fn)(__isl_take isl_constraint *c, void *user),
1765                 void *user);
1766         void *isl_constraint_free(__isl_take isl_constraint *c);
1767
1768 Again, the callback function C<fn> should return 0 if successful and
1769 -1 if an error occurs.  In the latter case, or if any other error
1770 occurs, the above functions will return -1.
1771 The constraint C<c> represents either an equality or an inequality.
1772 Use the following function to find out whether a constraint
1773 represents an equality.  If not, it represents an inequality.
1774
1775         int isl_constraint_is_equality(
1776                 __isl_keep isl_constraint *constraint);
1777
1778 The coefficients of the constraints can be inspected using
1779 the following functions.
1780
1781         int isl_constraint_is_lower_bound(
1782                 __isl_keep isl_constraint *constraint,
1783                 enum isl_dim_type type, unsigned pos);
1784         int isl_constraint_is_upper_bound(
1785                 __isl_keep isl_constraint *constraint,
1786                 enum isl_dim_type type, unsigned pos);
1787         void isl_constraint_get_constant(
1788                 __isl_keep isl_constraint *constraint, isl_int *v);
1789         void isl_constraint_get_coefficient(
1790                 __isl_keep isl_constraint *constraint,
1791                 enum isl_dim_type type, int pos, isl_int *v);
1792         int isl_constraint_involves_dims(
1793                 __isl_keep isl_constraint *constraint,
1794                 enum isl_dim_type type, unsigned first, unsigned n);
1795
1796 The explicit representations of the existentially quantified
1797 variables can be inspected using the following function.
1798 Note that the user is only allowed to use this function
1799 if the inspected set or map is the result of a call
1800 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1801 The existentially quantified variable is equal to the floor
1802 of the returned affine expression.  The affine expression
1803 itself can be inspected using the functions in
1804 L<"Piecewise Quasi Affine Expressions">.
1805
1806         __isl_give isl_aff *isl_constraint_get_div(
1807                 __isl_keep isl_constraint *constraint, int pos);
1808
1809 To obtain the constraints of a basic set or map in matrix
1810 form, use the following functions.
1811
1812         __isl_give isl_mat *isl_basic_set_equalities_matrix(
1813                 __isl_keep isl_basic_set *bset,
1814                 enum isl_dim_type c1, enum isl_dim_type c2,
1815                 enum isl_dim_type c3, enum isl_dim_type c4);
1816         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1817                 __isl_keep isl_basic_set *bset,
1818                 enum isl_dim_type c1, enum isl_dim_type c2,
1819                 enum isl_dim_type c3, enum isl_dim_type c4);
1820         __isl_give isl_mat *isl_basic_map_equalities_matrix(
1821                 __isl_keep isl_basic_map *bmap,
1822                 enum isl_dim_type c1,
1823                 enum isl_dim_type c2, enum isl_dim_type c3,
1824                 enum isl_dim_type c4, enum isl_dim_type c5);
1825         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1826                 __isl_keep isl_basic_map *bmap,
1827                 enum isl_dim_type c1,
1828                 enum isl_dim_type c2, enum isl_dim_type c3,
1829                 enum isl_dim_type c4, enum isl_dim_type c5);
1830
1831 The C<isl_dim_type> arguments dictate the order in which
1832 different kinds of variables appear in the resulting matrix
1833 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1834 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1835
1836 The number of parameters, input, output or set dimensions can
1837 be obtained using the following functions.
1838
1839         unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1840                 enum isl_dim_type type);
1841         unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1842                 enum isl_dim_type type);
1843         unsigned isl_set_dim(__isl_keep isl_set *set,
1844                 enum isl_dim_type type);
1845         unsigned isl_map_dim(__isl_keep isl_map *map,
1846                 enum isl_dim_type type);
1847
1848 To check whether the description of a set or relation depends
1849 on one or more given dimensions, it is not necessary to iterate over all
1850 constraints.  Instead the following functions can be used.
1851
1852         int isl_basic_set_involves_dims(
1853                 __isl_keep isl_basic_set *bset,
1854                 enum isl_dim_type type, unsigned first, unsigned n);
1855         int isl_set_involves_dims(__isl_keep isl_set *set,
1856                 enum isl_dim_type type, unsigned first, unsigned n);
1857         int isl_basic_map_involves_dims(
1858                 __isl_keep isl_basic_map *bmap,
1859                 enum isl_dim_type type, unsigned first, unsigned n);
1860         int isl_map_involves_dims(__isl_keep isl_map *map,
1861                 enum isl_dim_type type, unsigned first, unsigned n);
1862
1863 Similarly, the following functions can be used to check whether
1864 a given dimension is involved in any lower or upper bound.
1865
1866         int isl_set_dim_has_any_lower_bound(__isl_keep isl_set *set,
1867                 enum isl_dim_type type, unsigned pos);
1868         int isl_set_dim_has_any_upper_bound(__isl_keep isl_set *set,
1869                 enum isl_dim_type type, unsigned pos);
1870
1871 Note that these functions return true even if there is a bound on
1872 the dimension on only some of the basic sets of C<set>.
1873 To check if they have a bound for all of the basic sets in C<set>,
1874 use the following functions instead.
1875
1876         int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
1877                 enum isl_dim_type type, unsigned pos);
1878         int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
1879                 enum isl_dim_type type, unsigned pos);
1880
1881 The identifiers or names of the domain and range spaces of a set
1882 or relation can be read off or set using the following functions.
1883
1884         __isl_give isl_set *isl_set_set_tuple_id(
1885                 __isl_take isl_set *set, __isl_take isl_id *id);
1886         __isl_give isl_set *isl_set_reset_tuple_id(
1887                 __isl_take isl_set *set);
1888         int isl_set_has_tuple_id(__isl_keep isl_set *set);
1889         __isl_give isl_id *isl_set_get_tuple_id(
1890                 __isl_keep isl_set *set);
1891         __isl_give isl_map *isl_map_set_tuple_id(
1892                 __isl_take isl_map *map, enum isl_dim_type type,
1893                 __isl_take isl_id *id);
1894         __isl_give isl_map *isl_map_reset_tuple_id(
1895                 __isl_take isl_map *map, enum isl_dim_type type);
1896         int isl_map_has_tuple_id(__isl_keep isl_map *map,
1897                 enum isl_dim_type type);
1898         __isl_give isl_id *isl_map_get_tuple_id(
1899                 __isl_keep isl_map *map, enum isl_dim_type type);
1900
1901         const char *isl_basic_set_get_tuple_name(
1902                 __isl_keep isl_basic_set *bset);
1903         __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1904                 __isl_take isl_basic_set *set, const char *s);
1905         int isl_set_has_tuple_name(__isl_keep isl_set *set);
1906         const char *isl_set_get_tuple_name(
1907                 __isl_keep isl_set *set);
1908         const char *isl_basic_map_get_tuple_name(
1909                 __isl_keep isl_basic_map *bmap,
1910                 enum isl_dim_type type);
1911         __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1912                 __isl_take isl_basic_map *bmap,
1913                 enum isl_dim_type type, const char *s);
1914         int isl_map_has_tuple_name(__isl_keep isl_map *map,
1915                 enum isl_dim_type type);
1916         const char *isl_map_get_tuple_name(
1917                 __isl_keep isl_map *map,
1918                 enum isl_dim_type type);
1919
1920 As with C<isl_space_get_tuple_name>, the value returned points to
1921 an internal data structure.
1922 The identifiers, positions or names of individual dimensions can be
1923 read off using the following functions.
1924
1925         __isl_give isl_id *isl_basic_set_get_dim_id(
1926                 __isl_keep isl_basic_set *bset,
1927                 enum isl_dim_type type, unsigned pos);
1928         __isl_give isl_set *isl_set_set_dim_id(
1929                 __isl_take isl_set *set, enum isl_dim_type type,
1930                 unsigned pos, __isl_take isl_id *id);
1931         int isl_set_has_dim_id(__isl_keep isl_set *set,
1932                 enum isl_dim_type type, unsigned pos);
1933         __isl_give isl_id *isl_set_get_dim_id(
1934                 __isl_keep isl_set *set, enum isl_dim_type type,
1935                 unsigned pos);
1936         int isl_basic_map_has_dim_id(
1937                 __isl_keep isl_basic_map *bmap,
1938                 enum isl_dim_type type, unsigned pos);
1939         __isl_give isl_map *isl_map_set_dim_id(
1940                 __isl_take isl_map *map, enum isl_dim_type type,
1941                 unsigned pos, __isl_take isl_id *id);
1942         int isl_map_has_dim_id(__isl_keep isl_map *map,
1943                 enum isl_dim_type type, unsigned pos);
1944         __isl_give isl_id *isl_map_get_dim_id(
1945                 __isl_keep isl_map *map, enum isl_dim_type type,
1946                 unsigned pos);
1947
1948         int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1949                 enum isl_dim_type type, __isl_keep isl_id *id);
1950         int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1951                 enum isl_dim_type type, __isl_keep isl_id *id);
1952         int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1953                 enum isl_dim_type type, const char *name);
1954         int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1955                 enum isl_dim_type type, const char *name);
1956
1957         const char *isl_constraint_get_dim_name(
1958                 __isl_keep isl_constraint *constraint,
1959                 enum isl_dim_type type, unsigned pos);
1960         const char *isl_basic_set_get_dim_name(
1961                 __isl_keep isl_basic_set *bset,
1962                 enum isl_dim_type type, unsigned pos);
1963         int isl_set_has_dim_name(__isl_keep isl_set *set,
1964                 enum isl_dim_type type, unsigned pos);
1965         const char *isl_set_get_dim_name(
1966                 __isl_keep isl_set *set,
1967                 enum isl_dim_type type, unsigned pos);
1968         const char *isl_basic_map_get_dim_name(
1969                 __isl_keep isl_basic_map *bmap,
1970                 enum isl_dim_type type, unsigned pos);
1971         int isl_map_has_dim_name(__isl_keep isl_map *map,
1972                 enum isl_dim_type type, unsigned pos);
1973         const char *isl_map_get_dim_name(
1974                 __isl_keep isl_map *map,
1975                 enum isl_dim_type type, unsigned pos);
1976
1977 These functions are mostly useful to obtain the identifiers, positions
1978 or names of the parameters.  Identifiers of individual dimensions are
1979 essentially only useful for printing.  They are ignored by all other
1980 operations and may not be preserved across those operations.
1981
1982 =head2 Properties
1983
1984 =head3 Unary Properties
1985
1986 =over
1987
1988 =item * Emptiness
1989
1990 The following functions test whether the given set or relation
1991 contains any integer points.  The ``plain'' variants do not perform
1992 any computations, but simply check if the given set or relation
1993 is already known to be empty.
1994
1995         int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
1996         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
1997         int isl_set_plain_is_empty(__isl_keep isl_set *set);
1998         int isl_set_is_empty(__isl_keep isl_set *set);
1999         int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
2000         int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
2001         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
2002         int isl_map_plain_is_empty(__isl_keep isl_map *map);
2003         int isl_map_is_empty(__isl_keep isl_map *map);
2004         int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
2005
2006 =item * Universality
2007
2008         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
2009         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
2010         int isl_set_plain_is_universe(__isl_keep isl_set *set);
2011
2012 =item * Single-valuedness
2013
2014         int isl_basic_map_is_single_valued(
2015                 __isl_keep isl_basic_map *bmap);
2016         int isl_map_plain_is_single_valued(
2017                 __isl_keep isl_map *map);
2018         int isl_map_is_single_valued(__isl_keep isl_map *map);
2019         int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
2020
2021 =item * Injectivity
2022
2023         int isl_map_plain_is_injective(__isl_keep isl_map *map);
2024         int isl_map_is_injective(__isl_keep isl_map *map);
2025         int isl_union_map_plain_is_injective(
2026                 __isl_keep isl_union_map *umap);
2027         int isl_union_map_is_injective(
2028                 __isl_keep isl_union_map *umap);
2029
2030 =item * Bijectivity
2031
2032         int isl_map_is_bijective(__isl_keep isl_map *map);
2033         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
2034
2035 =item * Position
2036
2037         int isl_basic_map_plain_is_fixed(
2038                 __isl_keep isl_basic_map *bmap,
2039                 enum isl_dim_type type, unsigned pos,
2040                 isl_int *val);
2041         int isl_set_plain_is_fixed(__isl_keep isl_set *set,
2042                 enum isl_dim_type type, unsigned pos,
2043                 isl_int *val);
2044         int isl_map_plain_is_fixed(__isl_keep isl_map *map,
2045                 enum isl_dim_type type, unsigned pos,
2046                 isl_int *val);
2047
2048 Check if the relation obviously lies on a hyperplane where the given dimension
2049 has a fixed value and if so, return that value in C<*val>.
2050
2051 =item * Space
2052
2053 To check whether a set is a parameter domain, use this function:
2054
2055         int isl_set_is_params(__isl_keep isl_set *set);
2056         int isl_union_set_is_params(
2057                 __isl_keep isl_union_set *uset);
2058
2059 =item * Wrapping
2060
2061 The following functions check whether the domain of the given
2062 (basic) set is a wrapped relation.
2063
2064         int isl_basic_set_is_wrapping(
2065                 __isl_keep isl_basic_set *bset);
2066         int isl_set_is_wrapping(__isl_keep isl_set *set);
2067
2068 =item * Internal Product
2069
2070         int isl_basic_map_can_zip(
2071                 __isl_keep isl_basic_map *bmap);
2072         int isl_map_can_zip(__isl_keep isl_map *map);
2073
2074 Check whether the product of domain and range of the given relation
2075 can be computed,
2076 i.e., whether both domain and range are nested relations.
2077
2078 =item * Currying
2079
2080         int isl_basic_map_can_curry(
2081                 __isl_keep isl_basic_map *bmap);
2082         int isl_map_can_curry(__isl_keep isl_map *map);
2083
2084 Check whether the domain of the (basic) relation is a wrapped relation.
2085
2086         int isl_basic_map_can_uncurry(
2087                 __isl_keep isl_basic_map *bmap);
2088         int isl_map_can_uncurry(__isl_keep isl_map *map);
2089
2090 Check whether the range of the (basic) relation is a wrapped relation.
2091
2092 =back
2093
2094 =head3 Binary Properties
2095
2096 =over
2097
2098 =item * Equality
2099
2100         int isl_set_plain_is_equal(__isl_keep isl_set *set1,
2101                 __isl_keep isl_set *set2);
2102         int isl_set_is_equal(__isl_keep isl_set *set1,
2103                 __isl_keep isl_set *set2);
2104         int isl_union_set_is_equal(
2105                 __isl_keep isl_union_set *uset1,
2106                 __isl_keep isl_union_set *uset2);
2107         int isl_basic_map_is_equal(
2108                 __isl_keep isl_basic_map *bmap1,
2109                 __isl_keep isl_basic_map *bmap2);
2110         int isl_map_is_equal(__isl_keep isl_map *map1,
2111                 __isl_keep isl_map *map2);
2112         int isl_map_plain_is_equal(__isl_keep isl_map *map1,
2113                 __isl_keep isl_map *map2);
2114         int isl_union_map_is_equal(
2115                 __isl_keep isl_union_map *umap1,
2116                 __isl_keep isl_union_map *umap2);
2117
2118 =item * Disjointness
2119
2120         int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
2121                 __isl_keep isl_set *set2);
2122         int isl_set_is_disjoint(__isl_keep isl_set *set1,
2123                 __isl_keep isl_set *set2);
2124         int isl_map_is_disjoint(__isl_keep isl_map *map1,
2125                 __isl_keep isl_map *map2);
2126
2127 =item * Subset
2128
2129         int isl_basic_set_is_subset(
2130                 __isl_keep isl_basic_set *bset1,
2131                 __isl_keep isl_basic_set *bset2);
2132         int isl_set_is_subset(__isl_keep isl_set *set1,
2133                 __isl_keep isl_set *set2);
2134         int isl_set_is_strict_subset(
2135                 __isl_keep isl_set *set1,
2136                 __isl_keep isl_set *set2);
2137         int isl_union_set_is_subset(
2138                 __isl_keep isl_union_set *uset1,
2139                 __isl_keep isl_union_set *uset2);
2140         int isl_union_set_is_strict_subset(
2141                 __isl_keep isl_union_set *uset1,
2142                 __isl_keep isl_union_set *uset2);
2143         int isl_basic_map_is_subset(
2144                 __isl_keep isl_basic_map *bmap1,
2145                 __isl_keep isl_basic_map *bmap2);
2146         int isl_basic_map_is_strict_subset(
2147                 __isl_keep isl_basic_map *bmap1,
2148                 __isl_keep isl_basic_map *bmap2);
2149         int isl_map_is_subset(
2150                 __isl_keep isl_map *map1,
2151                 __isl_keep isl_map *map2);
2152         int isl_map_is_strict_subset(
2153                 __isl_keep isl_map *map1,
2154                 __isl_keep isl_map *map2);
2155         int isl_union_map_is_subset(
2156                 __isl_keep isl_union_map *umap1,
2157                 __isl_keep isl_union_map *umap2);
2158         int isl_union_map_is_strict_subset(
2159                 __isl_keep isl_union_map *umap1,
2160                 __isl_keep isl_union_map *umap2);
2161
2162 Check whether the first argument is a (strict) subset of the
2163 second argument.
2164
2165 =item * Order
2166
2167         int isl_set_plain_cmp(__isl_keep isl_set *set1,
2168                 __isl_keep isl_set *set2);
2169
2170 This function is useful for sorting C<isl_set>s.
2171 The order depends on the internal representation of the inputs.
2172 The order is fixed over different calls to the function (assuming
2173 the internal representation of the inputs has not changed), but may
2174 change over different versions of C<isl>.
2175
2176 =back
2177
2178 =head2 Unary Operations
2179
2180 =over
2181
2182 =item * Complement
2183
2184         __isl_give isl_set *isl_set_complement(
2185                 __isl_take isl_set *set);
2186         __isl_give isl_map *isl_map_complement(
2187                 __isl_take isl_map *map);
2188
2189 =item * Inverse map
2190
2191         __isl_give isl_basic_map *isl_basic_map_reverse(
2192                 __isl_take isl_basic_map *bmap);
2193         __isl_give isl_map *isl_map_reverse(
2194                 __isl_take isl_map *map);
2195         __isl_give isl_union_map *isl_union_map_reverse(
2196                 __isl_take isl_union_map *umap);
2197
2198 =item * Projection
2199
2200         __isl_give isl_basic_set *isl_basic_set_project_out(
2201                 __isl_take isl_basic_set *bset,
2202                 enum isl_dim_type type, unsigned first, unsigned n);
2203         __isl_give isl_basic_map *isl_basic_map_project_out(
2204                 __isl_take isl_basic_map *bmap,
2205                 enum isl_dim_type type, unsigned first, unsigned n);
2206         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
2207                 enum isl_dim_type type, unsigned first, unsigned n);
2208         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
2209                 enum isl_dim_type type, unsigned first, unsigned n);
2210         __isl_give isl_basic_set *isl_basic_set_params(
2211                 __isl_take isl_basic_set *bset);
2212         __isl_give isl_basic_set *isl_basic_map_domain(
2213                 __isl_take isl_basic_map *bmap);
2214         __isl_give isl_basic_set *isl_basic_map_range(
2215                 __isl_take isl_basic_map *bmap);
2216         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
2217         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
2218         __isl_give isl_set *isl_map_domain(
2219                 __isl_take isl_map *bmap);
2220         __isl_give isl_set *isl_map_range(
2221                 __isl_take isl_map *map);
2222         __isl_give isl_set *isl_union_set_params(
2223                 __isl_take isl_union_set *uset);
2224         __isl_give isl_set *isl_union_map_params(
2225                 __isl_take isl_union_map *umap);
2226         __isl_give isl_union_set *isl_union_map_domain(
2227                 __isl_take isl_union_map *umap);
2228         __isl_give isl_union_set *isl_union_map_range(
2229                 __isl_take isl_union_map *umap);
2230
2231         __isl_give isl_basic_map *isl_basic_map_domain_map(
2232                 __isl_take isl_basic_map *bmap);
2233         __isl_give isl_basic_map *isl_basic_map_range_map(
2234                 __isl_take isl_basic_map *bmap);
2235         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
2236         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
2237         __isl_give isl_union_map *isl_union_map_domain_map(
2238                 __isl_take isl_union_map *umap);
2239         __isl_give isl_union_map *isl_union_map_range_map(
2240                 __isl_take isl_union_map *umap);
2241
2242 The functions above construct a (basic, regular or union) relation
2243 that maps (a wrapped version of) the input relation to its domain or range.
2244
2245 =item * Elimination
2246
2247         __isl_give isl_basic_set *isl_basic_set_eliminate(
2248                 __isl_take isl_basic_set *bset,
2249                 enum isl_dim_type type,
2250                 unsigned first, unsigned n);
2251         __isl_give isl_set *isl_set_eliminate(
2252                 __isl_take isl_set *set, enum isl_dim_type type,
2253                 unsigned first, unsigned n);
2254         __isl_give isl_basic_map *isl_basic_map_eliminate(
2255                 __isl_take isl_basic_map *bmap,
2256                 enum isl_dim_type type,
2257                 unsigned first, unsigned n);
2258         __isl_give isl_map *isl_map_eliminate(
2259                 __isl_take isl_map *map, enum isl_dim_type type,
2260                 unsigned first, unsigned n);
2261
2262 Eliminate the coefficients for the given dimensions from the constraints,
2263 without removing the dimensions.
2264
2265 =item * Slicing
2266
2267         __isl_give isl_basic_set *isl_basic_set_fix(
2268                 __isl_take isl_basic_set *bset,
2269                 enum isl_dim_type type, unsigned pos,
2270                 isl_int value);
2271         __isl_give isl_basic_set *isl_basic_set_fix_si(
2272                 __isl_take isl_basic_set *bset,
2273                 enum isl_dim_type type, unsigned pos, int value);
2274         __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
2275                 enum isl_dim_type type, unsigned pos,
2276                 isl_int value);
2277         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
2278                 enum isl_dim_type type, unsigned pos, int value);
2279         __isl_give isl_basic_map *isl_basic_map_fix_si(
2280                 __isl_take isl_basic_map *bmap,
2281                 enum isl_dim_type type, unsigned pos, int value);
2282         __isl_give isl_map *isl_map_fix(__isl_take isl_map *map,
2283                 enum isl_dim_type type, unsigned pos,
2284                 isl_int value);
2285         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
2286                 enum isl_dim_type type, unsigned pos, int value);
2287
2288 Intersect the set or relation with the hyperplane where the given
2289 dimension has the fixed given value.
2290
2291         __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
2292                 __isl_take isl_basic_map *bmap,
2293                 enum isl_dim_type type, unsigned pos, int value);
2294         __isl_give isl_basic_map *isl_basic_map_upper_bound_si(
2295                 __isl_take isl_basic_map *bmap,
2296                 enum isl_dim_type type, unsigned pos, int value);
2297         __isl_give isl_set *isl_set_lower_bound(
2298                 __isl_take isl_set *set,
2299                 enum isl_dim_type type, unsigned pos,
2300                 isl_int value);
2301         __isl_give isl_set *isl_set_lower_bound_si(
2302                 __isl_take isl_set *set,
2303                 enum isl_dim_type type, unsigned pos, int value);
2304         __isl_give isl_map *isl_map_lower_bound_si(
2305                 __isl_take isl_map *map,
2306                 enum isl_dim_type type, unsigned pos, int value);
2307         __isl_give isl_set *isl_set_upper_bound(
2308                 __isl_take isl_set *set,
2309                 enum isl_dim_type type, unsigned pos,
2310                 isl_int value);
2311         __isl_give isl_set *isl_set_upper_bound_si(
2312                 __isl_take isl_set *set,
2313                 enum isl_dim_type type, unsigned pos, int value);
2314         __isl_give isl_map *isl_map_upper_bound_si(
2315                 __isl_take isl_map *map,
2316                 enum isl_dim_type type, unsigned pos, int value);
2317
2318 Intersect the set or relation with the half-space where the given
2319 dimension has a value bounded by the fixed given value.
2320
2321         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
2322                 enum isl_dim_type type1, int pos1,
2323                 enum isl_dim_type type2, int pos2);
2324         __isl_give isl_basic_map *isl_basic_map_equate(
2325                 __isl_take isl_basic_map *bmap,
2326                 enum isl_dim_type type1, int pos1,
2327                 enum isl_dim_type type2, int pos2);
2328         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
2329                 enum isl_dim_type type1, int pos1,
2330                 enum isl_dim_type type2, int pos2);
2331
2332 Intersect the set or relation with the hyperplane where the given
2333 dimensions are equal to each other.
2334
2335         __isl_give isl_map *isl_map_oppose(__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 relation with the hyperplane where the given
2340 dimensions have opposite values.
2341
2342         __isl_give isl_basic_map *isl_basic_map_order_ge(
2343                 __isl_take isl_basic_map *bmap,
2344                 enum isl_dim_type type1, int pos1,
2345                 enum isl_dim_type type2, int pos2);
2346         __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
2347                 enum isl_dim_type type1, int pos1,
2348                 enum isl_dim_type type2, int pos2);
2349         __isl_give isl_basic_map *isl_basic_map_order_gt(
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_gt(__isl_take isl_map *map,
2354                 enum isl_dim_type type1, int pos1,
2355                 enum isl_dim_type type2, int pos2);
2356
2357 Intersect the relation with the half-space where the given
2358 dimensions satisfy the given ordering.
2359
2360 =item * Identity
2361
2362         __isl_give isl_map *isl_set_identity(
2363                 __isl_take isl_set *set);
2364         __isl_give isl_union_map *isl_union_set_identity(
2365                 __isl_take isl_union_set *uset);
2366
2367 Construct an identity relation on the given (union) set.
2368
2369 =item * Deltas
2370
2371         __isl_give isl_basic_set *isl_basic_map_deltas(
2372                 __isl_take isl_basic_map *bmap);
2373         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
2374         __isl_give isl_union_set *isl_union_map_deltas(
2375                 __isl_take isl_union_map *umap);
2376
2377 These functions return a (basic) set containing the differences
2378 between image elements and corresponding domain elements in the input.
2379
2380         __isl_give isl_basic_map *isl_basic_map_deltas_map(
2381                 __isl_take isl_basic_map *bmap);
2382         __isl_give isl_map *isl_map_deltas_map(
2383                 __isl_take isl_map *map);
2384         __isl_give isl_union_map *isl_union_map_deltas_map(
2385                 __isl_take isl_union_map *umap);
2386
2387 The functions above construct a (basic, regular or union) relation
2388 that maps (a wrapped version of) the input relation to its delta set.
2389
2390 =item * Coalescing
2391
2392 Simplify the representation of a set or relation by trying
2393 to combine pairs of basic sets or relations into a single
2394 basic set or relation.
2395
2396         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
2397         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
2398         __isl_give isl_union_set *isl_union_set_coalesce(
2399                 __isl_take isl_union_set *uset);
2400         __isl_give isl_union_map *isl_union_map_coalesce(
2401                 __isl_take isl_union_map *umap);
2402
2403 One of the methods for combining pairs of basic sets or relations
2404 can result in coefficients that are much larger than those that appear
2405 in the constraints of the input.  By default, the coefficients are
2406 not allowed to grow larger, but this can be changed by unsetting
2407 the following option.
2408
2409         int isl_options_set_coalesce_bounded_wrapping(
2410                 isl_ctx *ctx, int val);
2411         int isl_options_get_coalesce_bounded_wrapping(
2412                 isl_ctx *ctx);
2413
2414 =item * Detecting equalities
2415
2416         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
2417                 __isl_take isl_basic_set *bset);
2418         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
2419                 __isl_take isl_basic_map *bmap);
2420         __isl_give isl_set *isl_set_detect_equalities(
2421                 __isl_take isl_set *set);
2422         __isl_give isl_map *isl_map_detect_equalities(
2423                 __isl_take isl_map *map);
2424         __isl_give isl_union_set *isl_union_set_detect_equalities(
2425                 __isl_take isl_union_set *uset);
2426         __isl_give isl_union_map *isl_union_map_detect_equalities(
2427                 __isl_take isl_union_map *umap);
2428
2429 Simplify the representation of a set or relation by detecting implicit
2430 equalities.
2431
2432 =item * Removing redundant constraints
2433
2434         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
2435                 __isl_take isl_basic_set *bset);
2436         __isl_give isl_set *isl_set_remove_redundancies(
2437                 __isl_take isl_set *set);
2438         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
2439                 __isl_take isl_basic_map *bmap);
2440         __isl_give isl_map *isl_map_remove_redundancies(
2441                 __isl_take isl_map *map);
2442
2443 =item * Convex hull
2444
2445         __isl_give isl_basic_set *isl_set_convex_hull(
2446                 __isl_take isl_set *set);
2447         __isl_give isl_basic_map *isl_map_convex_hull(
2448                 __isl_take isl_map *map);
2449
2450 If the input set or relation has any existentially quantified
2451 variables, then the result of these operations is currently undefined.
2452
2453 =item * Simple hull
2454
2455         __isl_give isl_basic_set *
2456         isl_set_unshifted_simple_hull(
2457                 __isl_take isl_set *set);
2458         __isl_give isl_basic_map *
2459         isl_map_unshifted_simple_hull(
2460                 __isl_take isl_map *map);
2461         __isl_give isl_basic_set *isl_set_simple_hull(
2462                 __isl_take isl_set *set);
2463         __isl_give isl_basic_map *isl_map_simple_hull(
2464                 __isl_take isl_map *map);
2465         __isl_give isl_union_map *isl_union_map_simple_hull(
2466                 __isl_take isl_union_map *umap);
2467
2468 These functions compute a single basic set or relation
2469 that contains the whole input set or relation.
2470 In particular, the output is described by translates
2471 of the constraints describing the basic sets or relations in the input.
2472 In case of C<isl_set_unshifted_simple_hull>, only the original
2473 constraints are used, without any translation.
2474
2475 =begin latex
2476
2477 (See \autoref{s:simple hull}.)
2478
2479 =end latex
2480
2481 =item * Affine hull
2482
2483         __isl_give isl_basic_set *isl_basic_set_affine_hull(
2484                 __isl_take isl_basic_set *bset);
2485         __isl_give isl_basic_set *isl_set_affine_hull(
2486                 __isl_take isl_set *set);
2487         __isl_give isl_union_set *isl_union_set_affine_hull(
2488                 __isl_take isl_union_set *uset);
2489         __isl_give isl_basic_map *isl_basic_map_affine_hull(
2490                 __isl_take isl_basic_map *bmap);
2491         __isl_give isl_basic_map *isl_map_affine_hull(
2492                 __isl_take isl_map *map);
2493         __isl_give isl_union_map *isl_union_map_affine_hull(
2494                 __isl_take isl_union_map *umap);
2495
2496 In case of union sets and relations, the affine hull is computed
2497 per space.
2498
2499 =item * Polyhedral hull
2500
2501         __isl_give isl_basic_set *isl_set_polyhedral_hull(
2502                 __isl_take isl_set *set);
2503         __isl_give isl_basic_map *isl_map_polyhedral_hull(
2504                 __isl_take isl_map *map);
2505         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2506                 __isl_take isl_union_set *uset);
2507         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2508                 __isl_take isl_union_map *umap);
2509
2510 These functions compute a single basic set or relation
2511 not involving any existentially quantified variables
2512 that contains the whole input set or relation.
2513 In case of union sets and relations, the polyhedral hull is computed
2514 per space.
2515
2516 =item * Other approximations
2517
2518         __isl_give isl_basic_set *
2519         isl_basic_set_drop_constraints_involving_dims(
2520                 __isl_take isl_basic_set *bset,
2521                 enum isl_dim_type type,
2522                 unsigned first, unsigned n);
2523         __isl_give isl_basic_map *
2524         isl_basic_map_drop_constraints_involving_dims(
2525                 __isl_take isl_basic_map *bmap,
2526                 enum isl_dim_type type,
2527                 unsigned first, unsigned n);
2528         __isl_give isl_basic_set *
2529         isl_basic_set_drop_constraints_not_involving_dims(
2530                 __isl_take isl_basic_set *bset,
2531                 enum isl_dim_type type,
2532                 unsigned first, unsigned n);
2533         __isl_give isl_set *
2534         isl_set_drop_constraints_involving_dims(
2535                 __isl_take isl_set *set,
2536                 enum isl_dim_type type,
2537                 unsigned first, unsigned n);
2538         __isl_give isl_map *
2539         isl_map_drop_constraints_involving_dims(
2540                 __isl_take isl_map *map,
2541                 enum isl_dim_type type,
2542                 unsigned first, unsigned n);
2543
2544 These functions drop any constraints (not) involving the specified dimensions.
2545 Note that the result depends on the representation of the input.
2546
2547 =item * Feasibility
2548
2549         __isl_give isl_basic_set *isl_basic_set_sample(
2550                 __isl_take isl_basic_set *bset);
2551         __isl_give isl_basic_set *isl_set_sample(
2552                 __isl_take isl_set *set);
2553         __isl_give isl_basic_map *isl_basic_map_sample(
2554                 __isl_take isl_basic_map *bmap);
2555         __isl_give isl_basic_map *isl_map_sample(
2556                 __isl_take isl_map *map);
2557
2558 If the input (basic) set or relation is non-empty, then return
2559 a singleton subset of the input.  Otherwise, return an empty set.
2560
2561 =item * Optimization
2562
2563         #include <isl/ilp.h>
2564         enum isl_lp_result isl_basic_set_max(
2565                 __isl_keep isl_basic_set *bset,
2566                 __isl_keep isl_aff *obj, isl_int *opt)
2567         enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
2568                 __isl_keep isl_aff *obj, isl_int *opt);
2569         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
2570                 __isl_keep isl_aff *obj, isl_int *opt);
2571
2572 Compute the minimum or maximum of the integer affine expression C<obj>
2573 over the points in C<set>, returning the result in C<opt>.
2574 The return value may be one of C<isl_lp_error>,
2575 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
2576
2577 =item * Parametric optimization
2578
2579         __isl_give isl_pw_aff *isl_set_dim_min(
2580                 __isl_take isl_set *set, int pos);
2581         __isl_give isl_pw_aff *isl_set_dim_max(
2582                 __isl_take isl_set *set, int pos);
2583         __isl_give isl_pw_aff *isl_map_dim_max(
2584                 __isl_take isl_map *map, int pos);
2585
2586 Compute the minimum or maximum of the given set or output dimension
2587 as a function of the parameters (and input dimensions), but independently
2588 of the other set or output dimensions.
2589 For lexicographic optimization, see L<"Lexicographic Optimization">.
2590
2591 =item * Dual
2592
2593 The following functions compute either the set of (rational) coefficient
2594 values of valid constraints for the given set or the set of (rational)
2595 values satisfying the constraints with coefficients from the given set.
2596 Internally, these two sets of functions perform essentially the
2597 same operations, except that the set of coefficients is assumed to
2598 be a cone, while the set of values may be any polyhedron.
2599 The current implementation is based on the Farkas lemma and
2600 Fourier-Motzkin elimination, but this may change or be made optional
2601 in future.  In particular, future implementations may use different
2602 dualization algorithms or skip the elimination step.
2603
2604         __isl_give isl_basic_set *isl_basic_set_coefficients(
2605                 __isl_take isl_basic_set *bset);
2606         __isl_give isl_basic_set *isl_set_coefficients(
2607                 __isl_take isl_set *set);
2608         __isl_give isl_union_set *isl_union_set_coefficients(
2609                 __isl_take isl_union_set *bset);
2610         __isl_give isl_basic_set *isl_basic_set_solutions(
2611                 __isl_take isl_basic_set *bset);
2612         __isl_give isl_basic_set *isl_set_solutions(
2613                 __isl_take isl_set *set);
2614         __isl_give isl_union_set *isl_union_set_solutions(
2615                 __isl_take isl_union_set *bset);
2616
2617 =item * Power
2618
2619         __isl_give isl_map *isl_map_fixed_power(
2620                 __isl_take isl_map *map, isl_int exp);
2621         __isl_give isl_union_map *isl_union_map_fixed_power(
2622                 __isl_take isl_union_map *umap, isl_int exp);
2623
2624 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2625 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2626 of C<map> is computed.
2627
2628         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2629                 int *exact);
2630         __isl_give isl_union_map *isl_union_map_power(
2631                 __isl_take isl_union_map *umap, int *exact);
2632
2633 Compute a parametric representation for all positive powers I<k> of C<map>.
2634 The result maps I<k> to a nested relation corresponding to the
2635 I<k>th power of C<map>.
2636 The result may be an overapproximation.  If the result is known to be exact,
2637 then C<*exact> is set to C<1>.
2638
2639 =item * Transitive closure
2640
2641         __isl_give isl_map *isl_map_transitive_closure(
2642                 __isl_take isl_map *map, int *exact);
2643         __isl_give isl_union_map *isl_union_map_transitive_closure(
2644                 __isl_take isl_union_map *umap, int *exact);
2645
2646 Compute the transitive closure of C<map>.
2647 The result may be an overapproximation.  If the result is known to be exact,
2648 then C<*exact> is set to C<1>.
2649
2650 =item * Reaching path lengths
2651
2652         __isl_give isl_map *isl_map_reaching_path_lengths(
2653                 __isl_take isl_map *map, int *exact);
2654
2655 Compute a relation that maps each element in the range of C<map>
2656 to the lengths of all paths composed of edges in C<map> that
2657 end up in the given element.
2658 The result may be an overapproximation.  If the result is known to be exact,
2659 then C<*exact> is set to C<1>.
2660 To compute the I<maximal> path length, the resulting relation
2661 should be postprocessed by C<isl_map_lexmax>.
2662 In particular, if the input relation is a dependence relation
2663 (mapping sources to sinks), then the maximal path length corresponds
2664 to the free schedule.
2665 Note, however, that C<isl_map_lexmax> expects the maximum to be
2666 finite, so if the path lengths are unbounded (possibly due to
2667 the overapproximation), then you will get an error message.
2668
2669 =item * Wrapping
2670
2671         __isl_give isl_basic_set *isl_basic_map_wrap(
2672                 __isl_take isl_basic_map *bmap);
2673         __isl_give isl_set *isl_map_wrap(
2674                 __isl_take isl_map *map);
2675         __isl_give isl_union_set *isl_union_map_wrap(
2676                 __isl_take isl_union_map *umap);
2677         __isl_give isl_basic_map *isl_basic_set_unwrap(
2678                 __isl_take isl_basic_set *bset);
2679         __isl_give isl_map *isl_set_unwrap(
2680                 __isl_take isl_set *set);
2681         __isl_give isl_union_map *isl_union_set_unwrap(
2682                 __isl_take isl_union_set *uset);
2683
2684 =item * Flattening
2685
2686 Remove any internal structure of domain (and range) of the given
2687 set or relation.  If there is any such internal structure in the input,
2688 then the name of the space is also removed.
2689
2690         __isl_give isl_basic_set *isl_basic_set_flatten(
2691                 __isl_take isl_basic_set *bset);
2692         __isl_give isl_set *isl_set_flatten(
2693                 __isl_take isl_set *set);
2694         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2695                 __isl_take isl_basic_map *bmap);
2696         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2697                 __isl_take isl_basic_map *bmap);
2698         __isl_give isl_map *isl_map_flatten_range(
2699                 __isl_take isl_map *map);
2700         __isl_give isl_map *isl_map_flatten_domain(
2701                 __isl_take isl_map *map);
2702         __isl_give isl_basic_map *isl_basic_map_flatten(
2703                 __isl_take isl_basic_map *bmap);
2704         __isl_give isl_map *isl_map_flatten(
2705                 __isl_take isl_map *map);
2706
2707         __isl_give isl_map *isl_set_flatten_map(
2708                 __isl_take isl_set *set);
2709
2710 The function above constructs a relation
2711 that maps the input set to a flattened version of the set.
2712
2713 =item * Lifting
2714
2715 Lift the input set to a space with extra dimensions corresponding
2716 to the existentially quantified variables in the input.
2717 In particular, the result lives in a wrapped map where the domain
2718 is the original space and the range corresponds to the original
2719 existentially quantified variables.
2720
2721         __isl_give isl_basic_set *isl_basic_set_lift(
2722                 __isl_take isl_basic_set *bset);
2723         __isl_give isl_set *isl_set_lift(
2724                 __isl_take isl_set *set);
2725         __isl_give isl_union_set *isl_union_set_lift(
2726                 __isl_take isl_union_set *uset);
2727
2728 Given a local space that contains the existentially quantified
2729 variables of a set, a basic relation that, when applied to
2730 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2731 can be constructed using the following function.
2732
2733         #include <isl/local_space.h>
2734         __isl_give isl_basic_map *isl_local_space_lifting(
2735                 __isl_take isl_local_space *ls);
2736
2737 =item * Internal Product
2738
2739         __isl_give isl_basic_map *isl_basic_map_zip(
2740                 __isl_take isl_basic_map *bmap);
2741         __isl_give isl_map *isl_map_zip(
2742                 __isl_take isl_map *map);
2743         __isl_give isl_union_map *isl_union_map_zip(
2744                 __isl_take isl_union_map *umap);
2745
2746 Given a relation with nested relations for domain and range,
2747 interchange the range of the domain with the domain of the range.
2748
2749 =item * Currying
2750
2751         __isl_give isl_basic_map *isl_basic_map_curry(
2752                 __isl_take isl_basic_map *bmap);
2753         __isl_give isl_basic_map *isl_basic_map_uncurry(
2754                 __isl_take isl_basic_map *bmap);
2755         __isl_give isl_map *isl_map_curry(
2756                 __isl_take isl_map *map);
2757         __isl_give isl_map *isl_map_uncurry(
2758                 __isl_take isl_map *map);
2759         __isl_give isl_union_map *isl_union_map_curry(
2760                 __isl_take isl_union_map *umap);
2761         __isl_give isl_union_map *isl_union_map_uncurry(
2762                 __isl_take isl_union_map *umap);
2763
2764 Given a relation with a nested relation for domain,
2765 the C<curry> functions
2766 move the range of the nested relation out of the domain
2767 and use it as the domain of a nested relation in the range,
2768 with the original range as range of this nested relation.
2769 The C<uncurry> functions perform the inverse operation.
2770
2771 =item * Aligning parameters
2772
2773         __isl_give isl_basic_set *isl_basic_set_align_params(
2774                 __isl_take isl_basic_set *bset,
2775                 __isl_take isl_space *model);
2776         __isl_give isl_set *isl_set_align_params(
2777                 __isl_take isl_set *set,
2778                 __isl_take isl_space *model);
2779         __isl_give isl_basic_map *isl_basic_map_align_params(
2780                 __isl_take isl_basic_map *bmap,
2781                 __isl_take isl_space *model);
2782         __isl_give isl_map *isl_map_align_params(
2783                 __isl_take isl_map *map,
2784                 __isl_take isl_space *model);
2785
2786 Change the order of the parameters of the given set or relation
2787 such that the first parameters match those of C<model>.
2788 This may involve the introduction of extra parameters.
2789 All parameters need to be named.
2790
2791 =item * Dimension manipulation
2792
2793         __isl_give isl_basic_set *isl_basic_set_add_dims(
2794                 __isl_take isl_basic_set *bset,
2795                 enum isl_dim_type type, unsigned n);
2796         __isl_give isl_set *isl_set_add_dims(
2797                 __isl_take isl_set *set,
2798                 enum isl_dim_type type, unsigned n);
2799         __isl_give isl_map *isl_map_add_dims(
2800                 __isl_take isl_map *map,
2801                 enum isl_dim_type type, unsigned n);
2802         __isl_give isl_basic_set *isl_basic_set_insert_dims(
2803                 __isl_take isl_basic_set *bset,
2804                 enum isl_dim_type type, unsigned pos,
2805                 unsigned n);
2806         __isl_give isl_basic_map *isl_basic_map_insert_dims(
2807                 __isl_take isl_basic_map *bmap,
2808                 enum isl_dim_type type, unsigned pos,
2809                 unsigned n);
2810         __isl_give isl_set *isl_set_insert_dims(
2811                 __isl_take isl_set *set,
2812                 enum isl_dim_type type, unsigned pos, unsigned n);
2813         __isl_give isl_map *isl_map_insert_dims(
2814                 __isl_take isl_map *map,
2815                 enum isl_dim_type type, unsigned pos, unsigned n);
2816         __isl_give isl_basic_set *isl_basic_set_move_dims(
2817                 __isl_take isl_basic_set *bset,
2818                 enum isl_dim_type dst_type, unsigned dst_pos,
2819                 enum isl_dim_type src_type, unsigned src_pos,
2820                 unsigned n);
2821         __isl_give isl_basic_map *isl_basic_map_move_dims(
2822                 __isl_take isl_basic_map *bmap,
2823                 enum isl_dim_type dst_type, unsigned dst_pos,
2824                 enum isl_dim_type src_type, unsigned src_pos,
2825                 unsigned n);
2826         __isl_give isl_set *isl_set_move_dims(
2827                 __isl_take isl_set *set,
2828                 enum isl_dim_type dst_type, unsigned dst_pos,
2829                 enum isl_dim_type src_type, unsigned src_pos,
2830                 unsigned n);
2831         __isl_give isl_map *isl_map_move_dims(
2832                 __isl_take isl_map *map,
2833                 enum isl_dim_type dst_type, unsigned dst_pos,
2834                 enum isl_dim_type src_type, unsigned src_pos,
2835                 unsigned n);
2836
2837 It is usually not advisable to directly change the (input or output)
2838 space of a set or a relation as this removes the name and the internal
2839 structure of the space.  However, the above functions can be useful
2840 to add new parameters, assuming
2841 C<isl_set_align_params> and C<isl_map_align_params>
2842 are not sufficient.
2843
2844 =back
2845
2846 =head2 Binary Operations
2847
2848 The two arguments of a binary operation not only need to live
2849 in the same C<isl_ctx>, they currently also need to have
2850 the same (number of) parameters.
2851
2852 =head3 Basic Operations
2853
2854 =over
2855
2856 =item * Intersection
2857
2858         __isl_give isl_basic_set *isl_basic_set_intersect_params(
2859                 __isl_take isl_basic_set *bset1,
2860                 __isl_take isl_basic_set *bset2);
2861         __isl_give isl_basic_set *isl_basic_set_intersect(
2862                 __isl_take isl_basic_set *bset1,
2863                 __isl_take isl_basic_set *bset2);
2864         __isl_give isl_set *isl_set_intersect_params(
2865                 __isl_take isl_set *set,
2866                 __isl_take isl_set *params);
2867         __isl_give isl_set *isl_set_intersect(
2868                 __isl_take isl_set *set1,
2869                 __isl_take isl_set *set2);
2870         __isl_give isl_union_set *isl_union_set_intersect_params(
2871                 __isl_take isl_union_set *uset,
2872                 __isl_take isl_set *set);
2873         __isl_give isl_union_map *isl_union_map_intersect_params(
2874                 __isl_take isl_union_map *umap,
2875                 __isl_take isl_set *set);
2876         __isl_give isl_union_set *isl_union_set_intersect(
2877                 __isl_take isl_union_set *uset1,
2878                 __isl_take isl_union_set *uset2);
2879         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2880                 __isl_take isl_basic_map *bmap,
2881                 __isl_take isl_basic_set *bset);
2882         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2883                 __isl_take isl_basic_map *bmap,
2884                 __isl_take isl_basic_set *bset);
2885         __isl_give isl_basic_map *isl_basic_map_intersect(
2886                 __isl_take isl_basic_map *bmap1,
2887                 __isl_take isl_basic_map *bmap2);
2888         __isl_give isl_map *isl_map_intersect_params(
2889                 __isl_take isl_map *map,
2890                 __isl_take isl_set *params);
2891         __isl_give isl_map *isl_map_intersect_domain(
2892                 __isl_take isl_map *map,
2893                 __isl_take isl_set *set);
2894         __isl_give isl_map *isl_map_intersect_range(
2895                 __isl_take isl_map *map,
2896                 __isl_take isl_set *set);
2897         __isl_give isl_map *isl_map_intersect(
2898                 __isl_take isl_map *map1,
2899                 __isl_take isl_map *map2);
2900         __isl_give isl_union_map *isl_union_map_intersect_domain(
2901                 __isl_take isl_union_map *umap,
2902                 __isl_take isl_union_set *uset);
2903         __isl_give isl_union_map *isl_union_map_intersect_range(
2904                 __isl_take isl_union_map *umap,
2905                 __isl_take isl_union_set *uset);
2906         __isl_give isl_union_map *isl_union_map_intersect(
2907                 __isl_take isl_union_map *umap1,
2908                 __isl_take isl_union_map *umap2);
2909
2910 The second argument to the C<_params> functions needs to be
2911 a parametric (basic) set.  For the other functions, a parametric set
2912 for either argument is only allowed if the other argument is
2913 a parametric set as well.
2914
2915 =item * Union
2916
2917         __isl_give isl_set *isl_basic_set_union(
2918                 __isl_take isl_basic_set *bset1,
2919                 __isl_take isl_basic_set *bset2);
2920         __isl_give isl_map *isl_basic_map_union(
2921                 __isl_take isl_basic_map *bmap1,
2922                 __isl_take isl_basic_map *bmap2);
2923         __isl_give isl_set *isl_set_union(
2924                 __isl_take isl_set *set1,
2925                 __isl_take isl_set *set2);
2926         __isl_give isl_map *isl_map_union(
2927                 __isl_take isl_map *map1,
2928                 __isl_take isl_map *map2);
2929         __isl_give isl_union_set *isl_union_set_union(
2930                 __isl_take isl_union_set *uset1,
2931                 __isl_take isl_union_set *uset2);
2932         __isl_give isl_union_map *isl_union_map_union(
2933                 __isl_take isl_union_map *umap1,
2934                 __isl_take isl_union_map *umap2);
2935
2936 =item * Set difference
2937
2938         __isl_give isl_set *isl_set_subtract(
2939                 __isl_take isl_set *set1,
2940                 __isl_take isl_set *set2);
2941         __isl_give isl_map *isl_map_subtract(
2942                 __isl_take isl_map *map1,
2943                 __isl_take isl_map *map2);
2944         __isl_give isl_map *isl_map_subtract_domain(
2945                 __isl_take isl_map *map,
2946                 __isl_take isl_set *dom);
2947         __isl_give isl_map *isl_map_subtract_range(
2948                 __isl_take isl_map *map,
2949                 __isl_take isl_set *dom);
2950         __isl_give isl_union_set *isl_union_set_subtract(
2951                 __isl_take isl_union_set *uset1,
2952                 __isl_take isl_union_set *uset2);
2953         __isl_give isl_union_map *isl_union_map_subtract(
2954                 __isl_take isl_union_map *umap1,
2955                 __isl_take isl_union_map *umap2);
2956         __isl_give isl_union_map *isl_union_map_subtract_domain(
2957                 __isl_take isl_union_map *umap,
2958                 __isl_take isl_union_set *dom);
2959         __isl_give isl_union_map *isl_union_map_subtract_range(
2960                 __isl_take isl_union_map *umap,
2961                 __isl_take isl_union_set *dom);
2962
2963 =item * Application
2964
2965         __isl_give isl_basic_set *isl_basic_set_apply(
2966                 __isl_take isl_basic_set *bset,
2967                 __isl_take isl_basic_map *bmap);
2968         __isl_give isl_set *isl_set_apply(
2969                 __isl_take isl_set *set,
2970                 __isl_take isl_map *map);
2971         __isl_give isl_union_set *isl_union_set_apply(
2972                 __isl_take isl_union_set *uset,
2973                 __isl_take isl_union_map *umap);
2974         __isl_give isl_basic_map *isl_basic_map_apply_domain(
2975                 __isl_take isl_basic_map *bmap1,
2976                 __isl_take isl_basic_map *bmap2);
2977         __isl_give isl_basic_map *isl_basic_map_apply_range(
2978                 __isl_take isl_basic_map *bmap1,
2979                 __isl_take isl_basic_map *bmap2);
2980         __isl_give isl_map *isl_map_apply_domain(
2981                 __isl_take isl_map *map1,
2982                 __isl_take isl_map *map2);
2983         __isl_give isl_union_map *isl_union_map_apply_domain(
2984                 __isl_take isl_union_map *umap1,
2985                 __isl_take isl_union_map *umap2);
2986         __isl_give isl_map *isl_map_apply_range(
2987                 __isl_take isl_map *map1,
2988                 __isl_take isl_map *map2);
2989         __isl_give isl_union_map *isl_union_map_apply_range(
2990                 __isl_take isl_union_map *umap1,
2991                 __isl_take isl_union_map *umap2);
2992
2993 =item * Preimage
2994
2995         __isl_give isl_basic_set *
2996         isl_basic_set_preimage_multi_aff(
2997                 __isl_take isl_basic_set *bset,
2998                 __isl_take isl_multi_aff *ma);
2999         __isl_give isl_set *isl_set_preimage_multi_aff(
3000                 __isl_take isl_set *set,
3001                 __isl_take isl_multi_aff *ma);
3002         __isl_give isl_set *isl_set_preimage_pw_multi_aff(
3003                 __isl_take isl_set *set,
3004                 __isl_take isl_pw_multi_aff *pma);
3005         __isl_give isl_map *isl_map_preimage_domain_multi_aff(
3006                 __isl_take isl_map *map,
3007                 __isl_take isl_multi_aff *ma);
3008         __isl_give isl_union_map *
3009         isl_union_map_preimage_domain_multi_aff(
3010                 __isl_take isl_union_map *umap,
3011                 __isl_take isl_multi_aff *ma);
3012
3013 These functions compute the preimage of the given set or map domain under
3014 the given function.  In other words, the expression is plugged
3015 into the set description or into the domain of the map.
3016 Objects of types C<isl_multi_aff> and C<isl_pw_multi_aff> are described in
3017 L</"Piecewise Multiple Quasi Affine Expressions">.
3018
3019 =item * Cartesian Product
3020
3021         __isl_give isl_set *isl_set_product(
3022                 __isl_take isl_set *set1,
3023                 __isl_take isl_set *set2);
3024         __isl_give isl_union_set *isl_union_set_product(
3025                 __isl_take isl_union_set *uset1,
3026                 __isl_take isl_union_set *uset2);
3027         __isl_give isl_basic_map *isl_basic_map_domain_product(
3028                 __isl_take isl_basic_map *bmap1,
3029                 __isl_take isl_basic_map *bmap2);
3030         __isl_give isl_basic_map *isl_basic_map_range_product(
3031                 __isl_take isl_basic_map *bmap1,
3032                 __isl_take isl_basic_map *bmap2);
3033         __isl_give isl_basic_map *isl_basic_map_product(
3034                 __isl_take isl_basic_map *bmap1,
3035                 __isl_take isl_basic_map *bmap2);
3036         __isl_give isl_map *isl_map_domain_product(
3037                 __isl_take isl_map *map1,
3038                 __isl_take isl_map *map2);
3039         __isl_give isl_map *isl_map_range_product(
3040                 __isl_take isl_map *map1,
3041                 __isl_take isl_map *map2);
3042         __isl_give isl_union_map *isl_union_map_domain_product(
3043                 __isl_take isl_union_map *umap1,
3044                 __isl_take isl_union_map *umap2);
3045         __isl_give isl_union_map *isl_union_map_range_product(
3046                 __isl_take isl_union_map *umap1,
3047                 __isl_take isl_union_map *umap2);
3048         __isl_give isl_map *isl_map_product(
3049                 __isl_take isl_map *map1,
3050                 __isl_take isl_map *map2);
3051         __isl_give isl_union_map *isl_union_map_product(
3052                 __isl_take isl_union_map *umap1,
3053                 __isl_take isl_union_map *umap2);
3054
3055 The above functions compute the cross product of the given
3056 sets or relations.  The domains and ranges of the results
3057 are wrapped maps between domains and ranges of the inputs.
3058 To obtain a ``flat'' product, use the following functions
3059 instead.
3060
3061         __isl_give isl_basic_set *isl_basic_set_flat_product(
3062                 __isl_take isl_basic_set *bset1,
3063                 __isl_take isl_basic_set *bset2);
3064         __isl_give isl_set *isl_set_flat_product(
3065                 __isl_take isl_set *set1,
3066                 __isl_take isl_set *set2);
3067         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
3068                 __isl_take isl_basic_map *bmap1,
3069                 __isl_take isl_basic_map *bmap2);
3070         __isl_give isl_map *isl_map_flat_domain_product(
3071                 __isl_take isl_map *map1,
3072                 __isl_take isl_map *map2);
3073         __isl_give isl_map *isl_map_flat_range_product(
3074                 __isl_take isl_map *map1,
3075                 __isl_take isl_map *map2);
3076         __isl_give isl_union_map *isl_union_map_flat_range_product(
3077                 __isl_take isl_union_map *umap1,
3078                 __isl_take isl_union_map *umap2);
3079         __isl_give isl_basic_map *isl_basic_map_flat_product(
3080                 __isl_take isl_basic_map *bmap1,
3081                 __isl_take isl_basic_map *bmap2);
3082         __isl_give isl_map *isl_map_flat_product(
3083                 __isl_take isl_map *map1,
3084                 __isl_take isl_map *map2);
3085
3086 =item * Simplification
3087
3088         __isl_give isl_basic_set *isl_basic_set_gist(
3089                 __isl_take isl_basic_set *bset,
3090                 __isl_take isl_basic_set *context);
3091         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
3092                 __isl_take isl_set *context);
3093         __isl_give isl_set *isl_set_gist_params(
3094                 __isl_take isl_set *set,
3095                 __isl_take isl_set *context);
3096         __isl_give isl_union_set *isl_union_set_gist(
3097                 __isl_take isl_union_set *uset,
3098                 __isl_take isl_union_set *context);
3099         __isl_give isl_union_set *isl_union_set_gist_params(
3100                 __isl_take isl_union_set *uset,
3101                 __isl_take isl_set *set);
3102         __isl_give isl_basic_map *isl_basic_map_gist(
3103                 __isl_take isl_basic_map *bmap,
3104                 __isl_take isl_basic_map *context);
3105         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
3106                 __isl_take isl_map *context);
3107         __isl_give isl_map *isl_map_gist_params(
3108                 __isl_take isl_map *map,
3109                 __isl_take isl_set *context);
3110         __isl_give isl_map *isl_map_gist_domain(
3111                 __isl_take isl_map *map,
3112                 __isl_take isl_set *context);
3113         __isl_give isl_map *isl_map_gist_range(
3114                 __isl_take isl_map *map,
3115                 __isl_take isl_set *context);
3116         __isl_give isl_union_map *isl_union_map_gist(
3117                 __isl_take isl_union_map *umap,
3118                 __isl_take isl_union_map *context);
3119         __isl_give isl_union_map *isl_union_map_gist_params(
3120                 __isl_take isl_union_map *umap,
3121                 __isl_take isl_set *set);
3122         __isl_give isl_union_map *isl_union_map_gist_domain(
3123                 __isl_take isl_union_map *umap,
3124                 __isl_take isl_union_set *uset);
3125         __isl_give isl_union_map *isl_union_map_gist_range(
3126                 __isl_take isl_union_map *umap,
3127                 __isl_take isl_union_set *uset);
3128
3129 The gist operation returns a set or relation that has the
3130 same intersection with the context as the input set or relation.
3131 Any implicit equality in the intersection is made explicit in the result,
3132 while all inequalities that are redundant with respect to the intersection
3133 are removed.
3134 In case of union sets and relations, the gist operation is performed
3135 per space.
3136
3137 =back
3138
3139 =head3 Lexicographic Optimization
3140
3141 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
3142 the following functions
3143 compute a set that contains the lexicographic minimum or maximum
3144 of the elements in C<set> (or C<bset>) for those values of the parameters
3145 that satisfy C<dom>.
3146 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3147 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
3148 has no elements.
3149 In other words, the union of the parameter values
3150 for which the result is non-empty and of C<*empty>
3151 is equal to C<dom>.
3152
3153         __isl_give isl_set *isl_basic_set_partial_lexmin(
3154                 __isl_take isl_basic_set *bset,
3155                 __isl_take isl_basic_set *dom,
3156                 __isl_give isl_set **empty);
3157         __isl_give isl_set *isl_basic_set_partial_lexmax(
3158                 __isl_take isl_basic_set *bset,
3159                 __isl_take isl_basic_set *dom,
3160                 __isl_give isl_set **empty);
3161         __isl_give isl_set *isl_set_partial_lexmin(
3162                 __isl_take isl_set *set, __isl_take isl_set *dom,
3163                 __isl_give isl_set **empty);
3164         __isl_give isl_set *isl_set_partial_lexmax(
3165                 __isl_take isl_set *set, __isl_take isl_set *dom,
3166                 __isl_give isl_set **empty);
3167
3168 Given a (basic) set C<set> (or C<bset>), the following functions simply
3169 return a set containing the lexicographic minimum or maximum
3170 of the elements in C<set> (or C<bset>).
3171 In case of union sets, the optimum is computed per space.
3172
3173         __isl_give isl_set *isl_basic_set_lexmin(
3174                 __isl_take isl_basic_set *bset);
3175         __isl_give isl_set *isl_basic_set_lexmax(
3176                 __isl_take isl_basic_set *bset);
3177         __isl_give isl_set *isl_set_lexmin(
3178                 __isl_take isl_set *set);
3179         __isl_give isl_set *isl_set_lexmax(
3180                 __isl_take isl_set *set);
3181         __isl_give isl_union_set *isl_union_set_lexmin(
3182                 __isl_take isl_union_set *uset);
3183         __isl_give isl_union_set *isl_union_set_lexmax(
3184                 __isl_take isl_union_set *uset);
3185
3186 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
3187 the following functions
3188 compute a relation that maps each element of C<dom>
3189 to the single lexicographic minimum or maximum
3190 of the elements that are associated to that same
3191 element in C<map> (or C<bmap>).
3192 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3193 that contains the elements in C<dom> that do not map
3194 to any elements in C<map> (or C<bmap>).
3195 In other words, the union of the domain of the result and of C<*empty>
3196 is equal to C<dom>.
3197
3198         __isl_give isl_map *isl_basic_map_partial_lexmax(
3199                 __isl_take isl_basic_map *bmap,
3200                 __isl_take isl_basic_set *dom,
3201                 __isl_give isl_set **empty);
3202         __isl_give isl_map *isl_basic_map_partial_lexmin(
3203                 __isl_take isl_basic_map *bmap,
3204                 __isl_take isl_basic_set *dom,
3205                 __isl_give isl_set **empty);
3206         __isl_give isl_map *isl_map_partial_lexmax(
3207                 __isl_take isl_map *map, __isl_take isl_set *dom,
3208                 __isl_give isl_set **empty);
3209         __isl_give isl_map *isl_map_partial_lexmin(
3210                 __isl_take isl_map *map, __isl_take isl_set *dom,
3211                 __isl_give isl_set **empty);
3212
3213 Given a (basic) map C<map> (or C<bmap>), the following functions simply
3214 return a map mapping each element in the domain of
3215 C<map> (or C<bmap>) to the lexicographic minimum or maximum
3216 of all elements associated to that element.
3217 In case of union relations, the optimum is computed per space.
3218
3219         __isl_give isl_map *isl_basic_map_lexmin(
3220                 __isl_take isl_basic_map *bmap);
3221         __isl_give isl_map *isl_basic_map_lexmax(
3222                 __isl_take isl_basic_map *bmap);
3223         __isl_give isl_map *isl_map_lexmin(
3224                 __isl_take isl_map *map);
3225         __isl_give isl_map *isl_map_lexmax(
3226                 __isl_take isl_map *map);
3227         __isl_give isl_union_map *isl_union_map_lexmin(
3228                 __isl_take isl_union_map *umap);
3229         __isl_give isl_union_map *isl_union_map_lexmax(
3230                 __isl_take isl_union_map *umap);
3231
3232 The following functions return their result in the form of
3233 a piecewise multi-affine expression
3234 (See L<"Piecewise Multiple Quasi Affine Expressions">),
3235 but are otherwise equivalent to the corresponding functions
3236 returning a basic set or relation.
3237
3238         __isl_give isl_pw_multi_aff *
3239         isl_basic_map_lexmin_pw_multi_aff(
3240                 __isl_take isl_basic_map *bmap);
3241         __isl_give isl_pw_multi_aff *
3242         isl_basic_set_partial_lexmin_pw_multi_aff(
3243                 __isl_take isl_basic_set *bset,
3244                 __isl_take isl_basic_set *dom,
3245                 __isl_give isl_set **empty);
3246         __isl_give isl_pw_multi_aff *
3247         isl_basic_set_partial_lexmax_pw_multi_aff(
3248                 __isl_take isl_basic_set *bset,
3249                 __isl_take isl_basic_set *dom,
3250                 __isl_give isl_set **empty);
3251         __isl_give isl_pw_multi_aff *
3252         isl_basic_map_partial_lexmin_pw_multi_aff(
3253                 __isl_take isl_basic_map *bmap,
3254                 __isl_take isl_basic_set *dom,
3255                 __isl_give isl_set **empty);
3256         __isl_give isl_pw_multi_aff *
3257         isl_basic_map_partial_lexmax_pw_multi_aff(
3258                 __isl_take isl_basic_map *bmap,
3259                 __isl_take isl_basic_set *dom,
3260                 __isl_give isl_set **empty);
3261         __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
3262                 __isl_take isl_set *set);
3263         __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
3264                 __isl_take isl_set *set);
3265         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
3266                 __isl_take isl_map *map);
3267         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
3268                 __isl_take isl_map *map);
3269
3270 =head2 Lists
3271
3272 Lists are defined over several element types, including
3273 C<isl_val>, C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_constraint>,
3274 C<isl_basic_set>, C<isl_set>, C<isl_ast_expr> and C<isl_ast_node>.
3275 Here we take lists of C<isl_set>s as an example.
3276 Lists can be created, copied, modified and freed using the following functions.
3277
3278         #include <isl/list.h>
3279         __isl_give isl_set_list *isl_set_list_from_set(
3280                 __isl_take isl_set *el);
3281         __isl_give isl_set_list *isl_set_list_alloc(
3282                 isl_ctx *ctx, int n);
3283         __isl_give isl_set_list *isl_set_list_copy(
3284                 __isl_keep isl_set_list *list);
3285         __isl_give isl_set_list *isl_set_list_insert(
3286                 __isl_take isl_set_list *list, unsigned pos,
3287                 __isl_take isl_set *el);
3288         __isl_give isl_set_list *isl_set_list_add(
3289                 __isl_take isl_set_list *list,
3290                 __isl_take isl_set *el);
3291         __isl_give isl_set_list *isl_set_list_drop(
3292                 __isl_take isl_set_list *list,
3293                 unsigned first, unsigned n);
3294         __isl_give isl_set_list *isl_set_list_set_set(
3295                 __isl_take isl_set_list *list, int index,
3296                 __isl_take isl_set *set);
3297         __isl_give isl_set_list *isl_set_list_concat(
3298                 __isl_take isl_set_list *list1,
3299                 __isl_take isl_set_list *list2);
3300         __isl_give isl_set_list *isl_set_list_sort(
3301                 __isl_take isl_set_list *list,
3302                 int (*cmp)(__isl_keep isl_set *a,
3303                         __isl_keep isl_set *b, void *user),
3304                 void *user);
3305         void *isl_set_list_free(__isl_take isl_set_list *list);
3306
3307 C<isl_set_list_alloc> creates an empty list with a capacity for
3308 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
3309 element.
3310
3311 Lists can be inspected using the following functions.
3312
3313         #include <isl/list.h>
3314         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
3315         int isl_set_list_n_set(__isl_keep isl_set_list *list);
3316         __isl_give isl_set *isl_set_list_get_set(
3317                 __isl_keep isl_set_list *list, int index);
3318         int isl_set_list_foreach(__isl_keep isl_set_list *list,
3319                 int (*fn)(__isl_take isl_set *el, void *user),
3320                 void *user);
3321         int isl_set_list_foreach_scc(__isl_keep isl_set_list *list,
3322                 int (*follows)(__isl_keep isl_set *a,
3323                         __isl_keep isl_set *b, void *user),
3324                 void *follows_user
3325                 int (*fn)(__isl_take isl_set *el, void *user),
3326                 void *fn_user);
3327
3328 The function C<isl_set_list_foreach_scc> calls C<fn> on each of the
3329 strongly connected components of the graph with as vertices the elements
3330 of C<list> and a directed edge from vertex C<b> to vertex C<a>
3331 iff C<follows(a, b)> returns C<1>.  The callbacks C<follows> and C<fn>
3332 should return C<-1> on error.
3333
3334 Lists can be printed using
3335
3336         #include <isl/list.h>
3337         __isl_give isl_printer *isl_printer_print_set_list(
3338                 __isl_take isl_printer *p,
3339                 __isl_keep isl_set_list *list);
3340
3341 =head2 Multiple Values
3342
3343 An C<isl_multi_val> object represents a sequence of zero or more values,
3344 living in a set space.
3345
3346 An C<isl_multi_val> can be constructed from an C<isl_val_list>
3347 using the following function
3348
3349         #include <isl/val.h>
3350         __isl_give isl_multi_val *isl_multi_val_from_val_list(
3351                 __isl_take isl_space *space,
3352                 __isl_take isl_val_list *list);
3353
3354 The zero multiple value (with value zero for each set dimension)
3355 can be created using the following function.
3356
3357         #include <isl/val.h>
3358         __isl_give isl_multi_val *isl_multi_val_zero(
3359                 __isl_take isl_space *space);
3360
3361 Multiple values can be copied and freed using
3362
3363         #include <isl/val.h>
3364         __isl_give isl_multi_val *isl_multi_val_copy(
3365                 __isl_keep isl_multi_val *mv);
3366         void *isl_multi_val_free(__isl_take isl_multi_val *mv);
3367
3368 They can be inspected using
3369
3370         #include <isl/val.h>
3371         isl_ctx *isl_multi_val_get_ctx(
3372                 __isl_keep isl_multi_val *mv);
3373         unsigned isl_multi_val_dim(__isl_keep isl_multi_val *mv,
3374                 enum isl_dim_type type);
3375         __isl_give isl_val *isl_multi_val_get_val(
3376                 __isl_keep isl_multi_val *mv, int pos);
3377         const char *isl_multi_val_get_tuple_name(
3378                 __isl_keep isl_multi_val *mv,
3379                 enum isl_dim_type type);
3380
3381 They can be modified using
3382
3383         #include <isl/val.h>
3384         __isl_give isl_multi_val *isl_multi_val_set_val(
3385                 __isl_take isl_multi_val *mv, int pos,
3386                 __isl_take isl_val *val);
3387         __isl_give isl_multi_val *isl_multi_val_set_dim_name(
3388                 __isl_take isl_multi_val *mv,
3389                 enum isl_dim_type type, unsigned pos, const char *s);
3390         __isl_give isl_multi_val *isl_multi_val_set_tuple_name(
3391                 __isl_take isl_multi_val *mv,
3392                 enum isl_dim_type type, const char *s);
3393         __isl_give isl_multi_val *isl_multi_val_set_tuple_id(
3394                 __isl_take isl_multi_val *mv,
3395                 enum isl_dim_type type, __isl_take isl_id *id);
3396
3397         __isl_give isl_multi_val *isl_multi_val_insert_dims(
3398                 __isl_take isl_multi_val *mv,
3399                 enum isl_dim_type type, unsigned first, unsigned n);
3400         __isl_give isl_multi_val *isl_multi_val_add_dims(
3401                 __isl_take isl_multi_val *mv,
3402                 enum isl_dim_type type, unsigned n);
3403         __isl_give isl_multi_val *isl_multi_val_drop_dims(
3404                 __isl_take isl_multi_val *mv,
3405                 enum isl_dim_type type, unsigned first, unsigned n);
3406
3407 Operations include
3408
3409         #include <isl/val.h>
3410         __isl_give isl_multi_val *isl_multi_val_align_params(
3411                 __isl_take isl_multi_val *mv,
3412                 __isl_take isl_space *model);
3413         __isl_give isl_multi_val *isl_multi_val_range_splice(
3414                 __isl_take isl_multi_val *mv1, unsigned pos,
3415                 __isl_take isl_multi_val *mv2);
3416         __isl_give isl_multi_val *isl_multi_val_range_product(
3417                 __isl_take isl_multi_val *mv1,
3418                 __isl_take isl_multi_val *mv2);
3419         __isl_give isl_multi_val *isl_multi_val_flat_range_product(
3420                 __isl_take isl_multi_val *mv1,
3421                 __isl_take isl_multi_aff *mv2);
3422         __isl_give isl_multi_val *isl_multi_val_add_val(
3423                 __isl_take isl_multi_val *mv,
3424                 __isl_take isl_val *v);
3425         __isl_give isl_multi_val *isl_multi_val_mod_val(
3426                 __isl_take isl_multi_val *mv,
3427                 __isl_take isl_val *v);
3428
3429 =head2 Vectors
3430
3431 Vectors can be created, copied and freed using the following functions.
3432
3433         #include <isl/vec.h>
3434         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
3435                 unsigned size);
3436         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
3437         void *isl_vec_free(__isl_take isl_vec *vec);
3438
3439 Note that the elements of a newly created vector may have arbitrary values.
3440 The elements can be changed and inspected using the following functions.
3441
3442         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
3443         int isl_vec_size(__isl_keep isl_vec *vec);
3444         int isl_vec_get_element(__isl_keep isl_vec *vec,
3445                 int pos, isl_int *v);
3446         __isl_give isl_val *isl_vec_get_element_val(
3447                 __isl_keep isl_vec *vec, int pos);
3448         __isl_give isl_vec *isl_vec_set_element(
3449                 __isl_take isl_vec *vec, int pos, isl_int v);
3450         __isl_give isl_vec *isl_vec_set_element_si(
3451                 __isl_take isl_vec *vec, int pos, int v);
3452         __isl_give isl_vec *isl_vec_set_element_val(
3453                 __isl_take isl_vec *vec, int pos,
3454                 __isl_take isl_val *v);
3455         __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec,
3456                 isl_int v);
3457         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
3458                 int v);
3459         __isl_give isl_vec *isl_vec_set_val(
3460                 __isl_take isl_vec *vec, __isl_take isl_val *v);
3461         __isl_give isl_vec *isl_vec_fdiv_r(__isl_take isl_vec *vec,
3462                 isl_int m);
3463
3464 C<isl_vec_get_element> will return a negative value if anything went wrong.
3465 In that case, the value of C<*v> is undefined.
3466
3467 The following function can be used to concatenate two vectors.
3468
3469         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
3470                 __isl_take isl_vec *vec2);
3471
3472 =head2 Matrices
3473
3474 Matrices can be created, copied and freed using the following functions.
3475
3476         #include <isl/mat.h>
3477         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
3478                 unsigned n_row, unsigned n_col);
3479         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
3480         void *isl_mat_free(__isl_take isl_mat *mat);
3481
3482 Note that the elements of a newly created matrix may have arbitrary values.
3483 The elements can be changed and inspected using the following functions.
3484
3485         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
3486         int isl_mat_rows(__isl_keep isl_mat *mat);
3487         int isl_mat_cols(__isl_keep isl_mat *mat);
3488         int isl_mat_get_element(__isl_keep isl_mat *mat,
3489                 int row, int col, isl_int *v);
3490         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
3491                 int row, int col, isl_int v);
3492         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
3493                 int row, int col, int v);
3494
3495 C<isl_mat_get_element> will return a negative value if anything went wrong.
3496 In that case, the value of C<*v> is undefined.
3497
3498 The following function can be used to compute the (right) inverse
3499 of a matrix, i.e., a matrix such that the product of the original
3500 and the inverse (in that order) is a multiple of the identity matrix.
3501 The input matrix is assumed to be of full row-rank.
3502
3503         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
3504
3505 The following function can be used to compute the (right) kernel
3506 (or null space) of a matrix, i.e., a matrix such that the product of
3507 the original and the kernel (in that order) is the zero matrix.
3508
3509         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
3510
3511 =head2 Piecewise Quasi Affine Expressions
3512
3513 The zero quasi affine expression or the quasi affine expression
3514 that is equal to a specified dimension on a given domain can be created using
3515
3516         __isl_give isl_aff *isl_aff_zero_on_domain(
3517                 __isl_take isl_local_space *ls);
3518         __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
3519                 __isl_take isl_local_space *ls);
3520         __isl_give isl_aff *isl_aff_var_on_domain(
3521                 __isl_take isl_local_space *ls,
3522                 enum isl_dim_type type, unsigned pos);
3523         __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
3524                 __isl_take isl_local_space *ls,
3525                 enum isl_dim_type type, unsigned pos);
3526
3527 Note that the space in which the resulting objects live is a map space
3528 with the given space as domain and a one-dimensional range.
3529
3530 An empty piecewise quasi affine expression (one with no cells)
3531 or a piecewise quasi affine expression with a single cell can
3532 be created using the following functions.
3533
3534         #include <isl/aff.h>
3535         __isl_give isl_pw_aff *isl_pw_aff_empty(
3536                 __isl_take isl_space *space);
3537         __isl_give isl_pw_aff *isl_pw_aff_alloc(
3538                 __isl_take isl_set *set, __isl_take isl_aff *aff);
3539         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
3540                 __isl_take isl_aff *aff);
3541
3542 A piecewise quasi affine expression that is equal to 1 on a set
3543 and 0 outside the set can be created using the following function.
3544
3545         #include <isl/aff.h>
3546         __isl_give isl_pw_aff *isl_set_indicator_function(
3547                 __isl_take isl_set *set);
3548
3549 Quasi affine expressions can be copied and freed using
3550
3551         #include <isl/aff.h>
3552         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
3553         void *isl_aff_free(__isl_take isl_aff *aff);
3554
3555         __isl_give isl_pw_aff *isl_pw_aff_copy(
3556                 __isl_keep isl_pw_aff *pwaff);
3557         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
3558
3559 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
3560 using the following function.  The constraint is required to have
3561 a non-zero coefficient for the specified dimension.
3562
3563         #include <isl/constraint.h>
3564         __isl_give isl_aff *isl_constraint_get_bound(
3565                 __isl_keep isl_constraint *constraint,
3566                 enum isl_dim_type type, int pos);
3567
3568 The entire affine expression of the constraint can also be extracted
3569 using the following function.
3570
3571         #include <isl/constraint.h>
3572         __isl_give isl_aff *isl_constraint_get_aff(
3573                 __isl_keep isl_constraint *constraint);
3574
3575 Conversely, an equality constraint equating
3576 the affine expression to zero or an inequality constraint enforcing
3577 the affine expression to be non-negative, can be constructed using
3578
3579         __isl_give isl_constraint *isl_equality_from_aff(
3580                 __isl_take isl_aff *aff);
3581         __isl_give isl_constraint *isl_inequality_from_aff(
3582                 __isl_take isl_aff *aff);
3583
3584 The expression can be inspected using
3585
3586         #include <isl/aff.h>
3587         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
3588         int isl_aff_dim(__isl_keep isl_aff *aff,
3589                 enum isl_dim_type type);
3590         __isl_give isl_local_space *isl_aff_get_domain_local_space(
3591                 __isl_keep isl_aff *aff);
3592         __isl_give isl_local_space *isl_aff_get_local_space(
3593                 __isl_keep isl_aff *aff);
3594         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3595                 enum isl_dim_type type, unsigned pos);
3596         const char *isl_pw_aff_get_dim_name(
3597                 __isl_keep isl_pw_aff *pa,
3598                 enum isl_dim_type type, unsigned pos);
3599         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3600                 enum isl_dim_type type, unsigned pos);
3601         __isl_give isl_id *isl_pw_aff_get_dim_id(
3602                 __isl_keep isl_pw_aff *pa,
3603                 enum isl_dim_type type, unsigned pos);
3604         __isl_give isl_id *isl_pw_aff_get_tuple_id(
3605                 __isl_keep isl_pw_aff *pa,
3606                 enum isl_dim_type type);
3607         int isl_aff_get_constant(__isl_keep isl_aff *aff,
3608                 isl_int *v);
3609         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
3610                 enum isl_dim_type type, int pos, isl_int *v);
3611         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
3612                 isl_int *v);
3613         __isl_give isl_aff *isl_aff_get_div(
3614                 __isl_keep isl_aff *aff, int pos);
3615
3616         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3617         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3618                 int (*fn)(__isl_take isl_set *set,
3619                           __isl_take isl_aff *aff,
3620                           void *user), void *user);
3621
3622         int isl_aff_is_cst(__isl_keep isl_aff *aff);
3623         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3624
3625         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3626                 enum isl_dim_type type, unsigned first, unsigned n);
3627         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3628                 enum isl_dim_type type, unsigned first, unsigned n);
3629
3630         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3631         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3632                 enum isl_dim_type type);
3633         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3634
3635 It can be modified using
3636
3637         #include <isl/aff.h>
3638         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3639                 __isl_take isl_pw_aff *pwaff,
3640                 enum isl_dim_type type, __isl_take isl_id *id);
3641         __isl_give isl_aff *isl_aff_set_dim_name(
3642                 __isl_take isl_aff *aff, enum isl_dim_type type,
3643                 unsigned pos, const char *s);
3644         __isl_give isl_aff *isl_aff_set_dim_id(
3645                 __isl_take isl_aff *aff, enum isl_dim_type type,
3646                 unsigned pos, __isl_take isl_id *id);
3647         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3648                 __isl_take isl_pw_aff *pma,
3649                 enum isl_dim_type type, unsigned pos,
3650                 __isl_take isl_id *id);
3651         __isl_give isl_aff *isl_aff_set_constant(
3652                 __isl_take isl_aff *aff, isl_int v);
3653         __isl_give isl_aff *isl_aff_set_constant_si(
3654                 __isl_take isl_aff *aff, int v);
3655         __isl_give isl_aff *isl_aff_set_coefficient(
3656                 __isl_take isl_aff *aff,
3657                 enum isl_dim_type type, int pos, isl_int v);
3658         __isl_give isl_aff *isl_aff_set_coefficient_si(
3659                 __isl_take isl_aff *aff,
3660                 enum isl_dim_type type, int pos, int v);
3661         __isl_give isl_aff *isl_aff_set_denominator(
3662                 __isl_take isl_aff *aff, isl_int v);
3663
3664         __isl_give isl_aff *isl_aff_add_constant(
3665                 __isl_take isl_aff *aff, isl_int v);
3666         __isl_give isl_aff *isl_aff_add_constant_si(
3667                 __isl_take isl_aff *aff, int v);
3668         __isl_give isl_aff *isl_aff_add_constant_num(
3669                 __isl_take isl_aff *aff, isl_int v);
3670         __isl_give isl_aff *isl_aff_add_constant_num_si(
3671                 __isl_take isl_aff *aff, int v);
3672         __isl_give isl_aff *isl_aff_add_coefficient(
3673                 __isl_take isl_aff *aff,
3674                 enum isl_dim_type type, int pos, isl_int v);
3675         __isl_give isl_aff *isl_aff_add_coefficient_si(
3676                 __isl_take isl_aff *aff,
3677                 enum isl_dim_type type, int pos, int v);
3678
3679         __isl_give isl_aff *isl_aff_insert_dims(
3680                 __isl_take isl_aff *aff,
3681                 enum isl_dim_type type, unsigned first, unsigned n);
3682         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3683                 __isl_take isl_pw_aff *pwaff,
3684                 enum isl_dim_type type, unsigned first, unsigned n);
3685         __isl_give isl_aff *isl_aff_add_dims(
3686                 __isl_take isl_aff *aff,
3687                 enum isl_dim_type type, unsigned n);
3688         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3689                 __isl_take isl_pw_aff *pwaff,
3690                 enum isl_dim_type type, unsigned n);
3691         __isl_give isl_aff *isl_aff_drop_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_drop_dims(
3695                 __isl_take isl_pw_aff *pwaff,
3696                 enum isl_dim_type type, unsigned first, unsigned n);
3697
3698 Note that the C<set_constant> and C<set_coefficient> functions
3699 set the I<numerator> of the constant or coefficient, while
3700 C<add_constant> and C<add_coefficient> add an integer value to
3701 the possibly rational constant or coefficient.
3702 The C<add_constant_num> functions add an integer value to
3703 the numerator.
3704
3705 To check whether an affine expressions is obviously zero
3706 or obviously equal to some other affine expression, use
3707
3708         #include <isl/aff.h>
3709         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3710         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3711                 __isl_keep isl_aff *aff2);
3712         int isl_pw_aff_plain_is_equal(
3713                 __isl_keep isl_pw_aff *pwaff1,
3714                 __isl_keep isl_pw_aff *pwaff2);
3715
3716 Operations include
3717
3718         #include <isl/aff.h>
3719         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
3720                 __isl_take isl_aff *aff2);
3721         __isl_give isl_pw_aff *isl_pw_aff_add(
3722                 __isl_take isl_pw_aff *pwaff1,
3723                 __isl_take isl_pw_aff *pwaff2);
3724         __isl_give isl_pw_aff *isl_pw_aff_min(
3725                 __isl_take isl_pw_aff *pwaff1,
3726                 __isl_take isl_pw_aff *pwaff2);
3727         __isl_give isl_pw_aff *isl_pw_aff_max(
3728                 __isl_take isl_pw_aff *pwaff1,
3729                 __isl_take isl_pw_aff *pwaff2);
3730         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
3731                 __isl_take isl_aff *aff2);
3732         __isl_give isl_pw_aff *isl_pw_aff_sub(
3733                 __isl_take isl_pw_aff *pwaff1,
3734                 __isl_take isl_pw_aff *pwaff2);
3735         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
3736         __isl_give isl_pw_aff *isl_pw_aff_neg(
3737                 __isl_take isl_pw_aff *pwaff);
3738         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
3739         __isl_give isl_pw_aff *isl_pw_aff_ceil(
3740                 __isl_take isl_pw_aff *pwaff);
3741         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
3742         __isl_give isl_pw_aff *isl_pw_aff_floor(
3743                 __isl_take isl_pw_aff *pwaff);
3744         __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
3745                 isl_int mod);
3746         __isl_give isl_pw_aff *isl_pw_aff_mod(
3747                 __isl_take isl_pw_aff *pwaff, isl_int mod);
3748         __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
3749                 isl_int f);
3750         __isl_give isl_pw_aff *isl_pw_aff_scale(
3751                 __isl_take isl_pw_aff *pwaff, isl_int f);
3752         __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
3753                 isl_int f);
3754         __isl_give isl_aff *isl_aff_scale_down_ui(
3755                 __isl_take isl_aff *aff, unsigned f);
3756         __isl_give isl_pw_aff *isl_pw_aff_scale_down(
3757                 __isl_take isl_pw_aff *pwaff, isl_int f);
3758
3759         __isl_give isl_pw_aff *isl_pw_aff_list_min(
3760                 __isl_take isl_pw_aff_list *list);
3761         __isl_give isl_pw_aff *isl_pw_aff_list_max(
3762                 __isl_take isl_pw_aff_list *list);
3763
3764         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
3765                 __isl_take isl_pw_aff *pwqp);
3766
3767         __isl_give isl_aff *isl_aff_align_params(
3768                 __isl_take isl_aff *aff,
3769                 __isl_take isl_space *model);
3770         __isl_give isl_pw_aff *isl_pw_aff_align_params(
3771                 __isl_take isl_pw_aff *pwaff,
3772                 __isl_take isl_space *model);
3773
3774         __isl_give isl_aff *isl_aff_project_domain_on_params(
3775                 __isl_take isl_aff *aff);
3776
3777         __isl_give isl_aff *isl_aff_gist_params(
3778                 __isl_take isl_aff *aff,
3779                 __isl_take isl_set *context);
3780         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
3781                 __isl_take isl_set *context);
3782         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
3783                 __isl_take isl_pw_aff *pwaff,
3784                 __isl_take isl_set *context);
3785         __isl_give isl_pw_aff *isl_pw_aff_gist(
3786                 __isl_take isl_pw_aff *pwaff,
3787                 __isl_take isl_set *context);
3788
3789         __isl_give isl_set *isl_pw_aff_domain(
3790                 __isl_take isl_pw_aff *pwaff);
3791         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
3792                 __isl_take isl_pw_aff *pa,
3793                 __isl_take isl_set *set);
3794         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
3795                 __isl_take isl_pw_aff *pa,
3796                 __isl_take isl_set *set);
3797
3798         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3799                 __isl_take isl_aff *aff2);
3800         __isl_give isl_aff *isl_aff_div(__isl_take isl_aff *aff1,
3801                 __isl_take isl_aff *aff2);
3802         __isl_give isl_pw_aff *isl_pw_aff_mul(
3803                 __isl_take isl_pw_aff *pwaff1,
3804                 __isl_take isl_pw_aff *pwaff2);
3805         __isl_give isl_pw_aff *isl_pw_aff_div(
3806                 __isl_take isl_pw_aff *pa1,
3807                 __isl_take isl_pw_aff *pa2);
3808         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
3809                 __isl_take isl_pw_aff *pa1,
3810                 __isl_take isl_pw_aff *pa2);
3811         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
3812                 __isl_take isl_pw_aff *pa1,
3813                 __isl_take isl_pw_aff *pa2);
3814
3815 When multiplying two affine expressions, at least one of the two needs
3816 to be a constant.  Similarly, when dividing an affine expression by another,
3817 the second expression needs to be a constant.
3818 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
3819 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
3820 remainder.
3821
3822         #include <isl/aff.h>
3823         __isl_give isl_aff *isl_aff_pullback_multi_aff(
3824                 __isl_take isl_aff *aff,
3825                 __isl_take isl_multi_aff *ma);
3826         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
3827                 __isl_take isl_pw_aff *pa,
3828                 __isl_take isl_multi_aff *ma);
3829         __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
3830                 __isl_take isl_pw_aff *pa,
3831                 __isl_take isl_pw_multi_aff *pma);
3832
3833 These functions precompose the input expression by the given
3834 C<isl_multi_aff> or C<isl_pw_multi_aff>.  In other words,
3835 the C<isl_multi_aff> or C<isl_pw_multi_aff> is plugged
3836 into the (piecewise) affine expression.
3837 Objects of type C<isl_multi_aff> are described in
3838 L</"Piecewise Multiple Quasi Affine Expressions">.
3839
3840         #include <isl/aff.h>
3841         __isl_give isl_basic_set *isl_aff_zero_basic_set(
3842                 __isl_take isl_aff *aff);
3843         __isl_give isl_basic_set *isl_aff_neg_basic_set(
3844                 __isl_take isl_aff *aff);
3845         __isl_give isl_basic_set *isl_aff_le_basic_set(
3846                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3847         __isl_give isl_basic_set *isl_aff_ge_basic_set(
3848                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3849         __isl_give isl_set *isl_pw_aff_eq_set(
3850                 __isl_take isl_pw_aff *pwaff1,
3851                 __isl_take isl_pw_aff *pwaff2);
3852         __isl_give isl_set *isl_pw_aff_ne_set(
3853                 __isl_take isl_pw_aff *pwaff1,
3854                 __isl_take isl_pw_aff *pwaff2);
3855         __isl_give isl_set *isl_pw_aff_le_set(
3856                 __isl_take isl_pw_aff *pwaff1,
3857                 __isl_take isl_pw_aff *pwaff2);
3858         __isl_give isl_set *isl_pw_aff_lt_set(
3859                 __isl_take isl_pw_aff *pwaff1,
3860                 __isl_take isl_pw_aff *pwaff2);
3861         __isl_give isl_set *isl_pw_aff_ge_set(
3862                 __isl_take isl_pw_aff *pwaff1,
3863                 __isl_take isl_pw_aff *pwaff2);
3864         __isl_give isl_set *isl_pw_aff_gt_set(
3865                 __isl_take isl_pw_aff *pwaff1,
3866                 __isl_take isl_pw_aff *pwaff2);
3867
3868         __isl_give isl_set *isl_pw_aff_list_eq_set(
3869                 __isl_take isl_pw_aff_list *list1,
3870                 __isl_take isl_pw_aff_list *list2);
3871         __isl_give isl_set *isl_pw_aff_list_ne_set(
3872                 __isl_take isl_pw_aff_list *list1,
3873                 __isl_take isl_pw_aff_list *list2);
3874         __isl_give isl_set *isl_pw_aff_list_le_set(
3875                 __isl_take isl_pw_aff_list *list1,
3876                 __isl_take isl_pw_aff_list *list2);
3877         __isl_give isl_set *isl_pw_aff_list_lt_set(
3878                 __isl_take isl_pw_aff_list *list1,
3879                 __isl_take isl_pw_aff_list *list2);
3880         __isl_give isl_set *isl_pw_aff_list_ge_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_gt_set(
3884                 __isl_take isl_pw_aff_list *list1,
3885                 __isl_take isl_pw_aff_list *list2);
3886
3887 The function C<isl_aff_neg_basic_set> returns a basic set
3888 containing those elements in the domain space
3889 of C<aff> where C<aff> is negative.
3890 The function C<isl_aff_ge_basic_set> returns a basic set
3891 containing those elements in the shared space
3892 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3893 The function C<isl_pw_aff_ge_set> returns a set
3894 containing those elements in the shared domain
3895 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3896 The functions operating on C<isl_pw_aff_list> apply the corresponding
3897 C<isl_pw_aff> function to each pair of elements in the two lists.
3898
3899         #include <isl/aff.h>
3900         __isl_give isl_set *isl_pw_aff_nonneg_set(
3901                 __isl_take isl_pw_aff *pwaff);
3902         __isl_give isl_set *isl_pw_aff_zero_set(
3903                 __isl_take isl_pw_aff *pwaff);
3904         __isl_give isl_set *isl_pw_aff_non_zero_set(
3905                 __isl_take isl_pw_aff *pwaff);
3906
3907 The function C<isl_pw_aff_nonneg_set> returns a set
3908 containing those elements in the domain
3909 of C<pwaff> where C<pwaff> is non-negative.
3910
3911         #include <isl/aff.h>
3912         __isl_give isl_pw_aff *isl_pw_aff_cond(
3913                 __isl_take isl_pw_aff *cond,
3914                 __isl_take isl_pw_aff *pwaff_true,
3915                 __isl_take isl_pw_aff *pwaff_false);
3916
3917 The function C<isl_pw_aff_cond> performs a conditional operator
3918 and returns an expression that is equal to C<pwaff_true>
3919 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
3920 where C<cond> is zero.
3921
3922         #include <isl/aff.h>
3923         __isl_give isl_pw_aff *isl_pw_aff_union_min(
3924                 __isl_take isl_pw_aff *pwaff1,
3925                 __isl_take isl_pw_aff *pwaff2);
3926         __isl_give isl_pw_aff *isl_pw_aff_union_max(
3927                 __isl_take isl_pw_aff *pwaff1,
3928                 __isl_take isl_pw_aff *pwaff2);
3929         __isl_give isl_pw_aff *isl_pw_aff_union_add(
3930                 __isl_take isl_pw_aff *pwaff1,
3931                 __isl_take isl_pw_aff *pwaff2);
3932
3933 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3934 expression with a domain that is the union of those of C<pwaff1> and
3935 C<pwaff2> and such that on each cell, the quasi-affine expression is
3936 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
3937 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
3938 associated expression is the defined one.
3939
3940 An expression can be read from input using
3941
3942         #include <isl/aff.h>
3943         __isl_give isl_aff *isl_aff_read_from_str(
3944                 isl_ctx *ctx, const char *str);
3945         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3946                 isl_ctx *ctx, const char *str);
3947
3948 An expression can be printed using
3949
3950         #include <isl/aff.h>
3951         __isl_give isl_printer *isl_printer_print_aff(
3952                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3953
3954         __isl_give isl_printer *isl_printer_print_pw_aff(
3955                 __isl_take isl_printer *p,
3956                 __isl_keep isl_pw_aff *pwaff);
3957
3958 =head2 Piecewise Multiple Quasi Affine Expressions
3959
3960 An C<isl_multi_aff> object represents a sequence of
3961 zero or more affine expressions, all defined on the same domain space.
3962 Similarly, an C<isl_multi_pw_aff> object represents a sequence of
3963 zero or more piecewise affine expressions.
3964
3965 An C<isl_multi_aff> can be constructed from a single
3966 C<isl_aff> or an C<isl_aff_list> using the
3967 following functions.  Similarly for C<isl_multi_pw_aff>.
3968
3969         #include <isl/aff.h>
3970         __isl_give isl_multi_aff *isl_multi_aff_from_aff(
3971                 __isl_take isl_aff *aff);
3972         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
3973                 __isl_take isl_pw_aff *pa);
3974         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
3975                 __isl_take isl_space *space,
3976                 __isl_take isl_aff_list *list);
3977
3978 An empty piecewise multiple quasi affine expression (one with no cells),
3979 the zero piecewise multiple quasi affine expression (with value zero
3980 for each output dimension),
3981 a piecewise multiple quasi affine expression with a single cell (with
3982 either a universe or a specified domain) or
3983 a zero-dimensional piecewise multiple quasi affine expression
3984 on a given domain
3985 can be created using the following functions.
3986
3987         #include <isl/aff.h>
3988         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
3989                 __isl_take isl_space *space);
3990         __isl_give isl_multi_aff *isl_multi_aff_zero(
3991                 __isl_take isl_space *space);
3992         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
3993                 __isl_take isl_space *space);
3994         __isl_give isl_multi_aff *isl_multi_aff_identity(
3995                 __isl_take isl_space *space);
3996         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
3997                 __isl_take isl_space *space);
3998         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
3999                 __isl_take isl_space *space);
4000         __isl_give isl_pw_multi_aff *
4001         isl_pw_multi_aff_from_multi_aff(
4002                 __isl_take isl_multi_aff *ma);
4003         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
4004                 __isl_take isl_set *set,
4005                 __isl_take isl_multi_aff *maff);
4006         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
4007                 __isl_take isl_set *set);
4008
4009         __isl_give isl_union_pw_multi_aff *
4010         isl_union_pw_multi_aff_empty(
4011                 __isl_take isl_space *space);
4012         __isl_give isl_union_pw_multi_aff *
4013         isl_union_pw_multi_aff_add_pw_multi_aff(
4014                 __isl_take isl_union_pw_multi_aff *upma,
4015                 __isl_take isl_pw_multi_aff *pma);
4016         __isl_give isl_union_pw_multi_aff *
4017         isl_union_pw_multi_aff_from_domain(
4018                 __isl_take isl_union_set *uset);
4019
4020 A piecewise multiple quasi affine expression can also be initialized
4021 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
4022 and the C<isl_map> is single-valued.
4023 In case of a conversion from an C<isl_union_set> or an C<isl_union_map>
4024 to an C<isl_union_pw_multi_aff>, these properties need to hold in each space.
4025
4026         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
4027                 __isl_take isl_set *set);
4028         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
4029                 __isl_take isl_map *map);
4030
4031         __isl_give isl_union_pw_multi_aff *
4032         isl_union_pw_multi_aff_from_union_set(
4033                 __isl_take isl_union_set *uset);
4034         __isl_give isl_union_pw_multi_aff *
4035         isl_union_pw_multi_aff_from_union_map(
4036                 __isl_take isl_union_map *umap);
4037
4038 Multiple quasi affine expressions can be copied and freed using
4039
4040         #include <isl/aff.h>
4041         __isl_give isl_multi_aff *isl_multi_aff_copy(
4042                 __isl_keep isl_multi_aff *maff);
4043         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
4044
4045         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
4046                 __isl_keep isl_pw_multi_aff *pma);
4047         void *isl_pw_multi_aff_free(
4048                 __isl_take isl_pw_multi_aff *pma);
4049
4050         __isl_give isl_union_pw_multi_aff *
4051         isl_union_pw_multi_aff_copy(
4052                 __isl_keep isl_union_pw_multi_aff *upma);
4053         void *isl_union_pw_multi_aff_free(
4054                 __isl_take isl_union_pw_multi_aff *upma);
4055
4056         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
4057                 __isl_keep isl_multi_pw_aff *mpa);
4058         void *isl_multi_pw_aff_free(
4059                 __isl_take isl_multi_pw_aff *mpa);
4060
4061 The expression can be inspected using
4062
4063         #include <isl/aff.h>
4064         isl_ctx *isl_multi_aff_get_ctx(
4065                 __isl_keep isl_multi_aff *maff);
4066         isl_ctx *isl_pw_multi_aff_get_ctx(
4067                 __isl_keep isl_pw_multi_aff *pma);
4068         isl_ctx *isl_union_pw_multi_aff_get_ctx(
4069                 __isl_keep isl_union_pw_multi_aff *upma);
4070         isl_ctx *isl_multi_pw_aff_get_ctx(
4071                 __isl_keep isl_multi_pw_aff *mpa);
4072         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
4073                 enum isl_dim_type type);
4074         unsigned isl_pw_multi_aff_dim(
4075                 __isl_keep isl_pw_multi_aff *pma,
4076                 enum isl_dim_type type);
4077         unsigned isl_multi_pw_aff_dim(
4078                 __isl_keep isl_multi_pw_aff *mpa,
4079                 enum isl_dim_type type);
4080         __isl_give isl_aff *isl_multi_aff_get_aff(
4081                 __isl_keep isl_multi_aff *multi, int pos);
4082         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
4083                 __isl_keep isl_pw_multi_aff *pma, int pos);
4084         __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
4085                 __isl_keep isl_multi_pw_aff *mpa, int pos);
4086         const char *isl_pw_multi_aff_get_dim_name(
4087                 __isl_keep isl_pw_multi_aff *pma,
4088                 enum isl_dim_type type, unsigned pos);
4089         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
4090                 __isl_keep isl_pw_multi_aff *pma,
4091                 enum isl_dim_type type, unsigned pos);
4092         const char *isl_multi_aff_get_tuple_name(
4093                 __isl_keep isl_multi_aff *multi,
4094                 enum isl_dim_type type);
4095         int isl_pw_multi_aff_has_tuple_name(
4096                 __isl_keep isl_pw_multi_aff *pma,
4097                 enum isl_dim_type type);
4098         const char *isl_pw_multi_aff_get_tuple_name(
4099                 __isl_keep isl_pw_multi_aff *pma,
4100                 enum isl_dim_type type);
4101         int isl_pw_multi_aff_has_tuple_id(
4102                 __isl_keep isl_pw_multi_aff *pma,
4103                 enum isl_dim_type type);
4104         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
4105                 __isl_keep isl_pw_multi_aff *pma,
4106                 enum isl_dim_type type);
4107
4108         int isl_pw_multi_aff_foreach_piece(
4109                 __isl_keep isl_pw_multi_aff *pma,
4110                 int (*fn)(__isl_take isl_set *set,
4111                             __isl_take isl_multi_aff *maff,
4112                             void *user), void *user);
4113
4114         int isl_union_pw_multi_aff_foreach_pw_multi_aff(
4115                 __isl_keep isl_union_pw_multi_aff *upma,
4116                 int (*fn)(__isl_take isl_pw_multi_aff *pma,
4117                             void *user), void *user);
4118
4119 It can be modified using
4120
4121         #include <isl/aff.h>
4122         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
4123                 __isl_take isl_multi_aff *multi, int pos,
4124                 __isl_take isl_aff *aff);
4125         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
4126                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
4127                 __isl_take isl_pw_aff *pa);
4128         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
4129                 __isl_take isl_multi_aff *maff,
4130                 enum isl_dim_type type, unsigned pos, const char *s);
4131         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
4132                 __isl_take isl_multi_aff *maff,
4133                 enum isl_dim_type type, const char *s);
4134         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
4135                 __isl_take isl_multi_aff *maff,
4136                 enum isl_dim_type type, __isl_take isl_id *id);
4137         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
4138                 __isl_take isl_pw_multi_aff *pma,
4139                 enum isl_dim_type type, __isl_take isl_id *id);
4140
4141         __isl_give isl_multi_pw_aff *
4142         isl_multi_pw_aff_set_dim_name(
4143                 __isl_take isl_multi_pw_aff *mpa,
4144                 enum isl_dim_type type, unsigned pos, const char *s);
4145         __isl_give isl_multi_pw_aff *
4146         isl_multi_pw_aff_set_tuple_name(
4147                 __isl_take isl_multi_pw_aff *mpa,
4148                 enum isl_dim_type type, const char *s);
4149
4150         __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
4151                 __isl_take isl_multi_aff *ma,
4152                 enum isl_dim_type type, unsigned first, unsigned n);
4153         __isl_give isl_multi_aff *isl_multi_aff_add_dims(
4154                 __isl_take isl_multi_aff *ma,
4155                 enum isl_dim_type type, unsigned n);
4156         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
4157                 __isl_take isl_multi_aff *maff,
4158                 enum isl_dim_type type, unsigned first, unsigned n);
4159         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
4160                 __isl_take isl_pw_multi_aff *pma,
4161                 enum isl_dim_type type, unsigned first, unsigned n);
4162
4163         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
4164                 __isl_take isl_multi_pw_aff *mpa,
4165                 enum isl_dim_type type, unsigned first, unsigned n);
4166         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
4167                 __isl_take isl_multi_pw_aff *mpa,
4168                 enum isl_dim_type type, unsigned n);
4169
4170 To check whether two multiple affine expressions are
4171 obviously equal to each other, use
4172
4173         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
4174                 __isl_keep isl_multi_aff *maff2);
4175         int isl_pw_multi_aff_plain_is_equal(
4176                 __isl_keep isl_pw_multi_aff *pma1,
4177                 __isl_keep isl_pw_multi_aff *pma2);
4178
4179 Operations include
4180
4181         #include <isl/aff.h>
4182         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
4183                 __isl_take isl_pw_multi_aff *pma1,
4184                 __isl_take isl_pw_multi_aff *pma2);
4185         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
4186                 __isl_take isl_pw_multi_aff *pma1,
4187                 __isl_take isl_pw_multi_aff *pma2);
4188         __isl_give isl_multi_aff *isl_multi_aff_add(
4189                 __isl_take isl_multi_aff *maff1,
4190                 __isl_take isl_multi_aff *maff2);
4191         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
4192                 __isl_take isl_pw_multi_aff *pma1,
4193                 __isl_take isl_pw_multi_aff *pma2);
4194         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
4195                 __isl_take isl_union_pw_multi_aff *upma1,
4196                 __isl_take isl_union_pw_multi_aff *upma2);
4197         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
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_sub(
4201                 __isl_take isl_multi_aff *ma1,
4202                 __isl_take isl_multi_aff *ma2);
4203         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
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_sub(
4207                 __isl_take isl_union_pw_multi_aff *upma1,
4208                 __isl_take isl_union_pw_multi_aff *upma2);
4209
4210 C<isl_multi_aff_sub> subtracts the second argument from the first.
4211
4212         __isl_give isl_multi_aff *isl_multi_aff_scale(
4213                 __isl_take isl_multi_aff *maff,
4214                 isl_int f);
4215         __isl_give isl_multi_aff *isl_multi_aff_scale_vec(
4216                 __isl_take isl_multi_aff *ma,
4217                 __isl_take isl_vec *v);
4218         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_vec(
4219                 __isl_take isl_pw_multi_aff *pma,
4220                 __isl_take isl_vec *v);
4221         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_scale_vec(
4222                 __isl_take isl_union_pw_multi_aff *upma,
4223                 __isl_take isl_vec *v);
4224
4225 C<isl_multi_aff_scale_vec> scales the first elements of C<ma>
4226 by the corresponding elements of C<v>.
4227
4228         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
4229                 __isl_take isl_pw_multi_aff *pma,
4230                 __isl_take isl_set *set);
4231         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
4232                 __isl_take isl_pw_multi_aff *pma,
4233                 __isl_take isl_set *set);
4234         __isl_give isl_union_pw_multi_aff *
4235         isl_union_pw_multi_aff_intersect_domain(
4236                 __isl_take isl_union_pw_multi_aff *upma,
4237                 __isl_take isl_union_set *uset);
4238         __isl_give isl_multi_aff *isl_multi_aff_lift(
4239                 __isl_take isl_multi_aff *maff,
4240                 __isl_give isl_local_space **ls);
4241         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
4242                 __isl_take isl_pw_multi_aff *pma);
4243         __isl_give isl_multi_aff *isl_multi_aff_align_params(
4244                 __isl_take isl_multi_aff *multi,
4245                 __isl_take isl_space *model);
4246         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
4247                 __isl_take isl_pw_multi_aff *pma,
4248                 __isl_take isl_space *model);
4249         __isl_give isl_pw_multi_aff *
4250         isl_pw_multi_aff_project_domain_on_params(
4251                 __isl_take isl_pw_multi_aff *pma);
4252         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
4253                 __isl_take isl_multi_aff *maff,
4254                 __isl_take isl_set *context);
4255         __isl_give isl_multi_aff *isl_multi_aff_gist(
4256                 __isl_take isl_multi_aff *maff,
4257                 __isl_take isl_set *context);
4258         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
4259                 __isl_take isl_pw_multi_aff *pma,
4260                 __isl_take isl_set *set);
4261         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
4262                 __isl_take isl_pw_multi_aff *pma,
4263                 __isl_take isl_set *set);
4264         __isl_give isl_set *isl_pw_multi_aff_domain(
4265                 __isl_take isl_pw_multi_aff *pma);
4266         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
4267                 __isl_take isl_union_pw_multi_aff *upma);
4268         __isl_give isl_multi_aff *isl_multi_aff_range_splice(
4269                 __isl_take isl_multi_aff *ma1, unsigned pos,
4270                 __isl_take isl_multi_aff *ma2);
4271         __isl_give isl_multi_aff *isl_multi_aff_splice(
4272                 __isl_take isl_multi_aff *ma1,
4273                 unsigned in_pos, unsigned out_pos,
4274                 __isl_take isl_multi_aff *ma2);
4275         __isl_give isl_multi_aff *isl_multi_aff_range_product(
4276                 __isl_take isl_multi_aff *ma1,
4277                 __isl_take isl_multi_aff *ma2);
4278         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
4279                 __isl_take isl_multi_aff *ma1,
4280                 __isl_take isl_multi_aff *ma2);
4281         __isl_give isl_multi_aff *isl_multi_aff_product(
4282                 __isl_take isl_multi_aff *ma1,
4283                 __isl_take isl_multi_aff *ma2);
4284         __isl_give isl_pw_multi_aff *
4285         isl_pw_multi_aff_range_product(
4286                 __isl_take isl_pw_multi_aff *pma1,
4287                 __isl_take isl_pw_multi_aff *pma2);
4288         __isl_give isl_pw_multi_aff *
4289         isl_pw_multi_aff_flat_range_product(
4290                 __isl_take isl_pw_multi_aff *pma1,
4291                 __isl_take isl_pw_multi_aff *pma2);
4292         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
4293                 __isl_take isl_pw_multi_aff *pma1,
4294                 __isl_take isl_pw_multi_aff *pma2);
4295         __isl_give isl_union_pw_multi_aff *
4296         isl_union_pw_multi_aff_flat_range_product(
4297                 __isl_take isl_union_pw_multi_aff *upma1,
4298                 __isl_take isl_union_pw_multi_aff *upma2);
4299         __isl_give isl_multi_pw_aff *
4300         isl_multi_pw_aff_range_splice(
4301                 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
4302                 __isl_take isl_multi_pw_aff *mpa2);
4303         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
4304                 __isl_take isl_multi_pw_aff *mpa1,
4305                 unsigned in_pos, unsigned out_pos,
4306                 __isl_take isl_multi_pw_aff *mpa2);
4307         __isl_give isl_multi_pw_aff *
4308         isl_multi_pw_aff_range_product(
4309                 __isl_take isl_multi_pw_aff *mpa1,
4310                 __isl_take isl_multi_pw_aff *mpa2);
4311         __isl_give isl_multi_pw_aff *
4312         isl_multi_pw_aff_flat_range_product(
4313                 __isl_take isl_multi_pw_aff *mpa1,
4314                 __isl_take isl_multi_pw_aff *mpa2);
4315
4316 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
4317 then it is assigned the local space that lies at the basis of
4318 the lifting applied.
4319
4320         #include <isl/aff.h>
4321         __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
4322                 __isl_take isl_multi_aff *ma1,
4323                 __isl_take isl_multi_aff *ma2);
4324         __isl_give isl_pw_multi_aff *
4325         isl_pw_multi_aff_pullback_multi_aff(
4326                 __isl_take isl_pw_multi_aff *pma,
4327                 __isl_take isl_multi_aff *ma);
4328         __isl_give isl_pw_multi_aff *
4329         isl_pw_multi_aff_pullback_pw_multi_aff(
4330                 __isl_take isl_pw_multi_aff *pma1,
4331                 __isl_take isl_pw_multi_aff *pma2);
4332
4333 The function C<isl_multi_aff_pullback_multi_aff> precomposes C<ma1> by C<ma2>.
4334 In other words, C<ma2> is plugged
4335 into C<ma1>.
4336
4337         __isl_give isl_set *isl_multi_aff_lex_le_set(
4338                 __isl_take isl_multi_aff *ma1,
4339                 __isl_take isl_multi_aff *ma2);
4340         __isl_give isl_set *isl_multi_aff_lex_ge_set(
4341                 __isl_take isl_multi_aff *ma1,
4342                 __isl_take isl_multi_aff *ma2);
4343
4344 The function C<isl_multi_aff_lex_le_set> returns a set
4345 containing those elements in the shared domain space
4346 where C<ma1> is lexicographically smaller than or
4347 equal to C<ma2>.
4348
4349 An expression can be read from input using
4350
4351         #include <isl/aff.h>
4352         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
4353                 isl_ctx *ctx, const char *str);
4354         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
4355                 isl_ctx *ctx, const char *str);
4356         __isl_give isl_union_pw_multi_aff *
4357         isl_union_pw_multi_aff_read_from_str(
4358                 isl_ctx *ctx, const char *str);
4359
4360 An expression can be printed using
4361
4362         #include <isl/aff.h>
4363         __isl_give isl_printer *isl_printer_print_multi_aff(
4364                 __isl_take isl_printer *p,
4365                 __isl_keep isl_multi_aff *maff);
4366         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
4367                 __isl_take isl_printer *p,
4368                 __isl_keep isl_pw_multi_aff *pma);
4369         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
4370                 __isl_take isl_printer *p,
4371                 __isl_keep isl_union_pw_multi_aff *upma);
4372         __isl_give isl_printer *isl_printer_print_multi_pw_aff(
4373                 __isl_take isl_printer *p,
4374                 __isl_keep isl_multi_pw_aff *mpa);
4375
4376 =head2 Points
4377
4378 Points are elements of a set.  They can be used to construct
4379 simple sets (boxes) or they can be used to represent the
4380 individual elements of a set.
4381 The zero point (the origin) can be created using
4382
4383         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
4384
4385 The coordinates of a point can be inspected, set and changed
4386 using
4387
4388         int isl_point_get_coordinate(__isl_keep isl_point *pnt,
4389                 enum isl_dim_type type, int pos, isl_int *v);
4390         __isl_give isl_point *isl_point_set_coordinate(
4391                 __isl_take isl_point *pnt,
4392                 enum isl_dim_type type, int pos, isl_int v);
4393
4394         __isl_give isl_point *isl_point_add_ui(
4395                 __isl_take isl_point *pnt,
4396                 enum isl_dim_type type, int pos, unsigned val);
4397         __isl_give isl_point *isl_point_sub_ui(
4398                 __isl_take isl_point *pnt,
4399                 enum isl_dim_type type, int pos, unsigned val);
4400
4401 Other properties can be obtained using
4402
4403         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
4404
4405 Points can be copied or freed using
4406
4407         __isl_give isl_point *isl_point_copy(
4408                 __isl_keep isl_point *pnt);
4409         void isl_point_free(__isl_take isl_point *pnt);
4410
4411 A singleton set can be created from a point using
4412
4413         __isl_give isl_basic_set *isl_basic_set_from_point(
4414                 __isl_take isl_point *pnt);
4415         __isl_give isl_set *isl_set_from_point(
4416                 __isl_take isl_point *pnt);
4417
4418 and a box can be created from two opposite extremal points using
4419
4420         __isl_give isl_basic_set *isl_basic_set_box_from_points(
4421                 __isl_take isl_point *pnt1,
4422                 __isl_take isl_point *pnt2);
4423         __isl_give isl_set *isl_set_box_from_points(
4424                 __isl_take isl_point *pnt1,
4425                 __isl_take isl_point *pnt2);
4426
4427 All elements of a B<bounded> (union) set can be enumerated using
4428 the following functions.
4429
4430         int isl_set_foreach_point(__isl_keep isl_set *set,
4431                 int (*fn)(__isl_take isl_point *pnt, void *user),
4432                 void *user);
4433         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
4434                 int (*fn)(__isl_take isl_point *pnt, void *user),
4435                 void *user);
4436
4437 The function C<fn> is called for each integer point in
4438 C<set> with as second argument the last argument of
4439 the C<isl_set_foreach_point> call.  The function C<fn>
4440 should return C<0> on success and C<-1> on failure.
4441 In the latter case, C<isl_set_foreach_point> will stop
4442 enumerating and return C<-1> as well.
4443 If the enumeration is performed successfully and to completion,
4444 then C<isl_set_foreach_point> returns C<0>.
4445
4446 To obtain a single point of a (basic) set, use
4447
4448         __isl_give isl_point *isl_basic_set_sample_point(
4449                 __isl_take isl_basic_set *bset);
4450         __isl_give isl_point *isl_set_sample_point(
4451                 __isl_take isl_set *set);
4452
4453 If C<set> does not contain any (integer) points, then the
4454 resulting point will be ``void'', a property that can be
4455 tested using
4456
4457         int isl_point_is_void(__isl_keep isl_point *pnt);
4458
4459 =head2 Piecewise Quasipolynomials
4460
4461 A piecewise quasipolynomial is a particular kind of function that maps
4462 a parametric point to a rational value.
4463 More specifically, a quasipolynomial is a polynomial expression in greatest
4464 integer parts of affine expressions of parameters and variables.
4465 A piecewise quasipolynomial is a subdivision of a given parametric
4466 domain into disjoint cells with a quasipolynomial associated to
4467 each cell.  The value of the piecewise quasipolynomial at a given
4468 point is the value of the quasipolynomial associated to the cell
4469 that contains the point.  Outside of the union of cells,
4470 the value is assumed to be zero.
4471 For example, the piecewise quasipolynomial
4472
4473         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
4474
4475 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
4476 A given piecewise quasipolynomial has a fixed domain dimension.
4477 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
4478 defined over different domains.
4479 Piecewise quasipolynomials are mainly used by the C<barvinok>
4480 library for representing the number of elements in a parametric set or map.
4481 For example, the piecewise quasipolynomial above represents
4482 the number of points in the map
4483
4484         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
4485
4486 =head3 Input and Output
4487
4488 Piecewise quasipolynomials can be read from input using
4489
4490         __isl_give isl_union_pw_qpolynomial *
4491         isl_union_pw_qpolynomial_read_from_str(
4492                 isl_ctx *ctx, const char *str);
4493
4494 Quasipolynomials and piecewise quasipolynomials can be printed
4495 using the following functions.
4496
4497         __isl_give isl_printer *isl_printer_print_qpolynomial(
4498                 __isl_take isl_printer *p,
4499                 __isl_keep isl_qpolynomial *qp);
4500
4501         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
4502                 __isl_take isl_printer *p,
4503                 __isl_keep isl_pw_qpolynomial *pwqp);
4504
4505         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
4506                 __isl_take isl_printer *p,
4507                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4508
4509 The output format of the printer
4510 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4511 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
4512 is supported.
4513 In case of printing in C<ISL_FORMAT_C>, the user may want
4514 to set the names of all dimensions
4515
4516         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
4517                 __isl_take isl_qpolynomial *qp,
4518                 enum isl_dim_type type, unsigned pos,
4519                 const char *s);
4520         __isl_give isl_pw_qpolynomial *
4521         isl_pw_qpolynomial_set_dim_name(
4522                 __isl_take isl_pw_qpolynomial *pwqp,
4523                 enum isl_dim_type type, unsigned pos,
4524                 const char *s);
4525
4526 =head3 Creating New (Piecewise) Quasipolynomials
4527
4528 Some simple quasipolynomials can be created using the following functions.
4529 More complicated quasipolynomials can be created by applying
4530 operations such as addition and multiplication
4531 on the resulting quasipolynomials
4532
4533         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
4534                 __isl_take isl_space *domain);
4535         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
4536                 __isl_take isl_space *domain);
4537         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
4538                 __isl_take isl_space *domain);
4539         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
4540                 __isl_take isl_space *domain);
4541         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
4542                 __isl_take isl_space *domain);
4543         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
4544                 __isl_take isl_space *domain,
4545                 const isl_int n, const isl_int d);
4546         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
4547                 __isl_take isl_space *domain,
4548                 enum isl_dim_type type, unsigned pos);
4549         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
4550                 __isl_take isl_aff *aff);
4551
4552 Note that the space in which a quasipolynomial lives is a map space
4553 with a one-dimensional range.  The C<domain> argument in some of
4554 the functions above corresponds to the domain of this map space.
4555
4556 The zero piecewise quasipolynomial or a piecewise quasipolynomial
4557 with a single cell can be created using the following functions.
4558 Multiple of these single cell piecewise quasipolynomials can
4559 be combined to create more complicated piecewise quasipolynomials.
4560
4561         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
4562                 __isl_take isl_space *space);
4563         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
4564                 __isl_take isl_set *set,
4565                 __isl_take isl_qpolynomial *qp);
4566         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
4567                 __isl_take isl_qpolynomial *qp);
4568         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
4569                 __isl_take isl_pw_aff *pwaff);
4570
4571         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
4572                 __isl_take isl_space *space);
4573         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
4574                 __isl_take isl_pw_qpolynomial *pwqp);
4575         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
4576                 __isl_take isl_union_pw_qpolynomial *upwqp,
4577                 __isl_take isl_pw_qpolynomial *pwqp);
4578
4579 Quasipolynomials can be copied and freed again using the following
4580 functions.
4581
4582         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
4583                 __isl_keep isl_qpolynomial *qp);
4584         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
4585
4586         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
4587                 __isl_keep isl_pw_qpolynomial *pwqp);
4588         void *isl_pw_qpolynomial_free(
4589                 __isl_take isl_pw_qpolynomial *pwqp);
4590
4591         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
4592                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4593         void *isl_union_pw_qpolynomial_free(
4594                 __isl_take isl_union_pw_qpolynomial *upwqp);
4595
4596 =head3 Inspecting (Piecewise) Quasipolynomials
4597
4598 To iterate over all piecewise quasipolynomials in a union
4599 piecewise quasipolynomial, use the following function
4600
4601         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
4602                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4603                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
4604                 void *user);
4605
4606 To extract the piecewise quasipolynomial in a given space from a union, use
4607
4608         __isl_give isl_pw_qpolynomial *
4609         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
4610                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4611                 __isl_take isl_space *space);
4612
4613 To iterate over the cells in a piecewise quasipolynomial,
4614 use either of the following two functions
4615
4616         int isl_pw_qpolynomial_foreach_piece(
4617                 __isl_keep isl_pw_qpolynomial *pwqp,
4618                 int (*fn)(__isl_take isl_set *set,
4619                           __isl_take isl_qpolynomial *qp,
4620                           void *user), void *user);
4621         int isl_pw_qpolynomial_foreach_lifted_piece(
4622                 __isl_keep isl_pw_qpolynomial *pwqp,
4623                 int (*fn)(__isl_take isl_set *set,
4624                           __isl_take isl_qpolynomial *qp,
4625                           void *user), void *user);
4626
4627 As usual, the function C<fn> should return C<0> on success
4628 and C<-1> on failure.  The difference between
4629 C<isl_pw_qpolynomial_foreach_piece> and
4630 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
4631 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
4632 compute unique representations for all existentially quantified
4633 variables and then turn these existentially quantified variables
4634 into extra set variables, adapting the associated quasipolynomial
4635 accordingly.  This means that the C<set> passed to C<fn>
4636 will not have any existentially quantified variables, but that
4637 the dimensions of the sets may be different for different
4638 invocations of C<fn>.
4639
4640 To iterate over all terms in a quasipolynomial,
4641 use
4642
4643         int isl_qpolynomial_foreach_term(
4644                 __isl_keep isl_qpolynomial *qp,
4645                 int (*fn)(__isl_take isl_term *term,
4646                           void *user), void *user);
4647
4648 The terms themselves can be inspected and freed using
4649 these functions
4650
4651         unsigned isl_term_dim(__isl_keep isl_term *term,
4652                 enum isl_dim_type type);
4653         void isl_term_get_num(__isl_keep isl_term *term,
4654                 isl_int *n);
4655         void isl_term_get_den(__isl_keep isl_term *term,
4656                 isl_int *d);
4657         int isl_term_get_exp(__isl_keep isl_term *term,
4658                 enum isl_dim_type type, unsigned pos);
4659         __isl_give isl_aff *isl_term_get_div(
4660                 __isl_keep isl_term *term, unsigned pos);
4661         void isl_term_free(__isl_take isl_term *term);
4662
4663 Each term is a product of parameters, set variables and
4664 integer divisions.  The function C<isl_term_get_exp>
4665 returns the exponent of a given dimensions in the given term.
4666 The C<isl_int>s in the arguments of C<isl_term_get_num>
4667 and C<isl_term_get_den> need to have been initialized
4668 using C<isl_int_init> before calling these functions.
4669
4670 =head3 Properties of (Piecewise) Quasipolynomials
4671
4672 To check whether a quasipolynomial is actually a constant,
4673 use the following function.
4674
4675         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
4676                 isl_int *n, isl_int *d);
4677
4678 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
4679 then the numerator and denominator of the constant
4680 are returned in C<*n> and C<*d>, respectively.
4681
4682 To check whether two union piecewise quasipolynomials are
4683 obviously equal, use
4684
4685         int isl_union_pw_qpolynomial_plain_is_equal(
4686                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
4687                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
4688
4689 =head3 Operations on (Piecewise) Quasipolynomials
4690
4691         __isl_give isl_qpolynomial *isl_qpolynomial_scale(
4692                 __isl_take isl_qpolynomial *qp, isl_int v);
4693         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
4694                 __isl_take isl_qpolynomial *qp);
4695         __isl_give isl_qpolynomial *isl_qpolynomial_add(
4696                 __isl_take isl_qpolynomial *qp1,
4697                 __isl_take isl_qpolynomial *qp2);
4698         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
4699                 __isl_take isl_qpolynomial *qp1,
4700                 __isl_take isl_qpolynomial *qp2);
4701         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
4702                 __isl_take isl_qpolynomial *qp1,
4703                 __isl_take isl_qpolynomial *qp2);
4704         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
4705                 __isl_take isl_qpolynomial *qp, unsigned exponent);
4706
4707         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
4708                 __isl_take isl_pw_qpolynomial *pwqp1,
4709                 __isl_take isl_pw_qpolynomial *pwqp2);
4710         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
4711                 __isl_take isl_pw_qpolynomial *pwqp1,
4712                 __isl_take isl_pw_qpolynomial *pwqp2);
4713         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
4714                 __isl_take isl_pw_qpolynomial *pwqp1,
4715                 __isl_take isl_pw_qpolynomial *pwqp2);
4716         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
4717                 __isl_take isl_pw_qpolynomial *pwqp);
4718         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
4719                 __isl_take isl_pw_qpolynomial *pwqp1,
4720                 __isl_take isl_pw_qpolynomial *pwqp2);
4721         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
4722                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
4723
4724         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
4725                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4726                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4727         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
4728                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4729                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4730         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
4731                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4732                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4733
4734         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
4735                 __isl_take isl_pw_qpolynomial *pwqp,
4736                 __isl_take isl_point *pnt);
4737
4738         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
4739                 __isl_take isl_union_pw_qpolynomial *upwqp,
4740                 __isl_take isl_point *pnt);
4741
4742         __isl_give isl_set *isl_pw_qpolynomial_domain(
4743                 __isl_take isl_pw_qpolynomial *pwqp);
4744         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
4745                 __isl_take isl_pw_qpolynomial *pwpq,
4746                 __isl_take isl_set *set);
4747         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
4748                 __isl_take isl_pw_qpolynomial *pwpq,
4749                 __isl_take isl_set *set);
4750
4751         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4752                 __isl_take isl_union_pw_qpolynomial *upwqp);
4753         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
4754                 __isl_take isl_union_pw_qpolynomial *upwpq,
4755                 __isl_take isl_union_set *uset);
4756         __isl_give isl_union_pw_qpolynomial *
4757         isl_union_pw_qpolynomial_intersect_params(
4758                 __isl_take isl_union_pw_qpolynomial *upwpq,
4759                 __isl_take isl_set *set);
4760
4761         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
4762                 __isl_take isl_qpolynomial *qp,
4763                 __isl_take isl_space *model);
4764
4765         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
4766                 __isl_take isl_qpolynomial *qp);
4767         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
4768                 __isl_take isl_pw_qpolynomial *pwqp);
4769
4770         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
4771                 __isl_take isl_union_pw_qpolynomial *upwqp);
4772
4773         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
4774                 __isl_take isl_qpolynomial *qp,
4775                 __isl_take isl_set *context);
4776         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
4777                 __isl_take isl_qpolynomial *qp,
4778                 __isl_take isl_set *context);
4779
4780         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
4781                 __isl_take isl_pw_qpolynomial *pwqp,
4782                 __isl_take isl_set *context);
4783         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
4784                 __isl_take isl_pw_qpolynomial *pwqp,
4785                 __isl_take isl_set *context);
4786
4787         __isl_give isl_union_pw_qpolynomial *
4788         isl_union_pw_qpolynomial_gist_params(
4789                 __isl_take isl_union_pw_qpolynomial *upwqp,
4790                 __isl_take isl_set *context);
4791         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
4792                 __isl_take isl_union_pw_qpolynomial *upwqp,
4793                 __isl_take isl_union_set *context);
4794
4795 The gist operation applies the gist operation to each of
4796 the cells in the domain of the input piecewise quasipolynomial.
4797 The context is also exploited
4798 to simplify the quasipolynomials associated to each cell.
4799
4800         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4801                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4802         __isl_give isl_union_pw_qpolynomial *
4803         isl_union_pw_qpolynomial_to_polynomial(
4804                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4805
4806 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
4807 the polynomial will be an overapproximation.  If C<sign> is negative,
4808 it will be an underapproximation.  If C<sign> is zero, the approximation
4809 will lie somewhere in between.
4810
4811 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
4812
4813 A piecewise quasipolynomial reduction is a piecewise
4814 reduction (or fold) of quasipolynomials.
4815 In particular, the reduction can be maximum or a minimum.
4816 The objects are mainly used to represent the result of
4817 an upper or lower bound on a quasipolynomial over its domain,
4818 i.e., as the result of the following function.
4819
4820         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
4821                 __isl_take isl_pw_qpolynomial *pwqp,
4822                 enum isl_fold type, int *tight);
4823
4824         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
4825                 __isl_take isl_union_pw_qpolynomial *upwqp,
4826                 enum isl_fold type, int *tight);
4827
4828 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
4829 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
4830 is the returned bound is known be tight, i.e., for each value
4831 of the parameters there is at least
4832 one element in the domain that reaches the bound.
4833 If the domain of C<pwqp> is not wrapping, then the bound is computed
4834 over all elements in that domain and the result has a purely parametric
4835 domain.  If the domain of C<pwqp> is wrapping, then the bound is
4836 computed over the range of the wrapped relation.  The domain of the
4837 wrapped relation becomes the domain of the result.
4838
4839 A (piecewise) quasipolynomial reduction can be copied or freed using the
4840 following functions.
4841
4842         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
4843                 __isl_keep isl_qpolynomial_fold *fold);
4844         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
4845                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4846         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
4847                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4848         void isl_qpolynomial_fold_free(
4849                 __isl_take isl_qpolynomial_fold *fold);
4850         void *isl_pw_qpolynomial_fold_free(
4851                 __isl_take isl_pw_qpolynomial_fold *pwf);
4852         void *isl_union_pw_qpolynomial_fold_free(
4853                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4854
4855 =head3 Printing Piecewise Quasipolynomial Reductions
4856
4857 Piecewise quasipolynomial reductions can be printed
4858 using the following function.
4859
4860         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
4861                 __isl_take isl_printer *p,
4862                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4863         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
4864                 __isl_take isl_printer *p,
4865                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4866
4867 For C<isl_printer_print_pw_qpolynomial_fold>,
4868 output format of the printer
4869 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4870 For C<isl_printer_print_union_pw_qpolynomial_fold>,
4871 output format of the printer
4872 needs to be set to C<ISL_FORMAT_ISL>.
4873 In case of printing in C<ISL_FORMAT_C>, the user may want
4874 to set the names of all dimensions
4875
4876         __isl_give isl_pw_qpolynomial_fold *
4877         isl_pw_qpolynomial_fold_set_dim_name(
4878                 __isl_take isl_pw_qpolynomial_fold *pwf,
4879                 enum isl_dim_type type, unsigned pos,
4880                 const char *s);
4881
4882 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
4883
4884 To iterate over all piecewise quasipolynomial reductions in a union
4885 piecewise quasipolynomial reduction, use the following function
4886
4887         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
4888                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
4889                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
4890                             void *user), void *user);
4891
4892 To iterate over the cells in a piecewise quasipolynomial reduction,
4893 use either of the following two functions
4894
4895         int isl_pw_qpolynomial_fold_foreach_piece(
4896                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4897                 int (*fn)(__isl_take isl_set *set,
4898                           __isl_take isl_qpolynomial_fold *fold,
4899                           void *user), void *user);
4900         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
4901                 __isl_keep isl_pw_qpolynomial_fold *pwf,
4902                 int (*fn)(__isl_take isl_set *set,
4903                           __isl_take isl_qpolynomial_fold *fold,
4904                           void *user), void *user);
4905
4906 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
4907 of the difference between these two functions.
4908
4909 To iterate over all quasipolynomials in a reduction, use
4910
4911         int isl_qpolynomial_fold_foreach_qpolynomial(
4912                 __isl_keep isl_qpolynomial_fold *fold,
4913                 int (*fn)(__isl_take isl_qpolynomial *qp,
4914                           void *user), void *user);
4915
4916 =head3 Properties of Piecewise Quasipolynomial Reductions
4917
4918 To check whether two union piecewise quasipolynomial reductions are
4919 obviously equal, use
4920
4921         int isl_union_pw_qpolynomial_fold_plain_is_equal(
4922                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
4923                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
4924
4925 =head3 Operations on Piecewise Quasipolynomial Reductions
4926
4927         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
4928                 __isl_take isl_qpolynomial_fold *fold, isl_int v);
4929
4930         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
4931                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4932                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4933
4934         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
4935                 __isl_take isl_pw_qpolynomial_fold *pwf1,
4936                 __isl_take isl_pw_qpolynomial_fold *pwf2);
4937
4938         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
4939                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
4940                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
4941
4942         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
4943                 __isl_take isl_pw_qpolynomial_fold *pwf,
4944                 __isl_take isl_point *pnt);
4945
4946         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
4947                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4948                 __isl_take isl_point *pnt);
4949
4950         __isl_give isl_pw_qpolynomial_fold *
4951         isl_pw_qpolynomial_fold_intersect_params(
4952                 __isl_take isl_pw_qpolynomial_fold *pwf,
4953                 __isl_take isl_set *set);
4954
4955         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
4956                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4957         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
4958                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4959                 __isl_take isl_union_set *uset);
4960         __isl_give isl_union_pw_qpolynomial_fold *
4961         isl_union_pw_qpolynomial_fold_intersect_params(
4962                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4963                 __isl_take isl_set *set);
4964
4965         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
4966                 __isl_take isl_pw_qpolynomial_fold *pwf);
4967
4968         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
4969                 __isl_take isl_pw_qpolynomial_fold *pwf);
4970
4971         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
4972                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4973
4974         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
4975                 __isl_take isl_qpolynomial_fold *fold,
4976                 __isl_take isl_set *context);
4977         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
4978                 __isl_take isl_qpolynomial_fold *fold,
4979                 __isl_take isl_set *context);
4980
4981         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
4982                 __isl_take isl_pw_qpolynomial_fold *pwf,
4983                 __isl_take isl_set *context);
4984         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
4985                 __isl_take isl_pw_qpolynomial_fold *pwf,
4986                 __isl_take isl_set *context);
4987
4988         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
4989                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4990                 __isl_take isl_union_set *context);
4991         __isl_give isl_union_pw_qpolynomial_fold *
4992         isl_union_pw_qpolynomial_fold_gist_params(
4993                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4994                 __isl_take isl_set *context);
4995
4996 The gist operation applies the gist operation to each of
4997 the cells in the domain of the input piecewise quasipolynomial reduction.
4998 In future, the operation will also exploit the context
4999 to simplify the quasipolynomial reductions associated to each cell.
5000
5001         __isl_give isl_pw_qpolynomial_fold *
5002         isl_set_apply_pw_qpolynomial_fold(
5003                 __isl_take isl_set *set,
5004                 __isl_take isl_pw_qpolynomial_fold *pwf,
5005                 int *tight);
5006         __isl_give isl_pw_qpolynomial_fold *
5007         isl_map_apply_pw_qpolynomial_fold(
5008                 __isl_take isl_map *map,
5009                 __isl_take isl_pw_qpolynomial_fold *pwf,
5010                 int *tight);
5011         __isl_give isl_union_pw_qpolynomial_fold *
5012         isl_union_set_apply_union_pw_qpolynomial_fold(
5013                 __isl_take isl_union_set *uset,
5014                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5015                 int *tight);
5016         __isl_give isl_union_pw_qpolynomial_fold *
5017         isl_union_map_apply_union_pw_qpolynomial_fold(
5018                 __isl_take isl_union_map *umap,
5019                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5020                 int *tight);
5021
5022 The functions taking a map
5023 compose the given map with the given piecewise quasipolynomial reduction.
5024 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
5025 over all elements in the intersection of the range of the map
5026 and the domain of the piecewise quasipolynomial reduction
5027 as a function of an element in the domain of the map.
5028 The functions taking a set compute a bound over all elements in the
5029 intersection of the set and the domain of the
5030 piecewise quasipolynomial reduction.
5031
5032 =head2 Parametric Vertex Enumeration
5033
5034 The parametric vertex enumeration described in this section
5035 is mainly intended to be used internally and by the C<barvinok>
5036 library.
5037
5038         #include <isl/vertices.h>
5039         __isl_give isl_vertices *isl_basic_set_compute_vertices(
5040                 __isl_keep isl_basic_set *bset);
5041
5042 The function C<isl_basic_set_compute_vertices> performs the
5043 actual computation of the parametric vertices and the chamber
5044 decomposition and store the result in an C<isl_vertices> object.
5045 This information can be queried by either iterating over all
5046 the vertices or iterating over all the chambers or cells
5047 and then iterating over all vertices that are active on the chamber.
5048
5049         int isl_vertices_foreach_vertex(
5050                 __isl_keep isl_vertices *vertices,
5051                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5052                 void *user);
5053
5054         int isl_vertices_foreach_cell(
5055                 __isl_keep isl_vertices *vertices,
5056                 int (*fn)(__isl_take isl_cell *cell, void *user),
5057                 void *user);
5058         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
5059                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5060                 void *user);
5061
5062 Other operations that can be performed on an C<isl_vertices> object are
5063 the following.
5064
5065         isl_ctx *isl_vertices_get_ctx(
5066                 __isl_keep isl_vertices *vertices);
5067         int isl_vertices_get_n_vertices(
5068                 __isl_keep isl_vertices *vertices);
5069         void isl_vertices_free(__isl_take isl_vertices *vertices);
5070
5071 Vertices can be inspected and destroyed using the following functions.
5072
5073         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
5074         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
5075         __isl_give isl_basic_set *isl_vertex_get_domain(
5076                 __isl_keep isl_vertex *vertex);
5077         __isl_give isl_basic_set *isl_vertex_get_expr(
5078                 __isl_keep isl_vertex *vertex);
5079         void isl_vertex_free(__isl_take isl_vertex *vertex);
5080
5081 C<isl_vertex_get_expr> returns a singleton parametric set describing
5082 the vertex, while C<isl_vertex_get_domain> returns the activity domain
5083 of the vertex.
5084 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
5085 B<rational> basic sets, so they should mainly be used for inspection
5086 and should not be mixed with integer sets.
5087
5088 Chambers can be inspected and destroyed using the following functions.
5089
5090         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
5091         __isl_give isl_basic_set *isl_cell_get_domain(
5092                 __isl_keep isl_cell *cell);
5093         void isl_cell_free(__isl_take isl_cell *cell);
5094
5095 =head1 Polyhedral Compilation Library
5096
5097 This section collects functionality in C<isl> that has been specifically
5098 designed for use during polyhedral compilation.
5099
5100 =head2 Dependence Analysis
5101
5102 C<isl> contains specialized functionality for performing
5103 array dataflow analysis.  That is, given a I<sink> access relation
5104 and a collection of possible I<source> access relations,
5105 C<isl> can compute relations that describe
5106 for each iteration of the sink access, which iteration
5107 of which of the source access relations was the last
5108 to access the same data element before the given iteration
5109 of the sink access.
5110 The resulting dependence relations map source iterations
5111 to the corresponding sink iterations.
5112 To compute standard flow dependences, the sink should be
5113 a read, while the sources should be writes.
5114 If any of the source accesses are marked as being I<may>
5115 accesses, then there will be a dependence from the last
5116 I<must> access B<and> from any I<may> access that follows
5117 this last I<must> access.
5118 In particular, if I<all> sources are I<may> accesses,
5119 then memory based dependence analysis is performed.
5120 If, on the other hand, all sources are I<must> accesses,
5121 then value based dependence analysis is performed.
5122
5123         #include <isl/flow.h>
5124
5125         typedef int (*isl_access_level_before)(void *first, void *second);
5126
5127         __isl_give isl_access_info *isl_access_info_alloc(
5128                 __isl_take isl_map *sink,
5129                 void *sink_user, isl_access_level_before fn,
5130                 int max_source);
5131         __isl_give isl_access_info *isl_access_info_add_source(
5132                 __isl_take isl_access_info *acc,
5133                 __isl_take isl_map *source, int must,
5134                 void *source_user);
5135         void *isl_access_info_free(__isl_take isl_access_info *acc);
5136
5137         __isl_give isl_flow *isl_access_info_compute_flow(
5138                 __isl_take isl_access_info *acc);
5139
5140         int isl_flow_foreach(__isl_keep isl_flow *deps,
5141                 int (*fn)(__isl_take isl_map *dep, int must,
5142                           void *dep_user, void *user),
5143                 void *user);
5144         __isl_give isl_map *isl_flow_get_no_source(
5145                 __isl_keep isl_flow *deps, int must);
5146         void isl_flow_free(__isl_take isl_flow *deps);
5147
5148 The function C<isl_access_info_compute_flow> performs the actual
5149 dependence analysis.  The other functions are used to construct
5150 the input for this function or to read off the output.
5151
5152 The input is collected in an C<isl_access_info>, which can
5153 be created through a call to C<isl_access_info_alloc>.
5154 The arguments to this functions are the sink access relation
5155 C<sink>, a token C<sink_user> used to identify the sink
5156 access to the user, a callback function for specifying the
5157 relative order of source and sink accesses, and the number
5158 of source access relations that will be added.
5159 The callback function has type C<int (*)(void *first, void *second)>.
5160 The function is called with two user supplied tokens identifying
5161 either a source or the sink and it should return the shared nesting
5162 level and the relative order of the two accesses.
5163 In particular, let I<n> be the number of loops shared by
5164 the two accesses.  If C<first> precedes C<second> textually,
5165 then the function should return I<2 * n + 1>; otherwise,
5166 it should return I<2 * n>.
5167 The sources can be added to the C<isl_access_info> by performing
5168 (at most) C<max_source> calls to C<isl_access_info_add_source>.
5169 C<must> indicates whether the source is a I<must> access
5170 or a I<may> access.  Note that a multi-valued access relation
5171 should only be marked I<must> if every iteration in the domain
5172 of the relation accesses I<all> elements in its image.
5173 The C<source_user> token is again used to identify
5174 the source access.  The range of the source access relation
5175 C<source> should have the same dimension as the range
5176 of the sink access relation.
5177 The C<isl_access_info_free> function should usually not be
5178 called explicitly, because it is called implicitly by
5179 C<isl_access_info_compute_flow>.
5180
5181 The result of the dependence analysis is collected in an
5182 C<isl_flow>.  There may be elements of
5183 the sink access for which no preceding source access could be
5184 found or for which all preceding sources are I<may> accesses.
5185 The relations containing these elements can be obtained through
5186 calls to C<isl_flow_get_no_source>, the first with C<must> set
5187 and the second with C<must> unset.
5188 In the case of standard flow dependence analysis,
5189 with the sink a read and the sources I<must> writes,
5190 the first relation corresponds to the reads from uninitialized
5191 array elements and the second relation is empty.
5192 The actual flow dependences can be extracted using
5193 C<isl_flow_foreach>.  This function will call the user-specified
5194 callback function C<fn> for each B<non-empty> dependence between
5195 a source and the sink.  The callback function is called
5196 with four arguments, the actual flow dependence relation
5197 mapping source iterations to sink iterations, a boolean that
5198 indicates whether it is a I<must> or I<may> dependence, a token
5199 identifying the source and an additional C<void *> with value
5200 equal to the third argument of the C<isl_flow_foreach> call.
5201 A dependence is marked I<must> if it originates from a I<must>
5202 source and if it is not followed by any I<may> sources.
5203
5204 After finishing with an C<isl_flow>, the user should call
5205 C<isl_flow_free> to free all associated memory.
5206
5207 A higher-level interface to dependence analysis is provided
5208 by the following function.
5209
5210         #include <isl/flow.h>
5211
5212         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
5213                 __isl_take isl_union_map *must_source,
5214                 __isl_take isl_union_map *may_source,
5215                 __isl_take isl_union_map *schedule,
5216                 __isl_give isl_union_map **must_dep,
5217                 __isl_give isl_union_map **may_dep,
5218                 __isl_give isl_union_map **must_no_source,
5219                 __isl_give isl_union_map **may_no_source);
5220
5221 The arrays are identified by the tuple names of the ranges
5222 of the accesses.  The iteration domains by the tuple names
5223 of the domains of the accesses and of the schedule.
5224 The relative order of the iteration domains is given by the
5225 schedule.  The relations returned through C<must_no_source>
5226 and C<may_no_source> are subsets of C<sink>.
5227 Any of C<must_dep>, C<may_dep>, C<must_no_source>
5228 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
5229 any of the other arguments is treated as an error.
5230
5231 =head3 Interaction with Dependence Analysis
5232
5233 During the dependence analysis, we frequently need to perform
5234 the following operation.  Given a relation between sink iterations
5235 and potential source iterations from a particular source domain,
5236 what is the last potential source iteration corresponding to each
5237 sink iteration.  It can sometimes be convenient to adjust
5238 the set of potential source iterations before or after each such operation.
5239 The prototypical example is fuzzy array dataflow analysis,
5240 where we need to analyze if, based on data-dependent constraints,
5241 the sink iteration can ever be executed without one or more of
5242 the corresponding potential source iterations being executed.
5243 If so, we can introduce extra parameters and select an unknown
5244 but fixed source iteration from the potential source iterations.
5245 To be able to perform such manipulations, C<isl> provides the following
5246 function.
5247
5248         #include <isl/flow.h>
5249
5250         typedef __isl_give isl_restriction *(*isl_access_restrict)(
5251                 __isl_keep isl_map *source_map,
5252                 __isl_keep isl_set *sink, void *source_user,
5253                 void *user);
5254         __isl_give isl_access_info *isl_access_info_set_restrict(
5255                 __isl_take isl_access_info *acc,
5256                 isl_access_restrict fn, void *user);
5257
5258 The function C<isl_access_info_set_restrict> should be called
5259 before calling C<isl_access_info_compute_flow> and registers a callback function
5260 that will be called any time C<isl> is about to compute the last
5261 potential source.  The first argument is the (reverse) proto-dependence,
5262 mapping sink iterations to potential source iterations.
5263 The second argument represents the sink iterations for which
5264 we want to compute the last source iteration.
5265 The third argument is the token corresponding to the source
5266 and the final argument is the token passed to C<isl_access_info_set_restrict>.
5267 The callback is expected to return a restriction on either the input or
5268 the output of the operation computing the last potential source.
5269 If the input needs to be restricted then restrictions are needed
5270 for both the source and the sink iterations.  The sink iterations
5271 and the potential source iterations will be intersected with these sets.
5272 If the output needs to be restricted then only a restriction on the source
5273 iterations is required.
5274 If any error occurs, the callback should return C<NULL>.
5275 An C<isl_restriction> object can be created, freed and inspected
5276 using the following functions.
5277
5278         #include <isl/flow.h>
5279
5280         __isl_give isl_restriction *isl_restriction_input(
5281                 __isl_take isl_set *source_restr,
5282                 __isl_take isl_set *sink_restr);
5283         __isl_give isl_restriction *isl_restriction_output(
5284                 __isl_take isl_set *source_restr);
5285         __isl_give isl_restriction *isl_restriction_none(
5286                 __isl_take isl_map *source_map);
5287         __isl_give isl_restriction *isl_restriction_empty(
5288                 __isl_take isl_map *source_map);
5289         void *isl_restriction_free(
5290                 __isl_take isl_restriction *restr);
5291         isl_ctx *isl_restriction_get_ctx(
5292                 __isl_keep isl_restriction *restr);
5293
5294 C<isl_restriction_none> and C<isl_restriction_empty> are special
5295 cases of C<isl_restriction_input>.  C<isl_restriction_none>
5296 is essentially equivalent to
5297
5298         isl_restriction_input(isl_set_universe(
5299             isl_space_range(isl_map_get_space(source_map))),
5300                             isl_set_universe(
5301             isl_space_domain(isl_map_get_space(source_map))));
5302
5303 whereas C<isl_restriction_empty> is essentially equivalent to
5304
5305         isl_restriction_input(isl_set_empty(
5306             isl_space_range(isl_map_get_space(source_map))),
5307                             isl_set_universe(
5308             isl_space_domain(isl_map_get_space(source_map))));
5309
5310 =head2 Scheduling
5311
5312 B<The functionality described in this section is fairly new
5313 and may be subject to change.>
5314
5315 The following function can be used to compute a schedule
5316 for a union of domains.
5317 By default, the algorithm used to construct the schedule is similar
5318 to that of C<Pluto>.
5319 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
5320 be selected.
5321 The generated schedule respects all C<validity> dependences.
5322 That is, all dependence distances over these dependences in the
5323 scheduled space are lexicographically positive.
5324 The default algorithm tries to minimize the dependence distances over
5325 C<proximity> dependences.
5326 Moreover, it tries to obtain sequences (bands) of schedule dimensions
5327 for groups of domains where the dependence distances have only
5328 non-negative values.
5329 When using Feautrier's algorithm, the C<proximity> dependence
5330 distances are only minimized during the extension to a
5331 full-dimensional schedule.
5332
5333         #include <isl/schedule.h>
5334         __isl_give isl_schedule *isl_union_set_compute_schedule(
5335                 __isl_take isl_union_set *domain,
5336                 __isl_take isl_union_map *validity,
5337                 __isl_take isl_union_map *proximity);
5338         void *isl_schedule_free(__isl_take isl_schedule *sched);
5339
5340 A mapping from the domains to the scheduled space can be obtained
5341 from an C<isl_schedule> using the following function.
5342
5343         __isl_give isl_union_map *isl_schedule_get_map(
5344                 __isl_keep isl_schedule *sched);
5345
5346 A representation of the schedule can be printed using
5347          
5348         __isl_give isl_printer *isl_printer_print_schedule(
5349                 __isl_take isl_printer *p,
5350                 __isl_keep isl_schedule *schedule);
5351
5352 A representation of the schedule as a forest of bands can be obtained
5353 using the following function.
5354
5355         __isl_give isl_band_list *isl_schedule_get_band_forest(
5356                 __isl_keep isl_schedule *schedule);
5357
5358 The individual bands can be visited in depth-first post-order
5359 using the following function.
5360
5361         #include <isl/schedule.h>
5362         int isl_schedule_foreach_band(
5363                 __isl_keep isl_schedule *sched,
5364                 int (*fn)(__isl_keep isl_band *band, void *user),
5365                 void *user);
5366
5367 The list can be manipulated as explained in L<"Lists">.
5368 The bands inside the list can be copied and freed using the following
5369 functions.
5370
5371         #include <isl/band.h>
5372         __isl_give isl_band *isl_band_copy(
5373                 __isl_keep isl_band *band);
5374         void *isl_band_free(__isl_take isl_band *band);
5375
5376 Each band contains zero or more scheduling dimensions.
5377 These are referred to as the members of the band.
5378 The section of the schedule that corresponds to the band is
5379 referred to as the partial schedule of the band.
5380 For those nodes that participate in a band, the outer scheduling
5381 dimensions form the prefix schedule, while the inner scheduling
5382 dimensions form the suffix schedule.
5383 That is, if we take a cut of the band forest, then the union of
5384 the concatenations of the prefix, partial and suffix schedules of
5385 each band in the cut is equal to the entire schedule (modulo
5386 some possible padding at the end with zero scheduling dimensions).
5387 The properties of a band can be inspected using the following functions.
5388
5389         #include <isl/band.h>
5390         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
5391
5392         int isl_band_has_children(__isl_keep isl_band *band);
5393         __isl_give isl_band_list *isl_band_get_children(
5394                 __isl_keep isl_band *band);
5395
5396         __isl_give isl_union_map *isl_band_get_prefix_schedule(
5397                 __isl_keep isl_band *band);
5398         __isl_give isl_union_map *isl_band_get_partial_schedule(
5399                 __isl_keep isl_band *band);
5400         __isl_give isl_union_map *isl_band_get_suffix_schedule(
5401                 __isl_keep isl_band *band);
5402
5403         int isl_band_n_member(__isl_keep isl_band *band);
5404         int isl_band_member_is_zero_distance(
5405                 __isl_keep isl_band *band, int pos);
5406
5407         int isl_band_list_foreach_band(
5408                 __isl_keep isl_band_list *list,
5409                 int (*fn)(__isl_keep isl_band *band, void *user),
5410                 void *user);
5411
5412 Note that a scheduling dimension is considered to be ``zero
5413 distance'' if it does not carry any proximity dependences
5414 within its band.
5415 That is, if the dependence distances of the proximity
5416 dependences are all zero in that direction (for fixed
5417 iterations of outer bands).
5418 Like C<isl_schedule_foreach_band>,
5419 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
5420 in depth-first post-order.
5421
5422 A band can be tiled using the following function.
5423
5424         #include <isl/band.h>
5425         int isl_band_tile(__isl_keep isl_band *band,
5426                 __isl_take isl_vec *sizes);
5427
5428         int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
5429                 int val);
5430         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
5431         int isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
5432                 int val);
5433         int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
5434
5435 The C<isl_band_tile> function tiles the band using the given tile sizes
5436 inside its schedule.
5437 A new child band is created to represent the point loops and it is
5438 inserted between the modified band and its children.
5439 The C<tile_scale_tile_loops> option specifies whether the tile
5440 loops iterators should be scaled by the tile sizes.
5441 If the C<tile_shift_point_loops> option is set, then the point loops
5442 are shifted to start at zero.
5443
5444 A band can be split into two nested bands using the following function.
5445
5446         int isl_band_split(__isl_keep isl_band *band, int pos);
5447
5448 The resulting outer band contains the first C<pos> dimensions of C<band>
5449 while the inner band contains the remaining dimensions.
5450
5451 A representation of the band can be printed using
5452
5453         #include <isl/band.h>
5454         __isl_give isl_printer *isl_printer_print_band(
5455                 __isl_take isl_printer *p,
5456                 __isl_keep isl_band *band);
5457
5458 =head3 Options
5459
5460         #include <isl/schedule.h>
5461         int isl_options_set_schedule_max_coefficient(
5462                 isl_ctx *ctx, int val);
5463         int isl_options_get_schedule_max_coefficient(
5464                 isl_ctx *ctx);
5465         int isl_options_set_schedule_max_constant_term(
5466                 isl_ctx *ctx, int val);
5467         int isl_options_get_schedule_max_constant_term(
5468                 isl_ctx *ctx);
5469         int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
5470         int isl_options_get_schedule_fuse(isl_ctx *ctx);
5471         int isl_options_set_schedule_maximize_band_depth(
5472                 isl_ctx *ctx, int val);
5473         int isl_options_get_schedule_maximize_band_depth(
5474                 isl_ctx *ctx);
5475         int isl_options_set_schedule_outer_zero_distance(
5476                 isl_ctx *ctx, int val);
5477         int isl_options_get_schedule_outer_zero_distance(
5478                 isl_ctx *ctx);
5479         int isl_options_set_schedule_split_scaled(
5480                 isl_ctx *ctx, int val);
5481         int isl_options_get_schedule_split_scaled(
5482                 isl_ctx *ctx);
5483         int isl_options_set_schedule_algorithm(
5484                 isl_ctx *ctx, int val);
5485         int isl_options_get_schedule_algorithm(
5486                 isl_ctx *ctx);
5487         int isl_options_set_schedule_separate_components(
5488                 isl_ctx *ctx, int val);
5489         int isl_options_get_schedule_separate_components(
5490                 isl_ctx *ctx);
5491
5492 =over
5493
5494 =item * schedule_max_coefficient
5495
5496 This option enforces that the coefficients for variable and parameter
5497 dimensions in the calculated schedule are not larger than the specified value.
5498 This option can significantly increase the speed of the scheduling calculation
5499 and may also prevent fusing of unrelated dimensions. A value of -1 means that
5500 this option does not introduce bounds on the variable or parameter
5501 coefficients.
5502
5503 =item * schedule_max_constant_term
5504
5505 This option enforces that the constant coefficients in the calculated schedule
5506 are not larger than the maximal constant term. This option can significantly
5507 increase the speed of the scheduling calculation and may also prevent fusing of
5508 unrelated dimensions. A value of -1 means that this option does not introduce
5509 bounds on the constant coefficients.
5510
5511 =item * schedule_fuse
5512
5513 This option controls the level of fusion.
5514 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
5515 resulting schedule will be distributed as much as possible.
5516 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
5517 try to fuse loops in the resulting schedule.
5518
5519 =item * schedule_maximize_band_depth
5520
5521 If this option is set, we do not split bands at the point
5522 where we detect splitting is necessary. Instead, we
5523 backtrack and split bands as early as possible. This
5524 reduces the number of splits and maximizes the width of
5525 the bands. Wider bands give more possibilities for tiling.
5526 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
5527 then bands will be split as early as possible, even if there is no need.
5528 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
5529
5530 =item * schedule_outer_zero_distance
5531
5532 If this option is set, then we try to construct schedules
5533 where the outermost scheduling dimension in each band
5534 results in a zero dependence distance over the proximity
5535 dependences.
5536
5537 =item * schedule_split_scaled
5538
5539 If this option is set, then we try to construct schedules in which the
5540 constant term is split off from the linear part if the linear parts of
5541 the scheduling rows for all nodes in the graphs have a common non-trivial
5542 divisor.
5543 The constant term is then placed in a separate band and the linear
5544 part is reduced.
5545
5546 =item * schedule_algorithm
5547
5548 Selects the scheduling algorithm to be used.
5549 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
5550 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
5551
5552 =item * schedule_separate_components
5553
5554 If at any point the dependence graph contains any (weakly connected) components,
5555 then these components are scheduled separately.
5556 If this option is not set, then some iterations of the domains
5557 in these components may be scheduled together.
5558 If this option is set, then the components are given consecutive
5559 schedules.
5560
5561 =back
5562
5563 =head2 AST Generation
5564
5565 This section describes the C<isl> functionality for generating
5566 ASTs that visit all the elements
5567 in a domain in an order specified by a schedule.
5568 In particular, given a C<isl_union_map>, an AST is generated
5569 that visits all the elements in the domain of the C<isl_union_map>
5570 according to the lexicographic order of the corresponding image
5571 element(s).  If the range of the C<isl_union_map> consists of
5572 elements in more than one space, then each of these spaces is handled
5573 separately in an arbitrary order.
5574 It should be noted that the image elements only specify the I<order>
5575 in which the corresponding domain elements should be visited.
5576 No direct relation between the image elements and the loop iterators
5577 in the generated AST should be assumed.
5578
5579 Each AST is generated within a build.  The initial build
5580 simply specifies the constraints on the parameters (if any)
5581 and can be created, inspected, copied and freed using the following functions.
5582
5583         #include <isl/ast_build.h>
5584         __isl_give isl_ast_build *isl_ast_build_from_context(
5585                 __isl_take isl_set *set);
5586         isl_ctx *isl_ast_build_get_ctx(
5587                 __isl_keep isl_ast_build *build);
5588         __isl_give isl_ast_build *isl_ast_build_copy(
5589                 __isl_keep isl_ast_build *build);
5590         void *isl_ast_build_free(
5591                 __isl_take isl_ast_build *build);
5592
5593 The C<set> argument is usually a parameter set with zero or more parameters.
5594 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
5595 and L</"Fine-grained Control over AST Generation">.
5596 Finally, the AST itself can be constructed using the following
5597 function.
5598
5599         #include <isl/ast_build.h>
5600         __isl_give isl_ast_node *isl_ast_build_ast_from_schedule(
5601                 __isl_keep isl_ast_build *build,
5602                 __isl_take isl_union_map *schedule);
5603
5604 =head3 Inspecting the AST
5605
5606 The basic properties of an AST node can be obtained as follows.
5607
5608         #include <isl/ast.h>
5609         isl_ctx *isl_ast_node_get_ctx(
5610                 __isl_keep isl_ast_node *node);
5611         enum isl_ast_node_type isl_ast_node_get_type(
5612                 __isl_keep isl_ast_node *node);
5613
5614 The type of an AST node is one of
5615 C<isl_ast_node_for>,
5616 C<isl_ast_node_if>,
5617 C<isl_ast_node_block> or
5618 C<isl_ast_node_user>.
5619 An C<isl_ast_node_for> represents a for node.
5620 An C<isl_ast_node_if> represents an if node.
5621 An C<isl_ast_node_block> represents a compound node.
5622 An C<isl_ast_node_user> represents an expression statement.
5623 An expression statement typically corresponds to a domain element, i.e.,
5624 one of the elements that is visited by the AST.
5625
5626 Each type of node has its own additional properties.
5627
5628         #include <isl/ast.h>
5629         __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
5630                 __isl_keep isl_ast_node *node);
5631         __isl_give isl_ast_expr *isl_ast_node_for_get_init(
5632                 __isl_keep isl_ast_node *node);
5633         __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
5634                 __isl_keep isl_ast_node *node);
5635         __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
5636                 __isl_keep isl_ast_node *node);
5637         __isl_give isl_ast_node *isl_ast_node_for_get_body(
5638                 __isl_keep isl_ast_node *node);
5639         int isl_ast_node_for_is_degenerate(
5640                 __isl_keep isl_ast_node *node);
5641
5642 An C<isl_ast_for> is considered degenerate if it is known to execute
5643 exactly once.
5644
5645         #include <isl/ast.h>
5646         __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
5647                 __isl_keep isl_ast_node *node);
5648         __isl_give isl_ast_node *isl_ast_node_if_get_then(
5649                 __isl_keep isl_ast_node *node);
5650         int isl_ast_node_if_has_else(
5651                 __isl_keep isl_ast_node *node);
5652         __isl_give isl_ast_node *isl_ast_node_if_get_else(
5653                 __isl_keep isl_ast_node *node);
5654
5655         __isl_give isl_ast_node_list *
5656         isl_ast_node_block_get_children(
5657                 __isl_keep isl_ast_node *node);
5658
5659         __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
5660                 __isl_keep isl_ast_node *node);
5661
5662 Each of the returned C<isl_ast_expr>s can in turn be inspected using
5663 the following functions.
5664
5665         #include <isl/ast.h>
5666         isl_ctx *isl_ast_expr_get_ctx(
5667                 __isl_keep isl_ast_expr *expr);
5668         enum isl_ast_expr_type isl_ast_expr_get_type(
5669                 __isl_keep isl_ast_expr *expr);
5670
5671 The type of an AST expression is one of
5672 C<isl_ast_expr_op>,
5673 C<isl_ast_expr_id> or
5674 C<isl_ast_expr_int>.
5675 An C<isl_ast_expr_op> represents the result of an operation.
5676 An C<isl_ast_expr_id> represents an identifier.
5677 An C<isl_ast_expr_int> represents an integer value.
5678
5679 Each type of expression has its own additional properties.
5680
5681         #include <isl/ast.h>
5682         enum isl_ast_op_type isl_ast_expr_get_op_type(
5683                 __isl_keep isl_ast_expr *expr);
5684         int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
5685         __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
5686                 __isl_keep isl_ast_expr *expr, int pos);
5687         int isl_ast_node_foreach_ast_op_type(
5688                 __isl_keep isl_ast_node *node,
5689                 int (*fn)(enum isl_ast_op_type type, void *user),
5690                 void *user);
5691
5692 C<isl_ast_expr_get_op_type> returns the type of the operation
5693 performed.  C<isl_ast_expr_get_op_n_arg> returns the number of
5694 arguments.  C<isl_ast_expr_get_op_arg> returns the specified
5695 argument.
5696 C<isl_ast_node_foreach_ast_op_type> calls C<fn> for each distinct
5697 C<isl_ast_op_type> that appears in C<node>.
5698 The operation type is one of the following.
5699
5700 =over
5701
5702 =item C<isl_ast_op_and>
5703
5704 Logical I<and> of two arguments.
5705 Both arguments can be evaluated.
5706
5707 =item C<isl_ast_op_and_then>
5708
5709 Logical I<and> of two arguments.
5710 The second argument can only be evaluated if the first evaluates to true.
5711
5712 =item C<isl_ast_op_or>
5713
5714 Logical I<or> of two arguments.
5715 Both arguments can be evaluated.
5716
5717 =item C<isl_ast_op_or_else>
5718
5719 Logical I<or> of two arguments.
5720 The second argument can only be evaluated if the first evaluates to false.
5721
5722 =item C<isl_ast_op_max>
5723
5724 Maximum of two or more arguments.
5725
5726 =item C<isl_ast_op_min>
5727
5728 Minimum of two or more arguments.
5729
5730 =item C<isl_ast_op_minus>
5731
5732 Change sign.
5733
5734 =item C<isl_ast_op_add>
5735
5736 Sum of two arguments.
5737
5738 =item C<isl_ast_op_sub>
5739
5740 Difference of two arguments.
5741
5742 =item C<isl_ast_op_mul>
5743
5744 Product of two arguments.
5745
5746 =item C<isl_ast_op_div>
5747
5748 Exact division.  That is, the result is known to be an integer.
5749
5750 =item C<isl_ast_op_fdiv_q>
5751
5752 Result of integer division, rounded towards negative
5753 infinity.
5754
5755 =item C<isl_ast_op_pdiv_q>
5756
5757 Result of integer division, where dividend is known to be non-negative.
5758
5759 =item C<isl_ast_op_pdiv_r>
5760
5761 Remainder of integer division, where dividend is known to be non-negative.
5762
5763 =item C<isl_ast_op_cond>
5764
5765 Conditional operator defined on three arguments.
5766 If the first argument evaluates to true, then the result
5767 is equal to the second argument.  Otherwise, the result
5768 is equal to the third argument.
5769 The second and third argument may only be evaluated if
5770 the first argument evaluates to true and false, respectively.
5771 Corresponds to C<a ? b : c> in C.
5772
5773 =item C<isl_ast_op_select>
5774
5775 Conditional operator defined on three arguments.
5776 If the first argument evaluates to true, then the result
5777 is equal to the second argument.  Otherwise, the result
5778 is equal to the third argument.
5779 The second and third argument may be evaluated independently
5780 of the value of the first argument.
5781 Corresponds to C<a * b + (1 - a) * c> in C.
5782
5783 =item C<isl_ast_op_eq>
5784
5785 Equality relation.
5786
5787 =item C<isl_ast_op_le>
5788
5789 Less than or equal relation.
5790
5791 =item C<isl_ast_op_lt>
5792
5793 Less than relation.
5794
5795 =item C<isl_ast_op_ge>
5796
5797 Greater than or equal relation.
5798
5799 =item C<isl_ast_op_gt>
5800
5801 Greater than relation.
5802
5803 =item C<isl_ast_op_call>
5804
5805 A function call.
5806 The number of arguments of the C<isl_ast_expr> is one more than
5807 the number of arguments in the function call, the first argument
5808 representing the function being called.
5809
5810 =back
5811
5812         #include <isl/ast.h>
5813         __isl_give isl_id *isl_ast_expr_get_id(
5814                 __isl_keep isl_ast_expr *expr);
5815
5816 Return the identifier represented by the AST expression.
5817
5818         #include <isl/ast.h>
5819         int isl_ast_expr_get_int(__isl_keep isl_ast_expr *expr,
5820                 isl_int *v);
5821
5822 Return the integer represented by the AST expression.
5823 Note that the integer is returned through the C<v> argument.
5824 The return value of the function itself indicates whether the
5825 operation was performed successfully.
5826
5827 =head3 Manipulating and printing the AST
5828
5829 AST nodes can be copied and freed using the following functions.
5830
5831         #include <isl/ast.h>
5832         __isl_give isl_ast_node *isl_ast_node_copy(
5833                 __isl_keep isl_ast_node *node);
5834         void *isl_ast_node_free(__isl_take isl_ast_node *node);
5835
5836 AST expressions can be copied and freed using the following functions.
5837
5838         #include <isl/ast.h>
5839         __isl_give isl_ast_expr *isl_ast_expr_copy(
5840                 __isl_keep isl_ast_expr *expr);
5841         void *isl_ast_expr_free(__isl_take isl_ast_expr *expr);
5842
5843 New AST expressions can be created either directly or within
5844 the context of an C<isl_ast_build>.
5845
5846         #include <isl/ast.h>
5847         __isl_give isl_ast_expr *isl_ast_expr_from_id(
5848                 __isl_take isl_id *id);
5849         __isl_give isl_ast_expr *isl_ast_expr_neg(
5850                 __isl_take isl_ast_expr *expr);
5851         __isl_give isl_ast_expr *isl_ast_expr_add(
5852                 __isl_take isl_ast_expr *expr1,
5853                 __isl_take isl_ast_expr *expr2);
5854         __isl_give isl_ast_expr *isl_ast_expr_sub(
5855                 __isl_take isl_ast_expr *expr1,
5856                 __isl_take isl_ast_expr *expr2);
5857         __isl_give isl_ast_expr *isl_ast_expr_mul(
5858                 __isl_take isl_ast_expr *expr1,
5859                 __isl_take isl_ast_expr *expr2);
5860         __isl_give isl_ast_expr *isl_ast_expr_div(
5861                 __isl_take isl_ast_expr *expr1,
5862                 __isl_take isl_ast_expr *expr2);
5863         __isl_give isl_ast_expr *isl_ast_expr_and(
5864                 __isl_take isl_ast_expr *expr1,
5865                 __isl_take isl_ast_expr *expr2)
5866         __isl_give isl_ast_expr *isl_ast_expr_or(
5867                 __isl_take isl_ast_expr *expr1,
5868                 __isl_take isl_ast_expr *expr2)
5869
5870         #include <isl/ast_build.h>
5871         __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
5872                 __isl_keep isl_ast_build *build,
5873                 __isl_take isl_pw_aff *pa);
5874         __isl_give isl_ast_expr *
5875         isl_ast_build_call_from_pw_multi_aff(
5876                 __isl_keep isl_ast_build *build,
5877                 __isl_take isl_pw_multi_aff *pma);
5878
5879 The domains of C<pa> and C<pma> should correspond
5880 to the schedule space of C<build>.
5881 The tuple id of C<pma> is used as the function being called.
5882
5883 User specified data can be attached to an C<isl_ast_node> and obtained
5884 from the same C<isl_ast_node> using the following functions.
5885
5886         #include <isl/ast.h>
5887         __isl_give isl_ast_node *isl_ast_node_set_annotation(
5888                 __isl_take isl_ast_node *node,
5889                 __isl_take isl_id *annotation);
5890         __isl_give isl_id *isl_ast_node_get_annotation(
5891                 __isl_keep isl_ast_node *node);
5892
5893 Basic printing can be performed using the following functions.
5894
5895         #include <isl/ast.h>
5896         __isl_give isl_printer *isl_printer_print_ast_expr(
5897                 __isl_take isl_printer *p,
5898                 __isl_keep isl_ast_expr *expr);
5899         __isl_give isl_printer *isl_printer_print_ast_node(
5900                 __isl_take isl_printer *p,
5901                 __isl_keep isl_ast_node *node);
5902
5903 More advanced printing can be performed using the following functions.
5904
5905         #include <isl/ast.h>
5906         __isl_give isl_printer *isl_ast_op_type_print_macro(
5907                 enum isl_ast_op_type type,
5908                 __isl_take isl_printer *p);
5909         __isl_give isl_printer *isl_ast_node_print_macros(
5910                 __isl_keep isl_ast_node *node,
5911                 __isl_take isl_printer *p);
5912         __isl_give isl_printer *isl_ast_node_print(
5913                 __isl_keep isl_ast_node *node,
5914                 __isl_take isl_printer *p,
5915                 __isl_take isl_ast_print_options *options);
5916         __isl_give isl_printer *isl_ast_node_for_print(
5917                 __isl_keep isl_ast_node *node,
5918                 __isl_take isl_printer *p,
5919                 __isl_take isl_ast_print_options *options);
5920         __isl_give isl_printer *isl_ast_node_if_print(
5921                 __isl_keep isl_ast_node *node,
5922                 __isl_take isl_printer *p,
5923                 __isl_take isl_ast_print_options *options);
5924
5925 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
5926 C<isl> may print out an AST that makes use of macros such
5927 as C<floord>, C<min> and C<max>.
5928 C<isl_ast_op_type_print_macro> prints out the macro
5929 corresponding to a specific C<isl_ast_op_type>.
5930 C<isl_ast_node_print_macros> scans the C<isl_ast_node>
5931 for expressions where these macros would be used and prints
5932 out the required macro definitions.
5933 Essentially, C<isl_ast_node_print_macros> calls
5934 C<isl_ast_node_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
5935 as function argument.
5936 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
5937 C<isl_ast_node_if_print> print an C<isl_ast_node>
5938 in C<ISL_FORMAT_C>, but allow for some extra control
5939 through an C<isl_ast_print_options> object.
5940 This object can be created using the following functions.
5941
5942         #include <isl/ast.h>
5943         __isl_give isl_ast_print_options *
5944         isl_ast_print_options_alloc(isl_ctx *ctx);
5945         __isl_give isl_ast_print_options *
5946         isl_ast_print_options_copy(
5947                 __isl_keep isl_ast_print_options *options);
5948         void *isl_ast_print_options_free(
5949                 __isl_take isl_ast_print_options *options);
5950
5951         __isl_give isl_ast_print_options *
5952         isl_ast_print_options_set_print_user(
5953                 __isl_take isl_ast_print_options *options,
5954                 __isl_give isl_printer *(*print_user)(
5955                         __isl_take isl_printer *p,
5956                         __isl_take isl_ast_print_options *options,
5957                         __isl_keep isl_ast_node *node, void *user),
5958                 void *user);
5959         __isl_give isl_ast_print_options *
5960         isl_ast_print_options_set_print_for(
5961                 __isl_take isl_ast_print_options *options,
5962                 __isl_give isl_printer *(*print_for)(
5963                         __isl_take isl_printer *p,
5964                         __isl_take isl_ast_print_options *options,
5965                         __isl_keep isl_ast_node *node, void *user),
5966                 void *user);
5967
5968 The callback set by C<isl_ast_print_options_set_print_user>
5969 is called whenever a node of type C<isl_ast_node_user> needs to
5970 be printed.
5971 The callback set by C<isl_ast_print_options_set_print_for>
5972 is called whenever a node of type C<isl_ast_node_for> needs to
5973 be printed.
5974 Note that C<isl_ast_node_for_print> will I<not> call the
5975 callback set by C<isl_ast_print_options_set_print_for> on the node
5976 on which C<isl_ast_node_for_print> is called, but only on nested
5977 nodes of type C<isl_ast_node_for>.  It is therefore safe to
5978 call C<isl_ast_node_for_print> from within the callback set by
5979 C<isl_ast_print_options_set_print_for>.
5980
5981 The following option determines the type to be used for iterators
5982 while printing the AST.
5983
5984         int isl_options_set_ast_iterator_type(
5985                 isl_ctx *ctx, const char *val);
5986         const char *isl_options_get_ast_iterator_type(
5987                 isl_ctx *ctx);
5988
5989 =head3 Options
5990
5991         #include <isl/ast_build.h>
5992         int isl_options_set_ast_build_atomic_upper_bound(
5993                 isl_ctx *ctx, int val);
5994         int isl_options_get_ast_build_atomic_upper_bound(
5995                 isl_ctx *ctx);
5996         int isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
5997                 int val);
5998         int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
5999         int isl_options_set_ast_build_exploit_nested_bounds(
6000                 isl_ctx *ctx, int val);
6001         int isl_options_get_ast_build_exploit_nested_bounds(
6002                 isl_ctx *ctx);
6003         int isl_options_set_ast_build_group_coscheduled(
6004                 isl_ctx *ctx, int val);
6005         int isl_options_get_ast_build_group_coscheduled(
6006                 isl_ctx *ctx);
6007         int isl_options_set_ast_build_scale_strides(
6008                 isl_ctx *ctx, int val);
6009         int isl_options_get_ast_build_scale_strides(
6010                 isl_ctx *ctx);
6011         int isl_options_set_ast_build_allow_else(isl_ctx *ctx,
6012                 int val);
6013         int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
6014         int isl_options_set_ast_build_allow_or(isl_ctx *ctx,
6015                 int val);
6016         int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
6017
6018 =over
6019
6020 =item * ast_build_atomic_upper_bound
6021
6022 Generate loop upper bounds that consist of the current loop iterator,
6023 an operator and an expression not involving the iterator.
6024 If this option is not set, then the current loop iterator may appear
6025 several times in the upper bound.
6026 For example, when this option is turned off, AST generation
6027 for the schedule
6028
6029         [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
6030
6031 produces
6032
6033         for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
6034           A(c0);
6035
6036 When the option is turned on, the following AST is generated
6037
6038         for (int c0 = 0; c0 <= min(100, n); c0 += 1)
6039           A(c0);
6040
6041 =item * ast_build_prefer_pdiv
6042
6043 If this option is turned off, then the AST generation will
6044 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
6045 operators, but no C<isl_ast_op_pdiv_q> or
6046 C<isl_ast_op_pdiv_r> operators.
6047 If this options is turned on, then C<isl> will try to convert
6048 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
6049 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
6050
6051 =item * ast_build_exploit_nested_bounds
6052
6053 Simplify conditions based on bounds of nested for loops.
6054 In particular, remove conditions that are implied by the fact
6055 that one or more nested loops have at least one iteration,
6056 meaning that the upper bound is at least as large as the lower bound.
6057 For example, when this option is turned off, AST generation
6058 for the schedule
6059
6060         [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
6061                                         0 <= j <= M }
6062
6063 produces
6064
6065         if (M >= 0)
6066           for (int c0 = 0; c0 <= N; c0 += 1)
6067             for (int c1 = 0; c1 <= M; c1 += 1)
6068               A(c0, c1);
6069
6070 When the option is turned on, the following AST is generated
6071
6072         for (int c0 = 0; c0 <= N; c0 += 1)
6073           for (int c1 = 0; c1 <= M; c1 += 1)
6074             A(c0, c1);
6075
6076 =item * ast_build_group_coscheduled
6077
6078 If two domain elements are assigned the same schedule point, then
6079 they may be executed in any order and they may even appear in different
6080 loops.  If this options is set, then the AST generator will make
6081 sure that coscheduled domain elements do not appear in separate parts
6082 of the AST.  This is useful in case of nested AST generation
6083 if the outer AST generation is given only part of a schedule
6084 and the inner AST generation should handle the domains that are
6085 coscheduled by this initial part of the schedule together.
6086 For example if an AST is generated for a schedule
6087
6088         { A[i] -> [0]; B[i] -> [0] }
6089
6090 then the C<isl_ast_build_set_create_leaf> callback described
6091 below may get called twice, once for each domain.
6092 Setting this option ensures that the callback is only called once
6093 on both domains together.
6094
6095 =item * ast_build_separation_bounds
6096
6097 This option specifies which bounds to use during separation.
6098 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
6099 then all (possibly implicit) bounds on the current dimension will
6100 be used during separation.
6101 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
6102 then only those bounds that are explicitly available will
6103 be used during separation.
6104
6105 =item * ast_build_scale_strides
6106
6107 This option specifies whether the AST generator is allowed
6108 to scale down iterators of strided loops.
6109
6110 =item * ast_build_allow_else
6111
6112 This option specifies whether the AST generator is allowed
6113 to construct if statements with else branches.
6114
6115 =item * ast_build_allow_or
6116
6117 This option specifies whether the AST generator is allowed
6118 to construct if conditions with disjunctions.
6119
6120 =back
6121
6122 =head3 Fine-grained Control over AST Generation
6123
6124 Besides specifying the constraints on the parameters,
6125 an C<isl_ast_build> object can be used to control
6126 various aspects of the AST generation process.
6127 The most prominent way of control is through ``options'',
6128 which can be set using the following function.
6129
6130         #include <isl/ast_build.h>
6131         __isl_give isl_ast_build *
6132         isl_ast_build_set_options(
6133                 __isl_take isl_ast_build *control,
6134                 __isl_take isl_union_map *options);
6135
6136 The options are encoded in an <isl_union_map>.
6137 The domain of this union relation refers to the schedule domain,
6138 i.e., the range of the schedule passed to C<isl_ast_build_ast_from_schedule>.
6139 In the case of nested AST generation (see L</"Nested AST Generation">),
6140 the domain of C<options> should refer to the extra piece of the schedule.
6141 That is, it should be equal to the range of the wrapped relation in the
6142 range of the schedule.
6143 The range of the options can consist of elements in one or more spaces,
6144 the names of which determine the effect of the option.
6145 The values of the range typically also refer to the schedule dimension
6146 to which the option applies.  In case of nested AST generation
6147 (see L</"Nested AST Generation">), these values refer to the position
6148 of the schedule dimension within the innermost AST generation.
6149 The constraints on the domain elements of
6150 the option should only refer to this dimension and earlier dimensions.
6151 We consider the following spaces.
6152
6153 =over
6154
6155 =item C<separation_class>
6156
6157 This space is a wrapped relation between two one dimensional spaces.
6158 The input space represents the schedule dimension to which the option
6159 applies and the output space represents the separation class.
6160 While constructing a loop corresponding to the specified schedule
6161 dimension(s), the AST generator will try to generate separate loops
6162 for domain elements that are assigned different classes.
6163 If only some of the elements are assigned a class, then those elements
6164 that are not assigned any class will be treated as belonging to a class
6165 that is separate from the explicitly assigned classes.
6166 The typical use case for this option is to separate full tiles from
6167 partial tiles.
6168 The other options, described below, are applied after the separation
6169 into classes.
6170
6171 As an example, consider the separation into full and partial tiles
6172 of a tiling of a triangular domain.
6173 Take, for example, the domain
6174
6175         { A[i,j] : 0 <= i,j and i + j <= 100 }
6176
6177 and a tiling into tiles of 10 by 10.  The input to the AST generator
6178 is then the schedule
6179
6180         { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
6181                                                 i + j <= 100 }
6182
6183 Without any options, the following AST is generated
6184
6185         for (int c0 = 0; c0 <= 10; c0 += 1)
6186           for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6187             for (int c2 = 10 * c0;
6188                  c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6189                  c2 += 1)
6190               for (int c3 = 10 * c1;
6191                    c3 <= min(10 * c1 + 9, -c2 + 100);
6192                    c3 += 1)
6193                 A(c2, c3);
6194
6195 Separation into full and partial tiles can be obtained by assigning
6196 a class, say C<0>, to the full tiles.  The full tiles are represented by those
6197 values of the first and second schedule dimensions for which there are
6198 values of the third and fourth dimensions to cover an entire tile.
6199 That is, we need to specify the following option
6200
6201         { [a,b,c,d] -> separation_class[[0]->[0]] :
6202                 exists b': 0 <= 10a,10b' and
6203                            10a+9+10b'+9 <= 100;
6204           [a,b,c,d] -> separation_class[[1]->[0]] :
6205                 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
6206
6207 which simplifies to
6208
6209         { [a, b, c, d] -> separation_class[[1] -> [0]] :
6210                 a >= 0 and b >= 0 and b <= 8 - a;
6211           [a, b, c, d] -> separation_class[[0] -> [0]] :
6212                 a >= 0 and a <= 8 }
6213
6214 With this option, the generated AST is as follows
6215
6216         {
6217           for (int c0 = 0; c0 <= 8; c0 += 1) {
6218             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
6219               for (int c2 = 10 * c0;
6220                    c2 <= 10 * c0 + 9; c2 += 1)
6221                 for (int c3 = 10 * c1;
6222                      c3 <= 10 * c1 + 9; c3 += 1)
6223                   A(c2, c3);
6224             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
6225               for (int c2 = 10 * c0;
6226                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6227                    c2 += 1)
6228                 for (int c3 = 10 * c1;
6229                      c3 <= min(-c2 + 100, 10 * c1 + 9);
6230                      c3 += 1)
6231                   A(c2, c3);
6232           }
6233           for (int c0 = 9; c0 <= 10; c0 += 1)
6234             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6235               for (int c2 = 10 * c0;
6236                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6237                    c2 += 1)
6238                 for (int c3 = 10 * c1;
6239                      c3 <= min(10 * c1 + 9, -c2 + 100);
6240                      c3 += 1)
6241                   A(c2, c3);
6242         }
6243
6244 =item C<separate>
6245
6246 This is a single-dimensional space representing the schedule dimension(s)
6247 to which ``separation'' should be applied.  Separation tries to split
6248 a loop into several pieces if this can avoid the generation of guards
6249 inside the loop.
6250 See also the C<atomic> option.
6251
6252 =item C<atomic>
6253
6254 This is a single-dimensional space representing the schedule dimension(s)
6255 for which the domains should be considered ``atomic''.  That is, the
6256 AST generator will make sure that any given domain space will only appear
6257 in a single loop at the specified level.
6258
6259 Consider the following schedule
6260
6261         { a[i] -> [i] : 0 <= i < 10;
6262           b[i] -> [i+1] : 0 <= i < 10 }
6263
6264 If the following option is specified
6265
6266         { [i] -> separate[x] }
6267
6268 then the following AST will be generated
6269
6270         {
6271           a(0);
6272           for (int c0 = 1; c0 <= 9; c0 += 1) {
6273             a(c0);
6274             b(c0 - 1);
6275           }
6276           b(9);
6277         }
6278
6279 If, on the other hand, the following option is specified
6280
6281         { [i] -> atomic[x] }
6282
6283 then the following AST will be generated
6284
6285         for (int c0 = 0; c0 <= 10; c0 += 1) {
6286           if (c0 <= 9)
6287             a(c0);
6288           if (c0 >= 1)
6289             b(c0 - 1);
6290         }
6291
6292 If neither C<atomic> nor C<separate> is specified, then the AST generator
6293 may produce either of these two results or some intermediate form.
6294
6295 =item C<unroll>
6296
6297 This is a single-dimensional space representing the schedule dimension(s)
6298 that should be I<completely> unrolled.
6299 To obtain a partial unrolling, the user should apply an additional
6300 strip-mining to the schedule and fully unroll the inner loop.
6301
6302 =back
6303
6304 Additional control is available through the following functions.
6305
6306         #include <isl/ast_build.h>
6307         __isl_give isl_ast_build *
6308         isl_ast_build_set_iterators(
6309                 __isl_take isl_ast_build *control,
6310                 __isl_take isl_id_list *iterators);
6311
6312 The function C<isl_ast_build_set_iterators> allows the user to
6313 specify a list of iterator C<isl_id>s to be used as iterators.
6314 If the input schedule is injective, then
6315 the number of elements in this list should be as large as the dimension
6316 of the schedule space, but no direct correspondence should be assumed
6317 between dimensions and elements.
6318 If the input schedule is not injective, then an additional number
6319 of C<isl_id>s equal to the largest dimension of the input domains
6320 may be required.
6321 If the number of provided C<isl_id>s is insufficient, then additional
6322 names are automatically generated.
6323
6324         #include <isl/ast_build.h>
6325         __isl_give isl_ast_build *
6326         isl_ast_build_set_create_leaf(
6327                 __isl_take isl_ast_build *control,
6328                 __isl_give isl_ast_node *(*fn)(
6329                         __isl_take isl_ast_build *build,
6330                         void *user), void *user);
6331
6332 The
6333 C<isl_ast_build_set_create_leaf> function allows for the
6334 specification of a callback that should be called whenever the AST
6335 generator arrives at an element of the schedule domain.
6336 The callback should return an AST node that should be inserted
6337 at the corresponding position of the AST.  The default action (when
6338 the callback is not set) is to continue generating parts of the AST to scan
6339 all the domain elements associated to the schedule domain element
6340 and to insert user nodes, ``calling'' the domain element, for each of them.
6341 The C<build> argument contains the current state of the C<isl_ast_build>.
6342 To ease nested AST generation (see L</"Nested AST Generation">),
6343 all control information that is
6344 specific to the current AST generation such as the options and
6345 the callbacks has been removed from this C<isl_ast_build>.
6346 The callback would typically return the result of a nested
6347 AST generation or a
6348 user defined node created using the following function.
6349
6350         #include <isl/ast.h>
6351         __isl_give isl_ast_node *isl_ast_node_alloc_user(
6352                 __isl_take isl_ast_expr *expr);
6353
6354         #include <isl/ast_build.h>
6355         __isl_give isl_ast_build *
6356         isl_ast_build_set_at_each_domain(
6357                 __isl_take isl_ast_build *build,
6358                 __isl_give isl_ast_node *(*fn)(
6359                         __isl_take isl_ast_node *node,
6360                         __isl_keep isl_ast_build *build,
6361                         void *user), void *user);
6362         __isl_give isl_ast_build *
6363         isl_ast_build_set_before_each_for(
6364                 __isl_take isl_ast_build *build,
6365                 __isl_give isl_id *(*fn)(
6366                         __isl_keep isl_ast_build *build,
6367                         void *user), void *user);
6368         __isl_give isl_ast_build *
6369         isl_ast_build_set_after_each_for(
6370                 __isl_take isl_ast_build *build,
6371                 __isl_give isl_ast_node *(*fn)(
6372                         __isl_take isl_ast_node *node,
6373                         __isl_keep isl_ast_build *build,
6374                         void *user), void *user);
6375
6376 The callback set by C<isl_ast_build_set_at_each_domain> will
6377 be called for each domain AST node.
6378 The callbacks set by C<isl_ast_build_set_before_each_for>
6379 and C<isl_ast_build_set_after_each_for> will be called
6380 for each for AST node.  The first will be called in depth-first
6381 pre-order, while the second will be called in depth-first post-order.
6382 Since C<isl_ast_build_set_before_each_for> is called before the for
6383 node is actually constructed, it is only passed an C<isl_ast_build>.
6384 The returned C<isl_id> will be added as an annotation (using
6385 C<isl_ast_node_set_annotation>) to the constructed for node.
6386 In particular, if the user has also specified an C<after_each_for>
6387 callback, then the annotation can be retrieved from the node passed to
6388 that callback using C<isl_ast_node_get_annotation>.
6389 All callbacks should C<NULL> on failure.
6390 The given C<isl_ast_build> can be used to create new
6391 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
6392 or C<isl_ast_build_call_from_pw_multi_aff>.
6393
6394 =head3 Nested AST Generation
6395
6396 C<isl> allows the user to create an AST within the context
6397 of another AST.  These nested ASTs are created using the
6398 same C<isl_ast_build_ast_from_schedule> function that is used to create the
6399 outer AST.  The C<build> argument should be an C<isl_ast_build>
6400 passed to a callback set by
6401 C<isl_ast_build_set_create_leaf>.
6402 The space of the range of the C<schedule> argument should refer
6403 to this build.  In particular, the space should be a wrapped
6404 relation and the domain of this wrapped relation should be the
6405 same as that of the range of the schedule returned by
6406 C<isl_ast_build_get_schedule> below.
6407 In practice, the new schedule is typically
6408 created by calling C<isl_union_map_range_product> on the old schedule
6409 and some extra piece of the schedule.
6410 The space of the schedule domain is also available from
6411 the C<isl_ast_build>.
6412
6413         #include <isl/ast_build.h>
6414         __isl_give isl_union_map *isl_ast_build_get_schedule(
6415                 __isl_keep isl_ast_build *build);
6416         __isl_give isl_space *isl_ast_build_get_schedule_space(
6417                 __isl_keep isl_ast_build *build);
6418         __isl_give isl_ast_build *isl_ast_build_restrict(
6419                 __isl_take isl_ast_build *build,
6420                 __isl_take isl_set *set);
6421
6422 The C<isl_ast_build_get_schedule> function returns a (partial)
6423 schedule for the domains elements for which part of the AST still needs to
6424 be generated in the current build.
6425 In particular, the domain elements are mapped to those iterations of the loops
6426 enclosing the current point of the AST generation inside which
6427 the domain elements are executed.
6428 No direct correspondence between
6429 the input schedule and this schedule should be assumed.
6430 The space obtained from C<isl_ast_build_get_schedule_space> can be used
6431 to create a set for C<isl_ast_build_restrict> to intersect
6432 with the current build.  In particular, the set passed to
6433 C<isl_ast_build_restrict> can have additional parameters.
6434 The ids of the set dimensions in the space returned by
6435 C<isl_ast_build_get_schedule_space> correspond to the
6436 iterators of the already generated loops.
6437 The user should not rely on the ids of the output dimensions
6438 of the relations in the union relation returned by
6439 C<isl_ast_build_get_schedule> having any particular value.
6440
6441 =head1 Applications
6442
6443 Although C<isl> is mainly meant to be used as a library,
6444 it also contains some basic applications that use some
6445 of the functionality of C<isl>.
6446 The input may be specified in either the L<isl format>
6447 or the L<PolyLib format>.
6448
6449 =head2 C<isl_polyhedron_sample>
6450
6451 C<isl_polyhedron_sample> takes a polyhedron as input and prints
6452 an integer element of the polyhedron, if there is any.
6453 The first column in the output is the denominator and is always
6454 equal to 1.  If the polyhedron contains no integer points,
6455 then a vector of length zero is printed.
6456
6457 =head2 C<isl_pip>
6458
6459 C<isl_pip> takes the same input as the C<example> program
6460 from the C<piplib> distribution, i.e., a set of constraints
6461 on the parameters, a line containing only -1 and finally a set
6462 of constraints on a parametric polyhedron.
6463 The coefficients of the parameters appear in the last columns
6464 (but before the final constant column).
6465 The output is the lexicographic minimum of the parametric polyhedron.
6466 As C<isl> currently does not have its own output format, the output
6467 is just a dump of the internal state.
6468
6469 =head2 C<isl_polyhedron_minimize>
6470
6471 C<isl_polyhedron_minimize> computes the minimum of some linear
6472 or affine objective function over the integer points in a polyhedron.
6473 If an affine objective function
6474 is given, then the constant should appear in the last column.
6475
6476 =head2 C<isl_polytope_scan>
6477
6478 Given a polytope, C<isl_polytope_scan> prints
6479 all integer points in the polytope.
6480
6481 =head2 C<isl_codegen>
6482
6483 Given a schedule, a context set and an options relation,
6484 C<isl_codegen> prints out an AST that scans the domain elements
6485 of the schedule in the order of their image(s) taking into account
6486 the constraints in the context set.