add isl_basic_set_max_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         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
2585                 __isl_keep isl_aff *obj, isl_int *opt);
2586
2587 Compute the minimum or maximum of the integer affine expression C<obj>
2588 over the points in C<set>, returning the result in C<opt>.
2589 The return value may be one of C<isl_lp_error>,
2590 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>, in case of
2591 an C<isl_lp_result>.  If the result is an C<isl_val> then
2592 the result is C<NULL> in case of an error, the optimal value in case
2593 there is one, infinity if the problem is unbounded and
2594 NaN if the problem is empty.
2595
2596 =item * Parametric optimization
2597
2598         __isl_give isl_pw_aff *isl_set_dim_min(
2599                 __isl_take isl_set *set, int pos);
2600         __isl_give isl_pw_aff *isl_set_dim_max(
2601                 __isl_take isl_set *set, int pos);
2602         __isl_give isl_pw_aff *isl_map_dim_max(
2603                 __isl_take isl_map *map, int pos);
2604
2605 Compute the minimum or maximum of the given set or output dimension
2606 as a function of the parameters (and input dimensions), but independently
2607 of the other set or output dimensions.
2608 For lexicographic optimization, see L<"Lexicographic Optimization">.
2609
2610 =item * Dual
2611
2612 The following functions compute either the set of (rational) coefficient
2613 values of valid constraints for the given set or the set of (rational)
2614 values satisfying the constraints with coefficients from the given set.
2615 Internally, these two sets of functions perform essentially the
2616 same operations, except that the set of coefficients is assumed to
2617 be a cone, while the set of values may be any polyhedron.
2618 The current implementation is based on the Farkas lemma and
2619 Fourier-Motzkin elimination, but this may change or be made optional
2620 in future.  In particular, future implementations may use different
2621 dualization algorithms or skip the elimination step.
2622
2623         __isl_give isl_basic_set *isl_basic_set_coefficients(
2624                 __isl_take isl_basic_set *bset);
2625         __isl_give isl_basic_set *isl_set_coefficients(
2626                 __isl_take isl_set *set);
2627         __isl_give isl_union_set *isl_union_set_coefficients(
2628                 __isl_take isl_union_set *bset);
2629         __isl_give isl_basic_set *isl_basic_set_solutions(
2630                 __isl_take isl_basic_set *bset);
2631         __isl_give isl_basic_set *isl_set_solutions(
2632                 __isl_take isl_set *set);
2633         __isl_give isl_union_set *isl_union_set_solutions(
2634                 __isl_take isl_union_set *bset);
2635
2636 =item * Power
2637
2638         __isl_give isl_map *isl_map_fixed_power(
2639                 __isl_take isl_map *map, isl_int exp);
2640         __isl_give isl_union_map *isl_union_map_fixed_power(
2641                 __isl_take isl_union_map *umap, isl_int exp);
2642
2643 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2644 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2645 of C<map> is computed.
2646
2647         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2648                 int *exact);
2649         __isl_give isl_union_map *isl_union_map_power(
2650                 __isl_take isl_union_map *umap, int *exact);
2651
2652 Compute a parametric representation for all positive powers I<k> of C<map>.
2653 The result maps I<k> to a nested relation corresponding to the
2654 I<k>th power of C<map>.
2655 The result may be an overapproximation.  If the result is known to be exact,
2656 then C<*exact> is set to C<1>.
2657
2658 =item * Transitive closure
2659
2660         __isl_give isl_map *isl_map_transitive_closure(
2661                 __isl_take isl_map *map, int *exact);
2662         __isl_give isl_union_map *isl_union_map_transitive_closure(
2663                 __isl_take isl_union_map *umap, int *exact);
2664
2665 Compute the transitive closure of C<map>.
2666 The result may be an overapproximation.  If the result is known to be exact,
2667 then C<*exact> is set to C<1>.
2668
2669 =item * Reaching path lengths
2670
2671         __isl_give isl_map *isl_map_reaching_path_lengths(
2672                 __isl_take isl_map *map, int *exact);
2673
2674 Compute a relation that maps each element in the range of C<map>
2675 to the lengths of all paths composed of edges in C<map> that
2676 end up in the given element.
2677 The result may be an overapproximation.  If the result is known to be exact,
2678 then C<*exact> is set to C<1>.
2679 To compute the I<maximal> path length, the resulting relation
2680 should be postprocessed by C<isl_map_lexmax>.
2681 In particular, if the input relation is a dependence relation
2682 (mapping sources to sinks), then the maximal path length corresponds
2683 to the free schedule.
2684 Note, however, that C<isl_map_lexmax> expects the maximum to be
2685 finite, so if the path lengths are unbounded (possibly due to
2686 the overapproximation), then you will get an error message.
2687
2688 =item * Wrapping
2689
2690         __isl_give isl_basic_set *isl_basic_map_wrap(
2691                 __isl_take isl_basic_map *bmap);
2692         __isl_give isl_set *isl_map_wrap(
2693                 __isl_take isl_map *map);
2694         __isl_give isl_union_set *isl_union_map_wrap(
2695                 __isl_take isl_union_map *umap);
2696         __isl_give isl_basic_map *isl_basic_set_unwrap(
2697                 __isl_take isl_basic_set *bset);
2698         __isl_give isl_map *isl_set_unwrap(
2699                 __isl_take isl_set *set);
2700         __isl_give isl_union_map *isl_union_set_unwrap(
2701                 __isl_take isl_union_set *uset);
2702
2703 =item * Flattening
2704
2705 Remove any internal structure of domain (and range) of the given
2706 set or relation.  If there is any such internal structure in the input,
2707 then the name of the space is also removed.
2708
2709         __isl_give isl_basic_set *isl_basic_set_flatten(
2710                 __isl_take isl_basic_set *bset);
2711         __isl_give isl_set *isl_set_flatten(
2712                 __isl_take isl_set *set);
2713         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2714                 __isl_take isl_basic_map *bmap);
2715         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2716                 __isl_take isl_basic_map *bmap);
2717         __isl_give isl_map *isl_map_flatten_range(
2718                 __isl_take isl_map *map);
2719         __isl_give isl_map *isl_map_flatten_domain(
2720                 __isl_take isl_map *map);
2721         __isl_give isl_basic_map *isl_basic_map_flatten(
2722                 __isl_take isl_basic_map *bmap);
2723         __isl_give isl_map *isl_map_flatten(
2724                 __isl_take isl_map *map);
2725
2726         __isl_give isl_map *isl_set_flatten_map(
2727                 __isl_take isl_set *set);
2728
2729 The function above constructs a relation
2730 that maps the input set to a flattened version of the set.
2731
2732 =item * Lifting
2733
2734 Lift the input set to a space with extra dimensions corresponding
2735 to the existentially quantified variables in the input.
2736 In particular, the result lives in a wrapped map where the domain
2737 is the original space and the range corresponds to the original
2738 existentially quantified variables.
2739
2740         __isl_give isl_basic_set *isl_basic_set_lift(
2741                 __isl_take isl_basic_set *bset);
2742         __isl_give isl_set *isl_set_lift(
2743                 __isl_take isl_set *set);
2744         __isl_give isl_union_set *isl_union_set_lift(
2745                 __isl_take isl_union_set *uset);
2746
2747 Given a local space that contains the existentially quantified
2748 variables of a set, a basic relation that, when applied to
2749 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2750 can be constructed using the following function.
2751
2752         #include <isl/local_space.h>
2753         __isl_give isl_basic_map *isl_local_space_lifting(
2754                 __isl_take isl_local_space *ls);
2755
2756 =item * Internal Product
2757
2758         __isl_give isl_basic_map *isl_basic_map_zip(
2759                 __isl_take isl_basic_map *bmap);
2760         __isl_give isl_map *isl_map_zip(
2761                 __isl_take isl_map *map);
2762         __isl_give isl_union_map *isl_union_map_zip(
2763                 __isl_take isl_union_map *umap);
2764
2765 Given a relation with nested relations for domain and range,
2766 interchange the range of the domain with the domain of the range.
2767
2768 =item * Currying
2769
2770         __isl_give isl_basic_map *isl_basic_map_curry(
2771                 __isl_take isl_basic_map *bmap);
2772         __isl_give isl_basic_map *isl_basic_map_uncurry(
2773                 __isl_take isl_basic_map *bmap);
2774         __isl_give isl_map *isl_map_curry(
2775                 __isl_take isl_map *map);
2776         __isl_give isl_map *isl_map_uncurry(
2777                 __isl_take isl_map *map);
2778         __isl_give isl_union_map *isl_union_map_curry(
2779                 __isl_take isl_union_map *umap);
2780         __isl_give isl_union_map *isl_union_map_uncurry(
2781                 __isl_take isl_union_map *umap);
2782
2783 Given a relation with a nested relation for domain,
2784 the C<curry> functions
2785 move the range of the nested relation out of the domain
2786 and use it as the domain of a nested relation in the range,
2787 with the original range as range of this nested relation.
2788 The C<uncurry> functions perform the inverse operation.
2789
2790 =item * Aligning parameters
2791
2792         __isl_give isl_basic_set *isl_basic_set_align_params(
2793                 __isl_take isl_basic_set *bset,
2794                 __isl_take isl_space *model);
2795         __isl_give isl_set *isl_set_align_params(
2796                 __isl_take isl_set *set,
2797                 __isl_take isl_space *model);
2798         __isl_give isl_basic_map *isl_basic_map_align_params(
2799                 __isl_take isl_basic_map *bmap,
2800                 __isl_take isl_space *model);
2801         __isl_give isl_map *isl_map_align_params(
2802                 __isl_take isl_map *map,
2803                 __isl_take isl_space *model);
2804
2805 Change the order of the parameters of the given set or relation
2806 such that the first parameters match those of C<model>.
2807 This may involve the introduction of extra parameters.
2808 All parameters need to be named.
2809
2810 =item * Dimension manipulation
2811
2812         __isl_give isl_basic_set *isl_basic_set_add_dims(
2813                 __isl_take isl_basic_set *bset,
2814                 enum isl_dim_type type, unsigned n);
2815         __isl_give isl_set *isl_set_add_dims(
2816                 __isl_take isl_set *set,
2817                 enum isl_dim_type type, unsigned n);
2818         __isl_give isl_map *isl_map_add_dims(
2819                 __isl_take isl_map *map,
2820                 enum isl_dim_type type, unsigned n);
2821         __isl_give isl_basic_set *isl_basic_set_insert_dims(
2822                 __isl_take isl_basic_set *bset,
2823                 enum isl_dim_type type, unsigned pos,
2824                 unsigned n);
2825         __isl_give isl_basic_map *isl_basic_map_insert_dims(
2826                 __isl_take isl_basic_map *bmap,
2827                 enum isl_dim_type type, unsigned pos,
2828                 unsigned n);
2829         __isl_give isl_set *isl_set_insert_dims(
2830                 __isl_take isl_set *set,
2831                 enum isl_dim_type type, unsigned pos, unsigned n);
2832         __isl_give isl_map *isl_map_insert_dims(
2833                 __isl_take isl_map *map,
2834                 enum isl_dim_type type, unsigned pos, unsigned n);
2835         __isl_give isl_basic_set *isl_basic_set_move_dims(
2836                 __isl_take isl_basic_set *bset,
2837                 enum isl_dim_type dst_type, unsigned dst_pos,
2838                 enum isl_dim_type src_type, unsigned src_pos,
2839                 unsigned n);
2840         __isl_give isl_basic_map *isl_basic_map_move_dims(
2841                 __isl_take isl_basic_map *bmap,
2842                 enum isl_dim_type dst_type, unsigned dst_pos,
2843                 enum isl_dim_type src_type, unsigned src_pos,
2844                 unsigned n);
2845         __isl_give isl_set *isl_set_move_dims(
2846                 __isl_take isl_set *set,
2847                 enum isl_dim_type dst_type, unsigned dst_pos,
2848                 enum isl_dim_type src_type, unsigned src_pos,
2849                 unsigned n);
2850         __isl_give isl_map *isl_map_move_dims(
2851                 __isl_take isl_map *map,
2852                 enum isl_dim_type dst_type, unsigned dst_pos,
2853                 enum isl_dim_type src_type, unsigned src_pos,
2854                 unsigned n);
2855
2856 It is usually not advisable to directly change the (input or output)
2857 space of a set or a relation as this removes the name and the internal
2858 structure of the space.  However, the above functions can be useful
2859 to add new parameters, assuming
2860 C<isl_set_align_params> and C<isl_map_align_params>
2861 are not sufficient.
2862
2863 =back
2864
2865 =head2 Binary Operations
2866
2867 The two arguments of a binary operation not only need to live
2868 in the same C<isl_ctx>, they currently also need to have
2869 the same (number of) parameters.
2870
2871 =head3 Basic Operations
2872
2873 =over
2874
2875 =item * Intersection
2876
2877         __isl_give isl_basic_set *isl_basic_set_intersect_params(
2878                 __isl_take isl_basic_set *bset1,
2879                 __isl_take isl_basic_set *bset2);
2880         __isl_give isl_basic_set *isl_basic_set_intersect(
2881                 __isl_take isl_basic_set *bset1,
2882                 __isl_take isl_basic_set *bset2);
2883         __isl_give isl_set *isl_set_intersect_params(
2884                 __isl_take isl_set *set,
2885                 __isl_take isl_set *params);
2886         __isl_give isl_set *isl_set_intersect(
2887                 __isl_take isl_set *set1,
2888                 __isl_take isl_set *set2);
2889         __isl_give isl_union_set *isl_union_set_intersect_params(
2890                 __isl_take isl_union_set *uset,
2891                 __isl_take isl_set *set);
2892         __isl_give isl_union_map *isl_union_map_intersect_params(
2893                 __isl_take isl_union_map *umap,
2894                 __isl_take isl_set *set);
2895         __isl_give isl_union_set *isl_union_set_intersect(
2896                 __isl_take isl_union_set *uset1,
2897                 __isl_take isl_union_set *uset2);
2898         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2899                 __isl_take isl_basic_map *bmap,
2900                 __isl_take isl_basic_set *bset);
2901         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2902                 __isl_take isl_basic_map *bmap,
2903                 __isl_take isl_basic_set *bset);
2904         __isl_give isl_basic_map *isl_basic_map_intersect(
2905                 __isl_take isl_basic_map *bmap1,
2906                 __isl_take isl_basic_map *bmap2);
2907         __isl_give isl_map *isl_map_intersect_params(
2908                 __isl_take isl_map *map,
2909                 __isl_take isl_set *params);
2910         __isl_give isl_map *isl_map_intersect_domain(
2911                 __isl_take isl_map *map,
2912                 __isl_take isl_set *set);
2913         __isl_give isl_map *isl_map_intersect_range(
2914                 __isl_take isl_map *map,
2915                 __isl_take isl_set *set);
2916         __isl_give isl_map *isl_map_intersect(
2917                 __isl_take isl_map *map1,
2918                 __isl_take isl_map *map2);
2919         __isl_give isl_union_map *isl_union_map_intersect_domain(
2920                 __isl_take isl_union_map *umap,
2921                 __isl_take isl_union_set *uset);
2922         __isl_give isl_union_map *isl_union_map_intersect_range(
2923                 __isl_take isl_union_map *umap,
2924                 __isl_take isl_union_set *uset);
2925         __isl_give isl_union_map *isl_union_map_intersect(
2926                 __isl_take isl_union_map *umap1,
2927                 __isl_take isl_union_map *umap2);
2928
2929 The second argument to the C<_params> functions needs to be
2930 a parametric (basic) set.  For the other functions, a parametric set
2931 for either argument is only allowed if the other argument is
2932 a parametric set as well.
2933
2934 =item * Union
2935
2936         __isl_give isl_set *isl_basic_set_union(
2937                 __isl_take isl_basic_set *bset1,
2938                 __isl_take isl_basic_set *bset2);
2939         __isl_give isl_map *isl_basic_map_union(
2940                 __isl_take isl_basic_map *bmap1,
2941                 __isl_take isl_basic_map *bmap2);
2942         __isl_give isl_set *isl_set_union(
2943                 __isl_take isl_set *set1,
2944                 __isl_take isl_set *set2);
2945         __isl_give isl_map *isl_map_union(
2946                 __isl_take isl_map *map1,
2947                 __isl_take isl_map *map2);
2948         __isl_give isl_union_set *isl_union_set_union(
2949                 __isl_take isl_union_set *uset1,
2950                 __isl_take isl_union_set *uset2);
2951         __isl_give isl_union_map *isl_union_map_union(
2952                 __isl_take isl_union_map *umap1,
2953                 __isl_take isl_union_map *umap2);
2954
2955 =item * Set difference
2956
2957         __isl_give isl_set *isl_set_subtract(
2958                 __isl_take isl_set *set1,
2959                 __isl_take isl_set *set2);
2960         __isl_give isl_map *isl_map_subtract(
2961                 __isl_take isl_map *map1,
2962                 __isl_take isl_map *map2);
2963         __isl_give isl_map *isl_map_subtract_domain(
2964                 __isl_take isl_map *map,
2965                 __isl_take isl_set *dom);
2966         __isl_give isl_map *isl_map_subtract_range(
2967                 __isl_take isl_map *map,
2968                 __isl_take isl_set *dom);
2969         __isl_give isl_union_set *isl_union_set_subtract(
2970                 __isl_take isl_union_set *uset1,
2971                 __isl_take isl_union_set *uset2);
2972         __isl_give isl_union_map *isl_union_map_subtract(
2973                 __isl_take isl_union_map *umap1,
2974                 __isl_take isl_union_map *umap2);
2975         __isl_give isl_union_map *isl_union_map_subtract_domain(
2976                 __isl_take isl_union_map *umap,
2977                 __isl_take isl_union_set *dom);
2978         __isl_give isl_union_map *isl_union_map_subtract_range(
2979                 __isl_take isl_union_map *umap,
2980                 __isl_take isl_union_set *dom);
2981
2982 =item * Application
2983
2984         __isl_give isl_basic_set *isl_basic_set_apply(
2985                 __isl_take isl_basic_set *bset,
2986                 __isl_take isl_basic_map *bmap);
2987         __isl_give isl_set *isl_set_apply(
2988                 __isl_take isl_set *set,
2989                 __isl_take isl_map *map);
2990         __isl_give isl_union_set *isl_union_set_apply(
2991                 __isl_take isl_union_set *uset,
2992                 __isl_take isl_union_map *umap);
2993         __isl_give isl_basic_map *isl_basic_map_apply_domain(
2994                 __isl_take isl_basic_map *bmap1,
2995                 __isl_take isl_basic_map *bmap2);
2996         __isl_give isl_basic_map *isl_basic_map_apply_range(
2997                 __isl_take isl_basic_map *bmap1,
2998                 __isl_take isl_basic_map *bmap2);
2999         __isl_give isl_map *isl_map_apply_domain(
3000                 __isl_take isl_map *map1,
3001                 __isl_take isl_map *map2);
3002         __isl_give isl_union_map *isl_union_map_apply_domain(
3003                 __isl_take isl_union_map *umap1,
3004                 __isl_take isl_union_map *umap2);
3005         __isl_give isl_map *isl_map_apply_range(
3006                 __isl_take isl_map *map1,
3007                 __isl_take isl_map *map2);
3008         __isl_give isl_union_map *isl_union_map_apply_range(
3009                 __isl_take isl_union_map *umap1,
3010                 __isl_take isl_union_map *umap2);
3011
3012 =item * Preimage
3013
3014         __isl_give isl_basic_set *
3015         isl_basic_set_preimage_multi_aff(
3016                 __isl_take isl_basic_set *bset,
3017                 __isl_take isl_multi_aff *ma);
3018         __isl_give isl_set *isl_set_preimage_multi_aff(
3019                 __isl_take isl_set *set,
3020                 __isl_take isl_multi_aff *ma);
3021         __isl_give isl_set *isl_set_preimage_pw_multi_aff(
3022                 __isl_take isl_set *set,
3023                 __isl_take isl_pw_multi_aff *pma);
3024         __isl_give isl_map *isl_map_preimage_domain_multi_aff(
3025                 __isl_take isl_map *map,
3026                 __isl_take isl_multi_aff *ma);
3027         __isl_give isl_union_map *
3028         isl_union_map_preimage_domain_multi_aff(
3029                 __isl_take isl_union_map *umap,
3030                 __isl_take isl_multi_aff *ma);
3031
3032 These functions compute the preimage of the given set or map domain under
3033 the given function.  In other words, the expression is plugged
3034 into the set description or into the domain of the map.
3035 Objects of types C<isl_multi_aff> and C<isl_pw_multi_aff> are described in
3036 L</"Piecewise Multiple Quasi Affine Expressions">.
3037
3038 =item * Cartesian Product
3039
3040         __isl_give isl_set *isl_set_product(
3041                 __isl_take isl_set *set1,
3042                 __isl_take isl_set *set2);
3043         __isl_give isl_union_set *isl_union_set_product(
3044                 __isl_take isl_union_set *uset1,
3045                 __isl_take isl_union_set *uset2);
3046         __isl_give isl_basic_map *isl_basic_map_domain_product(
3047                 __isl_take isl_basic_map *bmap1,
3048                 __isl_take isl_basic_map *bmap2);
3049         __isl_give isl_basic_map *isl_basic_map_range_product(
3050                 __isl_take isl_basic_map *bmap1,
3051                 __isl_take isl_basic_map *bmap2);
3052         __isl_give isl_basic_map *isl_basic_map_product(
3053                 __isl_take isl_basic_map *bmap1,
3054                 __isl_take isl_basic_map *bmap2);
3055         __isl_give isl_map *isl_map_domain_product(
3056                 __isl_take isl_map *map1,
3057                 __isl_take isl_map *map2);
3058         __isl_give isl_map *isl_map_range_product(
3059                 __isl_take isl_map *map1,
3060                 __isl_take isl_map *map2);
3061         __isl_give isl_union_map *isl_union_map_domain_product(
3062                 __isl_take isl_union_map *umap1,
3063                 __isl_take isl_union_map *umap2);
3064         __isl_give isl_union_map *isl_union_map_range_product(
3065                 __isl_take isl_union_map *umap1,
3066                 __isl_take isl_union_map *umap2);
3067         __isl_give isl_map *isl_map_product(
3068                 __isl_take isl_map *map1,
3069                 __isl_take isl_map *map2);
3070         __isl_give isl_union_map *isl_union_map_product(
3071                 __isl_take isl_union_map *umap1,
3072                 __isl_take isl_union_map *umap2);
3073
3074 The above functions compute the cross product of the given
3075 sets or relations.  The domains and ranges of the results
3076 are wrapped maps between domains and ranges of the inputs.
3077 To obtain a ``flat'' product, use the following functions
3078 instead.
3079
3080         __isl_give isl_basic_set *isl_basic_set_flat_product(
3081                 __isl_take isl_basic_set *bset1,
3082                 __isl_take isl_basic_set *bset2);
3083         __isl_give isl_set *isl_set_flat_product(
3084                 __isl_take isl_set *set1,
3085                 __isl_take isl_set *set2);
3086         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
3087                 __isl_take isl_basic_map *bmap1,
3088                 __isl_take isl_basic_map *bmap2);
3089         __isl_give isl_map *isl_map_flat_domain_product(
3090                 __isl_take isl_map *map1,
3091                 __isl_take isl_map *map2);
3092         __isl_give isl_map *isl_map_flat_range_product(
3093                 __isl_take isl_map *map1,
3094                 __isl_take isl_map *map2);
3095         __isl_give isl_union_map *isl_union_map_flat_range_product(
3096                 __isl_take isl_union_map *umap1,
3097                 __isl_take isl_union_map *umap2);
3098         __isl_give isl_basic_map *isl_basic_map_flat_product(
3099                 __isl_take isl_basic_map *bmap1,
3100                 __isl_take isl_basic_map *bmap2);
3101         __isl_give isl_map *isl_map_flat_product(
3102                 __isl_take isl_map *map1,
3103                 __isl_take isl_map *map2);
3104
3105 =item * Simplification
3106
3107         __isl_give isl_basic_set *isl_basic_set_gist(
3108                 __isl_take isl_basic_set *bset,
3109                 __isl_take isl_basic_set *context);
3110         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
3111                 __isl_take isl_set *context);
3112         __isl_give isl_set *isl_set_gist_params(
3113                 __isl_take isl_set *set,
3114                 __isl_take isl_set *context);
3115         __isl_give isl_union_set *isl_union_set_gist(
3116                 __isl_take isl_union_set *uset,
3117                 __isl_take isl_union_set *context);
3118         __isl_give isl_union_set *isl_union_set_gist_params(
3119                 __isl_take isl_union_set *uset,
3120                 __isl_take isl_set *set);
3121         __isl_give isl_basic_map *isl_basic_map_gist(
3122                 __isl_take isl_basic_map *bmap,
3123                 __isl_take isl_basic_map *context);
3124         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
3125                 __isl_take isl_map *context);
3126         __isl_give isl_map *isl_map_gist_params(
3127                 __isl_take isl_map *map,
3128                 __isl_take isl_set *context);
3129         __isl_give isl_map *isl_map_gist_domain(
3130                 __isl_take isl_map *map,
3131                 __isl_take isl_set *context);
3132         __isl_give isl_map *isl_map_gist_range(
3133                 __isl_take isl_map *map,
3134                 __isl_take isl_set *context);
3135         __isl_give isl_union_map *isl_union_map_gist(
3136                 __isl_take isl_union_map *umap,
3137                 __isl_take isl_union_map *context);
3138         __isl_give isl_union_map *isl_union_map_gist_params(
3139                 __isl_take isl_union_map *umap,
3140                 __isl_take isl_set *set);
3141         __isl_give isl_union_map *isl_union_map_gist_domain(
3142                 __isl_take isl_union_map *umap,
3143                 __isl_take isl_union_set *uset);
3144         __isl_give isl_union_map *isl_union_map_gist_range(
3145                 __isl_take isl_union_map *umap,
3146                 __isl_take isl_union_set *uset);
3147
3148 The gist operation returns a set or relation that has the
3149 same intersection with the context as the input set or relation.
3150 Any implicit equality in the intersection is made explicit in the result,
3151 while all inequalities that are redundant with respect to the intersection
3152 are removed.
3153 In case of union sets and relations, the gist operation is performed
3154 per space.
3155
3156 =back
3157
3158 =head3 Lexicographic Optimization
3159
3160 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
3161 the following functions
3162 compute a set that contains the lexicographic minimum or maximum
3163 of the elements in C<set> (or C<bset>) for those values of the parameters
3164 that satisfy C<dom>.
3165 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3166 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
3167 has no elements.
3168 In other words, the union of the parameter values
3169 for which the result is non-empty and of C<*empty>
3170 is equal to C<dom>.
3171
3172         __isl_give isl_set *isl_basic_set_partial_lexmin(
3173                 __isl_take isl_basic_set *bset,
3174                 __isl_take isl_basic_set *dom,
3175                 __isl_give isl_set **empty);
3176         __isl_give isl_set *isl_basic_set_partial_lexmax(
3177                 __isl_take isl_basic_set *bset,
3178                 __isl_take isl_basic_set *dom,
3179                 __isl_give isl_set **empty);
3180         __isl_give isl_set *isl_set_partial_lexmin(
3181                 __isl_take isl_set *set, __isl_take isl_set *dom,
3182                 __isl_give isl_set **empty);
3183         __isl_give isl_set *isl_set_partial_lexmax(
3184                 __isl_take isl_set *set, __isl_take isl_set *dom,
3185                 __isl_give isl_set **empty);
3186
3187 Given a (basic) set C<set> (or C<bset>), the following functions simply
3188 return a set containing the lexicographic minimum or maximum
3189 of the elements in C<set> (or C<bset>).
3190 In case of union sets, the optimum is computed per space.
3191
3192         __isl_give isl_set *isl_basic_set_lexmin(
3193                 __isl_take isl_basic_set *bset);
3194         __isl_give isl_set *isl_basic_set_lexmax(
3195                 __isl_take isl_basic_set *bset);
3196         __isl_give isl_set *isl_set_lexmin(
3197                 __isl_take isl_set *set);
3198         __isl_give isl_set *isl_set_lexmax(
3199                 __isl_take isl_set *set);
3200         __isl_give isl_union_set *isl_union_set_lexmin(
3201                 __isl_take isl_union_set *uset);
3202         __isl_give isl_union_set *isl_union_set_lexmax(
3203                 __isl_take isl_union_set *uset);
3204
3205 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
3206 the following functions
3207 compute a relation that maps each element of C<dom>
3208 to the single lexicographic minimum or maximum
3209 of the elements that are associated to that same
3210 element in C<map> (or C<bmap>).
3211 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3212 that contains the elements in C<dom> that do not map
3213 to any elements in C<map> (or C<bmap>).
3214 In other words, the union of the domain of the result and of C<*empty>
3215 is equal to C<dom>.
3216
3217         __isl_give isl_map *isl_basic_map_partial_lexmax(
3218                 __isl_take isl_basic_map *bmap,
3219                 __isl_take isl_basic_set *dom,
3220                 __isl_give isl_set **empty);
3221         __isl_give isl_map *isl_basic_map_partial_lexmin(
3222                 __isl_take isl_basic_map *bmap,
3223                 __isl_take isl_basic_set *dom,
3224                 __isl_give isl_set **empty);
3225         __isl_give isl_map *isl_map_partial_lexmax(
3226                 __isl_take isl_map *map, __isl_take isl_set *dom,
3227                 __isl_give isl_set **empty);
3228         __isl_give isl_map *isl_map_partial_lexmin(
3229                 __isl_take isl_map *map, __isl_take isl_set *dom,
3230                 __isl_give isl_set **empty);
3231
3232 Given a (basic) map C<map> (or C<bmap>), the following functions simply
3233 return a map mapping each element in the domain of
3234 C<map> (or C<bmap>) to the lexicographic minimum or maximum
3235 of all elements associated to that element.
3236 In case of union relations, the optimum is computed per space.
3237
3238         __isl_give isl_map *isl_basic_map_lexmin(
3239                 __isl_take isl_basic_map *bmap);
3240         __isl_give isl_map *isl_basic_map_lexmax(
3241                 __isl_take isl_basic_map *bmap);
3242         __isl_give isl_map *isl_map_lexmin(
3243                 __isl_take isl_map *map);
3244         __isl_give isl_map *isl_map_lexmax(
3245                 __isl_take isl_map *map);
3246         __isl_give isl_union_map *isl_union_map_lexmin(
3247                 __isl_take isl_union_map *umap);
3248         __isl_give isl_union_map *isl_union_map_lexmax(
3249                 __isl_take isl_union_map *umap);
3250
3251 The following functions return their result in the form of
3252 a piecewise multi-affine expression
3253 (See L<"Piecewise Multiple Quasi Affine Expressions">),
3254 but are otherwise equivalent to the corresponding functions
3255 returning a basic set or relation.
3256
3257         __isl_give isl_pw_multi_aff *
3258         isl_basic_map_lexmin_pw_multi_aff(
3259                 __isl_take isl_basic_map *bmap);
3260         __isl_give isl_pw_multi_aff *
3261         isl_basic_set_partial_lexmin_pw_multi_aff(
3262                 __isl_take isl_basic_set *bset,
3263                 __isl_take isl_basic_set *dom,
3264                 __isl_give isl_set **empty);
3265         __isl_give isl_pw_multi_aff *
3266         isl_basic_set_partial_lexmax_pw_multi_aff(
3267                 __isl_take isl_basic_set *bset,
3268                 __isl_take isl_basic_set *dom,
3269                 __isl_give isl_set **empty);
3270         __isl_give isl_pw_multi_aff *
3271         isl_basic_map_partial_lexmin_pw_multi_aff(
3272                 __isl_take isl_basic_map *bmap,
3273                 __isl_take isl_basic_set *dom,
3274                 __isl_give isl_set **empty);
3275         __isl_give isl_pw_multi_aff *
3276         isl_basic_map_partial_lexmax_pw_multi_aff(
3277                 __isl_take isl_basic_map *bmap,
3278                 __isl_take isl_basic_set *dom,
3279                 __isl_give isl_set **empty);
3280         __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
3281                 __isl_take isl_set *set);
3282         __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
3283                 __isl_take isl_set *set);
3284         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
3285                 __isl_take isl_map *map);
3286         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
3287                 __isl_take isl_map *map);
3288
3289 =head2 Lists
3290
3291 Lists are defined over several element types, including
3292 C<isl_val>, C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_constraint>,
3293 C<isl_basic_set>, C<isl_set>, C<isl_ast_expr> and C<isl_ast_node>.
3294 Here we take lists of C<isl_set>s as an example.
3295 Lists can be created, copied, modified and freed using the following functions.
3296
3297         #include <isl/list.h>
3298         __isl_give isl_set_list *isl_set_list_from_set(
3299                 __isl_take isl_set *el);
3300         __isl_give isl_set_list *isl_set_list_alloc(
3301                 isl_ctx *ctx, int n);
3302         __isl_give isl_set_list *isl_set_list_copy(
3303                 __isl_keep isl_set_list *list);
3304         __isl_give isl_set_list *isl_set_list_insert(
3305                 __isl_take isl_set_list *list, unsigned pos,
3306                 __isl_take isl_set *el);
3307         __isl_give isl_set_list *isl_set_list_add(
3308                 __isl_take isl_set_list *list,
3309                 __isl_take isl_set *el);
3310         __isl_give isl_set_list *isl_set_list_drop(
3311                 __isl_take isl_set_list *list,
3312                 unsigned first, unsigned n);
3313         __isl_give isl_set_list *isl_set_list_set_set(
3314                 __isl_take isl_set_list *list, int index,
3315                 __isl_take isl_set *set);
3316         __isl_give isl_set_list *isl_set_list_concat(
3317                 __isl_take isl_set_list *list1,
3318                 __isl_take isl_set_list *list2);
3319         __isl_give isl_set_list *isl_set_list_sort(
3320                 __isl_take isl_set_list *list,
3321                 int (*cmp)(__isl_keep isl_set *a,
3322                         __isl_keep isl_set *b, void *user),
3323                 void *user);
3324         void *isl_set_list_free(__isl_take isl_set_list *list);
3325
3326 C<isl_set_list_alloc> creates an empty list with a capacity for
3327 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
3328 element.
3329
3330 Lists can be inspected using the following functions.
3331
3332         #include <isl/list.h>
3333         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
3334         int isl_set_list_n_set(__isl_keep isl_set_list *list);
3335         __isl_give isl_set *isl_set_list_get_set(
3336                 __isl_keep isl_set_list *list, int index);
3337         int isl_set_list_foreach(__isl_keep isl_set_list *list,
3338                 int (*fn)(__isl_take isl_set *el, void *user),
3339                 void *user);
3340         int isl_set_list_foreach_scc(__isl_keep isl_set_list *list,
3341                 int (*follows)(__isl_keep isl_set *a,
3342                         __isl_keep isl_set *b, void *user),
3343                 void *follows_user
3344                 int (*fn)(__isl_take isl_set *el, void *user),
3345                 void *fn_user);
3346
3347 The function C<isl_set_list_foreach_scc> calls C<fn> on each of the
3348 strongly connected components of the graph with as vertices the elements
3349 of C<list> and a directed edge from vertex C<b> to vertex C<a>
3350 iff C<follows(a, b)> returns C<1>.  The callbacks C<follows> and C<fn>
3351 should return C<-1> on error.
3352
3353 Lists can be printed using
3354
3355         #include <isl/list.h>
3356         __isl_give isl_printer *isl_printer_print_set_list(
3357                 __isl_take isl_printer *p,
3358                 __isl_keep isl_set_list *list);
3359
3360 =head2 Multiple Values
3361
3362 An C<isl_multi_val> object represents a sequence of zero or more values,
3363 living in a set space.
3364
3365 An C<isl_multi_val> can be constructed from an C<isl_val_list>
3366 using the following function
3367
3368         #include <isl/val.h>
3369         __isl_give isl_multi_val *isl_multi_val_from_val_list(
3370                 __isl_take isl_space *space,
3371                 __isl_take isl_val_list *list);
3372
3373 The zero multiple value (with value zero for each set dimension)
3374 can be created using the following function.
3375
3376         #include <isl/val.h>
3377         __isl_give isl_multi_val *isl_multi_val_zero(
3378                 __isl_take isl_space *space);
3379
3380 Multiple values can be copied and freed using
3381
3382         #include <isl/val.h>
3383         __isl_give isl_multi_val *isl_multi_val_copy(
3384                 __isl_keep isl_multi_val *mv);
3385         void *isl_multi_val_free(__isl_take isl_multi_val *mv);
3386
3387 They can be inspected using
3388
3389         #include <isl/val.h>
3390         isl_ctx *isl_multi_val_get_ctx(
3391                 __isl_keep isl_multi_val *mv);
3392         unsigned isl_multi_val_dim(__isl_keep isl_multi_val *mv,
3393                 enum isl_dim_type type);
3394         __isl_give isl_val *isl_multi_val_get_val(
3395                 __isl_keep isl_multi_val *mv, int pos);
3396         const char *isl_multi_val_get_tuple_name(
3397                 __isl_keep isl_multi_val *mv,
3398                 enum isl_dim_type type);
3399
3400 They can be modified using
3401
3402         #include <isl/val.h>
3403         __isl_give isl_multi_val *isl_multi_val_set_val(
3404                 __isl_take isl_multi_val *mv, int pos,
3405                 __isl_take isl_val *val);
3406         __isl_give isl_multi_val *isl_multi_val_set_dim_name(
3407                 __isl_take isl_multi_val *mv,
3408                 enum isl_dim_type type, unsigned pos, const char *s);
3409         __isl_give isl_multi_val *isl_multi_val_set_tuple_name(
3410                 __isl_take isl_multi_val *mv,
3411                 enum isl_dim_type type, const char *s);
3412         __isl_give isl_multi_val *isl_multi_val_set_tuple_id(
3413                 __isl_take isl_multi_val *mv,
3414                 enum isl_dim_type type, __isl_take isl_id *id);
3415
3416         __isl_give isl_multi_val *isl_multi_val_insert_dims(
3417                 __isl_take isl_multi_val *mv,
3418                 enum isl_dim_type type, unsigned first, unsigned n);
3419         __isl_give isl_multi_val *isl_multi_val_add_dims(
3420                 __isl_take isl_multi_val *mv,
3421                 enum isl_dim_type type, unsigned n);
3422         __isl_give isl_multi_val *isl_multi_val_drop_dims(
3423                 __isl_take isl_multi_val *mv,
3424                 enum isl_dim_type type, unsigned first, unsigned n);
3425
3426 Operations include
3427
3428         #include <isl/val.h>
3429         __isl_give isl_multi_val *isl_multi_val_align_params(
3430                 __isl_take isl_multi_val *mv,
3431                 __isl_take isl_space *model);
3432         __isl_give isl_multi_val *isl_multi_val_range_splice(
3433                 __isl_take isl_multi_val *mv1, unsigned pos,
3434                 __isl_take isl_multi_val *mv2);
3435         __isl_give isl_multi_val *isl_multi_val_range_product(
3436                 __isl_take isl_multi_val *mv1,
3437                 __isl_take isl_multi_val *mv2);
3438         __isl_give isl_multi_val *isl_multi_val_flat_range_product(
3439                 __isl_take isl_multi_val *mv1,
3440                 __isl_take isl_multi_aff *mv2);
3441         __isl_give isl_multi_val *isl_multi_val_add_val(
3442                 __isl_take isl_multi_val *mv,
3443                 __isl_take isl_val *v);
3444         __isl_give isl_multi_val *isl_multi_val_mod_val(
3445                 __isl_take isl_multi_val *mv,
3446                 __isl_take isl_val *v);
3447         __isl_give isl_multi_val *isl_multi_val_scale_val(
3448                 __isl_take isl_multi_val *mv,
3449                 __isl_take isl_val *v);
3450
3451 =head2 Vectors
3452
3453 Vectors can be created, copied and freed using the following functions.
3454
3455         #include <isl/vec.h>
3456         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
3457                 unsigned size);
3458         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
3459         void *isl_vec_free(__isl_take isl_vec *vec);
3460
3461 Note that the elements of a newly created vector may have arbitrary values.
3462 The elements can be changed and inspected using the following functions.
3463
3464         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
3465         int isl_vec_size(__isl_keep isl_vec *vec);
3466         int isl_vec_get_element(__isl_keep isl_vec *vec,
3467                 int pos, isl_int *v);
3468         __isl_give isl_val *isl_vec_get_element_val(
3469                 __isl_keep isl_vec *vec, int pos);
3470         __isl_give isl_vec *isl_vec_set_element(
3471                 __isl_take isl_vec *vec, int pos, isl_int v);
3472         __isl_give isl_vec *isl_vec_set_element_si(
3473                 __isl_take isl_vec *vec, int pos, int v);
3474         __isl_give isl_vec *isl_vec_set_element_val(
3475                 __isl_take isl_vec *vec, int pos,
3476                 __isl_take isl_val *v);
3477         __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec,
3478                 isl_int v);
3479         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
3480                 int v);
3481         __isl_give isl_vec *isl_vec_set_val(
3482                 __isl_take isl_vec *vec, __isl_take isl_val *v);
3483         __isl_give isl_vec *isl_vec_fdiv_r(__isl_take isl_vec *vec,
3484                 isl_int m);
3485
3486 C<isl_vec_get_element> will return a negative value if anything went wrong.
3487 In that case, the value of C<*v> is undefined.
3488
3489 The following function can be used to concatenate two vectors.
3490
3491         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
3492                 __isl_take isl_vec *vec2);
3493
3494 =head2 Matrices
3495
3496 Matrices can be created, copied and freed using the following functions.
3497
3498         #include <isl/mat.h>
3499         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
3500                 unsigned n_row, unsigned n_col);
3501         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
3502         void *isl_mat_free(__isl_take isl_mat *mat);
3503
3504 Note that the elements of a newly created matrix may have arbitrary values.
3505 The elements can be changed and inspected using the following functions.
3506
3507         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
3508         int isl_mat_rows(__isl_keep isl_mat *mat);
3509         int isl_mat_cols(__isl_keep isl_mat *mat);
3510         int isl_mat_get_element(__isl_keep isl_mat *mat,
3511                 int row, int col, isl_int *v);
3512         __isl_give isl_val *isl_mat_get_element_val(
3513                 __isl_keep isl_mat *mat, int row, int col);
3514         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
3515                 int row, int col, isl_int v);
3516         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
3517                 int row, int col, int v);
3518         __isl_give isl_mat *isl_mat_set_element_val(
3519                 __isl_take isl_mat *mat, int row, int col,
3520                 __isl_take isl_val *v);
3521
3522 C<isl_mat_get_element> will return a negative value if anything went wrong.
3523 In that case, the value of C<*v> is undefined.
3524
3525 The following function can be used to compute the (right) inverse
3526 of a matrix, i.e., a matrix such that the product of the original
3527 and the inverse (in that order) is a multiple of the identity matrix.
3528 The input matrix is assumed to be of full row-rank.
3529
3530         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
3531
3532 The following function can be used to compute the (right) kernel
3533 (or null space) of a matrix, i.e., a matrix such that the product of
3534 the original and the kernel (in that order) is the zero matrix.
3535
3536         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
3537
3538 =head2 Piecewise Quasi Affine Expressions
3539
3540 The zero quasi affine expression or the quasi affine expression
3541 that is equal to a specified dimension on a given domain can be created using
3542
3543         __isl_give isl_aff *isl_aff_zero_on_domain(
3544                 __isl_take isl_local_space *ls);
3545         __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
3546                 __isl_take isl_local_space *ls);
3547         __isl_give isl_aff *isl_aff_var_on_domain(
3548                 __isl_take isl_local_space *ls,
3549                 enum isl_dim_type type, unsigned pos);
3550         __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
3551                 __isl_take isl_local_space *ls,
3552                 enum isl_dim_type type, unsigned pos);
3553
3554 Note that the space in which the resulting objects live is a map space
3555 with the given space as domain and a one-dimensional range.
3556
3557 An empty piecewise quasi affine expression (one with no cells)
3558 or a piecewise quasi affine expression with a single cell can
3559 be created using the following functions.
3560
3561         #include <isl/aff.h>
3562         __isl_give isl_pw_aff *isl_pw_aff_empty(
3563                 __isl_take isl_space *space);
3564         __isl_give isl_pw_aff *isl_pw_aff_alloc(
3565                 __isl_take isl_set *set, __isl_take isl_aff *aff);
3566         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
3567                 __isl_take isl_aff *aff);
3568
3569 A piecewise quasi affine expression that is equal to 1 on a set
3570 and 0 outside the set can be created using the following function.
3571
3572         #include <isl/aff.h>
3573         __isl_give isl_pw_aff *isl_set_indicator_function(
3574                 __isl_take isl_set *set);
3575
3576 Quasi affine expressions can be copied and freed using
3577
3578         #include <isl/aff.h>
3579         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
3580         void *isl_aff_free(__isl_take isl_aff *aff);
3581
3582         __isl_give isl_pw_aff *isl_pw_aff_copy(
3583                 __isl_keep isl_pw_aff *pwaff);
3584         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
3585
3586 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
3587 using the following function.  The constraint is required to have
3588 a non-zero coefficient for the specified dimension.
3589
3590         #include <isl/constraint.h>
3591         __isl_give isl_aff *isl_constraint_get_bound(
3592                 __isl_keep isl_constraint *constraint,
3593                 enum isl_dim_type type, int pos);
3594
3595 The entire affine expression of the constraint can also be extracted
3596 using the following function.
3597
3598         #include <isl/constraint.h>
3599         __isl_give isl_aff *isl_constraint_get_aff(
3600                 __isl_keep isl_constraint *constraint);
3601
3602 Conversely, an equality constraint equating
3603 the affine expression to zero or an inequality constraint enforcing
3604 the affine expression to be non-negative, can be constructed using
3605
3606         __isl_give isl_constraint *isl_equality_from_aff(
3607                 __isl_take isl_aff *aff);
3608         __isl_give isl_constraint *isl_inequality_from_aff(
3609                 __isl_take isl_aff *aff);
3610
3611 The expression can be inspected using
3612
3613         #include <isl/aff.h>
3614         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
3615         int isl_aff_dim(__isl_keep isl_aff *aff,
3616                 enum isl_dim_type type);
3617         __isl_give isl_local_space *isl_aff_get_domain_local_space(
3618                 __isl_keep isl_aff *aff);
3619         __isl_give isl_local_space *isl_aff_get_local_space(
3620                 __isl_keep isl_aff *aff);
3621         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3622                 enum isl_dim_type type, unsigned pos);
3623         const char *isl_pw_aff_get_dim_name(
3624                 __isl_keep isl_pw_aff *pa,
3625                 enum isl_dim_type type, unsigned pos);
3626         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3627                 enum isl_dim_type type, unsigned pos);
3628         __isl_give isl_id *isl_pw_aff_get_dim_id(
3629                 __isl_keep isl_pw_aff *pa,
3630                 enum isl_dim_type type, unsigned pos);
3631         __isl_give isl_id *isl_pw_aff_get_tuple_id(
3632                 __isl_keep isl_pw_aff *pa,
3633                 enum isl_dim_type type);
3634         int isl_aff_get_constant(__isl_keep isl_aff *aff,
3635                 isl_int *v);
3636         __isl_give isl_val *isl_aff_get_constant_val(
3637                 __isl_keep isl_aff *aff);
3638         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
3639                 enum isl_dim_type type, int pos, isl_int *v);
3640         __isl_give isl_val *isl_aff_get_coefficient_val(
3641                 __isl_keep isl_aff *aff,
3642                 enum isl_dim_type type, int pos);
3643         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
3644                 isl_int *v);
3645         __isl_give isl_val *isl_aff_get_denominator_val(
3646                 __isl_keep isl_aff *aff);
3647         __isl_give isl_aff *isl_aff_get_div(
3648                 __isl_keep isl_aff *aff, int pos);
3649
3650         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3651         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3652                 int (*fn)(__isl_take isl_set *set,
3653                           __isl_take isl_aff *aff,
3654                           void *user), void *user);
3655
3656         int isl_aff_is_cst(__isl_keep isl_aff *aff);
3657         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3658
3659         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3660                 enum isl_dim_type type, unsigned first, unsigned n);
3661         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3662                 enum isl_dim_type type, unsigned first, unsigned n);
3663
3664         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3665         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3666                 enum isl_dim_type type);
3667         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3668
3669 It can be modified using
3670
3671         #include <isl/aff.h>
3672         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3673                 __isl_take isl_pw_aff *pwaff,
3674                 enum isl_dim_type type, __isl_take isl_id *id);
3675         __isl_give isl_aff *isl_aff_set_dim_name(
3676                 __isl_take isl_aff *aff, enum isl_dim_type type,
3677                 unsigned pos, const char *s);
3678         __isl_give isl_aff *isl_aff_set_dim_id(
3679                 __isl_take isl_aff *aff, enum isl_dim_type type,
3680                 unsigned pos, __isl_take isl_id *id);
3681         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3682                 __isl_take isl_pw_aff *pma,
3683                 enum isl_dim_type type, unsigned pos,
3684                 __isl_take isl_id *id);
3685         __isl_give isl_aff *isl_aff_set_constant(
3686                 __isl_take isl_aff *aff, isl_int v);
3687         __isl_give isl_aff *isl_aff_set_constant_si(
3688                 __isl_take isl_aff *aff, int v);
3689         __isl_give isl_aff *isl_aff_set_constant_val(
3690                 __isl_take isl_aff *aff, __isl_take isl_val *v);
3691         __isl_give isl_aff *isl_aff_set_coefficient(
3692                 __isl_take isl_aff *aff,
3693                 enum isl_dim_type type, int pos, isl_int v);
3694         __isl_give isl_aff *isl_aff_set_coefficient_si(
3695                 __isl_take isl_aff *aff,
3696                 enum isl_dim_type type, int pos, int v);
3697         __isl_give isl_aff *isl_aff_set_coefficient_val(
3698                 __isl_take isl_aff *aff,
3699                 enum isl_dim_type type, int pos,
3700                 __isl_take isl_val *v);
3701         __isl_give isl_aff *isl_aff_set_denominator(
3702                 __isl_take isl_aff *aff, isl_int v);
3703
3704         __isl_give isl_aff *isl_aff_add_constant(
3705                 __isl_take isl_aff *aff, isl_int v);
3706         __isl_give isl_aff *isl_aff_add_constant_si(
3707                 __isl_take isl_aff *aff, int v);
3708         __isl_give isl_aff *isl_aff_add_constant_val(
3709                 __isl_take isl_aff *aff, __isl_take isl_val *v);
3710         __isl_give isl_aff *isl_aff_add_constant_num(
3711                 __isl_take isl_aff *aff, isl_int v);
3712         __isl_give isl_aff *isl_aff_add_constant_num_si(
3713                 __isl_take isl_aff *aff, int v);
3714         __isl_give isl_aff *isl_aff_add_coefficient(
3715                 __isl_take isl_aff *aff,
3716                 enum isl_dim_type type, int pos, isl_int v);
3717         __isl_give isl_aff *isl_aff_add_coefficient_si(
3718                 __isl_take isl_aff *aff,
3719                 enum isl_dim_type type, int pos, int v);
3720         __isl_give isl_aff *isl_aff_add_coefficient_val(
3721                 __isl_take isl_aff *aff,
3722                 enum isl_dim_type type, int pos,
3723                 __isl_take isl_val *v);
3724
3725         __isl_give isl_aff *isl_aff_insert_dims(
3726                 __isl_take isl_aff *aff,
3727                 enum isl_dim_type type, unsigned first, unsigned n);
3728         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3729                 __isl_take isl_pw_aff *pwaff,
3730                 enum isl_dim_type type, unsigned first, unsigned n);
3731         __isl_give isl_aff *isl_aff_add_dims(
3732                 __isl_take isl_aff *aff,
3733                 enum isl_dim_type type, unsigned n);
3734         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3735                 __isl_take isl_pw_aff *pwaff,
3736                 enum isl_dim_type type, unsigned n);
3737         __isl_give isl_aff *isl_aff_drop_dims(
3738                 __isl_take isl_aff *aff,
3739                 enum isl_dim_type type, unsigned first, unsigned n);
3740         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
3741                 __isl_take isl_pw_aff *pwaff,
3742                 enum isl_dim_type type, unsigned first, unsigned n);
3743
3744 Note that C<isl_aff_set_constant>, C<isl_aff_set_constant_si>,
3745 C<isl_aff_set_coefficient> and C<isl_aff_set_coefficient_si>
3746 set the I<numerator> of the constant or coefficient, while
3747 C<isl_aff_set_constant_val> and C<isl_aff_set_coefficient_val> set
3748 the constant or coefficient as a whole.
3749 The C<add_constant> and C<add_coefficient> functions add an integer
3750 or rational value to
3751 the possibly rational constant or coefficient.
3752 The C<add_constant_num> functions add an integer value to
3753 the numerator.
3754
3755 To check whether an affine expressions is obviously zero
3756 or obviously equal to some other affine expression, use
3757
3758         #include <isl/aff.h>
3759         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3760         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3761                 __isl_keep isl_aff *aff2);
3762         int isl_pw_aff_plain_is_equal(
3763                 __isl_keep isl_pw_aff *pwaff1,
3764                 __isl_keep isl_pw_aff *pwaff2);
3765
3766 Operations include
3767
3768         #include <isl/aff.h>
3769         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
3770                 __isl_take isl_aff *aff2);
3771         __isl_give isl_pw_aff *isl_pw_aff_add(
3772                 __isl_take isl_pw_aff *pwaff1,
3773                 __isl_take isl_pw_aff *pwaff2);
3774         __isl_give isl_pw_aff *isl_pw_aff_min(
3775                 __isl_take isl_pw_aff *pwaff1,
3776                 __isl_take isl_pw_aff *pwaff2);
3777         __isl_give isl_pw_aff *isl_pw_aff_max(
3778                 __isl_take isl_pw_aff *pwaff1,
3779                 __isl_take isl_pw_aff *pwaff2);
3780         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
3781                 __isl_take isl_aff *aff2);
3782         __isl_give isl_pw_aff *isl_pw_aff_sub(
3783                 __isl_take isl_pw_aff *pwaff1,
3784                 __isl_take isl_pw_aff *pwaff2);
3785         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
3786         __isl_give isl_pw_aff *isl_pw_aff_neg(
3787                 __isl_take isl_pw_aff *pwaff);
3788         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
3789         __isl_give isl_pw_aff *isl_pw_aff_ceil(
3790                 __isl_take isl_pw_aff *pwaff);
3791         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
3792         __isl_give isl_pw_aff *isl_pw_aff_floor(
3793                 __isl_take isl_pw_aff *pwaff);
3794         __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
3795                 isl_int mod);
3796         __isl_give isl_aff *isl_aff_mod_val(__isl_take isl_aff *aff,
3797                 __isl_take isl_val *mod);
3798         __isl_give isl_pw_aff *isl_pw_aff_mod(
3799                 __isl_take isl_pw_aff *pwaff, isl_int mod);
3800         __isl_give isl_pw_aff *isl_pw_aff_mod_val(
3801                 __isl_take isl_pw_aff *pa,
3802                 __isl_take isl_val *mod);
3803         __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
3804                 isl_int f);
3805         __isl_give isl_aff *isl_aff_scale_val(__isl_take isl_aff *aff,
3806                 __isl_take isl_val *v);
3807         __isl_give isl_pw_aff *isl_pw_aff_scale(
3808                 __isl_take isl_pw_aff *pwaff, isl_int f);
3809         __isl_give isl_pw_aff *isl_pw_aff_scale_val(
3810                 __isl_take isl_pw_aff *pa, __isl_take isl_val *v);
3811         __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
3812                 isl_int f);
3813         __isl_give isl_aff *isl_aff_scale_down_ui(
3814                 __isl_take isl_aff *aff, unsigned f);
3815         __isl_give isl_aff *isl_aff_scale_down_val(
3816                 __isl_take isl_aff *aff, __isl_take isl_val *v);
3817         __isl_give isl_pw_aff *isl_pw_aff_scale_down(
3818                 __isl_take isl_pw_aff *pwaff, isl_int f);
3819         __isl_give isl_pw_aff *isl_pw_aff_scale_down_val(
3820                 __isl_take isl_pw_aff *pa,
3821                 __isl_take isl_val *f);
3822
3823         __isl_give isl_pw_aff *isl_pw_aff_list_min(
3824                 __isl_take isl_pw_aff_list *list);
3825         __isl_give isl_pw_aff *isl_pw_aff_list_max(
3826                 __isl_take isl_pw_aff_list *list);
3827
3828         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
3829                 __isl_take isl_pw_aff *pwqp);
3830
3831         __isl_give isl_aff *isl_aff_align_params(
3832                 __isl_take isl_aff *aff,
3833                 __isl_take isl_space *model);
3834         __isl_give isl_pw_aff *isl_pw_aff_align_params(
3835                 __isl_take isl_pw_aff *pwaff,
3836                 __isl_take isl_space *model);
3837
3838         __isl_give isl_aff *isl_aff_project_domain_on_params(
3839                 __isl_take isl_aff *aff);
3840
3841         __isl_give isl_aff *isl_aff_gist_params(
3842                 __isl_take isl_aff *aff,
3843                 __isl_take isl_set *context);
3844         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
3845                 __isl_take isl_set *context);
3846         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
3847                 __isl_take isl_pw_aff *pwaff,
3848                 __isl_take isl_set *context);
3849         __isl_give isl_pw_aff *isl_pw_aff_gist(
3850                 __isl_take isl_pw_aff *pwaff,
3851                 __isl_take isl_set *context);
3852
3853         __isl_give isl_set *isl_pw_aff_domain(
3854                 __isl_take isl_pw_aff *pwaff);
3855         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
3856                 __isl_take isl_pw_aff *pa,
3857                 __isl_take isl_set *set);
3858         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
3859                 __isl_take isl_pw_aff *pa,
3860                 __isl_take isl_set *set);
3861
3862         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3863                 __isl_take isl_aff *aff2);
3864         __isl_give isl_aff *isl_aff_div(__isl_take isl_aff *aff1,
3865                 __isl_take isl_aff *aff2);
3866         __isl_give isl_pw_aff *isl_pw_aff_mul(
3867                 __isl_take isl_pw_aff *pwaff1,
3868                 __isl_take isl_pw_aff *pwaff2);
3869         __isl_give isl_pw_aff *isl_pw_aff_div(
3870                 __isl_take isl_pw_aff *pa1,
3871                 __isl_take isl_pw_aff *pa2);
3872         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
3873                 __isl_take isl_pw_aff *pa1,
3874                 __isl_take isl_pw_aff *pa2);
3875         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
3876                 __isl_take isl_pw_aff *pa1,
3877                 __isl_take isl_pw_aff *pa2);
3878
3879 When multiplying two affine expressions, at least one of the two needs
3880 to be a constant.  Similarly, when dividing an affine expression by another,
3881 the second expression needs to be a constant.
3882 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
3883 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
3884 remainder.
3885
3886         #include <isl/aff.h>
3887         __isl_give isl_aff *isl_aff_pullback_multi_aff(
3888                 __isl_take isl_aff *aff,
3889                 __isl_take isl_multi_aff *ma);
3890         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
3891                 __isl_take isl_pw_aff *pa,
3892                 __isl_take isl_multi_aff *ma);
3893         __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
3894                 __isl_take isl_pw_aff *pa,
3895                 __isl_take isl_pw_multi_aff *pma);
3896
3897 These functions precompose the input expression by the given
3898 C<isl_multi_aff> or C<isl_pw_multi_aff>.  In other words,
3899 the C<isl_multi_aff> or C<isl_pw_multi_aff> is plugged
3900 into the (piecewise) affine expression.
3901 Objects of type C<isl_multi_aff> are described in
3902 L</"Piecewise Multiple Quasi Affine Expressions">.
3903
3904         #include <isl/aff.h>
3905         __isl_give isl_basic_set *isl_aff_zero_basic_set(
3906                 __isl_take isl_aff *aff);
3907         __isl_give isl_basic_set *isl_aff_neg_basic_set(
3908                 __isl_take isl_aff *aff);
3909         __isl_give isl_basic_set *isl_aff_le_basic_set(
3910                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3911         __isl_give isl_basic_set *isl_aff_ge_basic_set(
3912                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3913         __isl_give isl_set *isl_pw_aff_eq_set(
3914                 __isl_take isl_pw_aff *pwaff1,
3915                 __isl_take isl_pw_aff *pwaff2);
3916         __isl_give isl_set *isl_pw_aff_ne_set(
3917                 __isl_take isl_pw_aff *pwaff1,
3918                 __isl_take isl_pw_aff *pwaff2);
3919         __isl_give isl_set *isl_pw_aff_le_set(
3920                 __isl_take isl_pw_aff *pwaff1,
3921                 __isl_take isl_pw_aff *pwaff2);
3922         __isl_give isl_set *isl_pw_aff_lt_set(
3923                 __isl_take isl_pw_aff *pwaff1,
3924                 __isl_take isl_pw_aff *pwaff2);
3925         __isl_give isl_set *isl_pw_aff_ge_set(
3926                 __isl_take isl_pw_aff *pwaff1,
3927                 __isl_take isl_pw_aff *pwaff2);
3928         __isl_give isl_set *isl_pw_aff_gt_set(
3929                 __isl_take isl_pw_aff *pwaff1,
3930                 __isl_take isl_pw_aff *pwaff2);
3931
3932         __isl_give isl_set *isl_pw_aff_list_eq_set(
3933                 __isl_take isl_pw_aff_list *list1,
3934                 __isl_take isl_pw_aff_list *list2);
3935         __isl_give isl_set *isl_pw_aff_list_ne_set(
3936                 __isl_take isl_pw_aff_list *list1,
3937                 __isl_take isl_pw_aff_list *list2);
3938         __isl_give isl_set *isl_pw_aff_list_le_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_lt_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_ge_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_gt_set(
3948                 __isl_take isl_pw_aff_list *list1,
3949                 __isl_take isl_pw_aff_list *list2);
3950
3951 The function C<isl_aff_neg_basic_set> returns a basic set
3952 containing those elements in the domain space
3953 of C<aff> where C<aff> is negative.
3954 The function C<isl_aff_ge_basic_set> returns a basic set
3955 containing those elements in the shared space
3956 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3957 The function C<isl_pw_aff_ge_set> returns a set
3958 containing those elements in the shared domain
3959 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3960 The functions operating on C<isl_pw_aff_list> apply the corresponding
3961 C<isl_pw_aff> function to each pair of elements in the two lists.
3962
3963         #include <isl/aff.h>
3964         __isl_give isl_set *isl_pw_aff_nonneg_set(
3965                 __isl_take isl_pw_aff *pwaff);
3966         __isl_give isl_set *isl_pw_aff_zero_set(
3967                 __isl_take isl_pw_aff *pwaff);
3968         __isl_give isl_set *isl_pw_aff_non_zero_set(
3969                 __isl_take isl_pw_aff *pwaff);
3970
3971 The function C<isl_pw_aff_nonneg_set> returns a set
3972 containing those elements in the domain
3973 of C<pwaff> where C<pwaff> is non-negative.
3974
3975         #include <isl/aff.h>
3976         __isl_give isl_pw_aff *isl_pw_aff_cond(
3977                 __isl_take isl_pw_aff *cond,
3978                 __isl_take isl_pw_aff *pwaff_true,
3979                 __isl_take isl_pw_aff *pwaff_false);
3980
3981 The function C<isl_pw_aff_cond> performs a conditional operator
3982 and returns an expression that is equal to C<pwaff_true>
3983 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
3984 where C<cond> is zero.
3985
3986         #include <isl/aff.h>
3987         __isl_give isl_pw_aff *isl_pw_aff_union_min(
3988                 __isl_take isl_pw_aff *pwaff1,
3989                 __isl_take isl_pw_aff *pwaff2);
3990         __isl_give isl_pw_aff *isl_pw_aff_union_max(
3991                 __isl_take isl_pw_aff *pwaff1,
3992                 __isl_take isl_pw_aff *pwaff2);
3993         __isl_give isl_pw_aff *isl_pw_aff_union_add(
3994                 __isl_take isl_pw_aff *pwaff1,
3995                 __isl_take isl_pw_aff *pwaff2);
3996
3997 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3998 expression with a domain that is the union of those of C<pwaff1> and
3999 C<pwaff2> and such that on each cell, the quasi-affine expression is
4000 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
4001 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
4002 associated expression is the defined one.
4003
4004 An expression can be read from input using
4005
4006         #include <isl/aff.h>
4007         __isl_give isl_aff *isl_aff_read_from_str(
4008                 isl_ctx *ctx, const char *str);
4009         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
4010                 isl_ctx *ctx, const char *str);
4011
4012 An expression can be printed using
4013
4014         #include <isl/aff.h>
4015         __isl_give isl_printer *isl_printer_print_aff(
4016                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
4017
4018         __isl_give isl_printer *isl_printer_print_pw_aff(
4019                 __isl_take isl_printer *p,
4020                 __isl_keep isl_pw_aff *pwaff);
4021
4022 =head2 Piecewise Multiple Quasi Affine Expressions
4023
4024 An C<isl_multi_aff> object represents a sequence of
4025 zero or more affine expressions, all defined on the same domain space.
4026 Similarly, an C<isl_multi_pw_aff> object represents a sequence of
4027 zero or more piecewise affine expressions.
4028
4029 An C<isl_multi_aff> can be constructed from a single
4030 C<isl_aff> or an C<isl_aff_list> using the
4031 following functions.  Similarly for C<isl_multi_pw_aff>.
4032
4033         #include <isl/aff.h>
4034         __isl_give isl_multi_aff *isl_multi_aff_from_aff(
4035                 __isl_take isl_aff *aff);
4036         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
4037                 __isl_take isl_pw_aff *pa);
4038         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
4039                 __isl_take isl_space *space,
4040                 __isl_take isl_aff_list *list);
4041
4042 An empty piecewise multiple quasi affine expression (one with no cells),
4043 the zero piecewise multiple quasi affine expression (with value zero
4044 for each output dimension),
4045 a piecewise multiple quasi affine expression with a single cell (with
4046 either a universe or a specified domain) or
4047 a zero-dimensional piecewise multiple quasi affine expression
4048 on a given domain
4049 can be created using the following functions.
4050
4051         #include <isl/aff.h>
4052         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
4053                 __isl_take isl_space *space);
4054         __isl_give isl_multi_aff *isl_multi_aff_zero(
4055                 __isl_take isl_space *space);
4056         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
4057                 __isl_take isl_space *space);
4058         __isl_give isl_multi_aff *isl_multi_aff_identity(
4059                 __isl_take isl_space *space);
4060         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
4061                 __isl_take isl_space *space);
4062         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
4063                 __isl_take isl_space *space);
4064         __isl_give isl_pw_multi_aff *
4065         isl_pw_multi_aff_from_multi_aff(
4066                 __isl_take isl_multi_aff *ma);
4067         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
4068                 __isl_take isl_set *set,
4069                 __isl_take isl_multi_aff *maff);
4070         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
4071                 __isl_take isl_set *set);
4072
4073         __isl_give isl_union_pw_multi_aff *
4074         isl_union_pw_multi_aff_empty(
4075                 __isl_take isl_space *space);
4076         __isl_give isl_union_pw_multi_aff *
4077         isl_union_pw_multi_aff_add_pw_multi_aff(
4078                 __isl_take isl_union_pw_multi_aff *upma,
4079                 __isl_take isl_pw_multi_aff *pma);
4080         __isl_give isl_union_pw_multi_aff *
4081         isl_union_pw_multi_aff_from_domain(
4082                 __isl_take isl_union_set *uset);
4083
4084 A piecewise multiple quasi affine expression can also be initialized
4085 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
4086 and the C<isl_map> is single-valued.
4087 In case of a conversion from an C<isl_union_set> or an C<isl_union_map>
4088 to an C<isl_union_pw_multi_aff>, these properties need to hold in each space.
4089
4090         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
4091                 __isl_take isl_set *set);
4092         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
4093                 __isl_take isl_map *map);
4094
4095         __isl_give isl_union_pw_multi_aff *
4096         isl_union_pw_multi_aff_from_union_set(
4097                 __isl_take isl_union_set *uset);
4098         __isl_give isl_union_pw_multi_aff *
4099         isl_union_pw_multi_aff_from_union_map(
4100                 __isl_take isl_union_map *umap);
4101
4102 Multiple quasi affine expressions can be copied and freed using
4103
4104         #include <isl/aff.h>
4105         __isl_give isl_multi_aff *isl_multi_aff_copy(
4106                 __isl_keep isl_multi_aff *maff);
4107         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
4108
4109         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
4110                 __isl_keep isl_pw_multi_aff *pma);
4111         void *isl_pw_multi_aff_free(
4112                 __isl_take isl_pw_multi_aff *pma);
4113
4114         __isl_give isl_union_pw_multi_aff *
4115         isl_union_pw_multi_aff_copy(
4116                 __isl_keep isl_union_pw_multi_aff *upma);
4117         void *isl_union_pw_multi_aff_free(
4118                 __isl_take isl_union_pw_multi_aff *upma);
4119
4120         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
4121                 __isl_keep isl_multi_pw_aff *mpa);
4122         void *isl_multi_pw_aff_free(
4123                 __isl_take isl_multi_pw_aff *mpa);
4124
4125 The expression can be inspected using
4126
4127         #include <isl/aff.h>
4128         isl_ctx *isl_multi_aff_get_ctx(
4129                 __isl_keep isl_multi_aff *maff);
4130         isl_ctx *isl_pw_multi_aff_get_ctx(
4131                 __isl_keep isl_pw_multi_aff *pma);
4132         isl_ctx *isl_union_pw_multi_aff_get_ctx(
4133                 __isl_keep isl_union_pw_multi_aff *upma);
4134         isl_ctx *isl_multi_pw_aff_get_ctx(
4135                 __isl_keep isl_multi_pw_aff *mpa);
4136         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
4137                 enum isl_dim_type type);
4138         unsigned isl_pw_multi_aff_dim(
4139                 __isl_keep isl_pw_multi_aff *pma,
4140                 enum isl_dim_type type);
4141         unsigned isl_multi_pw_aff_dim(
4142                 __isl_keep isl_multi_pw_aff *mpa,
4143                 enum isl_dim_type type);
4144         __isl_give isl_aff *isl_multi_aff_get_aff(
4145                 __isl_keep isl_multi_aff *multi, int pos);
4146         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
4147                 __isl_keep isl_pw_multi_aff *pma, int pos);
4148         __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
4149                 __isl_keep isl_multi_pw_aff *mpa, int pos);
4150         const char *isl_pw_multi_aff_get_dim_name(
4151                 __isl_keep isl_pw_multi_aff *pma,
4152                 enum isl_dim_type type, unsigned pos);
4153         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
4154                 __isl_keep isl_pw_multi_aff *pma,
4155                 enum isl_dim_type type, unsigned pos);
4156         const char *isl_multi_aff_get_tuple_name(
4157                 __isl_keep isl_multi_aff *multi,
4158                 enum isl_dim_type type);
4159         int isl_pw_multi_aff_has_tuple_name(
4160                 __isl_keep isl_pw_multi_aff *pma,
4161                 enum isl_dim_type type);
4162         const char *isl_pw_multi_aff_get_tuple_name(
4163                 __isl_keep isl_pw_multi_aff *pma,
4164                 enum isl_dim_type type);
4165         int isl_pw_multi_aff_has_tuple_id(
4166                 __isl_keep isl_pw_multi_aff *pma,
4167                 enum isl_dim_type type);
4168         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
4169                 __isl_keep isl_pw_multi_aff *pma,
4170                 enum isl_dim_type type);
4171
4172         int isl_pw_multi_aff_foreach_piece(
4173                 __isl_keep isl_pw_multi_aff *pma,
4174                 int (*fn)(__isl_take isl_set *set,
4175                             __isl_take isl_multi_aff *maff,
4176                             void *user), void *user);
4177
4178         int isl_union_pw_multi_aff_foreach_pw_multi_aff(
4179                 __isl_keep isl_union_pw_multi_aff *upma,
4180                 int (*fn)(__isl_take isl_pw_multi_aff *pma,
4181                             void *user), void *user);
4182
4183 It can be modified using
4184
4185         #include <isl/aff.h>
4186         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
4187                 __isl_take isl_multi_aff *multi, int pos,
4188                 __isl_take isl_aff *aff);
4189         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
4190                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
4191                 __isl_take isl_pw_aff *pa);
4192         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
4193                 __isl_take isl_multi_aff *maff,
4194                 enum isl_dim_type type, unsigned pos, const char *s);
4195         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
4196                 __isl_take isl_multi_aff *maff,
4197                 enum isl_dim_type type, const char *s);
4198         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
4199                 __isl_take isl_multi_aff *maff,
4200                 enum isl_dim_type type, __isl_take isl_id *id);
4201         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
4202                 __isl_take isl_pw_multi_aff *pma,
4203                 enum isl_dim_type type, __isl_take isl_id *id);
4204
4205         __isl_give isl_multi_pw_aff *
4206         isl_multi_pw_aff_set_dim_name(
4207                 __isl_take isl_multi_pw_aff *mpa,
4208                 enum isl_dim_type type, unsigned pos, const char *s);
4209         __isl_give isl_multi_pw_aff *
4210         isl_multi_pw_aff_set_tuple_name(
4211                 __isl_take isl_multi_pw_aff *mpa,
4212                 enum isl_dim_type type, const char *s);
4213
4214         __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
4215                 __isl_take isl_multi_aff *ma,
4216                 enum isl_dim_type type, unsigned first, unsigned n);
4217         __isl_give isl_multi_aff *isl_multi_aff_add_dims(
4218                 __isl_take isl_multi_aff *ma,
4219                 enum isl_dim_type type, unsigned n);
4220         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
4221                 __isl_take isl_multi_aff *maff,
4222                 enum isl_dim_type type, unsigned first, unsigned n);
4223         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
4224                 __isl_take isl_pw_multi_aff *pma,
4225                 enum isl_dim_type type, unsigned first, unsigned n);
4226
4227         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
4228                 __isl_take isl_multi_pw_aff *mpa,
4229                 enum isl_dim_type type, unsigned first, unsigned n);
4230         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
4231                 __isl_take isl_multi_pw_aff *mpa,
4232                 enum isl_dim_type type, unsigned n);
4233
4234 To check whether two multiple affine expressions are
4235 obviously equal to each other, use
4236
4237         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
4238                 __isl_keep isl_multi_aff *maff2);
4239         int isl_pw_multi_aff_plain_is_equal(
4240                 __isl_keep isl_pw_multi_aff *pma1,
4241                 __isl_keep isl_pw_multi_aff *pma2);
4242
4243 Operations include
4244
4245         #include <isl/aff.h>
4246         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
4247                 __isl_take isl_pw_multi_aff *pma1,
4248                 __isl_take isl_pw_multi_aff *pma2);
4249         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
4250                 __isl_take isl_pw_multi_aff *pma1,
4251                 __isl_take isl_pw_multi_aff *pma2);
4252         __isl_give isl_multi_aff *isl_multi_aff_add(
4253                 __isl_take isl_multi_aff *maff1,
4254                 __isl_take isl_multi_aff *maff2);
4255         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
4256                 __isl_take isl_pw_multi_aff *pma1,
4257                 __isl_take isl_pw_multi_aff *pma2);
4258         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
4259                 __isl_take isl_union_pw_multi_aff *upma1,
4260                 __isl_take isl_union_pw_multi_aff *upma2);
4261         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
4262                 __isl_take isl_pw_multi_aff *pma1,
4263                 __isl_take isl_pw_multi_aff *pma2);
4264         __isl_give isl_multi_aff *isl_multi_aff_sub(
4265                 __isl_take isl_multi_aff *ma1,
4266                 __isl_take isl_multi_aff *ma2);
4267         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
4268                 __isl_take isl_pw_multi_aff *pma1,
4269                 __isl_take isl_pw_multi_aff *pma2);
4270         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_sub(
4271                 __isl_take isl_union_pw_multi_aff *upma1,
4272                 __isl_take isl_union_pw_multi_aff *upma2);
4273
4274 C<isl_multi_aff_sub> subtracts the second argument from the first.
4275
4276         __isl_give isl_multi_aff *isl_multi_aff_scale(
4277                 __isl_take isl_multi_aff *maff,
4278                 isl_int f);
4279         __isl_give isl_multi_aff *isl_multi_aff_scale_val(
4280                 __isl_take isl_multi_aff *ma,
4281                 __isl_take isl_val *v);
4282         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_val(
4283                 __isl_take isl_pw_multi_aff *pma,
4284                 __isl_take isl_val *v);
4285         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_scale_val(
4286                 __isl_take isl_multi_pw_aff *mpa,
4287                 __isl_take isl_val *v);
4288         __isl_give isl_multi_aff *isl_multi_aff_scale_vec(
4289                 __isl_take isl_multi_aff *ma,
4290                 __isl_take isl_vec *v);
4291         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_vec(
4292                 __isl_take isl_pw_multi_aff *pma,
4293                 __isl_take isl_vec *v);
4294         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_scale_vec(
4295                 __isl_take isl_union_pw_multi_aff *upma,
4296                 __isl_take isl_vec *v);
4297
4298 C<isl_multi_aff_scale_vec> scales the first elements of C<ma>
4299 by the corresponding elements of C<v>.
4300
4301         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
4302                 __isl_take isl_pw_multi_aff *pma,
4303                 __isl_take isl_set *set);
4304         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
4305                 __isl_take isl_pw_multi_aff *pma,
4306                 __isl_take isl_set *set);
4307         __isl_give isl_union_pw_multi_aff *
4308         isl_union_pw_multi_aff_intersect_domain(
4309                 __isl_take isl_union_pw_multi_aff *upma,
4310                 __isl_take isl_union_set *uset);
4311         __isl_give isl_multi_aff *isl_multi_aff_lift(
4312                 __isl_take isl_multi_aff *maff,
4313                 __isl_give isl_local_space **ls);
4314         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
4315                 __isl_take isl_pw_multi_aff *pma);
4316         __isl_give isl_multi_aff *isl_multi_aff_align_params(
4317                 __isl_take isl_multi_aff *multi,
4318                 __isl_take isl_space *model);
4319         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
4320                 __isl_take isl_pw_multi_aff *pma,
4321                 __isl_take isl_space *model);
4322         __isl_give isl_pw_multi_aff *
4323         isl_pw_multi_aff_project_domain_on_params(
4324                 __isl_take isl_pw_multi_aff *pma);
4325         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
4326                 __isl_take isl_multi_aff *maff,
4327                 __isl_take isl_set *context);
4328         __isl_give isl_multi_aff *isl_multi_aff_gist(
4329                 __isl_take isl_multi_aff *maff,
4330                 __isl_take isl_set *context);
4331         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
4332                 __isl_take isl_pw_multi_aff *pma,
4333                 __isl_take isl_set *set);
4334         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
4335                 __isl_take isl_pw_multi_aff *pma,
4336                 __isl_take isl_set *set);
4337         __isl_give isl_set *isl_pw_multi_aff_domain(
4338                 __isl_take isl_pw_multi_aff *pma);
4339         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
4340                 __isl_take isl_union_pw_multi_aff *upma);
4341         __isl_give isl_multi_aff *isl_multi_aff_range_splice(
4342                 __isl_take isl_multi_aff *ma1, unsigned pos,
4343                 __isl_take isl_multi_aff *ma2);
4344         __isl_give isl_multi_aff *isl_multi_aff_splice(
4345                 __isl_take isl_multi_aff *ma1,
4346                 unsigned in_pos, unsigned out_pos,
4347                 __isl_take isl_multi_aff *ma2);
4348         __isl_give isl_multi_aff *isl_multi_aff_range_product(
4349                 __isl_take isl_multi_aff *ma1,
4350                 __isl_take isl_multi_aff *ma2);
4351         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
4352                 __isl_take isl_multi_aff *ma1,
4353                 __isl_take isl_multi_aff *ma2);
4354         __isl_give isl_multi_aff *isl_multi_aff_product(
4355                 __isl_take isl_multi_aff *ma1,
4356                 __isl_take isl_multi_aff *ma2);
4357         __isl_give isl_pw_multi_aff *
4358         isl_pw_multi_aff_range_product(
4359                 __isl_take isl_pw_multi_aff *pma1,
4360                 __isl_take isl_pw_multi_aff *pma2);
4361         __isl_give isl_pw_multi_aff *
4362         isl_pw_multi_aff_flat_range_product(
4363                 __isl_take isl_pw_multi_aff *pma1,
4364                 __isl_take isl_pw_multi_aff *pma2);
4365         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
4366                 __isl_take isl_pw_multi_aff *pma1,
4367                 __isl_take isl_pw_multi_aff *pma2);
4368         __isl_give isl_union_pw_multi_aff *
4369         isl_union_pw_multi_aff_flat_range_product(
4370                 __isl_take isl_union_pw_multi_aff *upma1,
4371                 __isl_take isl_union_pw_multi_aff *upma2);
4372         __isl_give isl_multi_pw_aff *
4373         isl_multi_pw_aff_range_splice(
4374                 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
4375                 __isl_take isl_multi_pw_aff *mpa2);
4376         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
4377                 __isl_take isl_multi_pw_aff *mpa1,
4378                 unsigned in_pos, unsigned out_pos,
4379                 __isl_take isl_multi_pw_aff *mpa2);
4380         __isl_give isl_multi_pw_aff *
4381         isl_multi_pw_aff_range_product(
4382                 __isl_take isl_multi_pw_aff *mpa1,
4383                 __isl_take isl_multi_pw_aff *mpa2);
4384         __isl_give isl_multi_pw_aff *
4385         isl_multi_pw_aff_flat_range_product(
4386                 __isl_take isl_multi_pw_aff *mpa1,
4387                 __isl_take isl_multi_pw_aff *mpa2);
4388
4389 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
4390 then it is assigned the local space that lies at the basis of
4391 the lifting applied.
4392
4393         #include <isl/aff.h>
4394         __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
4395                 __isl_take isl_multi_aff *ma1,
4396                 __isl_take isl_multi_aff *ma2);
4397         __isl_give isl_pw_multi_aff *
4398         isl_pw_multi_aff_pullback_multi_aff(
4399                 __isl_take isl_pw_multi_aff *pma,
4400                 __isl_take isl_multi_aff *ma);
4401         __isl_give isl_pw_multi_aff *
4402         isl_pw_multi_aff_pullback_pw_multi_aff(
4403                 __isl_take isl_pw_multi_aff *pma1,
4404                 __isl_take isl_pw_multi_aff *pma2);
4405
4406 The function C<isl_multi_aff_pullback_multi_aff> precomposes C<ma1> by C<ma2>.
4407 In other words, C<ma2> is plugged
4408 into C<ma1>.
4409
4410         __isl_give isl_set *isl_multi_aff_lex_le_set(
4411                 __isl_take isl_multi_aff *ma1,
4412                 __isl_take isl_multi_aff *ma2);
4413         __isl_give isl_set *isl_multi_aff_lex_ge_set(
4414                 __isl_take isl_multi_aff *ma1,
4415                 __isl_take isl_multi_aff *ma2);
4416
4417 The function C<isl_multi_aff_lex_le_set> returns a set
4418 containing those elements in the shared domain space
4419 where C<ma1> is lexicographically smaller than or
4420 equal to C<ma2>.
4421
4422 An expression can be read from input using
4423
4424         #include <isl/aff.h>
4425         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
4426                 isl_ctx *ctx, const char *str);
4427         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
4428                 isl_ctx *ctx, const char *str);
4429         __isl_give isl_union_pw_multi_aff *
4430         isl_union_pw_multi_aff_read_from_str(
4431                 isl_ctx *ctx, const char *str);
4432
4433 An expression can be printed using
4434
4435         #include <isl/aff.h>
4436         __isl_give isl_printer *isl_printer_print_multi_aff(
4437                 __isl_take isl_printer *p,
4438                 __isl_keep isl_multi_aff *maff);
4439         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
4440                 __isl_take isl_printer *p,
4441                 __isl_keep isl_pw_multi_aff *pma);
4442         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
4443                 __isl_take isl_printer *p,
4444                 __isl_keep isl_union_pw_multi_aff *upma);
4445         __isl_give isl_printer *isl_printer_print_multi_pw_aff(
4446                 __isl_take isl_printer *p,
4447                 __isl_keep isl_multi_pw_aff *mpa);
4448
4449 =head2 Points
4450
4451 Points are elements of a set.  They can be used to construct
4452 simple sets (boxes) or they can be used to represent the
4453 individual elements of a set.
4454 The zero point (the origin) can be created using
4455
4456         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
4457
4458 The coordinates of a point can be inspected, set and changed
4459 using
4460
4461         int isl_point_get_coordinate(__isl_keep isl_point *pnt,
4462                 enum isl_dim_type type, int pos, isl_int *v);
4463         __isl_give isl_val *isl_point_get_coordinate_val(
4464                 __isl_keep isl_point *pnt,
4465                 enum isl_dim_type type, int pos);
4466         __isl_give isl_point *isl_point_set_coordinate(
4467                 __isl_take isl_point *pnt,
4468                 enum isl_dim_type type, int pos, isl_int v);
4469         __isl_give isl_point *isl_point_set_coordinate_val(
4470                 __isl_take isl_point *pnt,
4471                 enum isl_dim_type type, int pos,
4472                 __isl_take isl_val *v);
4473
4474         __isl_give isl_point *isl_point_add_ui(
4475                 __isl_take isl_point *pnt,
4476                 enum isl_dim_type type, int pos, unsigned val);
4477         __isl_give isl_point *isl_point_sub_ui(
4478                 __isl_take isl_point *pnt,
4479                 enum isl_dim_type type, int pos, unsigned val);
4480
4481 Other properties can be obtained using
4482
4483         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
4484
4485 Points can be copied or freed using
4486
4487         __isl_give isl_point *isl_point_copy(
4488                 __isl_keep isl_point *pnt);
4489         void isl_point_free(__isl_take isl_point *pnt);
4490
4491 A singleton set can be created from a point using
4492
4493         __isl_give isl_basic_set *isl_basic_set_from_point(
4494                 __isl_take isl_point *pnt);
4495         __isl_give isl_set *isl_set_from_point(
4496                 __isl_take isl_point *pnt);
4497
4498 and a box can be created from two opposite extremal points using
4499
4500         __isl_give isl_basic_set *isl_basic_set_box_from_points(
4501                 __isl_take isl_point *pnt1,
4502                 __isl_take isl_point *pnt2);
4503         __isl_give isl_set *isl_set_box_from_points(
4504                 __isl_take isl_point *pnt1,
4505                 __isl_take isl_point *pnt2);
4506
4507 All elements of a B<bounded> (union) set can be enumerated using
4508 the following functions.
4509
4510         int isl_set_foreach_point(__isl_keep isl_set *set,
4511                 int (*fn)(__isl_take isl_point *pnt, void *user),
4512                 void *user);
4513         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
4514                 int (*fn)(__isl_take isl_point *pnt, void *user),
4515                 void *user);
4516
4517 The function C<fn> is called for each integer point in
4518 C<set> with as second argument the last argument of
4519 the C<isl_set_foreach_point> call.  The function C<fn>
4520 should return C<0> on success and C<-1> on failure.
4521 In the latter case, C<isl_set_foreach_point> will stop
4522 enumerating and return C<-1> as well.
4523 If the enumeration is performed successfully and to completion,
4524 then C<isl_set_foreach_point> returns C<0>.
4525
4526 To obtain a single point of a (basic) set, use
4527
4528         __isl_give isl_point *isl_basic_set_sample_point(
4529                 __isl_take isl_basic_set *bset);
4530         __isl_give isl_point *isl_set_sample_point(
4531                 __isl_take isl_set *set);
4532
4533 If C<set> does not contain any (integer) points, then the
4534 resulting point will be ``void'', a property that can be
4535 tested using
4536
4537         int isl_point_is_void(__isl_keep isl_point *pnt);
4538
4539 =head2 Piecewise Quasipolynomials
4540
4541 A piecewise quasipolynomial is a particular kind of function that maps
4542 a parametric point to a rational value.
4543 More specifically, a quasipolynomial is a polynomial expression in greatest
4544 integer parts of affine expressions of parameters and variables.
4545 A piecewise quasipolynomial is a subdivision of a given parametric
4546 domain into disjoint cells with a quasipolynomial associated to
4547 each cell.  The value of the piecewise quasipolynomial at a given
4548 point is the value of the quasipolynomial associated to the cell
4549 that contains the point.  Outside of the union of cells,
4550 the value is assumed to be zero.
4551 For example, the piecewise quasipolynomial
4552
4553         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
4554
4555 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
4556 A given piecewise quasipolynomial has a fixed domain dimension.
4557 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
4558 defined over different domains.
4559 Piecewise quasipolynomials are mainly used by the C<barvinok>
4560 library for representing the number of elements in a parametric set or map.
4561 For example, the piecewise quasipolynomial above represents
4562 the number of points in the map
4563
4564         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
4565
4566 =head3 Input and Output
4567
4568 Piecewise quasipolynomials can be read from input using
4569
4570         __isl_give isl_union_pw_qpolynomial *
4571         isl_union_pw_qpolynomial_read_from_str(
4572                 isl_ctx *ctx, const char *str);
4573
4574 Quasipolynomials and piecewise quasipolynomials can be printed
4575 using the following functions.
4576
4577         __isl_give isl_printer *isl_printer_print_qpolynomial(
4578                 __isl_take isl_printer *p,
4579                 __isl_keep isl_qpolynomial *qp);
4580
4581         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
4582                 __isl_take isl_printer *p,
4583                 __isl_keep isl_pw_qpolynomial *pwqp);
4584
4585         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
4586                 __isl_take isl_printer *p,
4587                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4588
4589 The output format of the printer
4590 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4591 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
4592 is supported.
4593 In case of printing in C<ISL_FORMAT_C>, the user may want
4594 to set the names of all dimensions
4595
4596         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
4597                 __isl_take isl_qpolynomial *qp,
4598                 enum isl_dim_type type, unsigned pos,
4599                 const char *s);
4600         __isl_give isl_pw_qpolynomial *
4601         isl_pw_qpolynomial_set_dim_name(
4602                 __isl_take isl_pw_qpolynomial *pwqp,
4603                 enum isl_dim_type type, unsigned pos,
4604                 const char *s);
4605
4606 =head3 Creating New (Piecewise) Quasipolynomials
4607
4608 Some simple quasipolynomials can be created using the following functions.
4609 More complicated quasipolynomials can be created by applying
4610 operations such as addition and multiplication
4611 on the resulting quasipolynomials
4612
4613         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
4614                 __isl_take isl_space *domain);
4615         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
4616                 __isl_take isl_space *domain);
4617         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
4618                 __isl_take isl_space *domain);
4619         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
4620                 __isl_take isl_space *domain);
4621         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
4622                 __isl_take isl_space *domain);
4623         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
4624                 __isl_take isl_space *domain,
4625                 const isl_int n, const isl_int d);
4626         __isl_give isl_qpolynomial *isl_qpolynomial_val_on_domain(
4627                 __isl_take isl_space *domain,
4628                 __isl_take isl_val *val);
4629         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
4630                 __isl_take isl_space *domain,
4631                 enum isl_dim_type type, unsigned pos);
4632         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
4633                 __isl_take isl_aff *aff);
4634
4635 Note that the space in which a quasipolynomial lives is a map space
4636 with a one-dimensional range.  The C<domain> argument in some of
4637 the functions above corresponds to the domain of this map space.
4638
4639 The zero piecewise quasipolynomial or a piecewise quasipolynomial
4640 with a single cell can be created using the following functions.
4641 Multiple of these single cell piecewise quasipolynomials can
4642 be combined to create more complicated piecewise quasipolynomials.
4643
4644         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
4645                 __isl_take isl_space *space);
4646         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
4647                 __isl_take isl_set *set,
4648                 __isl_take isl_qpolynomial *qp);
4649         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
4650                 __isl_take isl_qpolynomial *qp);
4651         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
4652                 __isl_take isl_pw_aff *pwaff);
4653
4654         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
4655                 __isl_take isl_space *space);
4656         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
4657                 __isl_take isl_pw_qpolynomial *pwqp);
4658         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
4659                 __isl_take isl_union_pw_qpolynomial *upwqp,
4660                 __isl_take isl_pw_qpolynomial *pwqp);
4661
4662 Quasipolynomials can be copied and freed again using the following
4663 functions.
4664
4665         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
4666                 __isl_keep isl_qpolynomial *qp);
4667         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
4668
4669         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
4670                 __isl_keep isl_pw_qpolynomial *pwqp);
4671         void *isl_pw_qpolynomial_free(
4672                 __isl_take isl_pw_qpolynomial *pwqp);
4673
4674         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
4675                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4676         void *isl_union_pw_qpolynomial_free(
4677                 __isl_take isl_union_pw_qpolynomial *upwqp);
4678
4679 =head3 Inspecting (Piecewise) Quasipolynomials
4680
4681 To iterate over all piecewise quasipolynomials in a union
4682 piecewise quasipolynomial, use the following function
4683
4684         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
4685                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4686                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
4687                 void *user);
4688
4689 To extract the piecewise quasipolynomial in a given space from a union, use
4690
4691         __isl_give isl_pw_qpolynomial *
4692         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
4693                 __isl_keep isl_union_pw_qpolynomial *upwqp,
4694                 __isl_take isl_space *space);
4695
4696 To iterate over the cells in a piecewise quasipolynomial,
4697 use either of the following two functions
4698
4699         int isl_pw_qpolynomial_foreach_piece(
4700                 __isl_keep isl_pw_qpolynomial *pwqp,
4701                 int (*fn)(__isl_take isl_set *set,
4702                           __isl_take isl_qpolynomial *qp,
4703                           void *user), void *user);
4704         int isl_pw_qpolynomial_foreach_lifted_piece(
4705                 __isl_keep isl_pw_qpolynomial *pwqp,
4706                 int (*fn)(__isl_take isl_set *set,
4707                           __isl_take isl_qpolynomial *qp,
4708                           void *user), void *user);
4709
4710 As usual, the function C<fn> should return C<0> on success
4711 and C<-1> on failure.  The difference between
4712 C<isl_pw_qpolynomial_foreach_piece> and
4713 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
4714 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
4715 compute unique representations for all existentially quantified
4716 variables and then turn these existentially quantified variables
4717 into extra set variables, adapting the associated quasipolynomial
4718 accordingly.  This means that the C<set> passed to C<fn>
4719 will not have any existentially quantified variables, but that
4720 the dimensions of the sets may be different for different
4721 invocations of C<fn>.
4722
4723 The constant term of a quasipolynomial can be extracted using
4724
4725         __isl_give isl_val *isl_qpolynomial_get_constant_val(
4726                 __isl_keep isl_qpolynomial *qp);
4727
4728 To iterate over all terms in a quasipolynomial,
4729 use
4730
4731         int isl_qpolynomial_foreach_term(
4732                 __isl_keep isl_qpolynomial *qp,
4733                 int (*fn)(__isl_take isl_term *term,
4734                           void *user), void *user);
4735
4736 The terms themselves can be inspected and freed using
4737 these functions
4738
4739         unsigned isl_term_dim(__isl_keep isl_term *term,
4740                 enum isl_dim_type type);
4741         void isl_term_get_num(__isl_keep isl_term *term,
4742                 isl_int *n);
4743         void isl_term_get_den(__isl_keep isl_term *term,
4744                 isl_int *d);
4745         __isl_give isl_val *isl_term_get_coefficient_val(
4746                 __isl_keep isl_term *term);
4747         int isl_term_get_exp(__isl_keep isl_term *term,
4748                 enum isl_dim_type type, unsigned pos);
4749         __isl_give isl_aff *isl_term_get_div(
4750                 __isl_keep isl_term *term, unsigned pos);
4751         void isl_term_free(__isl_take isl_term *term);
4752
4753 Each term is a product of parameters, set variables and
4754 integer divisions.  The function C<isl_term_get_exp>
4755 returns the exponent of a given dimensions in the given term.
4756 The C<isl_int>s in the arguments of C<isl_term_get_num>
4757 and C<isl_term_get_den> need to have been initialized
4758 using C<isl_int_init> before calling these functions.
4759
4760 =head3 Properties of (Piecewise) Quasipolynomials
4761
4762 To check whether a quasipolynomial is actually a constant,
4763 use the following function.
4764
4765         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
4766                 isl_int *n, isl_int *d);
4767
4768 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
4769 then the numerator and denominator of the constant
4770 are returned in C<*n> and C<*d>, respectively.
4771
4772 To check whether two union piecewise quasipolynomials are
4773 obviously equal, use
4774
4775         int isl_union_pw_qpolynomial_plain_is_equal(
4776                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
4777                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
4778
4779 =head3 Operations on (Piecewise) Quasipolynomials
4780
4781         __isl_give isl_qpolynomial *isl_qpolynomial_scale(
4782                 __isl_take isl_qpolynomial *qp, isl_int v);
4783         __isl_give isl_qpolynomial *isl_qpolynomial_scale_val(
4784                 __isl_take isl_qpolynomial *qp,
4785                 __isl_take isl_val *v);
4786         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
4787                 __isl_take isl_qpolynomial *qp);
4788         __isl_give isl_qpolynomial *isl_qpolynomial_add(
4789                 __isl_take isl_qpolynomial *qp1,
4790                 __isl_take isl_qpolynomial *qp2);
4791         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
4792                 __isl_take isl_qpolynomial *qp1,
4793                 __isl_take isl_qpolynomial *qp2);
4794         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
4795                 __isl_take isl_qpolynomial *qp1,
4796                 __isl_take isl_qpolynomial *qp2);
4797         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
4798                 __isl_take isl_qpolynomial *qp, unsigned exponent);
4799
4800         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_fix_val(
4801                 __isl_take isl_pw_qpolynomial *pwqp,
4802                 enum isl_dim_type type, unsigned n,
4803                 __isl_take isl_val *v);
4804         __isl_give isl_pw_qpolynomial *
4805         isl_pw_qpolynomial_scale_val(
4806                 __isl_take isl_pw_qpolynomial *pwqp,
4807                 __isl_take isl_val *v);
4808         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
4809                 __isl_take isl_pw_qpolynomial *pwqp1,
4810                 __isl_take isl_pw_qpolynomial *pwqp2);
4811         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
4812                 __isl_take isl_pw_qpolynomial *pwqp1,
4813                 __isl_take isl_pw_qpolynomial *pwqp2);
4814         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
4815                 __isl_take isl_pw_qpolynomial *pwqp1,
4816                 __isl_take isl_pw_qpolynomial *pwqp2);
4817         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
4818                 __isl_take isl_pw_qpolynomial *pwqp);
4819         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
4820                 __isl_take isl_pw_qpolynomial *pwqp1,
4821                 __isl_take isl_pw_qpolynomial *pwqp2);
4822         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
4823                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
4824
4825         __isl_give isl_union_pw_qpolynomial *
4826         isl_union_pw_qpolynomial_scale_val(
4827                 __isl_take isl_union_pw_qpolynomial *upwqp,
4828                 __isl_take isl_val *v);
4829         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
4830                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4831                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4832         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
4833                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4834                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4835         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
4836                 __isl_take isl_union_pw_qpolynomial *upwqp1,
4837                 __isl_take isl_union_pw_qpolynomial *upwqp2);
4838
4839         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
4840                 __isl_take isl_pw_qpolynomial *pwqp,
4841                 __isl_take isl_point *pnt);
4842
4843         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
4844                 __isl_take isl_union_pw_qpolynomial *upwqp,
4845                 __isl_take isl_point *pnt);
4846
4847         __isl_give isl_set *isl_pw_qpolynomial_domain(
4848                 __isl_take isl_pw_qpolynomial *pwqp);
4849         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
4850                 __isl_take isl_pw_qpolynomial *pwpq,
4851                 __isl_take isl_set *set);
4852         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
4853                 __isl_take isl_pw_qpolynomial *pwpq,
4854                 __isl_take isl_set *set);
4855
4856         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4857                 __isl_take isl_union_pw_qpolynomial *upwqp);
4858         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
4859                 __isl_take isl_union_pw_qpolynomial *upwpq,
4860                 __isl_take isl_union_set *uset);
4861         __isl_give isl_union_pw_qpolynomial *
4862         isl_union_pw_qpolynomial_intersect_params(
4863                 __isl_take isl_union_pw_qpolynomial *upwpq,
4864                 __isl_take isl_set *set);
4865
4866         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
4867                 __isl_take isl_qpolynomial *qp,
4868                 __isl_take isl_space *model);
4869
4870         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
4871                 __isl_take isl_qpolynomial *qp);
4872         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
4873                 __isl_take isl_pw_qpolynomial *pwqp);
4874
4875         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
4876                 __isl_take isl_union_pw_qpolynomial *upwqp);
4877
4878         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
4879                 __isl_take isl_qpolynomial *qp,
4880                 __isl_take isl_set *context);
4881         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
4882                 __isl_take isl_qpolynomial *qp,
4883                 __isl_take isl_set *context);
4884
4885         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
4886                 __isl_take isl_pw_qpolynomial *pwqp,
4887                 __isl_take isl_set *context);
4888         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
4889                 __isl_take isl_pw_qpolynomial *pwqp,
4890                 __isl_take isl_set *context);
4891
4892         __isl_give isl_union_pw_qpolynomial *
4893         isl_union_pw_qpolynomial_gist_params(
4894                 __isl_take isl_union_pw_qpolynomial *upwqp,
4895                 __isl_take isl_set *context);
4896         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
4897                 __isl_take isl_union_pw_qpolynomial *upwqp,
4898                 __isl_take isl_union_set *context);
4899
4900 The gist operation applies the gist operation to each of
4901 the cells in the domain of the input piecewise quasipolynomial.
4902 The context is also exploited
4903 to simplify the quasipolynomials associated to each cell.
4904
4905         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4906                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4907         __isl_give isl_union_pw_qpolynomial *
4908         isl_union_pw_qpolynomial_to_polynomial(
4909                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4910
4911 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
4912 the polynomial will be an overapproximation.  If C<sign> is negative,
4913 it will be an underapproximation.  If C<sign> is zero, the approximation
4914 will lie somewhere in between.
4915
4916 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
4917
4918 A piecewise quasipolynomial reduction is a piecewise
4919 reduction (or fold) of quasipolynomials.
4920 In particular, the reduction can be maximum or a minimum.
4921 The objects are mainly used to represent the result of
4922 an upper or lower bound on a quasipolynomial over its domain,
4923 i.e., as the result of the following function.
4924
4925         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
4926                 __isl_take isl_pw_qpolynomial *pwqp,
4927                 enum isl_fold type, int *tight);
4928
4929         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
4930                 __isl_take isl_union_pw_qpolynomial *upwqp,
4931                 enum isl_fold type, int *tight);
4932
4933 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
4934 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
4935 is the returned bound is known be tight, i.e., for each value
4936 of the parameters there is at least
4937 one element in the domain that reaches the bound.
4938 If the domain of C<pwqp> is not wrapping, then the bound is computed
4939 over all elements in that domain and the result has a purely parametric
4940 domain.  If the domain of C<pwqp> is wrapping, then the bound is
4941 computed over the range of the wrapped relation.  The domain of the
4942 wrapped relation becomes the domain of the result.
4943
4944 A (piecewise) quasipolynomial reduction can be copied or freed using the
4945 following functions.
4946
4947         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
4948                 __isl_keep isl_qpolynomial_fold *fold);
4949         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
4950                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4951         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
4952                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4953         void isl_qpolynomial_fold_free(
4954                 __isl_take isl_qpolynomial_fold *fold);
4955         void *isl_pw_qpolynomial_fold_free(
4956                 __isl_take isl_pw_qpolynomial_fold *pwf);
4957         void *isl_union_pw_qpolynomial_fold_free(
4958                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4959
4960 =head3 Printing Piecewise Quasipolynomial Reductions
4961
4962 Piecewise quasipolynomial reductions can be printed
4963 using the following function.
4964
4965         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
4966                 __isl_take isl_printer *p,
4967                 __isl_keep isl_pw_qpolynomial_fold *pwf);
4968         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
4969                 __isl_take isl_printer *p,
4970                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4971
4972 For C<isl_printer_print_pw_qpolynomial_fold>,
4973 output format of the printer
4974 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4975 For C<isl_printer_print_union_pw_qpolynomial_fold>,
4976 output format of the printer
4977 needs to be set to C<ISL_FORMAT_ISL>.
4978 In case of printing in C<ISL_FORMAT_C>, the user may want
4979 to set the names of all dimensions
4980
4981         __isl_give isl_pw_qpolynomial_fold *
4982         isl_pw_qpolynomial_fold_set_dim_name(
4983                 __isl_take isl_pw_qpolynomial_fold *pwf,
4984                 enum isl_dim_type type, unsigned pos,
4985                 const char *s);
4986
4987 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
4988
4989 To iterate over all piecewise quasipolynomial reductions in a union
4990 piecewise quasipolynomial reduction, use the following function
4991
4992         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
4993                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
4994                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
4995                             void *user), void *user);
4996
4997 To iterate over the cells in a piecewise quasipolynomial reduction,
4998 use either of the following two functions
4999
5000         int isl_pw_qpolynomial_fold_foreach_piece(
5001                 __isl_keep isl_pw_qpolynomial_fold *pwf,
5002                 int (*fn)(__isl_take isl_set *set,
5003                           __isl_take isl_qpolynomial_fold *fold,
5004                           void *user), void *user);
5005         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
5006                 __isl_keep isl_pw_qpolynomial_fold *pwf,
5007                 int (*fn)(__isl_take isl_set *set,
5008                           __isl_take isl_qpolynomial_fold *fold,
5009                           void *user), void *user);
5010
5011 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
5012 of the difference between these two functions.
5013
5014 To iterate over all quasipolynomials in a reduction, use
5015
5016         int isl_qpolynomial_fold_foreach_qpolynomial(
5017                 __isl_keep isl_qpolynomial_fold *fold,
5018                 int (*fn)(__isl_take isl_qpolynomial *qp,
5019                           void *user), void *user);
5020
5021 =head3 Properties of Piecewise Quasipolynomial Reductions
5022
5023 To check whether two union piecewise quasipolynomial reductions are
5024 obviously equal, use
5025
5026         int isl_union_pw_qpolynomial_fold_plain_is_equal(
5027                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
5028                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
5029
5030 =head3 Operations on Piecewise Quasipolynomial Reductions
5031
5032         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
5033                 __isl_take isl_qpolynomial_fold *fold, isl_int v);
5034         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale_val(
5035                 __isl_take isl_qpolynomial_fold *fold,
5036                 __isl_take isl_val *v);
5037         __isl_give isl_pw_qpolynomial_fold *
5038         isl_pw_qpolynomial_fold_scale_val(
5039                 __isl_take isl_pw_qpolynomial_fold *pwf,
5040                 __isl_take isl_val *v);
5041         __isl_give isl_union_pw_qpolynomial_fold *
5042         isl_union_pw_qpolynomial_fold_scale_val(
5043                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5044                 __isl_take isl_val *v);
5045
5046         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
5047                 __isl_take isl_pw_qpolynomial_fold *pwf1,
5048                 __isl_take isl_pw_qpolynomial_fold *pwf2);
5049
5050         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
5051                 __isl_take isl_pw_qpolynomial_fold *pwf1,
5052                 __isl_take isl_pw_qpolynomial_fold *pwf2);
5053
5054         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
5055                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
5056                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
5057
5058         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
5059                 __isl_take isl_pw_qpolynomial_fold *pwf,
5060                 __isl_take isl_point *pnt);
5061
5062         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
5063                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5064                 __isl_take isl_point *pnt);
5065
5066         __isl_give isl_pw_qpolynomial_fold *
5067         isl_pw_qpolynomial_fold_intersect_params(
5068                 __isl_take isl_pw_qpolynomial_fold *pwf,
5069                 __isl_take isl_set *set);
5070
5071         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
5072                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
5073         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
5074                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5075                 __isl_take isl_union_set *uset);
5076         __isl_give isl_union_pw_qpolynomial_fold *
5077         isl_union_pw_qpolynomial_fold_intersect_params(
5078                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5079                 __isl_take isl_set *set);
5080
5081         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
5082                 __isl_take isl_pw_qpolynomial_fold *pwf);
5083
5084         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
5085                 __isl_take isl_pw_qpolynomial_fold *pwf);
5086
5087         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
5088                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
5089
5090         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
5091                 __isl_take isl_qpolynomial_fold *fold,
5092                 __isl_take isl_set *context);
5093         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
5094                 __isl_take isl_qpolynomial_fold *fold,
5095                 __isl_take isl_set *context);
5096
5097         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
5098                 __isl_take isl_pw_qpolynomial_fold *pwf,
5099                 __isl_take isl_set *context);
5100         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
5101                 __isl_take isl_pw_qpolynomial_fold *pwf,
5102                 __isl_take isl_set *context);
5103
5104         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
5105                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5106                 __isl_take isl_union_set *context);
5107         __isl_give isl_union_pw_qpolynomial_fold *
5108         isl_union_pw_qpolynomial_fold_gist_params(
5109                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5110                 __isl_take isl_set *context);
5111
5112 The gist operation applies the gist operation to each of
5113 the cells in the domain of the input piecewise quasipolynomial reduction.
5114 In future, the operation will also exploit the context
5115 to simplify the quasipolynomial reductions associated to each cell.
5116
5117         __isl_give isl_pw_qpolynomial_fold *
5118         isl_set_apply_pw_qpolynomial_fold(
5119                 __isl_take isl_set *set,
5120                 __isl_take isl_pw_qpolynomial_fold *pwf,
5121                 int *tight);
5122         __isl_give isl_pw_qpolynomial_fold *
5123         isl_map_apply_pw_qpolynomial_fold(
5124                 __isl_take isl_map *map,
5125                 __isl_take isl_pw_qpolynomial_fold *pwf,
5126                 int *tight);
5127         __isl_give isl_union_pw_qpolynomial_fold *
5128         isl_union_set_apply_union_pw_qpolynomial_fold(
5129                 __isl_take isl_union_set *uset,
5130                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5131                 int *tight);
5132         __isl_give isl_union_pw_qpolynomial_fold *
5133         isl_union_map_apply_union_pw_qpolynomial_fold(
5134                 __isl_take isl_union_map *umap,
5135                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5136                 int *tight);
5137
5138 The functions taking a map
5139 compose the given map with the given piecewise quasipolynomial reduction.
5140 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
5141 over all elements in the intersection of the range of the map
5142 and the domain of the piecewise quasipolynomial reduction
5143 as a function of an element in the domain of the map.
5144 The functions taking a set compute a bound over all elements in the
5145 intersection of the set and the domain of the
5146 piecewise quasipolynomial reduction.
5147
5148 =head2 Parametric Vertex Enumeration
5149
5150 The parametric vertex enumeration described in this section
5151 is mainly intended to be used internally and by the C<barvinok>
5152 library.
5153
5154         #include <isl/vertices.h>
5155         __isl_give isl_vertices *isl_basic_set_compute_vertices(
5156                 __isl_keep isl_basic_set *bset);
5157
5158 The function C<isl_basic_set_compute_vertices> performs the
5159 actual computation of the parametric vertices and the chamber
5160 decomposition and store the result in an C<isl_vertices> object.
5161 This information can be queried by either iterating over all
5162 the vertices or iterating over all the chambers or cells
5163 and then iterating over all vertices that are active on the chamber.
5164
5165         int isl_vertices_foreach_vertex(
5166                 __isl_keep isl_vertices *vertices,
5167                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5168                 void *user);
5169
5170         int isl_vertices_foreach_cell(
5171                 __isl_keep isl_vertices *vertices,
5172                 int (*fn)(__isl_take isl_cell *cell, void *user),
5173                 void *user);
5174         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
5175                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5176                 void *user);
5177
5178 Other operations that can be performed on an C<isl_vertices> object are
5179 the following.
5180
5181         isl_ctx *isl_vertices_get_ctx(
5182                 __isl_keep isl_vertices *vertices);
5183         int isl_vertices_get_n_vertices(
5184                 __isl_keep isl_vertices *vertices);
5185         void isl_vertices_free(__isl_take isl_vertices *vertices);
5186
5187 Vertices can be inspected and destroyed using the following functions.
5188
5189         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
5190         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
5191         __isl_give isl_basic_set *isl_vertex_get_domain(
5192                 __isl_keep isl_vertex *vertex);
5193         __isl_give isl_basic_set *isl_vertex_get_expr(
5194                 __isl_keep isl_vertex *vertex);
5195         void isl_vertex_free(__isl_take isl_vertex *vertex);
5196
5197 C<isl_vertex_get_expr> returns a singleton parametric set describing
5198 the vertex, while C<isl_vertex_get_domain> returns the activity domain
5199 of the vertex.
5200 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
5201 B<rational> basic sets, so they should mainly be used for inspection
5202 and should not be mixed with integer sets.
5203
5204 Chambers can be inspected and destroyed using the following functions.
5205
5206         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
5207         __isl_give isl_basic_set *isl_cell_get_domain(
5208                 __isl_keep isl_cell *cell);
5209         void isl_cell_free(__isl_take isl_cell *cell);
5210
5211 =head1 Polyhedral Compilation Library
5212
5213 This section collects functionality in C<isl> that has been specifically
5214 designed for use during polyhedral compilation.
5215
5216 =head2 Dependence Analysis
5217
5218 C<isl> contains specialized functionality for performing
5219 array dataflow analysis.  That is, given a I<sink> access relation
5220 and a collection of possible I<source> access relations,
5221 C<isl> can compute relations that describe
5222 for each iteration of the sink access, which iteration
5223 of which of the source access relations was the last
5224 to access the same data element before the given iteration
5225 of the sink access.
5226 The resulting dependence relations map source iterations
5227 to the corresponding sink iterations.
5228 To compute standard flow dependences, the sink should be
5229 a read, while the sources should be writes.
5230 If any of the source accesses are marked as being I<may>
5231 accesses, then there will be a dependence from the last
5232 I<must> access B<and> from any I<may> access that follows
5233 this last I<must> access.
5234 In particular, if I<all> sources are I<may> accesses,
5235 then memory based dependence analysis is performed.
5236 If, on the other hand, all sources are I<must> accesses,
5237 then value based dependence analysis is performed.
5238
5239         #include <isl/flow.h>
5240
5241         typedef int (*isl_access_level_before)(void *first, void *second);
5242
5243         __isl_give isl_access_info *isl_access_info_alloc(
5244                 __isl_take isl_map *sink,
5245                 void *sink_user, isl_access_level_before fn,
5246                 int max_source);
5247         __isl_give isl_access_info *isl_access_info_add_source(
5248                 __isl_take isl_access_info *acc,
5249                 __isl_take isl_map *source, int must,
5250                 void *source_user);
5251         void *isl_access_info_free(__isl_take isl_access_info *acc);
5252
5253         __isl_give isl_flow *isl_access_info_compute_flow(
5254                 __isl_take isl_access_info *acc);
5255
5256         int isl_flow_foreach(__isl_keep isl_flow *deps,
5257                 int (*fn)(__isl_take isl_map *dep, int must,
5258                           void *dep_user, void *user),
5259                 void *user);
5260         __isl_give isl_map *isl_flow_get_no_source(
5261                 __isl_keep isl_flow *deps, int must);
5262         void isl_flow_free(__isl_take isl_flow *deps);
5263
5264 The function C<isl_access_info_compute_flow> performs the actual
5265 dependence analysis.  The other functions are used to construct
5266 the input for this function or to read off the output.
5267
5268 The input is collected in an C<isl_access_info>, which can
5269 be created through a call to C<isl_access_info_alloc>.
5270 The arguments to this functions are the sink access relation
5271 C<sink>, a token C<sink_user> used to identify the sink
5272 access to the user, a callback function for specifying the
5273 relative order of source and sink accesses, and the number
5274 of source access relations that will be added.
5275 The callback function has type C<int (*)(void *first, void *second)>.
5276 The function is called with two user supplied tokens identifying
5277 either a source or the sink and it should return the shared nesting
5278 level and the relative order of the two accesses.
5279 In particular, let I<n> be the number of loops shared by
5280 the two accesses.  If C<first> precedes C<second> textually,
5281 then the function should return I<2 * n + 1>; otherwise,
5282 it should return I<2 * n>.
5283 The sources can be added to the C<isl_access_info> by performing
5284 (at most) C<max_source> calls to C<isl_access_info_add_source>.
5285 C<must> indicates whether the source is a I<must> access
5286 or a I<may> access.  Note that a multi-valued access relation
5287 should only be marked I<must> if every iteration in the domain
5288 of the relation accesses I<all> elements in its image.
5289 The C<source_user> token is again used to identify
5290 the source access.  The range of the source access relation
5291 C<source> should have the same dimension as the range
5292 of the sink access relation.
5293 The C<isl_access_info_free> function should usually not be
5294 called explicitly, because it is called implicitly by
5295 C<isl_access_info_compute_flow>.
5296
5297 The result of the dependence analysis is collected in an
5298 C<isl_flow>.  There may be elements of
5299 the sink access for which no preceding source access could be
5300 found or for which all preceding sources are I<may> accesses.
5301 The relations containing these elements can be obtained through
5302 calls to C<isl_flow_get_no_source>, the first with C<must> set
5303 and the second with C<must> unset.
5304 In the case of standard flow dependence analysis,
5305 with the sink a read and the sources I<must> writes,
5306 the first relation corresponds to the reads from uninitialized
5307 array elements and the second relation is empty.
5308 The actual flow dependences can be extracted using
5309 C<isl_flow_foreach>.  This function will call the user-specified
5310 callback function C<fn> for each B<non-empty> dependence between
5311 a source and the sink.  The callback function is called
5312 with four arguments, the actual flow dependence relation
5313 mapping source iterations to sink iterations, a boolean that
5314 indicates whether it is a I<must> or I<may> dependence, a token
5315 identifying the source and an additional C<void *> with value
5316 equal to the third argument of the C<isl_flow_foreach> call.
5317 A dependence is marked I<must> if it originates from a I<must>
5318 source and if it is not followed by any I<may> sources.
5319
5320 After finishing with an C<isl_flow>, the user should call
5321 C<isl_flow_free> to free all associated memory.
5322
5323 A higher-level interface to dependence analysis is provided
5324 by the following function.
5325
5326         #include <isl/flow.h>
5327
5328         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
5329                 __isl_take isl_union_map *must_source,
5330                 __isl_take isl_union_map *may_source,
5331                 __isl_take isl_union_map *schedule,
5332                 __isl_give isl_union_map **must_dep,
5333                 __isl_give isl_union_map **may_dep,
5334                 __isl_give isl_union_map **must_no_source,
5335                 __isl_give isl_union_map **may_no_source);
5336
5337 The arrays are identified by the tuple names of the ranges
5338 of the accesses.  The iteration domains by the tuple names
5339 of the domains of the accesses and of the schedule.
5340 The relative order of the iteration domains is given by the
5341 schedule.  The relations returned through C<must_no_source>
5342 and C<may_no_source> are subsets of C<sink>.
5343 Any of C<must_dep>, C<may_dep>, C<must_no_source>
5344 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
5345 any of the other arguments is treated as an error.
5346
5347 =head3 Interaction with Dependence Analysis
5348
5349 During the dependence analysis, we frequently need to perform
5350 the following operation.  Given a relation between sink iterations
5351 and potential source iterations from a particular source domain,
5352 what is the last potential source iteration corresponding to each
5353 sink iteration.  It can sometimes be convenient to adjust
5354 the set of potential source iterations before or after each such operation.
5355 The prototypical example is fuzzy array dataflow analysis,
5356 where we need to analyze if, based on data-dependent constraints,
5357 the sink iteration can ever be executed without one or more of
5358 the corresponding potential source iterations being executed.
5359 If so, we can introduce extra parameters and select an unknown
5360 but fixed source iteration from the potential source iterations.
5361 To be able to perform such manipulations, C<isl> provides the following
5362 function.
5363
5364         #include <isl/flow.h>
5365
5366         typedef __isl_give isl_restriction *(*isl_access_restrict)(
5367                 __isl_keep isl_map *source_map,
5368                 __isl_keep isl_set *sink, void *source_user,
5369                 void *user);
5370         __isl_give isl_access_info *isl_access_info_set_restrict(
5371                 __isl_take isl_access_info *acc,
5372                 isl_access_restrict fn, void *user);
5373
5374 The function C<isl_access_info_set_restrict> should be called
5375 before calling C<isl_access_info_compute_flow> and registers a callback function
5376 that will be called any time C<isl> is about to compute the last
5377 potential source.  The first argument is the (reverse) proto-dependence,
5378 mapping sink iterations to potential source iterations.
5379 The second argument represents the sink iterations for which
5380 we want to compute the last source iteration.
5381 The third argument is the token corresponding to the source
5382 and the final argument is the token passed to C<isl_access_info_set_restrict>.
5383 The callback is expected to return a restriction on either the input or
5384 the output of the operation computing the last potential source.
5385 If the input needs to be restricted then restrictions are needed
5386 for both the source and the sink iterations.  The sink iterations
5387 and the potential source iterations will be intersected with these sets.
5388 If the output needs to be restricted then only a restriction on the source
5389 iterations is required.
5390 If any error occurs, the callback should return C<NULL>.
5391 An C<isl_restriction> object can be created, freed and inspected
5392 using the following functions.
5393
5394         #include <isl/flow.h>
5395
5396         __isl_give isl_restriction *isl_restriction_input(
5397                 __isl_take isl_set *source_restr,
5398                 __isl_take isl_set *sink_restr);
5399         __isl_give isl_restriction *isl_restriction_output(
5400                 __isl_take isl_set *source_restr);
5401         __isl_give isl_restriction *isl_restriction_none(
5402                 __isl_take isl_map *source_map);
5403         __isl_give isl_restriction *isl_restriction_empty(
5404                 __isl_take isl_map *source_map);
5405         void *isl_restriction_free(
5406                 __isl_take isl_restriction *restr);
5407         isl_ctx *isl_restriction_get_ctx(
5408                 __isl_keep isl_restriction *restr);
5409
5410 C<isl_restriction_none> and C<isl_restriction_empty> are special
5411 cases of C<isl_restriction_input>.  C<isl_restriction_none>
5412 is essentially equivalent to
5413
5414         isl_restriction_input(isl_set_universe(
5415             isl_space_range(isl_map_get_space(source_map))),
5416                             isl_set_universe(
5417             isl_space_domain(isl_map_get_space(source_map))));
5418
5419 whereas C<isl_restriction_empty> is essentially equivalent to
5420
5421         isl_restriction_input(isl_set_empty(
5422             isl_space_range(isl_map_get_space(source_map))),
5423                             isl_set_universe(
5424             isl_space_domain(isl_map_get_space(source_map))));
5425
5426 =head2 Scheduling
5427
5428 B<The functionality described in this section is fairly new
5429 and may be subject to change.>
5430
5431 The following function can be used to compute a schedule
5432 for a union of domains.
5433 By default, the algorithm used to construct the schedule is similar
5434 to that of C<Pluto>.
5435 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
5436 be selected.
5437 The generated schedule respects all C<validity> dependences.
5438 That is, all dependence distances over these dependences in the
5439 scheduled space are lexicographically positive.
5440 The default algorithm tries to minimize the dependence distances over
5441 C<proximity> dependences.
5442 Moreover, it tries to obtain sequences (bands) of schedule dimensions
5443 for groups of domains where the dependence distances have only
5444 non-negative values.
5445 When using Feautrier's algorithm, the C<proximity> dependence
5446 distances are only minimized during the extension to a
5447 full-dimensional schedule.
5448
5449         #include <isl/schedule.h>
5450         __isl_give isl_schedule *isl_union_set_compute_schedule(
5451                 __isl_take isl_union_set *domain,
5452                 __isl_take isl_union_map *validity,
5453                 __isl_take isl_union_map *proximity);
5454         void *isl_schedule_free(__isl_take isl_schedule *sched);
5455
5456 A mapping from the domains to the scheduled space can be obtained
5457 from an C<isl_schedule> using the following function.
5458
5459         __isl_give isl_union_map *isl_schedule_get_map(
5460                 __isl_keep isl_schedule *sched);
5461
5462 A representation of the schedule can be printed using
5463          
5464         __isl_give isl_printer *isl_printer_print_schedule(
5465                 __isl_take isl_printer *p,
5466                 __isl_keep isl_schedule *schedule);
5467
5468 A representation of the schedule as a forest of bands can be obtained
5469 using the following function.
5470
5471         __isl_give isl_band_list *isl_schedule_get_band_forest(
5472                 __isl_keep isl_schedule *schedule);
5473
5474 The individual bands can be visited in depth-first post-order
5475 using the following function.
5476
5477         #include <isl/schedule.h>
5478         int isl_schedule_foreach_band(
5479                 __isl_keep isl_schedule *sched,
5480                 int (*fn)(__isl_keep isl_band *band, void *user),
5481                 void *user);
5482
5483 The list can be manipulated as explained in L<"Lists">.
5484 The bands inside the list can be copied and freed using the following
5485 functions.
5486
5487         #include <isl/band.h>
5488         __isl_give isl_band *isl_band_copy(
5489                 __isl_keep isl_band *band);
5490         void *isl_band_free(__isl_take isl_band *band);
5491
5492 Each band contains zero or more scheduling dimensions.
5493 These are referred to as the members of the band.
5494 The section of the schedule that corresponds to the band is
5495 referred to as the partial schedule of the band.
5496 For those nodes that participate in a band, the outer scheduling
5497 dimensions form the prefix schedule, while the inner scheduling
5498 dimensions form the suffix schedule.
5499 That is, if we take a cut of the band forest, then the union of
5500 the concatenations of the prefix, partial and suffix schedules of
5501 each band in the cut is equal to the entire schedule (modulo
5502 some possible padding at the end with zero scheduling dimensions).
5503 The properties of a band can be inspected using the following functions.
5504
5505         #include <isl/band.h>
5506         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
5507
5508         int isl_band_has_children(__isl_keep isl_band *band);
5509         __isl_give isl_band_list *isl_band_get_children(
5510                 __isl_keep isl_band *band);
5511
5512         __isl_give isl_union_map *isl_band_get_prefix_schedule(
5513                 __isl_keep isl_band *band);
5514         __isl_give isl_union_map *isl_band_get_partial_schedule(
5515                 __isl_keep isl_band *band);
5516         __isl_give isl_union_map *isl_band_get_suffix_schedule(
5517                 __isl_keep isl_band *band);
5518
5519         int isl_band_n_member(__isl_keep isl_band *band);
5520         int isl_band_member_is_zero_distance(
5521                 __isl_keep isl_band *band, int pos);
5522
5523         int isl_band_list_foreach_band(
5524                 __isl_keep isl_band_list *list,
5525                 int (*fn)(__isl_keep isl_band *band, void *user),
5526                 void *user);
5527
5528 Note that a scheduling dimension is considered to be ``zero
5529 distance'' if it does not carry any proximity dependences
5530 within its band.
5531 That is, if the dependence distances of the proximity
5532 dependences are all zero in that direction (for fixed
5533 iterations of outer bands).
5534 Like C<isl_schedule_foreach_band>,
5535 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
5536 in depth-first post-order.
5537
5538 A band can be tiled using the following function.
5539
5540         #include <isl/band.h>
5541         int isl_band_tile(__isl_keep isl_band *band,
5542                 __isl_take isl_vec *sizes);
5543
5544         int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
5545                 int val);
5546         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
5547         int isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
5548                 int val);
5549         int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
5550
5551 The C<isl_band_tile> function tiles the band using the given tile sizes
5552 inside its schedule.
5553 A new child band is created to represent the point loops and it is
5554 inserted between the modified band and its children.
5555 The C<tile_scale_tile_loops> option specifies whether the tile
5556 loops iterators should be scaled by the tile sizes.
5557 If the C<tile_shift_point_loops> option is set, then the point loops
5558 are shifted to start at zero.
5559
5560 A band can be split into two nested bands using the following function.
5561
5562         int isl_band_split(__isl_keep isl_band *band, int pos);
5563
5564 The resulting outer band contains the first C<pos> dimensions of C<band>
5565 while the inner band contains the remaining dimensions.
5566
5567 A representation of the band can be printed using
5568
5569         #include <isl/band.h>
5570         __isl_give isl_printer *isl_printer_print_band(
5571                 __isl_take isl_printer *p,
5572                 __isl_keep isl_band *band);
5573
5574 =head3 Options
5575
5576         #include <isl/schedule.h>
5577         int isl_options_set_schedule_max_coefficient(
5578                 isl_ctx *ctx, int val);
5579         int isl_options_get_schedule_max_coefficient(
5580                 isl_ctx *ctx);
5581         int isl_options_set_schedule_max_constant_term(
5582                 isl_ctx *ctx, int val);
5583         int isl_options_get_schedule_max_constant_term(
5584                 isl_ctx *ctx);
5585         int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
5586         int isl_options_get_schedule_fuse(isl_ctx *ctx);
5587         int isl_options_set_schedule_maximize_band_depth(
5588                 isl_ctx *ctx, int val);
5589         int isl_options_get_schedule_maximize_band_depth(
5590                 isl_ctx *ctx);
5591         int isl_options_set_schedule_outer_zero_distance(
5592                 isl_ctx *ctx, int val);
5593         int isl_options_get_schedule_outer_zero_distance(
5594                 isl_ctx *ctx);
5595         int isl_options_set_schedule_split_scaled(
5596                 isl_ctx *ctx, int val);
5597         int isl_options_get_schedule_split_scaled(
5598                 isl_ctx *ctx);
5599         int isl_options_set_schedule_algorithm(
5600                 isl_ctx *ctx, int val);
5601         int isl_options_get_schedule_algorithm(
5602                 isl_ctx *ctx);
5603         int isl_options_set_schedule_separate_components(
5604                 isl_ctx *ctx, int val);
5605         int isl_options_get_schedule_separate_components(
5606                 isl_ctx *ctx);
5607
5608 =over
5609
5610 =item * schedule_max_coefficient
5611
5612 This option enforces that the coefficients for variable and parameter
5613 dimensions in the calculated schedule are not larger than the specified value.
5614 This option can significantly increase the speed of the scheduling calculation
5615 and may also prevent fusing of unrelated dimensions. A value of -1 means that
5616 this option does not introduce bounds on the variable or parameter
5617 coefficients.
5618
5619 =item * schedule_max_constant_term
5620
5621 This option enforces that the constant coefficients in the calculated schedule
5622 are not larger than the maximal constant term. This option can significantly
5623 increase the speed of the scheduling calculation and may also prevent fusing of
5624 unrelated dimensions. A value of -1 means that this option does not introduce
5625 bounds on the constant coefficients.
5626
5627 =item * schedule_fuse
5628
5629 This option controls the level of fusion.
5630 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
5631 resulting schedule will be distributed as much as possible.
5632 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
5633 try to fuse loops in the resulting schedule.
5634
5635 =item * schedule_maximize_band_depth
5636
5637 If this option is set, we do not split bands at the point
5638 where we detect splitting is necessary. Instead, we
5639 backtrack and split bands as early as possible. This
5640 reduces the number of splits and maximizes the width of
5641 the bands. Wider bands give more possibilities for tiling.
5642 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
5643 then bands will be split as early as possible, even if there is no need.
5644 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
5645
5646 =item * schedule_outer_zero_distance
5647
5648 If this option is set, then we try to construct schedules
5649 where the outermost scheduling dimension in each band
5650 results in a zero dependence distance over the proximity
5651 dependences.
5652
5653 =item * schedule_split_scaled
5654
5655 If this option is set, then we try to construct schedules in which the
5656 constant term is split off from the linear part if the linear parts of
5657 the scheduling rows for all nodes in the graphs have a common non-trivial
5658 divisor.
5659 The constant term is then placed in a separate band and the linear
5660 part is reduced.
5661
5662 =item * schedule_algorithm
5663
5664 Selects the scheduling algorithm to be used.
5665 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
5666 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
5667
5668 =item * schedule_separate_components
5669
5670 If at any point the dependence graph contains any (weakly connected) components,
5671 then these components are scheduled separately.
5672 If this option is not set, then some iterations of the domains
5673 in these components may be scheduled together.
5674 If this option is set, then the components are given consecutive
5675 schedules.
5676
5677 =back
5678
5679 =head2 AST Generation
5680
5681 This section describes the C<isl> functionality for generating
5682 ASTs that visit all the elements
5683 in a domain in an order specified by a schedule.
5684 In particular, given a C<isl_union_map>, an AST is generated
5685 that visits all the elements in the domain of the C<isl_union_map>
5686 according to the lexicographic order of the corresponding image
5687 element(s).  If the range of the C<isl_union_map> consists of
5688 elements in more than one space, then each of these spaces is handled
5689 separately in an arbitrary order.
5690 It should be noted that the image elements only specify the I<order>
5691 in which the corresponding domain elements should be visited.
5692 No direct relation between the image elements and the loop iterators
5693 in the generated AST should be assumed.
5694
5695 Each AST is generated within a build.  The initial build
5696 simply specifies the constraints on the parameters (if any)
5697 and can be created, inspected, copied and freed using the following functions.
5698
5699         #include <isl/ast_build.h>
5700         __isl_give isl_ast_build *isl_ast_build_from_context(
5701                 __isl_take isl_set *set);
5702         isl_ctx *isl_ast_build_get_ctx(
5703                 __isl_keep isl_ast_build *build);
5704         __isl_give isl_ast_build *isl_ast_build_copy(
5705                 __isl_keep isl_ast_build *build);
5706         void *isl_ast_build_free(
5707                 __isl_take isl_ast_build *build);
5708
5709 The C<set> argument is usually a parameter set with zero or more parameters.
5710 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
5711 and L</"Fine-grained Control over AST Generation">.
5712 Finally, the AST itself can be constructed using the following
5713 function.
5714
5715         #include <isl/ast_build.h>
5716         __isl_give isl_ast_node *isl_ast_build_ast_from_schedule(
5717                 __isl_keep isl_ast_build *build,
5718                 __isl_take isl_union_map *schedule);
5719
5720 =head3 Inspecting the AST
5721
5722 The basic properties of an AST node can be obtained as follows.
5723
5724         #include <isl/ast.h>
5725         isl_ctx *isl_ast_node_get_ctx(
5726                 __isl_keep isl_ast_node *node);
5727         enum isl_ast_node_type isl_ast_node_get_type(
5728                 __isl_keep isl_ast_node *node);
5729
5730 The type of an AST node is one of
5731 C<isl_ast_node_for>,
5732 C<isl_ast_node_if>,
5733 C<isl_ast_node_block> or
5734 C<isl_ast_node_user>.
5735 An C<isl_ast_node_for> represents a for node.
5736 An C<isl_ast_node_if> represents an if node.
5737 An C<isl_ast_node_block> represents a compound node.
5738 An C<isl_ast_node_user> represents an expression statement.
5739 An expression statement typically corresponds to a domain element, i.e.,
5740 one of the elements that is visited by the AST.
5741
5742 Each type of node has its own additional properties.
5743
5744         #include <isl/ast.h>
5745         __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
5746                 __isl_keep isl_ast_node *node);
5747         __isl_give isl_ast_expr *isl_ast_node_for_get_init(
5748                 __isl_keep isl_ast_node *node);
5749         __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
5750                 __isl_keep isl_ast_node *node);
5751         __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
5752                 __isl_keep isl_ast_node *node);
5753         __isl_give isl_ast_node *isl_ast_node_for_get_body(
5754                 __isl_keep isl_ast_node *node);
5755         int isl_ast_node_for_is_degenerate(
5756                 __isl_keep isl_ast_node *node);
5757
5758 An C<isl_ast_for> is considered degenerate if it is known to execute
5759 exactly once.
5760
5761         #include <isl/ast.h>
5762         __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
5763                 __isl_keep isl_ast_node *node);
5764         __isl_give isl_ast_node *isl_ast_node_if_get_then(
5765                 __isl_keep isl_ast_node *node);
5766         int isl_ast_node_if_has_else(
5767                 __isl_keep isl_ast_node *node);
5768         __isl_give isl_ast_node *isl_ast_node_if_get_else(
5769                 __isl_keep isl_ast_node *node);
5770
5771         __isl_give isl_ast_node_list *
5772         isl_ast_node_block_get_children(
5773                 __isl_keep isl_ast_node *node);
5774
5775         __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
5776                 __isl_keep isl_ast_node *node);
5777
5778 Each of the returned C<isl_ast_expr>s can in turn be inspected using
5779 the following functions.
5780
5781         #include <isl/ast.h>
5782         isl_ctx *isl_ast_expr_get_ctx(
5783                 __isl_keep isl_ast_expr *expr);
5784         enum isl_ast_expr_type isl_ast_expr_get_type(
5785                 __isl_keep isl_ast_expr *expr);
5786
5787 The type of an AST expression is one of
5788 C<isl_ast_expr_op>,
5789 C<isl_ast_expr_id> or
5790 C<isl_ast_expr_int>.
5791 An C<isl_ast_expr_op> represents the result of an operation.
5792 An C<isl_ast_expr_id> represents an identifier.
5793 An C<isl_ast_expr_int> represents an integer value.
5794
5795 Each type of expression has its own additional properties.
5796
5797         #include <isl/ast.h>
5798         enum isl_ast_op_type isl_ast_expr_get_op_type(
5799                 __isl_keep isl_ast_expr *expr);
5800         int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
5801         __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
5802                 __isl_keep isl_ast_expr *expr, int pos);
5803         int isl_ast_node_foreach_ast_op_type(
5804                 __isl_keep isl_ast_node *node,
5805                 int (*fn)(enum isl_ast_op_type type, void *user),
5806                 void *user);
5807
5808 C<isl_ast_expr_get_op_type> returns the type of the operation
5809 performed.  C<isl_ast_expr_get_op_n_arg> returns the number of
5810 arguments.  C<isl_ast_expr_get_op_arg> returns the specified
5811 argument.
5812 C<isl_ast_node_foreach_ast_op_type> calls C<fn> for each distinct
5813 C<isl_ast_op_type> that appears in C<node>.
5814 The operation type is one of the following.
5815
5816 =over
5817
5818 =item C<isl_ast_op_and>
5819
5820 Logical I<and> of two arguments.
5821 Both arguments can be evaluated.
5822
5823 =item C<isl_ast_op_and_then>
5824
5825 Logical I<and> of two arguments.
5826 The second argument can only be evaluated if the first evaluates to true.
5827
5828 =item C<isl_ast_op_or>
5829
5830 Logical I<or> of two arguments.
5831 Both arguments can be evaluated.
5832
5833 =item C<isl_ast_op_or_else>
5834
5835 Logical I<or> of two arguments.
5836 The second argument can only be evaluated if the first evaluates to false.
5837
5838 =item C<isl_ast_op_max>
5839
5840 Maximum of two or more arguments.
5841
5842 =item C<isl_ast_op_min>
5843
5844 Minimum of two or more arguments.
5845
5846 =item C<isl_ast_op_minus>
5847
5848 Change sign.
5849
5850 =item C<isl_ast_op_add>
5851
5852 Sum of two arguments.
5853
5854 =item C<isl_ast_op_sub>
5855
5856 Difference of two arguments.
5857
5858 =item C<isl_ast_op_mul>
5859
5860 Product of two arguments.
5861
5862 =item C<isl_ast_op_div>
5863
5864 Exact division.  That is, the result is known to be an integer.
5865
5866 =item C<isl_ast_op_fdiv_q>
5867
5868 Result of integer division, rounded towards negative
5869 infinity.
5870
5871 =item C<isl_ast_op_pdiv_q>
5872
5873 Result of integer division, where dividend is known to be non-negative.
5874
5875 =item C<isl_ast_op_pdiv_r>
5876
5877 Remainder of integer division, where dividend is known to be non-negative.
5878
5879 =item C<isl_ast_op_cond>
5880
5881 Conditional operator defined on three arguments.
5882 If the first argument evaluates to true, then the result
5883 is equal to the second argument.  Otherwise, the result
5884 is equal to the third argument.
5885 The second and third argument may only be evaluated if
5886 the first argument evaluates to true and false, respectively.
5887 Corresponds to C<a ? b : c> in C.
5888
5889 =item C<isl_ast_op_select>
5890
5891 Conditional operator defined on three arguments.
5892 If the first argument evaluates to true, then the result
5893 is equal to the second argument.  Otherwise, the result
5894 is equal to the third argument.
5895 The second and third argument may be evaluated independently
5896 of the value of the first argument.
5897 Corresponds to C<a * b + (1 - a) * c> in C.
5898
5899 =item C<isl_ast_op_eq>
5900
5901 Equality relation.
5902
5903 =item C<isl_ast_op_le>
5904
5905 Less than or equal relation.
5906
5907 =item C<isl_ast_op_lt>
5908
5909 Less than relation.
5910
5911 =item C<isl_ast_op_ge>
5912
5913 Greater than or equal relation.
5914
5915 =item C<isl_ast_op_gt>
5916
5917 Greater than relation.
5918
5919 =item C<isl_ast_op_call>
5920
5921 A function call.
5922 The number of arguments of the C<isl_ast_expr> is one more than
5923 the number of arguments in the function call, the first argument
5924 representing the function being called.
5925
5926 =back
5927
5928         #include <isl/ast.h>
5929         __isl_give isl_id *isl_ast_expr_get_id(
5930                 __isl_keep isl_ast_expr *expr);
5931
5932 Return the identifier represented by the AST expression.
5933
5934         #include <isl/ast.h>
5935         int isl_ast_expr_get_int(__isl_keep isl_ast_expr *expr,
5936                 isl_int *v);
5937
5938 Return the integer represented by the AST expression.
5939 Note that the integer is returned through the C<v> argument.
5940 The return value of the function itself indicates whether the
5941 operation was performed successfully.
5942
5943 =head3 Manipulating and printing the AST
5944
5945 AST nodes can be copied and freed using the following functions.
5946
5947         #include <isl/ast.h>
5948         __isl_give isl_ast_node *isl_ast_node_copy(
5949                 __isl_keep isl_ast_node *node);
5950         void *isl_ast_node_free(__isl_take isl_ast_node *node);
5951
5952 AST expressions can be copied and freed using the following functions.
5953
5954         #include <isl/ast.h>
5955         __isl_give isl_ast_expr *isl_ast_expr_copy(
5956                 __isl_keep isl_ast_expr *expr);
5957         void *isl_ast_expr_free(__isl_take isl_ast_expr *expr);
5958
5959 New AST expressions can be created either directly or within
5960 the context of an C<isl_ast_build>.
5961
5962         #include <isl/ast.h>
5963         __isl_give isl_ast_expr *isl_ast_expr_from_id(
5964                 __isl_take isl_id *id);
5965         __isl_give isl_ast_expr *isl_ast_expr_neg(
5966                 __isl_take isl_ast_expr *expr);
5967         __isl_give isl_ast_expr *isl_ast_expr_add(
5968                 __isl_take isl_ast_expr *expr1,
5969                 __isl_take isl_ast_expr *expr2);
5970         __isl_give isl_ast_expr *isl_ast_expr_sub(
5971                 __isl_take isl_ast_expr *expr1,
5972                 __isl_take isl_ast_expr *expr2);
5973         __isl_give isl_ast_expr *isl_ast_expr_mul(
5974                 __isl_take isl_ast_expr *expr1,
5975                 __isl_take isl_ast_expr *expr2);
5976         __isl_give isl_ast_expr *isl_ast_expr_div(
5977                 __isl_take isl_ast_expr *expr1,
5978                 __isl_take isl_ast_expr *expr2);
5979         __isl_give isl_ast_expr *isl_ast_expr_and(
5980                 __isl_take isl_ast_expr *expr1,
5981                 __isl_take isl_ast_expr *expr2)
5982         __isl_give isl_ast_expr *isl_ast_expr_or(
5983                 __isl_take isl_ast_expr *expr1,
5984                 __isl_take isl_ast_expr *expr2)
5985
5986         #include <isl/ast_build.h>
5987         __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
5988                 __isl_keep isl_ast_build *build,
5989                 __isl_take isl_pw_aff *pa);
5990         __isl_give isl_ast_expr *
5991         isl_ast_build_call_from_pw_multi_aff(
5992                 __isl_keep isl_ast_build *build,
5993                 __isl_take isl_pw_multi_aff *pma);
5994
5995 The domains of C<pa> and C<pma> should correspond
5996 to the schedule space of C<build>.
5997 The tuple id of C<pma> is used as the function being called.
5998
5999 User specified data can be attached to an C<isl_ast_node> and obtained
6000 from the same C<isl_ast_node> using the following functions.
6001
6002         #include <isl/ast.h>
6003         __isl_give isl_ast_node *isl_ast_node_set_annotation(
6004                 __isl_take isl_ast_node *node,
6005                 __isl_take isl_id *annotation);
6006         __isl_give isl_id *isl_ast_node_get_annotation(
6007                 __isl_keep isl_ast_node *node);
6008
6009 Basic printing can be performed using the following functions.
6010
6011         #include <isl/ast.h>
6012         __isl_give isl_printer *isl_printer_print_ast_expr(
6013                 __isl_take isl_printer *p,
6014                 __isl_keep isl_ast_expr *expr);
6015         __isl_give isl_printer *isl_printer_print_ast_node(
6016                 __isl_take isl_printer *p,
6017                 __isl_keep isl_ast_node *node);
6018
6019 More advanced printing can be performed using the following functions.
6020
6021         #include <isl/ast.h>
6022         __isl_give isl_printer *isl_ast_op_type_print_macro(
6023                 enum isl_ast_op_type type,
6024                 __isl_take isl_printer *p);
6025         __isl_give isl_printer *isl_ast_node_print_macros(
6026                 __isl_keep isl_ast_node *node,
6027                 __isl_take isl_printer *p);
6028         __isl_give isl_printer *isl_ast_node_print(
6029                 __isl_keep isl_ast_node *node,
6030                 __isl_take isl_printer *p,
6031                 __isl_take isl_ast_print_options *options);
6032         __isl_give isl_printer *isl_ast_node_for_print(
6033                 __isl_keep isl_ast_node *node,
6034                 __isl_take isl_printer *p,
6035                 __isl_take isl_ast_print_options *options);
6036         __isl_give isl_printer *isl_ast_node_if_print(
6037                 __isl_keep isl_ast_node *node,
6038                 __isl_take isl_printer *p,
6039                 __isl_take isl_ast_print_options *options);
6040
6041 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
6042 C<isl> may print out an AST that makes use of macros such
6043 as C<floord>, C<min> and C<max>.
6044 C<isl_ast_op_type_print_macro> prints out the macro
6045 corresponding to a specific C<isl_ast_op_type>.
6046 C<isl_ast_node_print_macros> scans the C<isl_ast_node>
6047 for expressions where these macros would be used and prints
6048 out the required macro definitions.
6049 Essentially, C<isl_ast_node_print_macros> calls
6050 C<isl_ast_node_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
6051 as function argument.
6052 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
6053 C<isl_ast_node_if_print> print an C<isl_ast_node>
6054 in C<ISL_FORMAT_C>, but allow for some extra control
6055 through an C<isl_ast_print_options> object.
6056 This object can be created using the following functions.
6057
6058         #include <isl/ast.h>
6059         __isl_give isl_ast_print_options *
6060         isl_ast_print_options_alloc(isl_ctx *ctx);
6061         __isl_give isl_ast_print_options *
6062         isl_ast_print_options_copy(
6063                 __isl_keep isl_ast_print_options *options);
6064         void *isl_ast_print_options_free(
6065                 __isl_take isl_ast_print_options *options);
6066
6067         __isl_give isl_ast_print_options *
6068         isl_ast_print_options_set_print_user(
6069                 __isl_take isl_ast_print_options *options,
6070                 __isl_give isl_printer *(*print_user)(
6071                         __isl_take isl_printer *p,
6072                         __isl_take isl_ast_print_options *options,
6073                         __isl_keep isl_ast_node *node, void *user),
6074                 void *user);
6075         __isl_give isl_ast_print_options *
6076         isl_ast_print_options_set_print_for(
6077                 __isl_take isl_ast_print_options *options,
6078                 __isl_give isl_printer *(*print_for)(
6079                         __isl_take isl_printer *p,
6080                         __isl_take isl_ast_print_options *options,
6081                         __isl_keep isl_ast_node *node, void *user),
6082                 void *user);
6083
6084 The callback set by C<isl_ast_print_options_set_print_user>
6085 is called whenever a node of type C<isl_ast_node_user> needs to
6086 be printed.
6087 The callback set by C<isl_ast_print_options_set_print_for>
6088 is called whenever a node of type C<isl_ast_node_for> needs to
6089 be printed.
6090 Note that C<isl_ast_node_for_print> will I<not> call the
6091 callback set by C<isl_ast_print_options_set_print_for> on the node
6092 on which C<isl_ast_node_for_print> is called, but only on nested
6093 nodes of type C<isl_ast_node_for>.  It is therefore safe to
6094 call C<isl_ast_node_for_print> from within the callback set by
6095 C<isl_ast_print_options_set_print_for>.
6096
6097 The following option determines the type to be used for iterators
6098 while printing the AST.
6099
6100         int isl_options_set_ast_iterator_type(
6101                 isl_ctx *ctx, const char *val);
6102         const char *isl_options_get_ast_iterator_type(
6103                 isl_ctx *ctx);
6104
6105 =head3 Options
6106
6107         #include <isl/ast_build.h>
6108         int isl_options_set_ast_build_atomic_upper_bound(
6109                 isl_ctx *ctx, int val);
6110         int isl_options_get_ast_build_atomic_upper_bound(
6111                 isl_ctx *ctx);
6112         int isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
6113                 int val);
6114         int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
6115         int isl_options_set_ast_build_exploit_nested_bounds(
6116                 isl_ctx *ctx, int val);
6117         int isl_options_get_ast_build_exploit_nested_bounds(
6118                 isl_ctx *ctx);
6119         int isl_options_set_ast_build_group_coscheduled(
6120                 isl_ctx *ctx, int val);
6121         int isl_options_get_ast_build_group_coscheduled(
6122                 isl_ctx *ctx);
6123         int isl_options_set_ast_build_scale_strides(
6124                 isl_ctx *ctx, int val);
6125         int isl_options_get_ast_build_scale_strides(
6126                 isl_ctx *ctx);
6127         int isl_options_set_ast_build_allow_else(isl_ctx *ctx,
6128                 int val);
6129         int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
6130         int isl_options_set_ast_build_allow_or(isl_ctx *ctx,
6131                 int val);
6132         int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
6133
6134 =over
6135
6136 =item * ast_build_atomic_upper_bound
6137
6138 Generate loop upper bounds that consist of the current loop iterator,
6139 an operator and an expression not involving the iterator.
6140 If this option is not set, then the current loop iterator may appear
6141 several times in the upper bound.
6142 For example, when this option is turned off, AST generation
6143 for the schedule
6144
6145         [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
6146
6147 produces
6148
6149         for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
6150           A(c0);
6151
6152 When the option is turned on, the following AST is generated
6153
6154         for (int c0 = 0; c0 <= min(100, n); c0 += 1)
6155           A(c0);
6156
6157 =item * ast_build_prefer_pdiv
6158
6159 If this option is turned off, then the AST generation will
6160 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
6161 operators, but no C<isl_ast_op_pdiv_q> or
6162 C<isl_ast_op_pdiv_r> operators.
6163 If this options is turned on, then C<isl> will try to convert
6164 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
6165 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
6166
6167 =item * ast_build_exploit_nested_bounds
6168
6169 Simplify conditions based on bounds of nested for loops.
6170 In particular, remove conditions that are implied by the fact
6171 that one or more nested loops have at least one iteration,
6172 meaning that the upper bound is at least as large as the lower bound.
6173 For example, when this option is turned off, AST generation
6174 for the schedule
6175
6176         [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
6177                                         0 <= j <= M }
6178
6179 produces
6180
6181         if (M >= 0)
6182           for (int c0 = 0; c0 <= N; c0 += 1)
6183             for (int c1 = 0; c1 <= M; c1 += 1)
6184               A(c0, c1);
6185
6186 When the option is turned on, the following AST is generated
6187
6188         for (int c0 = 0; c0 <= N; c0 += 1)
6189           for (int c1 = 0; c1 <= M; c1 += 1)
6190             A(c0, c1);
6191
6192 =item * ast_build_group_coscheduled
6193
6194 If two domain elements are assigned the same schedule point, then
6195 they may be executed in any order and they may even appear in different
6196 loops.  If this options is set, then the AST generator will make
6197 sure that coscheduled domain elements do not appear in separate parts
6198 of the AST.  This is useful in case of nested AST generation
6199 if the outer AST generation is given only part of a schedule
6200 and the inner AST generation should handle the domains that are
6201 coscheduled by this initial part of the schedule together.
6202 For example if an AST is generated for a schedule
6203
6204         { A[i] -> [0]; B[i] -> [0] }
6205
6206 then the C<isl_ast_build_set_create_leaf> callback described
6207 below may get called twice, once for each domain.
6208 Setting this option ensures that the callback is only called once
6209 on both domains together.
6210
6211 =item * ast_build_separation_bounds
6212
6213 This option specifies which bounds to use during separation.
6214 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
6215 then all (possibly implicit) bounds on the current dimension will
6216 be used during separation.
6217 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
6218 then only those bounds that are explicitly available will
6219 be used during separation.
6220
6221 =item * ast_build_scale_strides
6222
6223 This option specifies whether the AST generator is allowed
6224 to scale down iterators of strided loops.
6225
6226 =item * ast_build_allow_else
6227
6228 This option specifies whether the AST generator is allowed
6229 to construct if statements with else branches.
6230
6231 =item * ast_build_allow_or
6232
6233 This option specifies whether the AST generator is allowed
6234 to construct if conditions with disjunctions.
6235
6236 =back
6237
6238 =head3 Fine-grained Control over AST Generation
6239
6240 Besides specifying the constraints on the parameters,
6241 an C<isl_ast_build> object can be used to control
6242 various aspects of the AST generation process.
6243 The most prominent way of control is through ``options'',
6244 which can be set using the following function.
6245
6246         #include <isl/ast_build.h>
6247         __isl_give isl_ast_build *
6248         isl_ast_build_set_options(
6249                 __isl_take isl_ast_build *control,
6250                 __isl_take isl_union_map *options);
6251
6252 The options are encoded in an <isl_union_map>.
6253 The domain of this union relation refers to the schedule domain,
6254 i.e., the range of the schedule passed to C<isl_ast_build_ast_from_schedule>.
6255 In the case of nested AST generation (see L</"Nested AST Generation">),
6256 the domain of C<options> should refer to the extra piece of the schedule.
6257 That is, it should be equal to the range of the wrapped relation in the
6258 range of the schedule.
6259 The range of the options can consist of elements in one or more spaces,
6260 the names of which determine the effect of the option.
6261 The values of the range typically also refer to the schedule dimension
6262 to which the option applies.  In case of nested AST generation
6263 (see L</"Nested AST Generation">), these values refer to the position
6264 of the schedule dimension within the innermost AST generation.
6265 The constraints on the domain elements of
6266 the option should only refer to this dimension and earlier dimensions.
6267 We consider the following spaces.
6268
6269 =over
6270
6271 =item C<separation_class>
6272
6273 This space is a wrapped relation between two one dimensional spaces.
6274 The input space represents the schedule dimension to which the option
6275 applies and the output space represents the separation class.
6276 While constructing a loop corresponding to the specified schedule
6277 dimension(s), the AST generator will try to generate separate loops
6278 for domain elements that are assigned different classes.
6279 If only some of the elements are assigned a class, then those elements
6280 that are not assigned any class will be treated as belonging to a class
6281 that is separate from the explicitly assigned classes.
6282 The typical use case for this option is to separate full tiles from
6283 partial tiles.
6284 The other options, described below, are applied after the separation
6285 into classes.
6286
6287 As an example, consider the separation into full and partial tiles
6288 of a tiling of a triangular domain.
6289 Take, for example, the domain
6290
6291         { A[i,j] : 0 <= i,j and i + j <= 100 }
6292
6293 and a tiling into tiles of 10 by 10.  The input to the AST generator
6294 is then the schedule
6295
6296         { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
6297                                                 i + j <= 100 }
6298
6299 Without any options, the following AST is generated
6300
6301         for (int c0 = 0; c0 <= 10; c0 += 1)
6302           for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6303             for (int c2 = 10 * c0;
6304                  c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6305                  c2 += 1)
6306               for (int c3 = 10 * c1;
6307                    c3 <= min(10 * c1 + 9, -c2 + 100);
6308                    c3 += 1)
6309                 A(c2, c3);
6310
6311 Separation into full and partial tiles can be obtained by assigning
6312 a class, say C<0>, to the full tiles.  The full tiles are represented by those
6313 values of the first and second schedule dimensions for which there are
6314 values of the third and fourth dimensions to cover an entire tile.
6315 That is, we need to specify the following option
6316
6317         { [a,b,c,d] -> separation_class[[0]->[0]] :
6318                 exists b': 0 <= 10a,10b' and
6319                            10a+9+10b'+9 <= 100;
6320           [a,b,c,d] -> separation_class[[1]->[0]] :
6321                 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
6322
6323 which simplifies to
6324
6325         { [a, b, c, d] -> separation_class[[1] -> [0]] :
6326                 a >= 0 and b >= 0 and b <= 8 - a;
6327           [a, b, c, d] -> separation_class[[0] -> [0]] :
6328                 a >= 0 and a <= 8 }
6329
6330 With this option, the generated AST is as follows
6331
6332         {
6333           for (int c0 = 0; c0 <= 8; c0 += 1) {
6334             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
6335               for (int c2 = 10 * c0;
6336                    c2 <= 10 * c0 + 9; c2 += 1)
6337                 for (int c3 = 10 * c1;
6338                      c3 <= 10 * c1 + 9; c3 += 1)
6339                   A(c2, c3);
6340             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
6341               for (int c2 = 10 * c0;
6342                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6343                    c2 += 1)
6344                 for (int c3 = 10 * c1;
6345                      c3 <= min(-c2 + 100, 10 * c1 + 9);
6346                      c3 += 1)
6347                   A(c2, c3);
6348           }
6349           for (int c0 = 9; c0 <= 10; c0 += 1)
6350             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6351               for (int c2 = 10 * c0;
6352                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6353                    c2 += 1)
6354                 for (int c3 = 10 * c1;
6355                      c3 <= min(10 * c1 + 9, -c2 + 100);
6356                      c3 += 1)
6357                   A(c2, c3);
6358         }
6359
6360 =item C<separate>
6361
6362 This is a single-dimensional space representing the schedule dimension(s)
6363 to which ``separation'' should be applied.  Separation tries to split
6364 a loop into several pieces if this can avoid the generation of guards
6365 inside the loop.
6366 See also the C<atomic> option.
6367
6368 =item C<atomic>
6369
6370 This is a single-dimensional space representing the schedule dimension(s)
6371 for which the domains should be considered ``atomic''.  That is, the
6372 AST generator will make sure that any given domain space will only appear
6373 in a single loop at the specified level.
6374
6375 Consider the following schedule
6376
6377         { a[i] -> [i] : 0 <= i < 10;
6378           b[i] -> [i+1] : 0 <= i < 10 }
6379
6380 If the following option is specified
6381
6382         { [i] -> separate[x] }
6383
6384 then the following AST will be generated
6385
6386         {
6387           a(0);
6388           for (int c0 = 1; c0 <= 9; c0 += 1) {
6389             a(c0);
6390             b(c0 - 1);
6391           }
6392           b(9);
6393         }
6394
6395 If, on the other hand, the following option is specified
6396
6397         { [i] -> atomic[x] }
6398
6399 then the following AST will be generated
6400
6401         for (int c0 = 0; c0 <= 10; c0 += 1) {
6402           if (c0 <= 9)
6403             a(c0);
6404           if (c0 >= 1)
6405             b(c0 - 1);
6406         }
6407
6408 If neither C<atomic> nor C<separate> is specified, then the AST generator
6409 may produce either of these two results or some intermediate form.
6410
6411 =item C<unroll>
6412
6413 This is a single-dimensional space representing the schedule dimension(s)
6414 that should be I<completely> unrolled.
6415 To obtain a partial unrolling, the user should apply an additional
6416 strip-mining to the schedule and fully unroll the inner loop.
6417
6418 =back
6419
6420 Additional control is available through the following functions.
6421
6422         #include <isl/ast_build.h>
6423         __isl_give isl_ast_build *
6424         isl_ast_build_set_iterators(
6425                 __isl_take isl_ast_build *control,
6426                 __isl_take isl_id_list *iterators);
6427
6428 The function C<isl_ast_build_set_iterators> allows the user to
6429 specify a list of iterator C<isl_id>s to be used as iterators.
6430 If the input schedule is injective, then
6431 the number of elements in this list should be as large as the dimension
6432 of the schedule space, but no direct correspondence should be assumed
6433 between dimensions and elements.
6434 If the input schedule is not injective, then an additional number
6435 of C<isl_id>s equal to the largest dimension of the input domains
6436 may be required.
6437 If the number of provided C<isl_id>s is insufficient, then additional
6438 names are automatically generated.
6439
6440         #include <isl/ast_build.h>
6441         __isl_give isl_ast_build *
6442         isl_ast_build_set_create_leaf(
6443                 __isl_take isl_ast_build *control,
6444                 __isl_give isl_ast_node *(*fn)(
6445                         __isl_take isl_ast_build *build,
6446                         void *user), void *user);
6447
6448 The
6449 C<isl_ast_build_set_create_leaf> function allows for the
6450 specification of a callback that should be called whenever the AST
6451 generator arrives at an element of the schedule domain.
6452 The callback should return an AST node that should be inserted
6453 at the corresponding position of the AST.  The default action (when
6454 the callback is not set) is to continue generating parts of the AST to scan
6455 all the domain elements associated to the schedule domain element
6456 and to insert user nodes, ``calling'' the domain element, for each of them.
6457 The C<build> argument contains the current state of the C<isl_ast_build>.
6458 To ease nested AST generation (see L</"Nested AST Generation">),
6459 all control information that is
6460 specific to the current AST generation such as the options and
6461 the callbacks has been removed from this C<isl_ast_build>.
6462 The callback would typically return the result of a nested
6463 AST generation or a
6464 user defined node created using the following function.
6465
6466         #include <isl/ast.h>
6467         __isl_give isl_ast_node *isl_ast_node_alloc_user(
6468                 __isl_take isl_ast_expr *expr);
6469
6470         #include <isl/ast_build.h>
6471         __isl_give isl_ast_build *
6472         isl_ast_build_set_at_each_domain(
6473                 __isl_take isl_ast_build *build,
6474                 __isl_give isl_ast_node *(*fn)(
6475                         __isl_take isl_ast_node *node,
6476                         __isl_keep isl_ast_build *build,
6477                         void *user), void *user);
6478         __isl_give isl_ast_build *
6479         isl_ast_build_set_before_each_for(
6480                 __isl_take isl_ast_build *build,
6481                 __isl_give isl_id *(*fn)(
6482                         __isl_keep isl_ast_build *build,
6483                         void *user), void *user);
6484         __isl_give isl_ast_build *
6485         isl_ast_build_set_after_each_for(
6486                 __isl_take isl_ast_build *build,
6487                 __isl_give isl_ast_node *(*fn)(
6488                         __isl_take isl_ast_node *node,
6489                         __isl_keep isl_ast_build *build,
6490                         void *user), void *user);
6491
6492 The callback set by C<isl_ast_build_set_at_each_domain> will
6493 be called for each domain AST node.
6494 The callbacks set by C<isl_ast_build_set_before_each_for>
6495 and C<isl_ast_build_set_after_each_for> will be called
6496 for each for AST node.  The first will be called in depth-first
6497 pre-order, while the second will be called in depth-first post-order.
6498 Since C<isl_ast_build_set_before_each_for> is called before the for
6499 node is actually constructed, it is only passed an C<isl_ast_build>.
6500 The returned C<isl_id> will be added as an annotation (using
6501 C<isl_ast_node_set_annotation>) to the constructed for node.
6502 In particular, if the user has also specified an C<after_each_for>
6503 callback, then the annotation can be retrieved from the node passed to
6504 that callback using C<isl_ast_node_get_annotation>.
6505 All callbacks should C<NULL> on failure.
6506 The given C<isl_ast_build> can be used to create new
6507 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
6508 or C<isl_ast_build_call_from_pw_multi_aff>.
6509
6510 =head3 Nested AST Generation
6511
6512 C<isl> allows the user to create an AST within the context
6513 of another AST.  These nested ASTs are created using the
6514 same C<isl_ast_build_ast_from_schedule> function that is used to create the
6515 outer AST.  The C<build> argument should be an C<isl_ast_build>
6516 passed to a callback set by
6517 C<isl_ast_build_set_create_leaf>.
6518 The space of the range of the C<schedule> argument should refer
6519 to this build.  In particular, the space should be a wrapped
6520 relation and the domain of this wrapped relation should be the
6521 same as that of the range of the schedule returned by
6522 C<isl_ast_build_get_schedule> below.
6523 In practice, the new schedule is typically
6524 created by calling C<isl_union_map_range_product> on the old schedule
6525 and some extra piece of the schedule.
6526 The space of the schedule domain is also available from
6527 the C<isl_ast_build>.
6528
6529         #include <isl/ast_build.h>
6530         __isl_give isl_union_map *isl_ast_build_get_schedule(
6531                 __isl_keep isl_ast_build *build);
6532         __isl_give isl_space *isl_ast_build_get_schedule_space(
6533                 __isl_keep isl_ast_build *build);
6534         __isl_give isl_ast_build *isl_ast_build_restrict(
6535                 __isl_take isl_ast_build *build,
6536                 __isl_take isl_set *set);
6537
6538 The C<isl_ast_build_get_schedule> function returns a (partial)
6539 schedule for the domains elements for which part of the AST still needs to
6540 be generated in the current build.
6541 In particular, the domain elements are mapped to those iterations of the loops
6542 enclosing the current point of the AST generation inside which
6543 the domain elements are executed.
6544 No direct correspondence between
6545 the input schedule and this schedule should be assumed.
6546 The space obtained from C<isl_ast_build_get_schedule_space> can be used
6547 to create a set for C<isl_ast_build_restrict> to intersect
6548 with the current build.  In particular, the set passed to
6549 C<isl_ast_build_restrict> can have additional parameters.
6550 The ids of the set dimensions in the space returned by
6551 C<isl_ast_build_get_schedule_space> correspond to the
6552 iterators of the already generated loops.
6553 The user should not rely on the ids of the output dimensions
6554 of the relations in the union relation returned by
6555 C<isl_ast_build_get_schedule> having any particular value.
6556
6557 =head1 Applications
6558
6559 Although C<isl> is mainly meant to be used as a library,
6560 it also contains some basic applications that use some
6561 of the functionality of C<isl>.
6562 The input may be specified in either the L<isl format>
6563 or the L<PolyLib format>.
6564
6565 =head2 C<isl_polyhedron_sample>
6566
6567 C<isl_polyhedron_sample> takes a polyhedron as input and prints
6568 an integer element of the polyhedron, if there is any.
6569 The first column in the output is the denominator and is always
6570 equal to 1.  If the polyhedron contains no integer points,
6571 then a vector of length zero is printed.
6572
6573 =head2 C<isl_pip>
6574
6575 C<isl_pip> takes the same input as the C<example> program
6576 from the C<piplib> distribution, i.e., a set of constraints
6577 on the parameters, a line containing only -1 and finally a set
6578 of constraints on a parametric polyhedron.
6579 The coefficients of the parameters appear in the last columns
6580 (but before the final constant column).
6581 The output is the lexicographic minimum of the parametric polyhedron.
6582 As C<isl> currently does not have its own output format, the output
6583 is just a dump of the internal state.
6584
6585 =head2 C<isl_polyhedron_minimize>
6586
6587 C<isl_polyhedron_minimize> computes the minimum of some linear
6588 or affine objective function over the integer points in a polyhedron.
6589 If an affine objective function
6590 is given, then the constant should appear in the last column.
6591
6592 =head2 C<isl_polytope_scan>
6593
6594 Given a polytope, C<isl_polytope_scan> prints
6595 all integer points in the polytope.
6596
6597 =head2 C<isl_codegen>
6598
6599 Given a schedule, a context set and an options relation,
6600 C<isl_codegen> prints out an AST that scans the domain elements
6601 of the schedule in the order of their image(s) taking into account
6602 the constraints in the context set.