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