add isl_map_gist_domain
[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 =head1 Installation
157
158 The source of C<isl> can be obtained either as a tarball
159 or from the git repository.  Both are available from
160 L<http://freshmeat.net/projects/isl/>.
161 The installation process depends on how you obtained
162 the source.
163
164 =head2 Installation from the git repository
165
166 =over
167
168 =item 1 Clone or update the repository
169
170 The first time the source is obtained, you need to clone
171 the repository.
172
173         git clone git://repo.or.cz/isl.git
174
175 To obtain updates, you need to pull in the latest changes
176
177         git pull
178
179 =item 2 Generate C<configure>
180
181         ./autogen.sh
182
183 =back
184
185 After performing the above steps, continue
186 with the L<Common installation instructions>.
187
188 =head2 Common installation instructions
189
190 =over
191
192 =item 1 Obtain C<GMP>
193
194 Building C<isl> requires C<GMP>, including its headers files.
195 Your distribution may not provide these header files by default
196 and you may need to install a package called C<gmp-devel> or something
197 similar.  Alternatively, C<GMP> can be built from
198 source, available from L<http://gmplib.org/>.
199
200 =item 2 Configure
201
202 C<isl> uses the standard C<autoconf> C<configure> script.
203 To run it, just type
204
205         ./configure
206
207 optionally followed by some configure options.
208 A complete list of options can be obtained by running
209
210         ./configure --help
211
212 Below we discuss some of the more common options.
213
214 C<isl> can optionally use C<piplib>, but no
215 C<piplib> functionality is currently used by default.
216 The C<--with-piplib> option can
217 be used to specify which C<piplib>
218 library to use, either an installed version (C<system>),
219 an externally built version (C<build>)
220 or no version (C<no>).  The option C<build> is mostly useful
221 in C<configure> scripts of larger projects that bundle both C<isl>
222 and C<piplib>.
223
224 =over
225
226 =item C<--prefix>
227
228 Installation prefix for C<isl>
229
230 =item C<--with-gmp-prefix>
231
232 Installation prefix for C<GMP> (architecture-independent files).
233
234 =item C<--with-gmp-exec-prefix>
235
236 Installation prefix for C<GMP> (architecture-dependent files).
237
238 =item C<--with-piplib>
239
240 Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
241
242 =item C<--with-piplib-prefix>
243
244 Installation prefix for C<system> C<piplib> (architecture-independent files).
245
246 =item C<--with-piplib-exec-prefix>
247
248 Installation prefix for C<system> C<piplib> (architecture-dependent files).
249
250 =item C<--with-piplib-builddir>
251
252 Location where C<build> C<piplib> was built.
253
254 =back
255
256 =item 3 Compile
257
258         make
259
260 =item 4 Install (optional)
261
262         make install
263
264 =back
265
266 =head1 Library
267
268 =head2 Initialization
269
270 All manipulations of integer sets and relations occur within
271 the context of an C<isl_ctx>.
272 A given C<isl_ctx> can only be used within a single thread.
273 All arguments of a function are required to have been allocated
274 within the same context.
275 There are currently no functions available for moving an object
276 from one C<isl_ctx> to another C<isl_ctx>.  This means that
277 there is currently no way of safely moving an object from one
278 thread to another, unless the whole C<isl_ctx> is moved.
279
280 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
281 freed using C<isl_ctx_free>.
282 All objects allocated within an C<isl_ctx> should be freed
283 before the C<isl_ctx> itself is freed.
284
285         isl_ctx *isl_ctx_alloc();
286         void isl_ctx_free(isl_ctx *ctx);
287
288 =head2 Integers
289
290 All operations on integers, mainly the coefficients
291 of the constraints describing the sets and relations,
292 are performed in exact integer arithmetic using C<GMP>.
293 However, to allow future versions of C<isl> to optionally
294 support fixed integer arithmetic, all calls to C<GMP>
295 are wrapped inside C<isl> specific macros.
296 The basic type is C<isl_int> and the operations below
297 are available on this type.
298 The meanings of these operations are essentially the same
299 as their C<GMP> C<mpz_> counterparts.
300 As always with C<GMP> types, C<isl_int>s need to be
301 initialized with C<isl_int_init> before they can be used
302 and they need to be released with C<isl_int_clear>
303 after the last use.
304 The user should not assume that an C<isl_int> is represented
305 as a C<mpz_t>, but should instead explicitly convert between
306 C<mpz_t>s and C<isl_int>s using C<isl_int_set_gmp> and
307 C<isl_int_get_gmp> whenever a C<mpz_t> is required.
308
309 =over
310
311 =item isl_int_init(i)
312
313 =item isl_int_clear(i)
314
315 =item isl_int_set(r,i)
316
317 =item isl_int_set_si(r,i)
318
319 =item isl_int_set_gmp(r,g)
320
321 =item isl_int_get_gmp(i,g)
322
323 =item isl_int_abs(r,i)
324
325 =item isl_int_neg(r,i)
326
327 =item isl_int_swap(i,j)
328
329 =item isl_int_swap_or_set(i,j)
330
331 =item isl_int_add_ui(r,i,j)
332
333 =item isl_int_sub_ui(r,i,j)
334
335 =item isl_int_add(r,i,j)
336
337 =item isl_int_sub(r,i,j)
338
339 =item isl_int_mul(r,i,j)
340
341 =item isl_int_mul_ui(r,i,j)
342
343 =item isl_int_addmul(r,i,j)
344
345 =item isl_int_submul(r,i,j)
346
347 =item isl_int_gcd(r,i,j)
348
349 =item isl_int_lcm(r,i,j)
350
351 =item isl_int_divexact(r,i,j)
352
353 =item isl_int_cdiv_q(r,i,j)
354
355 =item isl_int_fdiv_q(r,i,j)
356
357 =item isl_int_fdiv_r(r,i,j)
358
359 =item isl_int_fdiv_q_ui(r,i,j)
360
361 =item isl_int_read(r,s)
362
363 =item isl_int_print(out,i,width)
364
365 =item isl_int_sgn(i)
366
367 =item isl_int_cmp(i,j)
368
369 =item isl_int_cmp_si(i,si)
370
371 =item isl_int_eq(i,j)
372
373 =item isl_int_ne(i,j)
374
375 =item isl_int_lt(i,j)
376
377 =item isl_int_le(i,j)
378
379 =item isl_int_gt(i,j)
380
381 =item isl_int_ge(i,j)
382
383 =item isl_int_abs_eq(i,j)
384
385 =item isl_int_abs_ne(i,j)
386
387 =item isl_int_abs_lt(i,j)
388
389 =item isl_int_abs_gt(i,j)
390
391 =item isl_int_abs_ge(i,j)
392
393 =item isl_int_is_zero(i)
394
395 =item isl_int_is_one(i)
396
397 =item isl_int_is_negone(i)
398
399 =item isl_int_is_pos(i)
400
401 =item isl_int_is_neg(i)
402
403 =item isl_int_is_nonpos(i)
404
405 =item isl_int_is_nonneg(i)
406
407 =item isl_int_is_divisible_by(i,j)
408
409 =back
410
411 =head2 Sets and Relations
412
413 C<isl> uses six types of objects for representing sets and relations,
414 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
415 C<isl_union_set> and C<isl_union_map>.
416 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
417 can be described as a conjunction of affine constraints, while
418 C<isl_set> and C<isl_map> represent unions of
419 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
420 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
421 to live in the same space.  C<isl_union_set>s and C<isl_union_map>s
422 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
423 where spaces are considered different if they have a different number
424 of dimensions and/or different names (see L<"Spaces">).
425 The difference between sets and relations (maps) is that sets have
426 one set of variables, while relations have two sets of variables,
427 input variables and output variables.
428
429 =head2 Memory Management
430
431 Since a high-level operation on sets and/or relations usually involves
432 several substeps and since the user is usually not interested in
433 the intermediate results, most functions that return a new object
434 will also release all the objects passed as arguments.
435 If the user still wants to use one or more of these arguments
436 after the function call, she should pass along a copy of the
437 object rather than the object itself.
438 The user is then responsible for making sure that the original
439 object gets used somewhere else or is explicitly freed.
440
441 The arguments and return values of all documented functions are
442 annotated to make clear which arguments are released and which
443 arguments are preserved.  In particular, the following annotations
444 are used
445
446 =over
447
448 =item C<__isl_give>
449
450 C<__isl_give> means that a new object is returned.
451 The user should make sure that the returned pointer is
452 used exactly once as a value for an C<__isl_take> argument.
453 In between, it can be used as a value for as many
454 C<__isl_keep> arguments as the user likes.
455 There is one exception, and that is the case where the
456 pointer returned is C<NULL>.  Is this case, the user
457 is free to use it as an C<__isl_take> argument or not.
458
459 =item C<__isl_take>
460
461 C<__isl_take> means that the object the argument points to
462 is taken over by the function and may no longer be used
463 by the user as an argument to any other function.
464 The pointer value must be one returned by a function
465 returning an C<__isl_give> pointer.
466 If the user passes in a C<NULL> value, then this will
467 be treated as an error in the sense that the function will
468 not perform its usual operation.  However, it will still
469 make sure that all the other C<__isl_take> arguments
470 are released.
471
472 =item C<__isl_keep>
473
474 C<__isl_keep> means that the function will only use the object
475 temporarily.  After the function has finished, the user
476 can still use it as an argument to other functions.
477 A C<NULL> value will be treated in the same way as
478 a C<NULL> value for an C<__isl_take> argument.
479
480 =back
481
482 =head2 Identifiers
483
484 Identifiers are used to identify both individual dimensions
485 and tuples of dimensions.  They consist of a name and an optional
486 pointer.  Identifiers with the same name but different pointer values
487 are considered to be distinct.
488 Identifiers can be constructed, copied, freed, inspected and printed
489 using the following functions.
490
491         #include <isl/id.h>
492         __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
493                 __isl_keep const char *name, void *user);
494         __isl_give isl_id *isl_id_copy(isl_id *id);
495         void *isl_id_free(__isl_take isl_id *id);
496
497         isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
498         void *isl_id_get_user(__isl_keep isl_id *id);
499         __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
500
501         __isl_give isl_printer *isl_printer_print_id(
502                 __isl_take isl_printer *p, __isl_keep isl_id *id);
503
504 Note that C<isl_id_get_name> returns a pointer to some internal
505 data structure, so the result can only be used while the
506 corresponding C<isl_id> is alive.
507
508 =head2 Spaces
509
510 Whenever a new set or relation is created from scratch,
511 the space in which it lives needs to be specified using an C<isl_space>.
512
513         #include <isl/space.h>
514         __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
515                 unsigned nparam, unsigned n_in, unsigned n_out);
516         __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
517                 unsigned nparam);
518         __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
519                 unsigned nparam, unsigned dim);
520         __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
521         void isl_space_free(__isl_take isl_space *space);
522         unsigned isl_space_dim(__isl_keep isl_space *space,
523                 enum isl_dim_type type);
524
525 The space used for creating a parameter domain
526 needs to be created using C<isl_space_params_alloc>.
527 For other sets, the space
528 needs to be created using C<isl_space_set_alloc>, while
529 for a relation, the space
530 needs to be created using C<isl_space_alloc>.
531 C<isl_space_dim> can be used
532 to find out the number of dimensions of each type in
533 a space, where type may be
534 C<isl_dim_param>, C<isl_dim_in> (only for relations),
535 C<isl_dim_out> (only for relations), C<isl_dim_set>
536 (only for sets) or C<isl_dim_all>.
537
538 To check whether a given space is that of a set or a map
539 or whether it is a parameter space, use these functions:
540
541         #include <isl/space.h>
542         int isl_space_is_params(__isl_keep isl_space *space);
543         int isl_space_is_set(__isl_keep isl_space *space);
544
545 It is often useful to create objects that live in the
546 same space as some other object.  This can be accomplished
547 by creating the new objects
548 (see L<Creating New Sets and Relations> or
549 L<Creating New (Piecewise) Quasipolynomials>) based on the space
550 of the original object.
551
552         #include <isl/set.h>
553         __isl_give isl_space *isl_basic_set_get_space(
554                 __isl_keep isl_basic_set *bset);
555         __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
556
557         #include <isl/union_set.h>
558         __isl_give isl_space *isl_union_set_get_space(
559                 __isl_keep isl_union_set *uset);
560
561         #include <isl/map.h>
562         __isl_give isl_space *isl_basic_map_get_space(
563                 __isl_keep isl_basic_map *bmap);
564         __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
565
566         #include <isl/union_map.h>
567         __isl_give isl_space *isl_union_map_get_space(
568                 __isl_keep isl_union_map *umap);
569
570         #include <isl/constraint.h>
571         __isl_give isl_space *isl_constraint_get_space(
572                 __isl_keep isl_constraint *constraint);
573
574         #include <isl/polynomial.h>
575         __isl_give isl_space *isl_qpolynomial_get_domain_space(
576                 __isl_keep isl_qpolynomial *qp);
577         __isl_give isl_space *isl_qpolynomial_get_space(
578                 __isl_keep isl_qpolynomial *qp);
579         __isl_give isl_space *isl_qpolynomial_fold_get_space(
580                 __isl_keep isl_qpolynomial_fold *fold);
581         __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
582                 __isl_keep isl_pw_qpolynomial *pwqp);
583         __isl_give isl_space *isl_pw_qpolynomial_get_space(
584                 __isl_keep isl_pw_qpolynomial *pwqp);
585         __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
586                 __isl_keep isl_pw_qpolynomial_fold *pwf);
587         __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
588                 __isl_keep isl_pw_qpolynomial_fold *pwf);
589         __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
590                 __isl_keep isl_union_pw_qpolynomial *upwqp);
591         __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
592                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
593
594         #include <isl/aff.h>
595         __isl_give isl_space *isl_aff_get_domain_space(
596                 __isl_keep isl_aff *aff);
597         __isl_give isl_space *isl_aff_get_space(
598                 __isl_keep isl_aff *aff);
599         __isl_give isl_space *isl_pw_aff_get_domain_space(
600                 __isl_keep isl_pw_aff *pwaff);
601         __isl_give isl_space *isl_pw_aff_get_space(
602                 __isl_keep isl_pw_aff *pwaff);
603         __isl_give isl_space *isl_multi_aff_get_space(
604                 __isl_keep isl_multi_aff *maff);
605         __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
606                 __isl_keep isl_pw_multi_aff *pma);
607         __isl_give isl_space *isl_pw_multi_aff_get_space(
608                 __isl_keep isl_pw_multi_aff *pma);
609
610         #include <isl/point.h>
611         __isl_give isl_space *isl_point_get_space(
612                 __isl_keep isl_point *pnt);
613
614 The identifiers or names of the individual dimensions may be set or read off
615 using the following functions.
616
617         #include <isl/space.h>
618         __isl_give isl_space *isl_space_set_dim_id(
619                 __isl_take isl_space *space,
620                 enum isl_dim_type type, unsigned pos,
621                 __isl_take isl_id *id);
622         int isl_space_has_dim_id(__isl_keep isl_space *space,
623                 enum isl_dim_type type, unsigned pos);
624         __isl_give isl_id *isl_space_get_dim_id(
625                 __isl_keep isl_space *space,
626                 enum isl_dim_type type, unsigned pos);
627         __isl_give isl_space *isl_space_set_dim_name(__isl_take isl_space *space,
628                                  enum isl_dim_type type, unsigned pos,
629                                  __isl_keep const char *name);
630         __isl_keep const char *isl_space_get_dim_name(__isl_keep isl_space *space,
631                                  enum isl_dim_type type, unsigned pos);
632
633 Note that C<isl_space_get_name> returns a pointer to some internal
634 data structure, so the result can only be used while the
635 corresponding C<isl_space> is alive.
636 Also note that every function that operates on two sets or relations
637 requires that both arguments have the same parameters.  This also
638 means that if one of the arguments has named parameters, then the
639 other needs to have named parameters too and the names need to match.
640 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
641 arguments may have different parameters (as long as they are named),
642 in which case the result will have as parameters the union of the parameters of
643 the arguments.
644
645 Given the identifier or name of a dimension (typically a parameter),
646 its position can be obtained from the following function.
647
648         #include <isl/space.h>
649         int isl_space_find_dim_by_id(__isl_keep isl_space *space,
650                 enum isl_dim_type type, __isl_keep isl_id *id);
651         int isl_space_find_dim_by_name(__isl_keep isl_space *space,
652                 enum isl_dim_type type, const char *name);
653
654 The identifiers or names of entire spaces may be set or read off
655 using the following functions.
656
657         #include <isl/space.h>
658         __isl_give isl_space *isl_space_set_tuple_id(
659                 __isl_take isl_space *space,
660                 enum isl_dim_type type, __isl_take isl_id *id);
661         __isl_give isl_space *isl_space_reset_tuple_id(
662                 __isl_take isl_space *space, enum isl_dim_type type);
663         int isl_space_has_tuple_id(__isl_keep isl_space *space,
664                 enum isl_dim_type type);
665         __isl_give isl_id *isl_space_get_tuple_id(
666                 __isl_keep isl_space *space, enum isl_dim_type type);
667         __isl_give isl_space *isl_space_set_tuple_name(
668                 __isl_take isl_space *space,
669                 enum isl_dim_type type, const char *s);
670         const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
671                 enum isl_dim_type type);
672
673 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
674 or C<isl_dim_set>.  As with C<isl_space_get_name>,
675 the C<isl_space_get_tuple_name> function returns a pointer to some internal
676 data structure.
677 Binary operations require the corresponding spaces of their arguments
678 to have the same name.
679
680 Spaces can be nested.  In particular, the domain of a set or
681 the domain or range of a relation can be a nested relation.
682 The following functions can be used to construct and deconstruct
683 such nested spaces.
684
685         #include <isl/space.h>
686         int isl_space_is_wrapping(__isl_keep isl_space *space);
687         __isl_give isl_space *isl_space_wrap(__isl_take isl_space *space);
688         __isl_give isl_space *isl_space_unwrap(__isl_take isl_space *space);
689
690 The input to C<isl_space_is_wrapping> and C<isl_space_unwrap> should
691 be the space of a set, while that of
692 C<isl_space_wrap> should be the space of a relation.
693 Conversely, the output of C<isl_space_unwrap> is the space
694 of a relation, while that of C<isl_space_wrap> is the space of a set.
695
696 Spaces can be created from other spaces
697 using the following functions.
698
699         __isl_give isl_space *isl_space_domain(__isl_take isl_space *space);
700         __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *space);
701         __isl_give isl_space *isl_space_range(__isl_take isl_space *space);
702         __isl_give isl_space *isl_space_from_range(__isl_take isl_space *space);
703         __isl_give isl_space *isl_space_params(
704                 __isl_take isl_space *space);
705         __isl_give isl_space *isl_space_set_from_params(
706                 __isl_take isl_space *space);
707         __isl_give isl_space *isl_space_reverse(__isl_take isl_space *space);
708         __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
709                 __isl_take isl_space *right);
710         __isl_give isl_space *isl_space_align_params(
711                 __isl_take isl_space *space1, __isl_take isl_space *space2)
712         __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *space,
713                 enum isl_dim_type type, unsigned pos, unsigned n);
714         __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *space,
715                 enum isl_dim_type type, unsigned n);
716         __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *space,
717                 enum isl_dim_type type, unsigned first, unsigned n);
718         __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *space,
719                 enum isl_dim_type dst_type, unsigned dst_pos,
720                 enum isl_dim_type src_type, unsigned src_pos,
721                 unsigned n);
722         __isl_give isl_space *isl_space_map_from_set(
723                 __isl_take isl_space *space);
724         __isl_give isl_space *isl_space_zip(__isl_take isl_space *space);
725
726 Note that if dimensions are added or removed from a space, then
727 the name and the internal structure are lost.
728
729 =head2 Local Spaces
730
731 A local space is essentially a space with
732 zero or more existentially quantified variables.
733 The local space of a basic set or relation can be obtained
734 using the following functions.
735
736         #include <isl/set.h>
737         __isl_give isl_local_space *isl_basic_set_get_local_space(
738                 __isl_keep isl_basic_set *bset);
739
740         #include <isl/map.h>
741         __isl_give isl_local_space *isl_basic_map_get_local_space(
742                 __isl_keep isl_basic_map *bmap);
743
744 A new local space can be created from a space using
745
746         #include <isl/local_space.h>
747         __isl_give isl_local_space *isl_local_space_from_space(
748                 __isl_take isl_space *space);
749
750 They can be inspected, modified, copied and freed using the following functions.
751
752         #include <isl/local_space.h>
753         isl_ctx *isl_local_space_get_ctx(
754                 __isl_keep isl_local_space *ls);
755         int isl_local_space_is_set(__isl_keep isl_local_space *ls);
756         int isl_local_space_dim(__isl_keep isl_local_space *ls,
757                 enum isl_dim_type type);
758         const char *isl_local_space_get_dim_name(
759                 __isl_keep isl_local_space *ls,
760                 enum isl_dim_type type, unsigned pos);
761         __isl_give isl_local_space *isl_local_space_set_dim_name(
762                 __isl_take isl_local_space *ls,
763                 enum isl_dim_type type, unsigned pos, const char *s);
764         __isl_give isl_local_space *isl_local_space_set_dim_id(
765                 __isl_take isl_local_space *ls,
766                 enum isl_dim_type type, unsigned pos,
767                 __isl_take isl_id *id);
768         __isl_give isl_space *isl_local_space_get_space(
769                 __isl_keep isl_local_space *ls);
770         __isl_give isl_aff *isl_local_space_get_div(
771                 __isl_keep isl_local_space *ls, int pos);
772         __isl_give isl_local_space *isl_local_space_copy(
773                 __isl_keep isl_local_space *ls);
774         void *isl_local_space_free(__isl_take isl_local_space *ls);
775
776 Two local spaces can be compared using
777
778         int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
779                 __isl_keep isl_local_space *ls2);
780
781 Local spaces can be created from other local spaces
782 using the following functions.
783
784         __isl_give isl_local_space *isl_local_space_domain(
785                 __isl_take isl_local_space *ls);
786         __isl_give isl_local_space *isl_local_space_from_domain(
787                 __isl_take isl_local_space *ls);
788         __isl_give isl_local_space *isl_local_space_intersect(
789                 __isl_take isl_local_space *ls1,
790                 __isl_take isl_local_space *ls2);
791         __isl_give isl_local_space *isl_local_space_add_dims(
792                 __isl_take isl_local_space *ls,
793                 enum isl_dim_type type, unsigned n);
794         __isl_give isl_local_space *isl_local_space_insert_dims(
795                 __isl_take isl_local_space *ls,
796                 enum isl_dim_type type, unsigned first, unsigned n);
797         __isl_give isl_local_space *isl_local_space_drop_dims(
798                 __isl_take isl_local_space *ls,
799                 enum isl_dim_type type, unsigned first, unsigned n);
800
801 =head2 Input and Output
802
803 C<isl> supports its own input/output format, which is similar
804 to the C<Omega> format, but also supports the C<PolyLib> format
805 in some cases.
806
807 =head3 C<isl> format
808
809 The C<isl> format is similar to that of C<Omega>, but has a different
810 syntax for describing the parameters and allows for the definition
811 of an existentially quantified variable as the integer division
812 of an affine expression.
813 For example, the set of integers C<i> between C<0> and C<n>
814 such that C<i % 10 <= 6> can be described as
815
816         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
817                                 i - 10 a <= 6) }
818
819 A set or relation can have several disjuncts, separated
820 by the keyword C<or>.  Each disjunct is either a conjunction
821 of constraints or a projection (C<exists>) of a conjunction
822 of constraints.  The constraints are separated by the keyword
823 C<and>.
824
825 =head3 C<PolyLib> format
826
827 If the represented set is a union, then the first line
828 contains a single number representing the number of disjuncts.
829 Otherwise, a line containing the number C<1> is optional.
830
831 Each disjunct is represented by a matrix of constraints.
832 The first line contains two numbers representing
833 the number of rows and columns,
834 where the number of rows is equal to the number of constraints
835 and the number of columns is equal to two plus the number of variables.
836 The following lines contain the actual rows of the constraint matrix.
837 In each row, the first column indicates whether the constraint
838 is an equality (C<0>) or inequality (C<1>).  The final column
839 corresponds to the constant term.
840
841 If the set is parametric, then the coefficients of the parameters
842 appear in the last columns before the constant column.
843 The coefficients of any existentially quantified variables appear
844 between those of the set variables and those of the parameters.
845
846 =head3 Extended C<PolyLib> format
847
848 The extended C<PolyLib> format is nearly identical to the
849 C<PolyLib> format.  The only difference is that the line
850 containing the number of rows and columns of a constraint matrix
851 also contains four additional numbers:
852 the number of output dimensions, the number of input dimensions,
853 the number of local dimensions (i.e., the number of existentially
854 quantified variables) and the number of parameters.
855 For sets, the number of ``output'' dimensions is equal
856 to the number of set dimensions, while the number of ``input''
857 dimensions is zero.
858
859 =head3 Input
860
861         #include <isl/set.h>
862         __isl_give isl_basic_set *isl_basic_set_read_from_file(
863                 isl_ctx *ctx, FILE *input);
864         __isl_give isl_basic_set *isl_basic_set_read_from_str(
865                 isl_ctx *ctx, const char *str);
866         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
867                 FILE *input);
868         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
869                 const char *str);
870
871         #include <isl/map.h>
872         __isl_give isl_basic_map *isl_basic_map_read_from_file(
873                 isl_ctx *ctx, FILE *input);
874         __isl_give isl_basic_map *isl_basic_map_read_from_str(
875                 isl_ctx *ctx, const char *str);
876         __isl_give isl_map *isl_map_read_from_file(
877                 isl_ctx *ctx, FILE *input);
878         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
879                 const char *str);
880
881         #include <isl/union_set.h>
882         __isl_give isl_union_set *isl_union_set_read_from_file(
883                 isl_ctx *ctx, FILE *input);
884         __isl_give isl_union_set *isl_union_set_read_from_str(
885                 isl_ctx *ctx, const char *str);
886
887         #include <isl/union_map.h>
888         __isl_give isl_union_map *isl_union_map_read_from_file(
889                 isl_ctx *ctx, FILE *input);
890         __isl_give isl_union_map *isl_union_map_read_from_str(
891                 isl_ctx *ctx, const char *str);
892
893 The input format is autodetected and may be either the C<PolyLib> format
894 or the C<isl> format.
895
896 =head3 Output
897
898 Before anything can be printed, an C<isl_printer> needs to
899 be created.
900
901         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
902                 FILE *file);
903         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
904         void isl_printer_free(__isl_take isl_printer *printer);
905         __isl_give char *isl_printer_get_str(
906                 __isl_keep isl_printer *printer);
907
908 The behavior of the printer can be modified in various ways
909
910         __isl_give isl_printer *isl_printer_set_output_format(
911                 __isl_take isl_printer *p, int output_format);
912         __isl_give isl_printer *isl_printer_set_indent(
913                 __isl_take isl_printer *p, int indent);
914         __isl_give isl_printer *isl_printer_indent(
915                 __isl_take isl_printer *p, int indent);
916         __isl_give isl_printer *isl_printer_set_prefix(
917                 __isl_take isl_printer *p, const char *prefix);
918         __isl_give isl_printer *isl_printer_set_suffix(
919                 __isl_take isl_printer *p, const char *suffix);
920
921 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
922 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
923 and defaults to C<ISL_FORMAT_ISL>.
924 Each line in the output is indented by C<indent> (set by
925 C<isl_printer_set_indent>) spaces
926 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
927 In the C<PolyLib> format output,
928 the coefficients of the existentially quantified variables
929 appear between those of the set variables and those
930 of the parameters.
931 The function C<isl_printer_indent> increases the indentation
932 by the specified amount (which may be negative).
933
934 To actually print something, use
935
936         #include <isl/set.h>
937         __isl_give isl_printer *isl_printer_print_basic_set(
938                 __isl_take isl_printer *printer,
939                 __isl_keep isl_basic_set *bset);
940         __isl_give isl_printer *isl_printer_print_set(
941                 __isl_take isl_printer *printer,
942                 __isl_keep isl_set *set);
943
944         #include <isl/map.h>
945         __isl_give isl_printer *isl_printer_print_basic_map(
946                 __isl_take isl_printer *printer,
947                 __isl_keep isl_basic_map *bmap);
948         __isl_give isl_printer *isl_printer_print_map(
949                 __isl_take isl_printer *printer,
950                 __isl_keep isl_map *map);
951
952         #include <isl/union_set.h>
953         __isl_give isl_printer *isl_printer_print_union_set(
954                 __isl_take isl_printer *p,
955                 __isl_keep isl_union_set *uset);
956
957         #include <isl/union_map.h>
958         __isl_give isl_printer *isl_printer_print_union_map(
959                 __isl_take isl_printer *p,
960                 __isl_keep isl_union_map *umap);
961
962 When called on a file printer, the following function flushes
963 the file.  When called on a string printer, the buffer is cleared.
964
965         __isl_give isl_printer *isl_printer_flush(
966                 __isl_take isl_printer *p);
967
968 =head2 Creating New Sets and Relations
969
970 C<isl> has functions for creating some standard sets and relations.
971
972 =over
973
974 =item * Empty sets and relations
975
976         __isl_give isl_basic_set *isl_basic_set_empty(
977                 __isl_take isl_space *space);
978         __isl_give isl_basic_map *isl_basic_map_empty(
979                 __isl_take isl_space *space);
980         __isl_give isl_set *isl_set_empty(
981                 __isl_take isl_space *space);
982         __isl_give isl_map *isl_map_empty(
983                 __isl_take isl_space *space);
984         __isl_give isl_union_set *isl_union_set_empty(
985                 __isl_take isl_space *space);
986         __isl_give isl_union_map *isl_union_map_empty(
987                 __isl_take isl_space *space);
988
989 For C<isl_union_set>s and C<isl_union_map>s, the space
990 is only used to specify the parameters.
991
992 =item * Universe sets and relations
993
994         __isl_give isl_basic_set *isl_basic_set_universe(
995                 __isl_take isl_space *space);
996         __isl_give isl_basic_map *isl_basic_map_universe(
997                 __isl_take isl_space *space);
998         __isl_give isl_set *isl_set_universe(
999                 __isl_take isl_space *space);
1000         __isl_give isl_map *isl_map_universe(
1001                 __isl_take isl_space *space);
1002         __isl_give isl_union_set *isl_union_set_universe(
1003                 __isl_take isl_union_set *uset);
1004         __isl_give isl_union_map *isl_union_map_universe(
1005                 __isl_take isl_union_map *umap);
1006
1007 The sets and relations constructed by the functions above
1008 contain all integer values, while those constructed by the
1009 functions below only contain non-negative values.
1010
1011         __isl_give isl_basic_set *isl_basic_set_nat_universe(
1012                 __isl_take isl_space *space);
1013         __isl_give isl_basic_map *isl_basic_map_nat_universe(
1014                 __isl_take isl_space *space);
1015         __isl_give isl_set *isl_set_nat_universe(
1016                 __isl_take isl_space *space);
1017         __isl_give isl_map *isl_map_nat_universe(
1018                 __isl_take isl_space *space);
1019
1020 =item * Identity relations
1021
1022         __isl_give isl_basic_map *isl_basic_map_identity(
1023                 __isl_take isl_space *space);
1024         __isl_give isl_map *isl_map_identity(
1025                 __isl_take isl_space *space);
1026
1027 The number of input and output dimensions in C<space> needs
1028 to be the same.
1029
1030 =item * Lexicographic order
1031
1032         __isl_give isl_map *isl_map_lex_lt(
1033                 __isl_take isl_space *set_space);
1034         __isl_give isl_map *isl_map_lex_le(
1035                 __isl_take isl_space *set_space);
1036         __isl_give isl_map *isl_map_lex_gt(
1037                 __isl_take isl_space *set_space);
1038         __isl_give isl_map *isl_map_lex_ge(
1039                 __isl_take isl_space *set_space);
1040         __isl_give isl_map *isl_map_lex_lt_first(
1041                 __isl_take isl_space *space, unsigned n);
1042         __isl_give isl_map *isl_map_lex_le_first(
1043                 __isl_take isl_space *space, unsigned n);
1044         __isl_give isl_map *isl_map_lex_gt_first(
1045                 __isl_take isl_space *space, unsigned n);
1046         __isl_give isl_map *isl_map_lex_ge_first(
1047                 __isl_take isl_space *space, unsigned n);
1048
1049 The first four functions take a space for a B<set>
1050 and return relations that express that the elements in the domain
1051 are lexicographically less
1052 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1053 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1054 than the elements in the range.
1055 The last four functions take a space for a map
1056 and return relations that express that the first C<n> dimensions
1057 in the domain are lexicographically less
1058 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1059 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1060 than the first C<n> dimensions in the range.
1061
1062 =back
1063
1064 A basic set or relation can be converted to a set or relation
1065 using the following functions.
1066
1067         __isl_give isl_set *isl_set_from_basic_set(
1068                 __isl_take isl_basic_set *bset);
1069         __isl_give isl_map *isl_map_from_basic_map(
1070                 __isl_take isl_basic_map *bmap);
1071
1072 Sets and relations can be converted to union sets and relations
1073 using the following functions.
1074
1075         __isl_give isl_union_map *isl_union_map_from_map(
1076                 __isl_take isl_map *map);
1077         __isl_give isl_union_set *isl_union_set_from_set(
1078                 __isl_take isl_set *set);
1079
1080 The inverse conversions below can only be used if the input
1081 union set or relation is known to contain elements in exactly one
1082 space.
1083
1084         __isl_give isl_set *isl_set_from_union_set(
1085                 __isl_take isl_union_set *uset);
1086         __isl_give isl_map *isl_map_from_union_map(
1087                 __isl_take isl_union_map *umap);
1088
1089 A zero-dimensional set can be constructed on a given parameter domain
1090 using the following function.
1091
1092         __isl_give isl_set *isl_set_from_params(
1093                 __isl_take isl_set *set);
1094
1095 Sets and relations can be copied and freed again using the following
1096 functions.
1097
1098         __isl_give isl_basic_set *isl_basic_set_copy(
1099                 __isl_keep isl_basic_set *bset);
1100         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1101         __isl_give isl_union_set *isl_union_set_copy(
1102                 __isl_keep isl_union_set *uset);
1103         __isl_give isl_basic_map *isl_basic_map_copy(
1104                 __isl_keep isl_basic_map *bmap);
1105         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1106         __isl_give isl_union_map *isl_union_map_copy(
1107                 __isl_keep isl_union_map *umap);
1108         void isl_basic_set_free(__isl_take isl_basic_set *bset);
1109         void isl_set_free(__isl_take isl_set *set);
1110         void *isl_union_set_free(__isl_take isl_union_set *uset);
1111         void isl_basic_map_free(__isl_take isl_basic_map *bmap);
1112         void isl_map_free(__isl_take isl_map *map);
1113         void *isl_union_map_free(__isl_take isl_union_map *umap);
1114
1115 Other sets and relations can be constructed by starting
1116 from a universe set or relation, adding equality and/or
1117 inequality constraints and then projecting out the
1118 existentially quantified variables, if any.
1119 Constraints can be constructed, manipulated and
1120 added to (or removed from) (basic) sets and relations
1121 using the following functions.
1122
1123         #include <isl/constraint.h>
1124         __isl_give isl_constraint *isl_equality_alloc(
1125                 __isl_take isl_local_space *ls);
1126         __isl_give isl_constraint *isl_inequality_alloc(
1127                 __isl_take isl_local_space *ls);
1128         __isl_give isl_constraint *isl_constraint_set_constant(
1129                 __isl_take isl_constraint *constraint, isl_int v);
1130         __isl_give isl_constraint *isl_constraint_set_constant_si(
1131                 __isl_take isl_constraint *constraint, int v);
1132         __isl_give isl_constraint *isl_constraint_set_coefficient(
1133                 __isl_take isl_constraint *constraint,
1134                 enum isl_dim_type type, int pos, isl_int v);
1135         __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1136                 __isl_take isl_constraint *constraint,
1137                 enum isl_dim_type type, int pos, int v);
1138         __isl_give isl_basic_map *isl_basic_map_add_constraint(
1139                 __isl_take isl_basic_map *bmap,
1140                 __isl_take isl_constraint *constraint);
1141         __isl_give isl_basic_set *isl_basic_set_add_constraint(
1142                 __isl_take isl_basic_set *bset,
1143                 __isl_take isl_constraint *constraint);
1144         __isl_give isl_map *isl_map_add_constraint(
1145                 __isl_take isl_map *map,
1146                 __isl_take isl_constraint *constraint);
1147         __isl_give isl_set *isl_set_add_constraint(
1148                 __isl_take isl_set *set,
1149                 __isl_take isl_constraint *constraint);
1150         __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1151                 __isl_take isl_basic_set *bset,
1152                 __isl_take isl_constraint *constraint);
1153
1154 For example, to create a set containing the even integers
1155 between 10 and 42, you would use the following code.
1156
1157         isl_space *space;
1158         isl_local_space *ls;
1159         isl_constraint *c;
1160         isl_basic_set *bset;
1161
1162         space = isl_space_set_alloc(ctx, 0, 2);
1163         bset = isl_basic_set_universe(isl_space_copy(space));
1164         ls = isl_local_space_from_space(space);
1165
1166         c = isl_equality_alloc(isl_local_space_copy(ls));
1167         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1168         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1169         bset = isl_basic_set_add_constraint(bset, c);
1170
1171         c = isl_inequality_alloc(isl_local_space_copy(ls));
1172         c = isl_constraint_set_constant_si(c, -10);
1173         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1174         bset = isl_basic_set_add_constraint(bset, c);
1175
1176         c = isl_inequality_alloc(ls);
1177         c = isl_constraint_set_constant_si(c, 42);
1178         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1179         bset = isl_basic_set_add_constraint(bset, c);
1180
1181         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1182
1183 Or, alternatively,
1184
1185         isl_basic_set *bset;
1186         bset = isl_basic_set_read_from_str(ctx,
1187                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1188
1189 A basic set or relation can also be constructed from two matrices
1190 describing the equalities and the inequalities.
1191
1192         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1193                 __isl_take isl_space *space,
1194                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1195                 enum isl_dim_type c1,
1196                 enum isl_dim_type c2, enum isl_dim_type c3,
1197                 enum isl_dim_type c4);
1198         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1199                 __isl_take isl_space *space,
1200                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1201                 enum isl_dim_type c1,
1202                 enum isl_dim_type c2, enum isl_dim_type c3,
1203                 enum isl_dim_type c4, enum isl_dim_type c5);
1204
1205 The C<isl_dim_type> arguments indicate the order in which
1206 different kinds of variables appear in the input matrices
1207 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1208 C<isl_dim_set> and C<isl_dim_div> for sets and
1209 of C<isl_dim_cst>, C<isl_dim_param>,
1210 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1211
1212 A (basic) set or relation can also be constructed from a (piecewise)
1213 (multiple) affine expression
1214 or a list of affine expressions
1215 (See L<"Piecewise Quasi Affine Expressions"> and
1216 L<"Piecewise Multiple Quasi Affine Expressions">).
1217
1218         __isl_give isl_basic_map *isl_basic_map_from_aff(
1219                 __isl_take isl_aff *aff);
1220         __isl_give isl_set *isl_set_from_pw_aff(
1221                 __isl_take isl_pw_aff *pwaff);
1222         __isl_give isl_map *isl_map_from_pw_aff(
1223                 __isl_take isl_pw_aff *pwaff);
1224         __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1225                 __isl_take isl_space *domain_space,
1226                 __isl_take isl_aff_list *list);
1227         __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1228                 __isl_take isl_multi_aff *maff)
1229         __isl_give isl_set *isl_set_from_pw_multi_aff(
1230                 __isl_take isl_pw_multi_aff *pma);
1231         __isl_give isl_map *isl_map_from_pw_multi_aff(
1232                 __isl_take isl_pw_multi_aff *pma);
1233
1234 The C<domain_dim> argument describes the domain of the resulting
1235 basic relation.  It is required because the C<list> may consist
1236 of zero affine expressions.
1237
1238 =head2 Inspecting Sets and Relations
1239
1240 Usually, the user should not have to care about the actual constraints
1241 of the sets and maps, but should instead apply the abstract operations
1242 explained in the following sections.
1243 Occasionally, however, it may be required to inspect the individual
1244 coefficients of the constraints.  This section explains how to do so.
1245 In these cases, it may also be useful to have C<isl> compute
1246 an explicit representation of the existentially quantified variables.
1247
1248         __isl_give isl_set *isl_set_compute_divs(
1249                 __isl_take isl_set *set);
1250         __isl_give isl_map *isl_map_compute_divs(
1251                 __isl_take isl_map *map);
1252         __isl_give isl_union_set *isl_union_set_compute_divs(
1253                 __isl_take isl_union_set *uset);
1254         __isl_give isl_union_map *isl_union_map_compute_divs(
1255                 __isl_take isl_union_map *umap);
1256
1257 This explicit representation defines the existentially quantified
1258 variables as integer divisions of the other variables, possibly
1259 including earlier existentially quantified variables.
1260 An explicitly represented existentially quantified variable therefore
1261 has a unique value when the values of the other variables are known.
1262 If, furthermore, the same existentials, i.e., existentials
1263 with the same explicit representations, should appear in the
1264 same order in each of the disjuncts of a set or map, then the user should call
1265 either of the following functions.
1266
1267         __isl_give isl_set *isl_set_align_divs(
1268                 __isl_take isl_set *set);
1269         __isl_give isl_map *isl_map_align_divs(
1270                 __isl_take isl_map *map);
1271
1272 Alternatively, the existentially quantified variables can be removed
1273 using the following functions, which compute an overapproximation.
1274
1275         __isl_give isl_basic_set *isl_basic_set_remove_divs(
1276                 __isl_take isl_basic_set *bset);
1277         __isl_give isl_basic_map *isl_basic_map_remove_divs(
1278                 __isl_take isl_basic_map *bmap);
1279         __isl_give isl_set *isl_set_remove_divs(
1280                 __isl_take isl_set *set);
1281         __isl_give isl_map *isl_map_remove_divs(
1282                 __isl_take isl_map *map);
1283
1284 To iterate over all the sets or maps in a union set or map, use
1285
1286         int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1287                 int (*fn)(__isl_take isl_set *set, void *user),
1288                 void *user);
1289         int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1290                 int (*fn)(__isl_take isl_map *map, void *user),
1291                 void *user);
1292
1293 The number of sets or maps in a union set or map can be obtained
1294 from
1295
1296         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1297         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1298
1299 To extract the set or map in a given space from a union, use
1300
1301         __isl_give isl_set *isl_union_set_extract_set(
1302                 __isl_keep isl_union_set *uset,
1303                 __isl_take isl_space *space);
1304         __isl_give isl_map *isl_union_map_extract_map(
1305                 __isl_keep isl_union_map *umap,
1306                 __isl_take isl_space *space);
1307
1308 To iterate over all the basic sets or maps in a set or map, use
1309
1310         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1311                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1312                 void *user);
1313         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1314                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1315                 void *user);
1316
1317 The callback function C<fn> should return 0 if successful and
1318 -1 if an error occurs.  In the latter case, or if any other error
1319 occurs, the above functions will return -1.
1320
1321 It should be noted that C<isl> does not guarantee that
1322 the basic sets or maps passed to C<fn> are disjoint.
1323 If this is required, then the user should call one of
1324 the following functions first.
1325
1326         __isl_give isl_set *isl_set_make_disjoint(
1327                 __isl_take isl_set *set);
1328         __isl_give isl_map *isl_map_make_disjoint(
1329                 __isl_take isl_map *map);
1330
1331 The number of basic sets in a set can be obtained
1332 from
1333
1334         int isl_set_n_basic_set(__isl_keep isl_set *set);
1335
1336 To iterate over the constraints of a basic set or map, use
1337
1338         #include <isl/constraint.h>
1339
1340         int isl_basic_map_foreach_constraint(
1341                 __isl_keep isl_basic_map *bmap,
1342                 int (*fn)(__isl_take isl_constraint *c, void *user),
1343                 void *user);
1344         void *isl_constraint_free(__isl_take isl_constraint *c);
1345
1346 Again, the callback function C<fn> should return 0 if successful and
1347 -1 if an error occurs.  In the latter case, or if any other error
1348 occurs, the above functions will return -1.
1349 The constraint C<c> represents either an equality or an inequality.
1350 Use the following function to find out whether a constraint
1351 represents an equality.  If not, it represents an inequality.
1352
1353         int isl_constraint_is_equality(
1354                 __isl_keep isl_constraint *constraint);
1355
1356 The coefficients of the constraints can be inspected using
1357 the following functions.
1358
1359         void isl_constraint_get_constant(
1360                 __isl_keep isl_constraint *constraint, isl_int *v);
1361         void isl_constraint_get_coefficient(
1362                 __isl_keep isl_constraint *constraint,
1363                 enum isl_dim_type type, int pos, isl_int *v);
1364         int isl_constraint_involves_dims(
1365                 __isl_keep isl_constraint *constraint,
1366                 enum isl_dim_type type, unsigned first, unsigned n);
1367
1368 The explicit representations of the existentially quantified
1369 variables can be inspected using the following function.
1370 Note that the user is only allowed to use this function
1371 if the inspected set or map is the result of a call
1372 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1373 The existentially quantified variable is equal to the floor
1374 of the returned affine expression.  The affine expression
1375 itself can be inspected using the functions in
1376 L<"Piecewise Quasi Affine Expressions">.
1377
1378         __isl_give isl_aff *isl_constraint_get_div(
1379                 __isl_keep isl_constraint *constraint, int pos);
1380
1381 To obtain the constraints of a basic set or map in matrix
1382 form, use the following functions.
1383
1384         __isl_give isl_mat *isl_basic_set_equalities_matrix(
1385                 __isl_keep isl_basic_set *bset,
1386                 enum isl_dim_type c1, enum isl_dim_type c2,
1387                 enum isl_dim_type c3, enum isl_dim_type c4);
1388         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1389                 __isl_keep isl_basic_set *bset,
1390                 enum isl_dim_type c1, enum isl_dim_type c2,
1391                 enum isl_dim_type c3, enum isl_dim_type c4);
1392         __isl_give isl_mat *isl_basic_map_equalities_matrix(
1393                 __isl_keep isl_basic_map *bmap,
1394                 enum isl_dim_type c1,
1395                 enum isl_dim_type c2, enum isl_dim_type c3,
1396                 enum isl_dim_type c4, enum isl_dim_type c5);
1397         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1398                 __isl_keep isl_basic_map *bmap,
1399                 enum isl_dim_type c1,
1400                 enum isl_dim_type c2, enum isl_dim_type c3,
1401                 enum isl_dim_type c4, enum isl_dim_type c5);
1402
1403 The C<isl_dim_type> arguments dictate the order in which
1404 different kinds of variables appear in the resulting matrix
1405 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1406 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1407
1408 The number of parameters, input, output or set dimensions can
1409 be obtained using the following functions.
1410
1411         unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1412                 enum isl_dim_type type);
1413         unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1414                 enum isl_dim_type type);
1415         unsigned isl_set_dim(__isl_keep isl_set *set,
1416                 enum isl_dim_type type);
1417         unsigned isl_map_dim(__isl_keep isl_map *map,
1418                 enum isl_dim_type type);
1419
1420 To check whether the description of a set or relation depends
1421 on one or more given dimensions, it is not necessary to iterate over all
1422 constraints.  Instead the following functions can be used.
1423
1424         int isl_basic_set_involves_dims(
1425                 __isl_keep isl_basic_set *bset,
1426                 enum isl_dim_type type, unsigned first, unsigned n);
1427         int isl_set_involves_dims(__isl_keep isl_set *set,
1428                 enum isl_dim_type type, unsigned first, unsigned n);
1429         int isl_basic_map_involves_dims(
1430                 __isl_keep isl_basic_map *bmap,
1431                 enum isl_dim_type type, unsigned first, unsigned n);
1432         int isl_map_involves_dims(__isl_keep isl_map *map,
1433                 enum isl_dim_type type, unsigned first, unsigned n);
1434
1435 Similarly, the following functions can be used to check whether
1436 a given dimension is involved in any lower or upper bound.
1437
1438         int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
1439                 enum isl_dim_type type, unsigned pos);
1440         int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
1441                 enum isl_dim_type type, unsigned pos);
1442
1443 The identifiers or names of the domain and range spaces of a set
1444 or relation can be read off or set using the following functions.
1445
1446         __isl_give isl_set *isl_set_set_tuple_id(
1447                 __isl_take isl_set *set, __isl_take isl_id *id);
1448         __isl_give isl_set *isl_set_reset_tuple_id(
1449                 __isl_take isl_set *set);
1450         int isl_set_has_tuple_id(__isl_keep isl_set *set);
1451         __isl_give isl_id *isl_set_get_tuple_id(
1452                 __isl_keep isl_set *set);
1453         __isl_give isl_map *isl_map_set_tuple_id(
1454                 __isl_take isl_map *map, enum isl_dim_type type,
1455                 __isl_take isl_id *id);
1456         __isl_give isl_map *isl_map_reset_tuple_id(
1457                 __isl_take isl_map *map, enum isl_dim_type type);
1458         int isl_map_has_tuple_id(__isl_keep isl_map *map,
1459                 enum isl_dim_type type);
1460         __isl_give isl_id *isl_map_get_tuple_id(
1461                 __isl_keep isl_map *map, enum isl_dim_type type);
1462
1463         const char *isl_basic_set_get_tuple_name(
1464                 __isl_keep isl_basic_set *bset);
1465         __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1466                 __isl_take isl_basic_set *set, const char *s);
1467         const char *isl_set_get_tuple_name(
1468                 __isl_keep isl_set *set);
1469         const char *isl_basic_map_get_tuple_name(
1470                 __isl_keep isl_basic_map *bmap,
1471                 enum isl_dim_type type);
1472         const char *isl_map_get_tuple_name(
1473                 __isl_keep isl_map *map,
1474                 enum isl_dim_type type);
1475
1476 As with C<isl_space_get_tuple_name>, the value returned points to
1477 an internal data structure.
1478 The identifiers, positions or names of individual dimensions can be
1479 read off using the following functions.
1480
1481         __isl_give isl_set *isl_set_set_dim_id(
1482                 __isl_take isl_set *set, enum isl_dim_type type,
1483                 unsigned pos, __isl_take isl_id *id);
1484         int isl_set_has_dim_id(__isl_keep isl_set *set,
1485                 enum isl_dim_type type, unsigned pos);
1486         __isl_give isl_id *isl_set_get_dim_id(
1487                 __isl_keep isl_set *set, enum isl_dim_type type,
1488                 unsigned pos);
1489         int isl_basic_map_has_dim_id(
1490                 __isl_keep isl_basic_map *bmap,
1491                 enum isl_dim_type type, unsigned pos);
1492         __isl_give isl_map *isl_map_set_dim_id(
1493                 __isl_take isl_map *map, enum isl_dim_type type,
1494                 unsigned pos, __isl_take isl_id *id);
1495         int isl_map_has_dim_id(__isl_keep isl_map *map,
1496                 enum isl_dim_type type, unsigned pos);
1497         __isl_give isl_id *isl_map_get_dim_id(
1498                 __isl_keep isl_map *map, enum isl_dim_type type,
1499                 unsigned pos);
1500
1501         int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1502                 enum isl_dim_type type, __isl_keep isl_id *id);
1503         int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1504                 enum isl_dim_type type, __isl_keep isl_id *id);
1505         int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1506                 enum isl_dim_type type, const char *name);
1507
1508         const char *isl_constraint_get_dim_name(
1509                 __isl_keep isl_constraint *constraint,
1510                 enum isl_dim_type type, unsigned pos);
1511         const char *isl_basic_set_get_dim_name(
1512                 __isl_keep isl_basic_set *bset,
1513                 enum isl_dim_type type, unsigned pos);
1514         const char *isl_set_get_dim_name(
1515                 __isl_keep isl_set *set,
1516                 enum isl_dim_type type, unsigned pos);
1517         const char *isl_basic_map_get_dim_name(
1518                 __isl_keep isl_basic_map *bmap,
1519                 enum isl_dim_type type, unsigned pos);
1520         const char *isl_map_get_dim_name(
1521                 __isl_keep isl_map *map,
1522                 enum isl_dim_type type, unsigned pos);
1523
1524 These functions are mostly useful to obtain the identifiers, positions
1525 or names of the parameters.  Identifiers of individual dimensions are
1526 essentially only useful for printing.  They are ignored by all other
1527 operations and may not be preserved across those operations.
1528
1529 =head2 Properties
1530
1531 =head3 Unary Properties
1532
1533 =over
1534
1535 =item * Emptiness
1536
1537 The following functions test whether the given set or relation
1538 contains any integer points.  The ``plain'' variants do not perform
1539 any computations, but simply check if the given set or relation
1540 is already known to be empty.
1541
1542         int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
1543         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
1544         int isl_set_plain_is_empty(__isl_keep isl_set *set);
1545         int isl_set_is_empty(__isl_keep isl_set *set);
1546         int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
1547         int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
1548         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
1549         int isl_map_plain_is_empty(__isl_keep isl_map *map);
1550         int isl_map_is_empty(__isl_keep isl_map *map);
1551         int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
1552
1553 =item * Universality
1554
1555         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
1556         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
1557         int isl_set_plain_is_universe(__isl_keep isl_set *set);
1558
1559 =item * Single-valuedness
1560
1561         int isl_map_is_single_valued(__isl_keep isl_map *map);
1562         int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
1563
1564 =item * Injectivity
1565
1566         int isl_map_plain_is_injective(__isl_keep isl_map *map);
1567         int isl_map_is_injective(__isl_keep isl_map *map);
1568         int isl_union_map_plain_is_injective(
1569                 __isl_keep isl_union_map *umap);
1570         int isl_union_map_is_injective(
1571                 __isl_keep isl_union_map *umap);
1572
1573 =item * Bijectivity
1574
1575         int isl_map_is_bijective(__isl_keep isl_map *map);
1576         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
1577
1578 =item * Position
1579
1580         int isl_basic_map_plain_is_fixed(
1581                 __isl_keep isl_basic_map *bmap,
1582                 enum isl_dim_type type, unsigned pos,
1583                 isl_int *val);
1584         int isl_set_plain_is_fixed(__isl_keep isl_set *set,
1585                 enum isl_dim_type type, unsigned pos,
1586                 isl_int *val);
1587         int isl_map_plain_is_fixed(__isl_keep isl_map *map,
1588                 enum isl_dim_type type, unsigned pos,
1589                 isl_int *val);
1590
1591 Check if the relation obviously lies on a hyperplane where the given dimension
1592 has a fixed value and if so, return that value in C<*val>.
1593
1594 =item * Space
1595
1596 To check whether a set is a parameter domain, use this function:
1597
1598         int isl_set_is_params(__isl_keep isl_set *set);
1599         int isl_union_set_is_params(
1600                 __isl_keep isl_union_set *uset);
1601
1602 =item * Wrapping
1603
1604 The following functions check whether the domain of the given
1605 (basic) set is a wrapped relation.
1606
1607         int isl_basic_set_is_wrapping(
1608                 __isl_keep isl_basic_set *bset);
1609         int isl_set_is_wrapping(__isl_keep isl_set *set);
1610
1611 =item * Internal Product
1612
1613         int isl_basic_map_can_zip(
1614                 __isl_keep isl_basic_map *bmap);
1615         int isl_map_can_zip(__isl_keep isl_map *map);
1616
1617 Check whether the product of domain and range of the given relation
1618 can be computed,
1619 i.e., whether both domain and range are nested relations.
1620
1621 =back
1622
1623 =head3 Binary Properties
1624
1625 =over
1626
1627 =item * Equality
1628
1629         int isl_set_plain_is_equal(__isl_keep isl_set *set1,
1630                 __isl_keep isl_set *set2);
1631         int isl_set_is_equal(__isl_keep isl_set *set1,
1632                 __isl_keep isl_set *set2);
1633         int isl_union_set_is_equal(
1634                 __isl_keep isl_union_set *uset1,
1635                 __isl_keep isl_union_set *uset2);
1636         int isl_basic_map_is_equal(
1637                 __isl_keep isl_basic_map *bmap1,
1638                 __isl_keep isl_basic_map *bmap2);
1639         int isl_map_is_equal(__isl_keep isl_map *map1,
1640                 __isl_keep isl_map *map2);
1641         int isl_map_plain_is_equal(__isl_keep isl_map *map1,
1642                 __isl_keep isl_map *map2);
1643         int isl_union_map_is_equal(
1644                 __isl_keep isl_union_map *umap1,
1645                 __isl_keep isl_union_map *umap2);
1646
1647 =item * Disjointness
1648
1649         int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
1650                 __isl_keep isl_set *set2);
1651
1652 =item * Subset
1653
1654         int isl_set_is_subset(__isl_keep isl_set *set1,
1655                 __isl_keep isl_set *set2);
1656         int isl_set_is_strict_subset(
1657                 __isl_keep isl_set *set1,
1658                 __isl_keep isl_set *set2);
1659         int isl_union_set_is_subset(
1660                 __isl_keep isl_union_set *uset1,
1661                 __isl_keep isl_union_set *uset2);
1662         int isl_union_set_is_strict_subset(
1663                 __isl_keep isl_union_set *uset1,
1664                 __isl_keep isl_union_set *uset2);
1665         int isl_basic_map_is_subset(
1666                 __isl_keep isl_basic_map *bmap1,
1667                 __isl_keep isl_basic_map *bmap2);
1668         int isl_basic_map_is_strict_subset(
1669                 __isl_keep isl_basic_map *bmap1,
1670                 __isl_keep isl_basic_map *bmap2);
1671         int isl_map_is_subset(
1672                 __isl_keep isl_map *map1,
1673                 __isl_keep isl_map *map2);
1674         int isl_map_is_strict_subset(
1675                 __isl_keep isl_map *map1,
1676                 __isl_keep isl_map *map2);
1677         int isl_union_map_is_subset(
1678                 __isl_keep isl_union_map *umap1,
1679                 __isl_keep isl_union_map *umap2);
1680         int isl_union_map_is_strict_subset(
1681                 __isl_keep isl_union_map *umap1,
1682                 __isl_keep isl_union_map *umap2);
1683
1684 =back
1685
1686 =head2 Unary Operations
1687
1688 =over
1689
1690 =item * Complement
1691
1692         __isl_give isl_set *isl_set_complement(
1693                 __isl_take isl_set *set);
1694
1695 =item * Inverse map
1696
1697         __isl_give isl_basic_map *isl_basic_map_reverse(
1698                 __isl_take isl_basic_map *bmap);
1699         __isl_give isl_map *isl_map_reverse(
1700                 __isl_take isl_map *map);
1701         __isl_give isl_union_map *isl_union_map_reverse(
1702                 __isl_take isl_union_map *umap);
1703
1704 =item * Projection
1705
1706         __isl_give isl_basic_set *isl_basic_set_project_out(
1707                 __isl_take isl_basic_set *bset,
1708                 enum isl_dim_type type, unsigned first, unsigned n);
1709         __isl_give isl_basic_map *isl_basic_map_project_out(
1710                 __isl_take isl_basic_map *bmap,
1711                 enum isl_dim_type type, unsigned first, unsigned n);
1712         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
1713                 enum isl_dim_type type, unsigned first, unsigned n);
1714         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
1715                 enum isl_dim_type type, unsigned first, unsigned n);
1716         __isl_give isl_basic_set *isl_basic_set_params(
1717                 __isl_take isl_basic_set *bset);
1718         __isl_give isl_basic_set *isl_basic_map_domain(
1719                 __isl_take isl_basic_map *bmap);
1720         __isl_give isl_basic_set *isl_basic_map_range(
1721                 __isl_take isl_basic_map *bmap);
1722         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
1723         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
1724         __isl_give isl_set *isl_map_domain(
1725                 __isl_take isl_map *bmap);
1726         __isl_give isl_set *isl_map_range(
1727                 __isl_take isl_map *map);
1728         __isl_give isl_union_set *isl_union_map_domain(
1729                 __isl_take isl_union_map *umap);
1730         __isl_give isl_union_set *isl_union_map_range(
1731                 __isl_take isl_union_map *umap);
1732
1733         __isl_give isl_basic_map *isl_basic_map_domain_map(
1734                 __isl_take isl_basic_map *bmap);
1735         __isl_give isl_basic_map *isl_basic_map_range_map(
1736                 __isl_take isl_basic_map *bmap);
1737         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
1738         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
1739         __isl_give isl_union_map *isl_union_map_domain_map(
1740                 __isl_take isl_union_map *umap);
1741         __isl_give isl_union_map *isl_union_map_range_map(
1742                 __isl_take isl_union_map *umap);
1743
1744 The functions above construct a (basic, regular or union) relation
1745 that maps (a wrapped version of) the input relation to its domain or range.
1746
1747 =item * Elimination
1748
1749         __isl_give isl_set *isl_set_eliminate(
1750                 __isl_take isl_set *set, enum isl_dim_type type,
1751                 unsigned first, unsigned n);
1752         __isl_give isl_basic_map *isl_basic_map_eliminate(
1753                 __isl_take isl_basic_map *bmap,
1754                 enum isl_dim_type type,
1755                 unsigned first, unsigned n);
1756
1757 Eliminate the coefficients for the given dimensions from the constraints,
1758 without removing the dimensions.
1759
1760 =item * Slicing
1761
1762         __isl_give isl_basic_set *isl_basic_set_fix(
1763                 __isl_take isl_basic_set *bset,
1764                 enum isl_dim_type type, unsigned pos,
1765                 isl_int value);
1766         __isl_give isl_basic_set *isl_basic_set_fix_si(
1767                 __isl_take isl_basic_set *bset,
1768                 enum isl_dim_type type, unsigned pos, int value);
1769         __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
1770                 enum isl_dim_type type, unsigned pos,
1771                 isl_int value);
1772         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
1773                 enum isl_dim_type type, unsigned pos, int value);
1774         __isl_give isl_basic_map *isl_basic_map_fix_si(
1775                 __isl_take isl_basic_map *bmap,
1776                 enum isl_dim_type type, unsigned pos, int value);
1777         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
1778                 enum isl_dim_type type, unsigned pos, int value);
1779
1780 Intersect the set or relation with the hyperplane where the given
1781 dimension has the fixed given value.
1782
1783         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
1784                 enum isl_dim_type type1, int pos1,
1785                 enum isl_dim_type type2, int pos2);
1786         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
1787                 enum isl_dim_type type1, int pos1,
1788                 enum isl_dim_type type2, int pos2);
1789
1790 Intersect the set or relation with the hyperplane where the given
1791 dimensions are equal to each other.
1792
1793         __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
1794                 enum isl_dim_type type1, int pos1,
1795                 enum isl_dim_type type2, int pos2);
1796
1797 Intersect the relation with the hyperplane where the given
1798 dimensions have opposite values.
1799
1800 =item * Identity
1801
1802         __isl_give isl_map *isl_set_identity(
1803                 __isl_take isl_set *set);
1804         __isl_give isl_union_map *isl_union_set_identity(
1805                 __isl_take isl_union_set *uset);
1806
1807 Construct an identity relation on the given (union) set.
1808
1809 =item * Deltas
1810
1811         __isl_give isl_basic_set *isl_basic_map_deltas(
1812                 __isl_take isl_basic_map *bmap);
1813         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
1814         __isl_give isl_union_set *isl_union_map_deltas(
1815                 __isl_take isl_union_map *umap);
1816
1817 These functions return a (basic) set containing the differences
1818 between image elements and corresponding domain elements in the input.
1819
1820         __isl_give isl_basic_map *isl_basic_map_deltas_map(
1821                 __isl_take isl_basic_map *bmap);
1822         __isl_give isl_map *isl_map_deltas_map(
1823                 __isl_take isl_map *map);
1824         __isl_give isl_union_map *isl_union_map_deltas_map(
1825                 __isl_take isl_union_map *umap);
1826
1827 The functions above construct a (basic, regular or union) relation
1828 that maps (a wrapped version of) the input relation to its delta set.
1829
1830 =item * Coalescing
1831
1832 Simplify the representation of a set or relation by trying
1833 to combine pairs of basic sets or relations into a single
1834 basic set or relation.
1835
1836         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
1837         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
1838         __isl_give isl_union_set *isl_union_set_coalesce(
1839                 __isl_take isl_union_set *uset);
1840         __isl_give isl_union_map *isl_union_map_coalesce(
1841                 __isl_take isl_union_map *umap);
1842
1843 =item * Detecting equalities
1844
1845         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
1846                 __isl_take isl_basic_set *bset);
1847         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
1848                 __isl_take isl_basic_map *bmap);
1849         __isl_give isl_set *isl_set_detect_equalities(
1850                 __isl_take isl_set *set);
1851         __isl_give isl_map *isl_map_detect_equalities(
1852                 __isl_take isl_map *map);
1853         __isl_give isl_union_set *isl_union_set_detect_equalities(
1854                 __isl_take isl_union_set *uset);
1855         __isl_give isl_union_map *isl_union_map_detect_equalities(
1856                 __isl_take isl_union_map *umap);
1857
1858 Simplify the representation of a set or relation by detecting implicit
1859 equalities.
1860
1861 =item * Removing redundant constraints
1862
1863         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
1864                 __isl_take isl_basic_set *bset);
1865         __isl_give isl_set *isl_set_remove_redundancies(
1866                 __isl_take isl_set *set);
1867         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
1868                 __isl_take isl_basic_map *bmap);
1869         __isl_give isl_map *isl_map_remove_redundancies(
1870                 __isl_take isl_map *map);
1871
1872 =item * Convex hull
1873
1874         __isl_give isl_basic_set *isl_set_convex_hull(
1875                 __isl_take isl_set *set);
1876         __isl_give isl_basic_map *isl_map_convex_hull(
1877                 __isl_take isl_map *map);
1878
1879 If the input set or relation has any existentially quantified
1880 variables, then the result of these operations is currently undefined.
1881
1882 =item * Simple hull
1883
1884         __isl_give isl_basic_set *isl_set_simple_hull(
1885                 __isl_take isl_set *set);
1886         __isl_give isl_basic_map *isl_map_simple_hull(
1887                 __isl_take isl_map *map);
1888         __isl_give isl_union_map *isl_union_map_simple_hull(
1889                 __isl_take isl_union_map *umap);
1890
1891 These functions compute a single basic set or relation
1892 that contains the whole input set or relation.
1893 In particular, the output is described by translates
1894 of the constraints describing the basic sets or relations in the input.
1895
1896 =begin latex
1897
1898 (See \autoref{s:simple hull}.)
1899
1900 =end latex
1901
1902 =item * Affine hull
1903
1904         __isl_give isl_basic_set *isl_basic_set_affine_hull(
1905                 __isl_take isl_basic_set *bset);
1906         __isl_give isl_basic_set *isl_set_affine_hull(
1907                 __isl_take isl_set *set);
1908         __isl_give isl_union_set *isl_union_set_affine_hull(
1909                 __isl_take isl_union_set *uset);
1910         __isl_give isl_basic_map *isl_basic_map_affine_hull(
1911                 __isl_take isl_basic_map *bmap);
1912         __isl_give isl_basic_map *isl_map_affine_hull(
1913                 __isl_take isl_map *map);
1914         __isl_give isl_union_map *isl_union_map_affine_hull(
1915                 __isl_take isl_union_map *umap);
1916
1917 In case of union sets and relations, the affine hull is computed
1918 per space.
1919
1920 =item * Polyhedral hull
1921
1922         __isl_give isl_basic_set *isl_set_polyhedral_hull(
1923                 __isl_take isl_set *set);
1924         __isl_give isl_basic_map *isl_map_polyhedral_hull(
1925                 __isl_take isl_map *map);
1926         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
1927                 __isl_take isl_union_set *uset);
1928         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
1929                 __isl_take isl_union_map *umap);
1930
1931 These functions compute a single basic set or relation
1932 not involving any existentially quantified variables
1933 that contains the whole input set or relation.
1934 In case of union sets and relations, the polyhedral hull is computed
1935 per space.
1936
1937 =item * Optimization
1938
1939         #include <isl/ilp.h>
1940         enum isl_lp_result isl_basic_set_max(
1941                 __isl_keep isl_basic_set *bset,
1942                 __isl_keep isl_aff *obj, isl_int *opt)
1943         enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
1944                 __isl_keep isl_aff *obj, isl_int *opt);
1945         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
1946                 __isl_keep isl_aff *obj, isl_int *opt);
1947
1948 Compute the minimum or maximum of the integer affine expression C<obj>
1949 over the points in C<set>, returning the result in C<opt>.
1950 The return value may be one of C<isl_lp_error>,
1951 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
1952
1953 =item * Parametric optimization
1954
1955         __isl_give isl_pw_aff *isl_set_dim_min(
1956                 __isl_take isl_set *set, int pos);
1957         __isl_give isl_pw_aff *isl_set_dim_max(
1958                 __isl_take isl_set *set, int pos);
1959         __isl_give isl_pw_aff *isl_map_dim_max(
1960                 __isl_take isl_map *map, int pos);
1961
1962 Compute the minimum or maximum of the given set or output dimension
1963 as a function of the parameters (and input dimensions), but independently
1964 of the other set or output dimensions.
1965 For lexicographic optimization, see L<"Lexicographic Optimization">.
1966
1967 =item * Dual
1968
1969 The following functions compute either the set of (rational) coefficient
1970 values of valid constraints for the given set or the set of (rational)
1971 values satisfying the constraints with coefficients from the given set.
1972 Internally, these two sets of functions perform essentially the
1973 same operations, except that the set of coefficients is assumed to
1974 be a cone, while the set of values may be any polyhedron.
1975 The current implementation is based on the Farkas lemma and
1976 Fourier-Motzkin elimination, but this may change or be made optional
1977 in future.  In particular, future implementations may use different
1978 dualization algorithms or skip the elimination step.
1979
1980         __isl_give isl_basic_set *isl_basic_set_coefficients(
1981                 __isl_take isl_basic_set *bset);
1982         __isl_give isl_basic_set *isl_set_coefficients(
1983                 __isl_take isl_set *set);
1984         __isl_give isl_union_set *isl_union_set_coefficients(
1985                 __isl_take isl_union_set *bset);
1986         __isl_give isl_basic_set *isl_basic_set_solutions(
1987                 __isl_take isl_basic_set *bset);
1988         __isl_give isl_basic_set *isl_set_solutions(
1989                 __isl_take isl_set *set);
1990         __isl_give isl_union_set *isl_union_set_solutions(
1991                 __isl_take isl_union_set *bset);
1992
1993 =item * Power
1994
1995         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
1996                 int *exact);
1997         __isl_give isl_union_map *isl_union_map_power(
1998                 __isl_take isl_union_map *umap, int *exact);
1999
2000 Compute a parametric representation for all positive powers I<k> of C<map>.
2001 The result maps I<k> to a nested relation corresponding to the
2002 I<k>th power of C<map>.
2003 The result may be an overapproximation.  If the result is known to be exact,
2004 then C<*exact> is set to C<1>.
2005
2006 =item * Transitive closure
2007
2008         __isl_give isl_map *isl_map_transitive_closure(
2009                 __isl_take isl_map *map, int *exact);
2010         __isl_give isl_union_map *isl_union_map_transitive_closure(
2011                 __isl_take isl_union_map *umap, int *exact);
2012
2013 Compute the transitive closure of C<map>.
2014 The result may be an overapproximation.  If the result is known to be exact,
2015 then C<*exact> is set to C<1>.
2016
2017 =item * Reaching path lengths
2018
2019         __isl_give isl_map *isl_map_reaching_path_lengths(
2020                 __isl_take isl_map *map, int *exact);
2021
2022 Compute a relation that maps each element in the range of C<map>
2023 to the lengths of all paths composed of edges in C<map> that
2024 end up in the given element.
2025 The result may be an overapproximation.  If the result is known to be exact,
2026 then C<*exact> is set to C<1>.
2027 To compute the I<maximal> path length, the resulting relation
2028 should be postprocessed by C<isl_map_lexmax>.
2029 In particular, if the input relation is a dependence relation
2030 (mapping sources to sinks), then the maximal path length corresponds
2031 to the free schedule.
2032 Note, however, that C<isl_map_lexmax> expects the maximum to be
2033 finite, so if the path lengths are unbounded (possibly due to
2034 the overapproximation), then you will get an error message.
2035
2036 =item * Wrapping
2037
2038         __isl_give isl_basic_set *isl_basic_map_wrap(
2039                 __isl_take isl_basic_map *bmap);
2040         __isl_give isl_set *isl_map_wrap(
2041                 __isl_take isl_map *map);
2042         __isl_give isl_union_set *isl_union_map_wrap(
2043                 __isl_take isl_union_map *umap);
2044         __isl_give isl_basic_map *isl_basic_set_unwrap(
2045                 __isl_take isl_basic_set *bset);
2046         __isl_give isl_map *isl_set_unwrap(
2047                 __isl_take isl_set *set);
2048         __isl_give isl_union_map *isl_union_set_unwrap(
2049                 __isl_take isl_union_set *uset);
2050
2051 =item * Flattening
2052
2053 Remove any internal structure of domain (and range) of the given
2054 set or relation.  If there is any such internal structure in the input,
2055 then the name of the space is also removed.
2056
2057         __isl_give isl_basic_set *isl_basic_set_flatten(
2058                 __isl_take isl_basic_set *bset);
2059         __isl_give isl_set *isl_set_flatten(
2060                 __isl_take isl_set *set);
2061         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2062                 __isl_take isl_basic_map *bmap);
2063         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2064                 __isl_take isl_basic_map *bmap);
2065         __isl_give isl_map *isl_map_flatten_range(
2066                 __isl_take isl_map *map);
2067         __isl_give isl_map *isl_map_flatten_domain(
2068                 __isl_take isl_map *map);
2069         __isl_give isl_basic_map *isl_basic_map_flatten(
2070                 __isl_take isl_basic_map *bmap);
2071         __isl_give isl_map *isl_map_flatten(
2072                 __isl_take isl_map *map);
2073
2074         __isl_give isl_map *isl_set_flatten_map(
2075                 __isl_take isl_set *set);
2076
2077 The function above constructs a relation
2078 that maps the input set to a flattened version of the set.
2079
2080 =item * Lifting
2081
2082 Lift the input set to a space with extra dimensions corresponding
2083 to the existentially quantified variables in the input.
2084 In particular, the result lives in a wrapped map where the domain
2085 is the original space and the range corresponds to the original
2086 existentially quantified variables.
2087
2088         __isl_give isl_basic_set *isl_basic_set_lift(
2089                 __isl_take isl_basic_set *bset);
2090         __isl_give isl_set *isl_set_lift(
2091                 __isl_take isl_set *set);
2092         __isl_give isl_union_set *isl_union_set_lift(
2093                 __isl_take isl_union_set *uset);
2094
2095 Given a local space that contains the existentially quantified
2096 variables of a set, a basic relation that, when applied to
2097 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2098 can be constructed using the following function.
2099
2100         #include <isl/local_space.h>
2101         __isl_give isl_basic_map *isl_local_space_lifting(
2102                 __isl_take isl_local_space *ls);
2103
2104 =item * Internal Product
2105
2106         __isl_give isl_basic_map *isl_basic_map_zip(
2107                 __isl_take isl_basic_map *bmap);
2108         __isl_give isl_map *isl_map_zip(
2109                 __isl_take isl_map *map);
2110         __isl_give isl_union_map *isl_union_map_zip(
2111                 __isl_take isl_union_map *umap);
2112
2113 Given a relation with nested relations for domain and range,
2114 interchange the range of the domain with the domain of the range.
2115
2116 =item * Aligning parameters
2117
2118         __isl_give isl_set *isl_set_align_params(
2119                 __isl_take isl_set *set,
2120                 __isl_take isl_space *model);
2121         __isl_give isl_map *isl_map_align_params(
2122                 __isl_take isl_map *map,
2123                 __isl_take isl_space *model);
2124
2125 Change the order of the parameters of the given set or relation
2126 such that the first parameters match those of C<model>.
2127 This may involve the introduction of extra parameters.
2128 All parameters need to be named.
2129
2130 =item * Dimension manipulation
2131
2132         __isl_give isl_set *isl_set_add_dims(
2133                 __isl_take isl_set *set,
2134                 enum isl_dim_type type, unsigned n);
2135         __isl_give isl_map *isl_map_add_dims(
2136                 __isl_take isl_map *map,
2137                 enum isl_dim_type type, unsigned n);
2138         __isl_give isl_set *isl_set_insert_dims(
2139                 __isl_take isl_set *set,
2140                 enum isl_dim_type type, unsigned pos, unsigned n);
2141         __isl_give isl_map *isl_map_insert_dims(
2142                 __isl_take isl_map *map,
2143                 enum isl_dim_type type, unsigned pos, unsigned n);
2144         __isl_give isl_basic_set *isl_basic_set_move_dims(
2145                 __isl_take isl_basic_set *bset,
2146                 enum isl_dim_type dst_type, unsigned dst_pos,
2147                 enum isl_dim_type src_type, unsigned src_pos,
2148                 unsigned n);
2149         __isl_give isl_basic_map *isl_basic_map_move_dims(
2150                 __isl_take isl_basic_map *bmap,
2151                 enum isl_dim_type dst_type, unsigned dst_pos,
2152                 enum isl_dim_type src_type, unsigned src_pos,
2153                 unsigned n);
2154         __isl_give isl_set *isl_set_move_dims(
2155                 __isl_take isl_set *set,
2156                 enum isl_dim_type dst_type, unsigned dst_pos,
2157                 enum isl_dim_type src_type, unsigned src_pos,
2158                 unsigned n);
2159         __isl_give isl_map *isl_map_move_dims(
2160                 __isl_take isl_map *map,
2161                 enum isl_dim_type dst_type, unsigned dst_pos,
2162                 enum isl_dim_type src_type, unsigned src_pos,
2163                 unsigned n);
2164
2165 It is usually not advisable to directly change the (input or output)
2166 space of a set or a relation as this removes the name and the internal
2167 structure of the space.  However, the above functions can be useful
2168 to add new parameters, assuming
2169 C<isl_set_align_params> and C<isl_map_align_params>
2170 are not sufficient.
2171
2172 =back
2173
2174 =head2 Binary Operations
2175
2176 The two arguments of a binary operation not only need to live
2177 in the same C<isl_ctx>, they currently also need to have
2178 the same (number of) parameters.
2179
2180 =head3 Basic Operations
2181
2182 =over
2183
2184 =item * Intersection
2185
2186         __isl_give isl_basic_set *isl_basic_set_intersect(
2187                 __isl_take isl_basic_set *bset1,
2188                 __isl_take isl_basic_set *bset2);
2189         __isl_give isl_set *isl_set_intersect_params(
2190                 __isl_take isl_set *set,
2191                 __isl_take isl_set *params);
2192         __isl_give isl_set *isl_set_intersect(
2193                 __isl_take isl_set *set1,
2194                 __isl_take isl_set *set2);
2195         __isl_give isl_union_set *isl_union_set_intersect_params(
2196                 __isl_take isl_union_set *uset,
2197                 __isl_take isl_set *set);
2198         __isl_give isl_union_map *isl_union_map_intersect_params(
2199                 __isl_take isl_union_map *umap,
2200                 __isl_take isl_set *set);
2201         __isl_give isl_union_set *isl_union_set_intersect(
2202                 __isl_take isl_union_set *uset1,
2203                 __isl_take isl_union_set *uset2);
2204         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2205                 __isl_take isl_basic_map *bmap,
2206                 __isl_take isl_basic_set *bset);
2207         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2208                 __isl_take isl_basic_map *bmap,
2209                 __isl_take isl_basic_set *bset);
2210         __isl_give isl_basic_map *isl_basic_map_intersect(
2211                 __isl_take isl_basic_map *bmap1,
2212                 __isl_take isl_basic_map *bmap2);
2213         __isl_give isl_map *isl_map_intersect_params(
2214                 __isl_take isl_map *map,
2215                 __isl_take isl_set *params);
2216         __isl_give isl_map *isl_map_intersect_domain(
2217                 __isl_take isl_map *map,
2218                 __isl_take isl_set *set);
2219         __isl_give isl_map *isl_map_intersect_range(
2220                 __isl_take isl_map *map,
2221                 __isl_take isl_set *set);
2222         __isl_give isl_map *isl_map_intersect(
2223                 __isl_take isl_map *map1,
2224                 __isl_take isl_map *map2);
2225         __isl_give isl_union_map *isl_union_map_intersect_domain(
2226                 __isl_take isl_union_map *umap,
2227                 __isl_take isl_union_set *uset);
2228         __isl_give isl_union_map *isl_union_map_intersect_range(
2229                 __isl_take isl_union_map *umap,
2230                 __isl_take isl_union_set *uset);
2231         __isl_give isl_union_map *isl_union_map_intersect(
2232                 __isl_take isl_union_map *umap1,
2233                 __isl_take isl_union_map *umap2);
2234
2235 =item * Union
2236
2237         __isl_give isl_set *isl_basic_set_union(
2238                 __isl_take isl_basic_set *bset1,
2239                 __isl_take isl_basic_set *bset2);
2240         __isl_give isl_map *isl_basic_map_union(
2241                 __isl_take isl_basic_map *bmap1,
2242                 __isl_take isl_basic_map *bmap2);
2243         __isl_give isl_set *isl_set_union(
2244                 __isl_take isl_set *set1,
2245                 __isl_take isl_set *set2);
2246         __isl_give isl_map *isl_map_union(
2247                 __isl_take isl_map *map1,
2248                 __isl_take isl_map *map2);
2249         __isl_give isl_union_set *isl_union_set_union(
2250                 __isl_take isl_union_set *uset1,
2251                 __isl_take isl_union_set *uset2);
2252         __isl_give isl_union_map *isl_union_map_union(
2253                 __isl_take isl_union_map *umap1,
2254                 __isl_take isl_union_map *umap2);
2255
2256 =item * Set difference
2257
2258         __isl_give isl_set *isl_set_subtract(
2259                 __isl_take isl_set *set1,
2260                 __isl_take isl_set *set2);
2261         __isl_give isl_map *isl_map_subtract(
2262                 __isl_take isl_map *map1,
2263                 __isl_take isl_map *map2);
2264         __isl_give isl_union_set *isl_union_set_subtract(
2265                 __isl_take isl_union_set *uset1,
2266                 __isl_take isl_union_set *uset2);
2267         __isl_give isl_union_map *isl_union_map_subtract(
2268                 __isl_take isl_union_map *umap1,
2269                 __isl_take isl_union_map *umap2);
2270
2271 =item * Application
2272
2273         __isl_give isl_basic_set *isl_basic_set_apply(
2274                 __isl_take isl_basic_set *bset,
2275                 __isl_take isl_basic_map *bmap);
2276         __isl_give isl_set *isl_set_apply(
2277                 __isl_take isl_set *set,
2278                 __isl_take isl_map *map);
2279         __isl_give isl_union_set *isl_union_set_apply(
2280                 __isl_take isl_union_set *uset,
2281                 __isl_take isl_union_map *umap);
2282         __isl_give isl_basic_map *isl_basic_map_apply_domain(
2283                 __isl_take isl_basic_map *bmap1,
2284                 __isl_take isl_basic_map *bmap2);
2285         __isl_give isl_basic_map *isl_basic_map_apply_range(
2286                 __isl_take isl_basic_map *bmap1,
2287                 __isl_take isl_basic_map *bmap2);
2288         __isl_give isl_map *isl_map_apply_domain(
2289                 __isl_take isl_map *map1,
2290                 __isl_take isl_map *map2);
2291         __isl_give isl_union_map *isl_union_map_apply_domain(
2292                 __isl_take isl_union_map *umap1,
2293                 __isl_take isl_union_map *umap2);
2294         __isl_give isl_map *isl_map_apply_range(
2295                 __isl_take isl_map *map1,
2296                 __isl_take isl_map *map2);
2297         __isl_give isl_union_map *isl_union_map_apply_range(
2298                 __isl_take isl_union_map *umap1,
2299                 __isl_take isl_union_map *umap2);
2300
2301 =item * Cartesian Product
2302
2303         __isl_give isl_set *isl_set_product(
2304                 __isl_take isl_set *set1,
2305                 __isl_take isl_set *set2);
2306         __isl_give isl_union_set *isl_union_set_product(
2307                 __isl_take isl_union_set *uset1,
2308                 __isl_take isl_union_set *uset2);
2309         __isl_give isl_basic_map *isl_basic_map_domain_product(
2310                 __isl_take isl_basic_map *bmap1,
2311                 __isl_take isl_basic_map *bmap2);
2312         __isl_give isl_basic_map *isl_basic_map_range_product(
2313                 __isl_take isl_basic_map *bmap1,
2314                 __isl_take isl_basic_map *bmap2);
2315         __isl_give isl_map *isl_map_domain_product(
2316                 __isl_take isl_map *map1,
2317                 __isl_take isl_map *map2);
2318         __isl_give isl_map *isl_map_range_product(
2319                 __isl_take isl_map *map1,
2320                 __isl_take isl_map *map2);
2321         __isl_give isl_union_map *isl_union_map_range_product(
2322                 __isl_take isl_union_map *umap1,
2323                 __isl_take isl_union_map *umap2);
2324         __isl_give isl_map *isl_map_product(
2325                 __isl_take isl_map *map1,
2326                 __isl_take isl_map *map2);
2327         __isl_give isl_union_map *isl_union_map_product(
2328                 __isl_take isl_union_map *umap1,
2329                 __isl_take isl_union_map *umap2);
2330
2331 The above functions compute the cross product of the given
2332 sets or relations.  The domains and ranges of the results
2333 are wrapped maps between domains and ranges of the inputs.
2334 To obtain a ``flat'' product, use the following functions
2335 instead.
2336
2337         __isl_give isl_basic_set *isl_basic_set_flat_product(
2338                 __isl_take isl_basic_set *bset1,
2339                 __isl_take isl_basic_set *bset2);
2340         __isl_give isl_set *isl_set_flat_product(
2341                 __isl_take isl_set *set1,
2342                 __isl_take isl_set *set2);
2343         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
2344                 __isl_take isl_basic_map *bmap1,
2345                 __isl_take isl_basic_map *bmap2);
2346         __isl_give isl_map *isl_map_flat_domain_product(
2347                 __isl_take isl_map *map1,
2348                 __isl_take isl_map *map2);
2349         __isl_give isl_map *isl_map_flat_range_product(
2350                 __isl_take isl_map *map1,
2351                 __isl_take isl_map *map2);
2352         __isl_give isl_union_map *isl_union_map_flat_range_product(
2353                 __isl_take isl_union_map *umap1,
2354                 __isl_take isl_union_map *umap2);
2355         __isl_give isl_basic_map *isl_basic_map_flat_product(
2356                 __isl_take isl_basic_map *bmap1,
2357                 __isl_take isl_basic_map *bmap2);
2358         __isl_give isl_map *isl_map_flat_product(
2359                 __isl_take isl_map *map1,
2360                 __isl_take isl_map *map2);
2361
2362 =item * Simplification
2363
2364         __isl_give isl_basic_set *isl_basic_set_gist(
2365                 __isl_take isl_basic_set *bset,
2366                 __isl_take isl_basic_set *context);
2367         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
2368                 __isl_take isl_set *context);
2369         __isl_give isl_set *isl_set_gist_params(
2370                 __isl_take isl_set *set,
2371                 __isl_take isl_set *context);
2372         __isl_give isl_union_set *isl_union_set_gist(
2373                 __isl_take isl_union_set *uset,
2374                 __isl_take isl_union_set *context);
2375         __isl_give isl_union_set *isl_union_set_gist_params(
2376                 __isl_take isl_union_set *uset,
2377                 __isl_take isl_set *set);
2378         __isl_give isl_basic_map *isl_basic_map_gist(
2379                 __isl_take isl_basic_map *bmap,
2380                 __isl_take isl_basic_map *context);
2381         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
2382                 __isl_take isl_map *context);
2383         __isl_give isl_map *isl_map_gist_params(
2384                 __isl_take isl_map *map,
2385                 __isl_take isl_set *context);
2386         __isl_give isl_map *isl_map_gist_domain(
2387                 __isl_take isl_map *map,
2388                 __isl_take isl_set *context);
2389         __isl_give isl_union_map *isl_union_map_gist(
2390                 __isl_take isl_union_map *umap,
2391                 __isl_take isl_union_map *context);
2392         __isl_give isl_union_map *isl_union_map_gist_params(
2393                 __isl_take isl_union_map *umap,
2394                 __isl_take isl_set *set);
2395
2396 The gist operation returns a set or relation that has the
2397 same intersection with the context as the input set or relation.
2398 Any implicit equality in the intersection is made explicit in the result,
2399 while all inequalities that are redundant with respect to the intersection
2400 are removed.
2401 In case of union sets and relations, the gist operation is performed
2402 per space.
2403
2404 =back
2405
2406 =head3 Lexicographic Optimization
2407
2408 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
2409 the following functions
2410 compute a set that contains the lexicographic minimum or maximum
2411 of the elements in C<set> (or C<bset>) for those values of the parameters
2412 that satisfy C<dom>.
2413 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2414 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
2415 has no elements.
2416 In other words, the union of the parameter values
2417 for which the result is non-empty and of C<*empty>
2418 is equal to C<dom>.
2419
2420         __isl_give isl_set *isl_basic_set_partial_lexmin(
2421                 __isl_take isl_basic_set *bset,
2422                 __isl_take isl_basic_set *dom,
2423                 __isl_give isl_set **empty);
2424         __isl_give isl_set *isl_basic_set_partial_lexmax(
2425                 __isl_take isl_basic_set *bset,
2426                 __isl_take isl_basic_set *dom,
2427                 __isl_give isl_set **empty);
2428         __isl_give isl_set *isl_set_partial_lexmin(
2429                 __isl_take isl_set *set, __isl_take isl_set *dom,
2430                 __isl_give isl_set **empty);
2431         __isl_give isl_set *isl_set_partial_lexmax(
2432                 __isl_take isl_set *set, __isl_take isl_set *dom,
2433                 __isl_give isl_set **empty);
2434
2435 Given a (basic) set C<set> (or C<bset>), the following functions simply
2436 return a set containing the lexicographic minimum or maximum
2437 of the elements in C<set> (or C<bset>).
2438 In case of union sets, the optimum is computed per space.
2439
2440         __isl_give isl_set *isl_basic_set_lexmin(
2441                 __isl_take isl_basic_set *bset);
2442         __isl_give isl_set *isl_basic_set_lexmax(
2443                 __isl_take isl_basic_set *bset);
2444         __isl_give isl_set *isl_set_lexmin(
2445                 __isl_take isl_set *set);
2446         __isl_give isl_set *isl_set_lexmax(
2447                 __isl_take isl_set *set);
2448         __isl_give isl_union_set *isl_union_set_lexmin(
2449                 __isl_take isl_union_set *uset);
2450         __isl_give isl_union_set *isl_union_set_lexmax(
2451                 __isl_take isl_union_set *uset);
2452
2453 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
2454 the following functions
2455 compute a relation that maps each element of C<dom>
2456 to the single lexicographic minimum or maximum
2457 of the elements that are associated to that same
2458 element in C<map> (or C<bmap>).
2459 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2460 that contains the elements in C<dom> that do not map
2461 to any elements in C<map> (or C<bmap>).
2462 In other words, the union of the domain of the result and of C<*empty>
2463 is equal to C<dom>.
2464
2465         __isl_give isl_map *isl_basic_map_partial_lexmax(
2466                 __isl_take isl_basic_map *bmap,
2467                 __isl_take isl_basic_set *dom,
2468                 __isl_give isl_set **empty);
2469         __isl_give isl_map *isl_basic_map_partial_lexmin(
2470                 __isl_take isl_basic_map *bmap,
2471                 __isl_take isl_basic_set *dom,
2472                 __isl_give isl_set **empty);
2473         __isl_give isl_map *isl_map_partial_lexmax(
2474                 __isl_take isl_map *map, __isl_take isl_set *dom,
2475                 __isl_give isl_set **empty);
2476         __isl_give isl_map *isl_map_partial_lexmin(
2477                 __isl_take isl_map *map, __isl_take isl_set *dom,
2478                 __isl_give isl_set **empty);
2479
2480 Given a (basic) map C<map> (or C<bmap>), the following functions simply
2481 return a map mapping each element in the domain of
2482 C<map> (or C<bmap>) to the lexicographic minimum or maximum
2483 of all elements associated to that element.
2484 In case of union relations, the optimum is computed per space.
2485
2486         __isl_give isl_map *isl_basic_map_lexmin(
2487                 __isl_take isl_basic_map *bmap);
2488         __isl_give isl_map *isl_basic_map_lexmax(
2489                 __isl_take isl_basic_map *bmap);
2490         __isl_give isl_map *isl_map_lexmin(
2491                 __isl_take isl_map *map);
2492         __isl_give isl_map *isl_map_lexmax(
2493                 __isl_take isl_map *map);
2494         __isl_give isl_union_map *isl_union_map_lexmin(
2495                 __isl_take isl_union_map *umap);
2496         __isl_give isl_union_map *isl_union_map_lexmax(
2497                 __isl_take isl_union_map *umap);
2498
2499 The following functions return their result in the form of
2500 a piecewise multi-affine expression
2501 (See L<"Piecewise Multiple Quasi Affine Expressions">),
2502 but are otherwise equivalent to the corresponding functions
2503 returning a basic set or relation.
2504
2505         __isl_give isl_pw_multi_aff *
2506         isl_basic_map_lexmin_pw_multi_aff(
2507                 __isl_take isl_basic_map *bmap);
2508         __isl_give isl_pw_multi_aff *
2509         isl_basic_set_partial_lexmin_pw_multi_aff(
2510                 __isl_take isl_basic_set *bset,
2511                 __isl_take isl_basic_set *dom,
2512                 __isl_give isl_set **empty);
2513         __isl_give isl_pw_multi_aff *
2514         isl_basic_set_partial_lexmax_pw_multi_aff(
2515                 __isl_take isl_basic_set *bset,
2516                 __isl_take isl_basic_set *dom,
2517                 __isl_give isl_set **empty);
2518         __isl_give isl_pw_multi_aff *
2519         isl_basic_map_partial_lexmin_pw_multi_aff(
2520                 __isl_take isl_basic_map *bmap,
2521                 __isl_take isl_basic_set *dom,
2522                 __isl_give isl_set **empty);
2523         __isl_give isl_pw_multi_aff *
2524         isl_basic_map_partial_lexmax_pw_multi_aff(
2525                 __isl_take isl_basic_map *bmap,
2526                 __isl_take isl_basic_set *dom,
2527                 __isl_give isl_set **empty);
2528
2529 =head2 Lists
2530
2531 Lists are defined over several element types, including
2532 C<isl_aff>, C<isl_pw_aff>, C<isl_basic_set> and C<isl_set>.
2533 Here we take lists of C<isl_set>s as an example.
2534 Lists can be created, copied and freed using the following functions.
2535
2536         #include <isl/list.h>
2537         __isl_give isl_set_list *isl_set_list_from_set(
2538                 __isl_take isl_set *el);
2539         __isl_give isl_set_list *isl_set_list_alloc(
2540                 isl_ctx *ctx, int n);
2541         __isl_give isl_set_list *isl_set_list_copy(
2542                 __isl_keep isl_set_list *list);
2543         __isl_give isl_set_list *isl_set_list_add(
2544                 __isl_take isl_set_list *list,
2545                 __isl_take isl_set *el);
2546         __isl_give isl_set_list *isl_set_list_concat(
2547                 __isl_take isl_set_list *list1,
2548                 __isl_take isl_set_list *list2);
2549         void *isl_set_list_free(__isl_take isl_set_list *list);
2550
2551 C<isl_set_list_alloc> creates an empty list with a capacity for
2552 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
2553 element.
2554
2555 Lists can be inspected using the following functions.
2556
2557         #include <isl/list.h>
2558         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
2559         int isl_set_list_n_set(__isl_keep isl_set_list *list);
2560         __isl_give isl_set *isl_set_list_get_set(
2561                 __isl_keep isl_set_list *list, int index);
2562         int isl_set_list_foreach(__isl_keep isl_set_list *list,
2563                 int (*fn)(__isl_take isl_set *el, void *user),
2564                 void *user);
2565
2566 Lists can be printed using
2567
2568         #include <isl/list.h>
2569         __isl_give isl_printer *isl_printer_print_set_list(
2570                 __isl_take isl_printer *p,
2571                 __isl_keep isl_set_list *list);
2572
2573 =head2 Matrices
2574
2575 Matrices can be created, copied and freed using the following functions.
2576
2577         #include <isl/mat.h>
2578         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
2579                 unsigned n_row, unsigned n_col);
2580         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
2581         void isl_mat_free(__isl_take isl_mat *mat);
2582
2583 Note that the elements of a newly created matrix may have arbitrary values.
2584 The elements can be changed and inspected using the following functions.
2585
2586         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
2587         int isl_mat_rows(__isl_keep isl_mat *mat);
2588         int isl_mat_cols(__isl_keep isl_mat *mat);
2589         int isl_mat_get_element(__isl_keep isl_mat *mat,
2590                 int row, int col, isl_int *v);
2591         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
2592                 int row, int col, isl_int v);
2593         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
2594                 int row, int col, int v);
2595
2596 C<isl_mat_get_element> will return a negative value if anything went wrong.
2597 In that case, the value of C<*v> is undefined.
2598
2599 The following function can be used to compute the (right) inverse
2600 of a matrix, i.e., a matrix such that the product of the original
2601 and the inverse (in that order) is a multiple of the identity matrix.
2602 The input matrix is assumed to be of full row-rank.
2603
2604         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
2605
2606 The following function can be used to compute the (right) kernel
2607 (or null space) of a matrix, i.e., a matrix such that the product of
2608 the original and the kernel (in that order) is the zero matrix.
2609
2610         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
2611
2612 =head2 Piecewise Quasi Affine Expressions
2613
2614 The zero quasi affine expression on a given domain can be created using
2615
2616         __isl_give isl_aff *isl_aff_zero_on_domain(
2617                 __isl_take isl_local_space *ls);
2618
2619 Note that the space in which the resulting object lives is a map space
2620 with the given space as domain and a one-dimensional range.
2621
2622 An empty piecewise quasi affine expression (one with no cells)
2623 or a piecewise quasi affine expression with a single cell can
2624 be created using the following functions.
2625
2626         #include <isl/aff.h>
2627         __isl_give isl_pw_aff *isl_pw_aff_empty(
2628                 __isl_take isl_space *space);
2629         __isl_give isl_pw_aff *isl_pw_aff_alloc(
2630                 __isl_take isl_set *set, __isl_take isl_aff *aff);
2631         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
2632                 __isl_take isl_aff *aff);
2633
2634 Quasi affine expressions can be copied and freed using
2635
2636         #include <isl/aff.h>
2637         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
2638         void *isl_aff_free(__isl_take isl_aff *aff);
2639
2640         __isl_give isl_pw_aff *isl_pw_aff_copy(
2641                 __isl_keep isl_pw_aff *pwaff);
2642         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
2643
2644 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
2645 using the following function.  The constraint is required to have
2646 a non-zero coefficient for the specified dimension.
2647
2648         #include <isl/constraint.h>
2649         __isl_give isl_aff *isl_constraint_get_bound(
2650                 __isl_keep isl_constraint *constraint,
2651                 enum isl_dim_type type, int pos);
2652
2653 The entire affine expression of the constraint can also be extracted
2654 using the following function.
2655
2656         #include <isl/constraint.h>
2657         __isl_give isl_aff *isl_constraint_get_aff(
2658                 __isl_keep isl_constraint *constraint);
2659
2660 Conversely, an equality constraint equating
2661 the affine expression to zero or an inequality constraint enforcing
2662 the affine expression to be non-negative, can be constructed using
2663
2664         __isl_give isl_constraint *isl_equality_from_aff(
2665                 __isl_take isl_aff *aff);
2666         __isl_give isl_constraint *isl_inequality_from_aff(
2667                 __isl_take isl_aff *aff);
2668
2669 The expression can be inspected using
2670
2671         #include <isl/aff.h>
2672         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
2673         int isl_aff_dim(__isl_keep isl_aff *aff,
2674                 enum isl_dim_type type);
2675         __isl_give isl_local_space *isl_aff_get_domain_local_space(
2676                 __isl_keep isl_aff *aff);
2677         __isl_give isl_local_space *isl_aff_get_local_space(
2678                 __isl_keep isl_aff *aff);
2679         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
2680                 enum isl_dim_type type, unsigned pos);
2681         const char *isl_pw_aff_get_dim_name(
2682                 __isl_keep isl_pw_aff *pa,
2683                 enum isl_dim_type type, unsigned pos);
2684         __isl_give isl_id *isl_pw_aff_get_dim_id(
2685                 __isl_keep isl_pw_aff *pa,
2686                 enum isl_dim_type type, unsigned pos);
2687         int isl_aff_get_constant(__isl_keep isl_aff *aff,
2688                 isl_int *v);
2689         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
2690                 enum isl_dim_type type, int pos, isl_int *v);
2691         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
2692                 isl_int *v);
2693         __isl_give isl_aff *isl_aff_get_div(
2694                 __isl_keep isl_aff *aff, int pos);
2695
2696         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
2697                 int (*fn)(__isl_take isl_set *set,
2698                           __isl_take isl_aff *aff,
2699                           void *user), void *user);
2700
2701         int isl_aff_is_cst(__isl_keep isl_aff *aff);
2702         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
2703
2704         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
2705                 enum isl_dim_type type, unsigned first, unsigned n);
2706         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
2707                 enum isl_dim_type type, unsigned first, unsigned n);
2708
2709         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
2710         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
2711                 enum isl_dim_type type);
2712         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
2713
2714 It can be modified using
2715
2716         #include <isl/aff.h>
2717         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
2718                 __isl_take isl_pw_aff *pwaff,
2719                 enum isl_dim_type type, __isl_take isl_id *id);
2720         __isl_give isl_aff *isl_aff_set_dim_name(
2721                 __isl_take isl_aff *aff, enum isl_dim_type type,
2722                 unsigned pos, const char *s);
2723         __isl_give isl_aff *isl_aff_set_dim_id(
2724                 __isl_take isl_aff *aff, enum isl_dim_type type,
2725                 unsigned pos, __isl_take isl_id *id);
2726         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
2727                 __isl_take isl_pw_aff *pma,
2728                 enum isl_dim_type type, unsigned pos,
2729                 __isl_take isl_id *id);
2730         __isl_give isl_aff *isl_aff_set_constant(
2731                 __isl_take isl_aff *aff, isl_int v);
2732         __isl_give isl_aff *isl_aff_set_constant_si(
2733                 __isl_take isl_aff *aff, int v);
2734         __isl_give isl_aff *isl_aff_set_coefficient(
2735                 __isl_take isl_aff *aff,
2736                 enum isl_dim_type type, int pos, isl_int v);
2737         __isl_give isl_aff *isl_aff_set_coefficient_si(
2738                 __isl_take isl_aff *aff,
2739                 enum isl_dim_type type, int pos, int v);
2740         __isl_give isl_aff *isl_aff_set_denominator(
2741                 __isl_take isl_aff *aff, isl_int v);
2742
2743         __isl_give isl_aff *isl_aff_add_constant(
2744                 __isl_take isl_aff *aff, isl_int v);
2745         __isl_give isl_aff *isl_aff_add_constant_si(
2746                 __isl_take isl_aff *aff, int v);
2747         __isl_give isl_aff *isl_aff_add_coefficient(
2748                 __isl_take isl_aff *aff,
2749                 enum isl_dim_type type, int pos, isl_int v);
2750         __isl_give isl_aff *isl_aff_add_coefficient_si(
2751                 __isl_take isl_aff *aff,
2752                 enum isl_dim_type type, int pos, int v);
2753
2754         __isl_give isl_aff *isl_aff_insert_dims(
2755                 __isl_take isl_aff *aff,
2756                 enum isl_dim_type type, unsigned first, unsigned n);
2757         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
2758                 __isl_take isl_pw_aff *pwaff,
2759                 enum isl_dim_type type, unsigned first, unsigned n);
2760         __isl_give isl_aff *isl_aff_add_dims(
2761                 __isl_take isl_aff *aff,
2762                 enum isl_dim_type type, unsigned n);
2763         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
2764                 __isl_take isl_pw_aff *pwaff,
2765                 enum isl_dim_type type, unsigned n);
2766         __isl_give isl_aff *isl_aff_drop_dims(
2767                 __isl_take isl_aff *aff,
2768                 enum isl_dim_type type, unsigned first, unsigned n);
2769         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
2770                 __isl_take isl_pw_aff *pwaff,
2771                 enum isl_dim_type type, unsigned first, unsigned n);
2772
2773 Note that the C<set_constant> and C<set_coefficient> functions
2774 set the I<numerator> of the constant or coefficient, while
2775 C<add_constant> and C<add_coefficient> add an integer value to
2776 the possibly rational constant or coefficient.
2777
2778 To check whether an affine expressions is obviously zero
2779 or obviously equal to some other affine expression, use
2780
2781         #include <isl/aff.h>
2782         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
2783         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
2784                 __isl_keep isl_aff *aff2);
2785         int isl_pw_aff_plain_is_equal(
2786                 __isl_keep isl_pw_aff *pwaff1,
2787                 __isl_keep isl_pw_aff *pwaff2);
2788
2789 Operations include
2790
2791         #include <isl/aff.h>
2792         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
2793                 __isl_take isl_aff *aff2);
2794         __isl_give isl_pw_aff *isl_pw_aff_add(
2795                 __isl_take isl_pw_aff *pwaff1,
2796                 __isl_take isl_pw_aff *pwaff2);
2797         __isl_give isl_pw_aff *isl_pw_aff_min(
2798                 __isl_take isl_pw_aff *pwaff1,
2799                 __isl_take isl_pw_aff *pwaff2);
2800         __isl_give isl_pw_aff *isl_pw_aff_max(
2801                 __isl_take isl_pw_aff *pwaff1,
2802                 __isl_take isl_pw_aff *pwaff2);
2803         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
2804                 __isl_take isl_aff *aff2);
2805         __isl_give isl_pw_aff *isl_pw_aff_sub(
2806                 __isl_take isl_pw_aff *pwaff1,
2807                 __isl_take isl_pw_aff *pwaff2);
2808         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
2809         __isl_give isl_pw_aff *isl_pw_aff_neg(
2810                 __isl_take isl_pw_aff *pwaff);
2811         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
2812         __isl_give isl_pw_aff *isl_pw_aff_ceil(
2813                 __isl_take isl_pw_aff *pwaff);
2814         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
2815         __isl_give isl_pw_aff *isl_pw_aff_floor(
2816                 __isl_take isl_pw_aff *pwaff);
2817         __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
2818                 isl_int mod);
2819         __isl_give isl_pw_aff *isl_pw_aff_mod(
2820                 __isl_take isl_pw_aff *pwaff, isl_int mod);
2821         __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
2822                 isl_int f);
2823         __isl_give isl_pw_aff *isl_pw_aff_scale(
2824                 __isl_take isl_pw_aff *pwaff, isl_int f);
2825         __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
2826                 isl_int f);
2827         __isl_give isl_aff *isl_aff_scale_down_ui(
2828                 __isl_take isl_aff *aff, unsigned f);
2829         __isl_give isl_pw_aff *isl_pw_aff_scale_down(
2830                 __isl_take isl_pw_aff *pwaff, isl_int f);
2831
2832         __isl_give isl_pw_aff *isl_pw_aff_list_min(
2833                 __isl_take isl_pw_aff_list *list);
2834         __isl_give isl_pw_aff *isl_pw_aff_list_max(
2835                 __isl_take isl_pw_aff_list *list);
2836
2837         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
2838                 __isl_take isl_pw_aff *pwqp);
2839
2840         __isl_give isl_pw_aff *isl_pw_aff_align_params(
2841                 __isl_take isl_pw_aff *pwaff,
2842                 __isl_take isl_space *model);
2843
2844         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
2845                 __isl_take isl_set *context);
2846         __isl_give isl_pw_aff *isl_pw_aff_gist(
2847                 __isl_take isl_pw_aff *pwaff,
2848                 __isl_take isl_set *context);
2849
2850         __isl_give isl_set *isl_pw_aff_domain(
2851                 __isl_take isl_pw_aff *pwaff);
2852         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
2853                 __isl_take isl_pw_aff *pa,
2854                 __isl_take isl_set *set);
2855
2856         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
2857                 __isl_take isl_aff *aff2);
2858         __isl_give isl_pw_aff *isl_pw_aff_mul(
2859                 __isl_take isl_pw_aff *pwaff1,
2860                 __isl_take isl_pw_aff *pwaff2);
2861
2862 When multiplying two affine expressions, at least one of the two needs
2863 to be a constant.
2864
2865         #include <isl/aff.h>
2866         __isl_give isl_basic_set *isl_aff_le_basic_set(
2867                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
2868         __isl_give isl_basic_set *isl_aff_ge_basic_set(
2869                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
2870         __isl_give isl_set *isl_pw_aff_eq_set(
2871                 __isl_take isl_pw_aff *pwaff1,
2872                 __isl_take isl_pw_aff *pwaff2);
2873         __isl_give isl_set *isl_pw_aff_ne_set(
2874                 __isl_take isl_pw_aff *pwaff1,
2875                 __isl_take isl_pw_aff *pwaff2);
2876         __isl_give isl_set *isl_pw_aff_le_set(
2877                 __isl_take isl_pw_aff *pwaff1,
2878                 __isl_take isl_pw_aff *pwaff2);
2879         __isl_give isl_set *isl_pw_aff_lt_set(
2880                 __isl_take isl_pw_aff *pwaff1,
2881                 __isl_take isl_pw_aff *pwaff2);
2882         __isl_give isl_set *isl_pw_aff_ge_set(
2883                 __isl_take isl_pw_aff *pwaff1,
2884                 __isl_take isl_pw_aff *pwaff2);
2885         __isl_give isl_set *isl_pw_aff_gt_set(
2886                 __isl_take isl_pw_aff *pwaff1,
2887                 __isl_take isl_pw_aff *pwaff2);
2888
2889         __isl_give isl_set *isl_pw_aff_list_eq_set(
2890                 __isl_take isl_pw_aff_list *list1,
2891                 __isl_take isl_pw_aff_list *list2);
2892         __isl_give isl_set *isl_pw_aff_list_ne_set(
2893                 __isl_take isl_pw_aff_list *list1,
2894                 __isl_take isl_pw_aff_list *list2);
2895         __isl_give isl_set *isl_pw_aff_list_le_set(
2896                 __isl_take isl_pw_aff_list *list1,
2897                 __isl_take isl_pw_aff_list *list2);
2898         __isl_give isl_set *isl_pw_aff_list_lt_set(
2899                 __isl_take isl_pw_aff_list *list1,
2900                 __isl_take isl_pw_aff_list *list2);
2901         __isl_give isl_set *isl_pw_aff_list_ge_set(
2902                 __isl_take isl_pw_aff_list *list1,
2903                 __isl_take isl_pw_aff_list *list2);
2904         __isl_give isl_set *isl_pw_aff_list_gt_set(
2905                 __isl_take isl_pw_aff_list *list1,
2906                 __isl_take isl_pw_aff_list *list2);
2907
2908 The function C<isl_aff_ge_basic_set> returns a basic set
2909 containing those elements in the shared space
2910 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
2911 The function C<isl_aff_ge_set> returns a set
2912 containing those elements in the shared domain
2913 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
2914 The functions operating on C<isl_pw_aff_list> apply the corresponding
2915 C<isl_pw_aff> function to each pair of elements in the two lists.
2916
2917         #include <isl/aff.h>
2918         __isl_give isl_set *isl_pw_aff_nonneg_set(
2919                 __isl_take isl_pw_aff *pwaff);
2920         __isl_give isl_set *isl_pw_aff_zero_set(
2921                 __isl_take isl_pw_aff *pwaff);
2922         __isl_give isl_set *isl_pw_aff_non_zero_set(
2923                 __isl_take isl_pw_aff *pwaff);
2924
2925 The function C<isl_pw_aff_nonneg_set> returns a set
2926 containing those elements in the domain
2927 of C<pwaff> where C<pwaff> is non-negative.
2928
2929         #include <isl/aff.h>
2930         __isl_give isl_pw_aff *isl_pw_aff_cond(
2931                 __isl_take isl_set *cond,
2932                 __isl_take isl_pw_aff *pwaff_true,
2933                 __isl_take isl_pw_aff *pwaff_false);
2934
2935 The function C<isl_pw_aff_cond> performs a conditional operator
2936 and returns an expression that is equal to C<pwaff_true>
2937 for elements in C<cond> and equal to C<pwaff_false> for elements
2938 not in C<cond>.
2939
2940         #include <isl/aff.h>
2941         __isl_give isl_pw_aff *isl_pw_aff_union_min(
2942                 __isl_take isl_pw_aff *pwaff1,
2943                 __isl_take isl_pw_aff *pwaff2);
2944         __isl_give isl_pw_aff *isl_pw_aff_union_max(
2945                 __isl_take isl_pw_aff *pwaff1,
2946                 __isl_take isl_pw_aff *pwaff2);
2947         __isl_give isl_pw_aff *isl_pw_aff_union_add(
2948                 __isl_take isl_pw_aff *pwaff1,
2949                 __isl_take isl_pw_aff *pwaff2);
2950
2951 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
2952 expression with a domain that is the union of those of C<pwaff1> and
2953 C<pwaff2> and such that on each cell, the quasi-affine expression is
2954 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
2955 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
2956 associated expression is the defined one.
2957
2958 An expression can be read from input using
2959
2960         #include <isl/aff.h>
2961         __isl_give isl_aff *isl_aff_read_from_str(
2962                 isl_ctx *ctx, const char *str);
2963         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
2964                 isl_ctx *ctx, const char *str);
2965
2966 An expression can be printed using
2967
2968         #include <isl/aff.h>
2969         __isl_give isl_printer *isl_printer_print_aff(
2970                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
2971
2972         __isl_give isl_printer *isl_printer_print_pw_aff(
2973                 __isl_take isl_printer *p,
2974                 __isl_keep isl_pw_aff *pwaff);
2975
2976 =head2 Piecewise Multiple Quasi Affine Expressions
2977
2978 An C<isl_multi_aff> object represents a sequence of
2979 zero or more affine expressions, all defined on the same domain space.
2980
2981 An C<isl_multi_aff> can be constructed from a C<isl_aff_list> using the
2982 following function.
2983
2984         #include <isl/aff.h>
2985         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
2986                 __isl_take isl_space *space,
2987                 __isl_take isl_aff_list *list);
2988
2989 An empty piecewise multiple quasi affine expression (one with no cells) or
2990 a piecewise multiple quasi affine expression with a single cell can
2991 be created using the following functions.
2992
2993         #include <isl/aff.h>
2994         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
2995                 __isl_take isl_space *space);
2996         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
2997                 __isl_take isl_set *set,
2998                 __isl_take isl_multi_aff *maff);
2999
3000 A piecewise multiple quasi affine expression can also be initialized
3001 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
3002 and the C<isl_map> is single-valued.
3003
3004         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
3005                 __isl_take isl_set *set);
3006         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
3007                 __isl_take isl_map *map);
3008
3009 Multiple quasi affine expressions can be copied and freed using
3010
3011         #include <isl/aff.h>
3012         __isl_give isl_multi_aff *isl_multi_aff_copy(
3013                 __isl_keep isl_multi_aff *maff);
3014         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
3015
3016         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
3017                 __isl_keep isl_pw_multi_aff *pma);
3018         void *isl_pw_multi_aff_free(
3019                 __isl_take isl_pw_multi_aff *pma);
3020
3021 The expression can be inspected using
3022
3023         #include <isl/aff.h>
3024         isl_ctx *isl_multi_aff_get_ctx(
3025                 __isl_keep isl_multi_aff *maff);
3026         isl_ctx *isl_pw_multi_aff_get_ctx(
3027                 __isl_keep isl_pw_multi_aff *pma);
3028         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
3029                 enum isl_dim_type type);
3030         unsigned isl_pw_multi_aff_dim(
3031                 __isl_keep isl_pw_multi_aff *pma,
3032                 enum isl_dim_type type);
3033         __isl_give isl_aff *isl_multi_aff_get_aff(
3034                 __isl_keep isl_multi_aff *multi, int pos);
3035         const char *isl_pw_multi_aff_get_dim_name(
3036                 __isl_keep isl_pw_multi_aff *pma,
3037                 enum isl_dim_type type, unsigned pos);
3038         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
3039                 __isl_keep isl_pw_multi_aff *pma,
3040                 enum isl_dim_type type, unsigned pos);
3041         const char *isl_multi_aff_get_tuple_name(
3042                 __isl_keep isl_multi_aff *multi,
3043                 enum isl_dim_type type);
3044         const char *isl_pw_multi_aff_get_tuple_name(
3045                 __isl_keep isl_pw_multi_aff *pma,
3046                 enum isl_dim_type type);
3047         int isl_pw_multi_aff_has_tuple_id(
3048                 __isl_keep isl_pw_multi_aff *pma,
3049                 enum isl_dim_type type);
3050         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
3051                 __isl_keep isl_pw_multi_aff *pma,
3052                 enum isl_dim_type type);
3053
3054         int isl_pw_multi_aff_foreach_piece(
3055                 __isl_keep isl_pw_multi_aff *pma,
3056                 int (*fn)(__isl_take isl_set *set,
3057                             __isl_take isl_multi_aff *maff,
3058                             void *user), void *user);
3059
3060 It can be modified using
3061
3062         #include <isl/aff.h>
3063         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
3064                 __isl_take isl_multi_aff *maff,
3065                 enum isl_dim_type type, unsigned pos, const char *s);
3066         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
3067                 __isl_take isl_pw_multi_aff *pma,
3068                 enum isl_dim_type type, __isl_take isl_id *id);
3069
3070 To check whether two multiple affine expressions are
3071 obviously equal to each other, use
3072
3073         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
3074                 __isl_keep isl_multi_aff *maff2);
3075         int isl_pw_multi_aff_plain_is_equal(
3076                 __isl_keep isl_pw_multi_aff *pma1,
3077                 __isl_keep isl_pw_multi_aff *pma2);
3078
3079 Operations include
3080
3081         #include <isl/aff.h>
3082         __isl_give isl_multi_aff *isl_multi_aff_add(
3083                 __isl_take isl_multi_aff *maff1,
3084                 __isl_take isl_multi_aff *maff2);
3085         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
3086                 __isl_take isl_pw_multi_aff *pma1,
3087                 __isl_take isl_pw_multi_aff *pma2);
3088         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
3089                 __isl_take isl_pw_multi_aff *pma1,
3090                 __isl_take isl_pw_multi_aff *pma2);
3091         __isl_give isl_multi_aff *isl_multi_aff_scale(
3092                 __isl_take isl_multi_aff *maff,
3093                 isl_int f);
3094         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
3095                 __isl_take isl_pw_multi_aff *pma,
3096                 __isl_take isl_set *set);
3097         __isl_give isl_multi_aff *isl_multi_aff_lift(
3098                 __isl_take isl_multi_aff *maff,
3099                 __isl_give isl_local_space **ls);
3100         __isl_give isl_multi_aff *isl_multi_aff_gist(
3101                 __isl_take isl_multi_aff *maff,
3102                 __isl_take isl_set *context);
3103
3104 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
3105 then it is assigned the local space that lies at the basis of
3106 the lifting applied.
3107
3108 An expression can be read from input using
3109
3110         #include <isl/aff.h>
3111         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
3112                 isl_ctx *ctx, const char *str);
3113         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
3114                 isl_ctx *ctx, const char *str);
3115
3116 An expression can be printed using
3117
3118         #include <isl/aff.h>
3119         __isl_give isl_printer *isl_printer_print_multi_aff(
3120                 __isl_take isl_printer *p,
3121                 __isl_keep isl_multi_aff *maff);
3122         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
3123                 __isl_take isl_printer *p,
3124                 __isl_keep isl_pw_multi_aff *pma);
3125
3126 =head2 Points
3127
3128 Points are elements of a set.  They can be used to construct
3129 simple sets (boxes) or they can be used to represent the
3130 individual elements of a set.
3131 The zero point (the origin) can be created using
3132
3133         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
3134
3135 The coordinates of a point can be inspected, set and changed
3136 using
3137
3138         int isl_point_get_coordinate(__isl_keep isl_point *pnt,
3139                 enum isl_dim_type type, int pos, isl_int *v);
3140         __isl_give isl_point *isl_point_set_coordinate(
3141                 __isl_take isl_point *pnt,
3142                 enum isl_dim_type type, int pos, isl_int v);
3143
3144         __isl_give isl_point *isl_point_add_ui(
3145                 __isl_take isl_point *pnt,
3146                 enum isl_dim_type type, int pos, unsigned val);
3147         __isl_give isl_point *isl_point_sub_ui(
3148                 __isl_take isl_point *pnt,
3149                 enum isl_dim_type type, int pos, unsigned val);
3150
3151 Other properties can be obtained using
3152
3153         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
3154
3155 Points can be copied or freed using
3156
3157         __isl_give isl_point *isl_point_copy(
3158                 __isl_keep isl_point *pnt);
3159         void isl_point_free(__isl_take isl_point *pnt);
3160
3161 A singleton set can be created from a point using
3162
3163         __isl_give isl_basic_set *isl_basic_set_from_point(
3164                 __isl_take isl_point *pnt);
3165         __isl_give isl_set *isl_set_from_point(
3166                 __isl_take isl_point *pnt);
3167
3168 and a box can be created from two opposite extremal points using
3169
3170         __isl_give isl_basic_set *isl_basic_set_box_from_points(
3171                 __isl_take isl_point *pnt1,
3172                 __isl_take isl_point *pnt2);
3173         __isl_give isl_set *isl_set_box_from_points(
3174                 __isl_take isl_point *pnt1,
3175                 __isl_take isl_point *pnt2);
3176
3177 All elements of a B<bounded> (union) set can be enumerated using
3178 the following functions.
3179
3180         int isl_set_foreach_point(__isl_keep isl_set *set,
3181                 int (*fn)(__isl_take isl_point *pnt, void *user),
3182                 void *user);
3183         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
3184                 int (*fn)(__isl_take isl_point *pnt, void *user),
3185                 void *user);
3186
3187 The function C<fn> is called for each integer point in
3188 C<set> with as second argument the last argument of
3189 the C<isl_set_foreach_point> call.  The function C<fn>
3190 should return C<0> on success and C<-1> on failure.
3191 In the latter case, C<isl_set_foreach_point> will stop
3192 enumerating and return C<-1> as well.
3193 If the enumeration is performed successfully and to completion,
3194 then C<isl_set_foreach_point> returns C<0>.
3195
3196 To obtain a single point of a (basic) set, use
3197
3198         __isl_give isl_point *isl_basic_set_sample_point(
3199                 __isl_take isl_basic_set *bset);
3200         __isl_give isl_point *isl_set_sample_point(
3201                 __isl_take isl_set *set);
3202
3203 If C<set> does not contain any (integer) points, then the
3204 resulting point will be ``void'', a property that can be
3205 tested using
3206
3207         int isl_point_is_void(__isl_keep isl_point *pnt);
3208
3209 =head2 Piecewise Quasipolynomials
3210
3211 A piecewise quasipolynomial is a particular kind of function that maps
3212 a parametric point to a rational value.
3213 More specifically, a quasipolynomial is a polynomial expression in greatest
3214 integer parts of affine expressions of parameters and variables.
3215 A piecewise quasipolynomial is a subdivision of a given parametric
3216 domain into disjoint cells with a quasipolynomial associated to
3217 each cell.  The value of the piecewise quasipolynomial at a given
3218 point is the value of the quasipolynomial associated to the cell
3219 that contains the point.  Outside of the union of cells,
3220 the value is assumed to be zero.
3221 For example, the piecewise quasipolynomial
3222
3223         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
3224
3225 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
3226 A given piecewise quasipolynomial has a fixed domain dimension.
3227 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
3228 defined over different domains.
3229 Piecewise quasipolynomials are mainly used by the C<barvinok>
3230 library for representing the number of elements in a parametric set or map.
3231 For example, the piecewise quasipolynomial above represents
3232 the number of points in the map
3233
3234         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
3235
3236 =head3 Input and Output
3237
3238 Piecewise quasipolynomials can be read from input using
3239
3240         __isl_give isl_union_pw_qpolynomial *
3241         isl_union_pw_qpolynomial_read_from_str(
3242                 isl_ctx *ctx, const char *str);
3243
3244 Quasipolynomials and piecewise quasipolynomials can be printed
3245 using the following functions.
3246
3247         __isl_give isl_printer *isl_printer_print_qpolynomial(
3248                 __isl_take isl_printer *p,
3249                 __isl_keep isl_qpolynomial *qp);
3250
3251         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
3252                 __isl_take isl_printer *p,
3253                 __isl_keep isl_pw_qpolynomial *pwqp);
3254
3255         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
3256                 __isl_take isl_printer *p,
3257                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3258
3259 The output format of the printer
3260 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3261 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
3262 is supported.
3263 In case of printing in C<ISL_FORMAT_C>, the user may want
3264 to set the names of all dimensions
3265
3266         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
3267                 __isl_take isl_qpolynomial *qp,
3268                 enum isl_dim_type type, unsigned pos,
3269                 const char *s);
3270         __isl_give isl_pw_qpolynomial *
3271         isl_pw_qpolynomial_set_dim_name(
3272                 __isl_take isl_pw_qpolynomial *pwqp,
3273                 enum isl_dim_type type, unsigned pos,
3274                 const char *s);
3275
3276 =head3 Creating New (Piecewise) Quasipolynomials
3277
3278 Some simple quasipolynomials can be created using the following functions.
3279 More complicated quasipolynomials can be created by applying
3280 operations such as addition and multiplication
3281 on the resulting quasipolynomials
3282
3283         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
3284                 __isl_take isl_space *domain);
3285         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
3286                 __isl_take isl_space *domain);
3287         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
3288                 __isl_take isl_space *domain);
3289         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
3290                 __isl_take isl_space *domain);
3291         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
3292                 __isl_take isl_space *domain);
3293         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
3294                 __isl_take isl_space *domain,
3295                 const isl_int n, const isl_int d);
3296         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
3297                 __isl_take isl_space *domain,
3298                 enum isl_dim_type type, unsigned pos);
3299         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
3300                 __isl_take isl_aff *aff);
3301
3302 Note that the space in which a quasipolynomial lives is a map space
3303 with a one-dimensional range.  The C<domain> argument in some of
3304 the functions above corresponds to the domain of this map space.
3305
3306 The zero piecewise quasipolynomial or a piecewise quasipolynomial
3307 with a single cell can be created using the following functions.
3308 Multiple of these single cell piecewise quasipolynomials can
3309 be combined to create more complicated piecewise quasipolynomials.
3310
3311         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
3312                 __isl_take isl_space *space);
3313         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
3314                 __isl_take isl_set *set,
3315                 __isl_take isl_qpolynomial *qp);
3316         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
3317                 __isl_take isl_qpolynomial *qp);
3318         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
3319                 __isl_take isl_pw_aff *pwaff);
3320
3321         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
3322                 __isl_take isl_space *space);
3323         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
3324                 __isl_take isl_pw_qpolynomial *pwqp);
3325         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
3326                 __isl_take isl_union_pw_qpolynomial *upwqp,
3327                 __isl_take isl_pw_qpolynomial *pwqp);
3328
3329 Quasipolynomials can be copied and freed again using the following
3330 functions.
3331
3332         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
3333                 __isl_keep isl_qpolynomial *qp);
3334         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
3335
3336         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
3337                 __isl_keep isl_pw_qpolynomial *pwqp);
3338         void *isl_pw_qpolynomial_free(
3339                 __isl_take isl_pw_qpolynomial *pwqp);
3340
3341         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
3342                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3343         void isl_union_pw_qpolynomial_free(
3344                 __isl_take isl_union_pw_qpolynomial *upwqp);
3345
3346 =head3 Inspecting (Piecewise) Quasipolynomials
3347
3348 To iterate over all piecewise quasipolynomials in a union
3349 piecewise quasipolynomial, use the following function
3350
3351         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
3352                 __isl_keep isl_union_pw_qpolynomial *upwqp,
3353                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
3354                 void *user);
3355
3356 To extract the piecewise quasipolynomial in a given space from a union, use
3357
3358         __isl_give isl_pw_qpolynomial *
3359         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
3360                 __isl_keep isl_union_pw_qpolynomial *upwqp,
3361                 __isl_take isl_space *space);
3362
3363 To iterate over the cells in a piecewise quasipolynomial,
3364 use either of the following two functions
3365
3366         int isl_pw_qpolynomial_foreach_piece(
3367                 __isl_keep isl_pw_qpolynomial *pwqp,
3368                 int (*fn)(__isl_take isl_set *set,
3369                           __isl_take isl_qpolynomial *qp,
3370                           void *user), void *user);
3371         int isl_pw_qpolynomial_foreach_lifted_piece(
3372                 __isl_keep isl_pw_qpolynomial *pwqp,
3373                 int (*fn)(__isl_take isl_set *set,
3374                           __isl_take isl_qpolynomial *qp,
3375                           void *user), void *user);
3376
3377 As usual, the function C<fn> should return C<0> on success
3378 and C<-1> on failure.  The difference between
3379 C<isl_pw_qpolynomial_foreach_piece> and
3380 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
3381 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
3382 compute unique representations for all existentially quantified
3383 variables and then turn these existentially quantified variables
3384 into extra set variables, adapting the associated quasipolynomial
3385 accordingly.  This means that the C<set> passed to C<fn>
3386 will not have any existentially quantified variables, but that
3387 the dimensions of the sets may be different for different
3388 invocations of C<fn>.
3389
3390 To iterate over all terms in a quasipolynomial,
3391 use
3392
3393         int isl_qpolynomial_foreach_term(
3394                 __isl_keep isl_qpolynomial *qp,
3395                 int (*fn)(__isl_take isl_term *term,
3396                           void *user), void *user);
3397
3398 The terms themselves can be inspected and freed using
3399 these functions
3400
3401         unsigned isl_term_dim(__isl_keep isl_term *term,
3402                 enum isl_dim_type type);
3403         void isl_term_get_num(__isl_keep isl_term *term,
3404                 isl_int *n);
3405         void isl_term_get_den(__isl_keep isl_term *term,
3406                 isl_int *d);
3407         int isl_term_get_exp(__isl_keep isl_term *term,
3408                 enum isl_dim_type type, unsigned pos);
3409         __isl_give isl_aff *isl_term_get_div(
3410                 __isl_keep isl_term *term, unsigned pos);
3411         void isl_term_free(__isl_take isl_term *term);
3412
3413 Each term is a product of parameters, set variables and
3414 integer divisions.  The function C<isl_term_get_exp>
3415 returns the exponent of a given dimensions in the given term.
3416 The C<isl_int>s in the arguments of C<isl_term_get_num>
3417 and C<isl_term_get_den> need to have been initialized
3418 using C<isl_int_init> before calling these functions.
3419
3420 =head3 Properties of (Piecewise) Quasipolynomials
3421
3422 To check whether a quasipolynomial is actually a constant,
3423 use the following function.
3424
3425         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
3426                 isl_int *n, isl_int *d);
3427
3428 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
3429 then the numerator and denominator of the constant
3430 are returned in C<*n> and C<*d>, respectively.
3431
3432 To check whether two union piecewise quasipolynomials are
3433 obviously equal, use
3434
3435         int isl_union_pw_qpolynomial_plain_is_equal(
3436                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
3437                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
3438
3439 =head3 Operations on (Piecewise) Quasipolynomials
3440
3441         __isl_give isl_qpolynomial *isl_qpolynomial_scale(
3442                 __isl_take isl_qpolynomial *qp, isl_int v);
3443         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
3444                 __isl_take isl_qpolynomial *qp);
3445         __isl_give isl_qpolynomial *isl_qpolynomial_add(
3446                 __isl_take isl_qpolynomial *qp1,
3447                 __isl_take isl_qpolynomial *qp2);
3448         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
3449                 __isl_take isl_qpolynomial *qp1,
3450                 __isl_take isl_qpolynomial *qp2);
3451         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
3452                 __isl_take isl_qpolynomial *qp1,
3453                 __isl_take isl_qpolynomial *qp2);
3454         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
3455                 __isl_take isl_qpolynomial *qp, unsigned exponent);
3456
3457         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
3458                 __isl_take isl_pw_qpolynomial *pwqp1,
3459                 __isl_take isl_pw_qpolynomial *pwqp2);
3460         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
3461                 __isl_take isl_pw_qpolynomial *pwqp1,
3462                 __isl_take isl_pw_qpolynomial *pwqp2);
3463         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
3464                 __isl_take isl_pw_qpolynomial *pwqp1,
3465                 __isl_take isl_pw_qpolynomial *pwqp2);
3466         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
3467                 __isl_take isl_pw_qpolynomial *pwqp);
3468         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
3469                 __isl_take isl_pw_qpolynomial *pwqp1,
3470                 __isl_take isl_pw_qpolynomial *pwqp2);
3471         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
3472                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
3473
3474         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
3475                 __isl_take isl_union_pw_qpolynomial *upwqp1,
3476                 __isl_take isl_union_pw_qpolynomial *upwqp2);
3477         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
3478                 __isl_take isl_union_pw_qpolynomial *upwqp1,
3479                 __isl_take isl_union_pw_qpolynomial *upwqp2);
3480         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
3481                 __isl_take isl_union_pw_qpolynomial *upwqp1,
3482                 __isl_take isl_union_pw_qpolynomial *upwqp2);
3483
3484         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
3485                 __isl_take isl_pw_qpolynomial *pwqp,
3486                 __isl_take isl_point *pnt);
3487
3488         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
3489                 __isl_take isl_union_pw_qpolynomial *upwqp,
3490                 __isl_take isl_point *pnt);
3491
3492         __isl_give isl_set *isl_pw_qpolynomial_domain(
3493                 __isl_take isl_pw_qpolynomial *pwqp);
3494         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
3495                 __isl_take isl_pw_qpolynomial *pwpq,
3496                 __isl_take isl_set *set);
3497
3498         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
3499                 __isl_take isl_union_pw_qpolynomial *upwqp);
3500         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
3501                 __isl_take isl_union_pw_qpolynomial *upwpq,
3502                 __isl_take isl_union_set *uset);
3503
3504         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
3505                 __isl_take isl_qpolynomial *qp,
3506                 __isl_take isl_space *model);
3507
3508         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
3509                 __isl_take isl_qpolynomial *qp);
3510         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
3511                 __isl_take isl_pw_qpolynomial *pwqp);
3512
3513         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
3514                 __isl_take isl_union_pw_qpolynomial *upwqp);
3515
3516         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
3517                 __isl_take isl_qpolynomial *qp,
3518                 __isl_take isl_set *context);
3519
3520         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
3521                 __isl_take isl_pw_qpolynomial *pwqp,
3522                 __isl_take isl_set *context);
3523
3524         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
3525                 __isl_take isl_union_pw_qpolynomial *upwqp,
3526                 __isl_take isl_union_set *context);
3527
3528 The gist operation applies the gist operation to each of
3529 the cells in the domain of the input piecewise quasipolynomial.
3530 The context is also exploited
3531 to simplify the quasipolynomials associated to each cell.
3532
3533         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
3534                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
3535         __isl_give isl_union_pw_qpolynomial *
3536         isl_union_pw_qpolynomial_to_polynomial(
3537                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
3538
3539 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
3540 the polynomial will be an overapproximation.  If C<sign> is negative,
3541 it will be an underapproximation.  If C<sign> is zero, the approximation
3542 will lie somewhere in between.
3543
3544 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
3545
3546 A piecewise quasipolynomial reduction is a piecewise
3547 reduction (or fold) of quasipolynomials.
3548 In particular, the reduction can be maximum or a minimum.
3549 The objects are mainly used to represent the result of
3550 an upper or lower bound on a quasipolynomial over its domain,
3551 i.e., as the result of the following function.
3552
3553         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
3554                 __isl_take isl_pw_qpolynomial *pwqp,
3555                 enum isl_fold type, int *tight);
3556
3557         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
3558                 __isl_take isl_union_pw_qpolynomial *upwqp,
3559                 enum isl_fold type, int *tight);
3560
3561 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
3562 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
3563 is the returned bound is known be tight, i.e., for each value
3564 of the parameters there is at least
3565 one element in the domain that reaches the bound.
3566 If the domain of C<pwqp> is not wrapping, then the bound is computed
3567 over all elements in that domain and the result has a purely parametric
3568 domain.  If the domain of C<pwqp> is wrapping, then the bound is
3569 computed over the range of the wrapped relation.  The domain of the
3570 wrapped relation becomes the domain of the result.
3571
3572 A (piecewise) quasipolynomial reduction can be copied or freed using the
3573 following functions.
3574
3575         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
3576                 __isl_keep isl_qpolynomial_fold *fold);
3577         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
3578                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3579         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
3580                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3581         void isl_qpolynomial_fold_free(
3582                 __isl_take isl_qpolynomial_fold *fold);
3583         void *isl_pw_qpolynomial_fold_free(
3584                 __isl_take isl_pw_qpolynomial_fold *pwf);
3585         void isl_union_pw_qpolynomial_fold_free(
3586                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3587
3588 =head3 Printing Piecewise Quasipolynomial Reductions
3589
3590 Piecewise quasipolynomial reductions can be printed
3591 using the following function.
3592
3593         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
3594                 __isl_take isl_printer *p,
3595                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3596         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
3597                 __isl_take isl_printer *p,
3598                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3599
3600 For C<isl_printer_print_pw_qpolynomial_fold>,
3601 output format of the printer
3602 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3603 For C<isl_printer_print_union_pw_qpolynomial_fold>,
3604 output format of the printer
3605 needs to be set to C<ISL_FORMAT_ISL>.
3606 In case of printing in C<ISL_FORMAT_C>, the user may want
3607 to set the names of all dimensions
3608
3609         __isl_give isl_pw_qpolynomial_fold *
3610         isl_pw_qpolynomial_fold_set_dim_name(
3611                 __isl_take isl_pw_qpolynomial_fold *pwf,
3612                 enum isl_dim_type type, unsigned pos,
3613                 const char *s);
3614
3615 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
3616
3617 To iterate over all piecewise quasipolynomial reductions in a union
3618 piecewise quasipolynomial reduction, use the following function
3619
3620         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
3621                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
3622                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
3623                             void *user), void *user);
3624
3625 To iterate over the cells in a piecewise quasipolynomial reduction,
3626 use either of the following two functions
3627
3628         int isl_pw_qpolynomial_fold_foreach_piece(
3629                 __isl_keep isl_pw_qpolynomial_fold *pwf,
3630                 int (*fn)(__isl_take isl_set *set,
3631                           __isl_take isl_qpolynomial_fold *fold,
3632                           void *user), void *user);
3633         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
3634                 __isl_keep isl_pw_qpolynomial_fold *pwf,
3635                 int (*fn)(__isl_take isl_set *set,
3636                           __isl_take isl_qpolynomial_fold *fold,
3637                           void *user), void *user);
3638
3639 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
3640 of the difference between these two functions.
3641
3642 To iterate over all quasipolynomials in a reduction, use
3643
3644         int isl_qpolynomial_fold_foreach_qpolynomial(
3645                 __isl_keep isl_qpolynomial_fold *fold,
3646                 int (*fn)(__isl_take isl_qpolynomial *qp,
3647                           void *user), void *user);
3648
3649 =head3 Properties of Piecewise Quasipolynomial Reductions
3650
3651 To check whether two union piecewise quasipolynomial reductions are
3652 obviously equal, use
3653
3654         int isl_union_pw_qpolynomial_fold_plain_is_equal(
3655                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
3656                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
3657
3658 =head3 Operations on Piecewise Quasipolynomial Reductions
3659
3660         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
3661                 __isl_take isl_qpolynomial_fold *fold, isl_int v);
3662
3663         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
3664                 __isl_take isl_pw_qpolynomial_fold *pwf1,
3665                 __isl_take isl_pw_qpolynomial_fold *pwf2);
3666
3667         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
3668                 __isl_take isl_pw_qpolynomial_fold *pwf1,
3669                 __isl_take isl_pw_qpolynomial_fold *pwf2);
3670
3671         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
3672                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
3673                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
3674
3675         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
3676                 __isl_take isl_pw_qpolynomial_fold *pwf,
3677                 __isl_take isl_point *pnt);
3678
3679         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
3680                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3681                 __isl_take isl_point *pnt);
3682
3683         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
3684                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3685         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
3686                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3687                 __isl_take isl_union_set *uset);
3688
3689         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
3690                 __isl_take isl_pw_qpolynomial_fold *pwf);
3691
3692         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
3693                 __isl_take isl_pw_qpolynomial_fold *pwf);
3694
3695         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
3696                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3697
3698         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
3699                 __isl_take isl_pw_qpolynomial_fold *pwf,
3700                 __isl_take isl_set *context);
3701
3702         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
3703                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3704                 __isl_take isl_union_set *context);
3705
3706 The gist operation applies the gist operation to each of
3707 the cells in the domain of the input piecewise quasipolynomial reduction.
3708 In future, the operation will also exploit the context
3709 to simplify the quasipolynomial reductions associated to each cell.
3710
3711         __isl_give isl_pw_qpolynomial_fold *
3712         isl_set_apply_pw_qpolynomial_fold(
3713                 __isl_take isl_set *set,
3714                 __isl_take isl_pw_qpolynomial_fold *pwf,
3715                 int *tight);
3716         __isl_give isl_pw_qpolynomial_fold *
3717         isl_map_apply_pw_qpolynomial_fold(
3718                 __isl_take isl_map *map,
3719                 __isl_take isl_pw_qpolynomial_fold *pwf,
3720                 int *tight);
3721         __isl_give isl_union_pw_qpolynomial_fold *
3722         isl_union_set_apply_union_pw_qpolynomial_fold(
3723                 __isl_take isl_union_set *uset,
3724                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3725                 int *tight);
3726         __isl_give isl_union_pw_qpolynomial_fold *
3727         isl_union_map_apply_union_pw_qpolynomial_fold(
3728                 __isl_take isl_union_map *umap,
3729                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3730                 int *tight);
3731
3732 The functions taking a map
3733 compose the given map with the given piecewise quasipolynomial reduction.
3734 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
3735 over all elements in the intersection of the range of the map
3736 and the domain of the piecewise quasipolynomial reduction
3737 as a function of an element in the domain of the map.
3738 The functions taking a set compute a bound over all elements in the
3739 intersection of the set and the domain of the
3740 piecewise quasipolynomial reduction.
3741
3742 =head2 Dependence Analysis
3743
3744 C<isl> contains specialized functionality for performing
3745 array dataflow analysis.  That is, given a I<sink> access relation
3746 and a collection of possible I<source> access relations,
3747 C<isl> can compute relations that describe
3748 for each iteration of the sink access, which iteration
3749 of which of the source access relations was the last
3750 to access the same data element before the given iteration
3751 of the sink access.
3752 To compute standard flow dependences, the sink should be
3753 a read, while the sources should be writes.
3754 If any of the source accesses are marked as being I<may>
3755 accesses, then there will be a dependence to the last
3756 I<must> access B<and> to any I<may> access that follows
3757 this last I<must> access.
3758 In particular, if I<all> sources are I<may> accesses,
3759 then memory based dependence analysis is performed.
3760 If, on the other hand, all sources are I<must> accesses,
3761 then value based dependence analysis is performed.
3762
3763         #include <isl/flow.h>
3764
3765         typedef int (*isl_access_level_before)(void *first, void *second);
3766
3767         __isl_give isl_access_info *isl_access_info_alloc(
3768                 __isl_take isl_map *sink,
3769                 void *sink_user, isl_access_level_before fn,
3770                 int max_source);
3771         __isl_give isl_access_info *isl_access_info_add_source(
3772                 __isl_take isl_access_info *acc,
3773                 __isl_take isl_map *source, int must,
3774                 void *source_user);
3775         void isl_access_info_free(__isl_take isl_access_info *acc);
3776
3777         __isl_give isl_flow *isl_access_info_compute_flow(
3778                 __isl_take isl_access_info *acc);
3779
3780         int isl_flow_foreach(__isl_keep isl_flow *deps,
3781                 int (*fn)(__isl_take isl_map *dep, int must,
3782                           void *dep_user, void *user),
3783                 void *user);
3784         __isl_give isl_map *isl_flow_get_no_source(
3785                 __isl_keep isl_flow *deps, int must);
3786         void isl_flow_free(__isl_take isl_flow *deps);
3787
3788 The function C<isl_access_info_compute_flow> performs the actual
3789 dependence analysis.  The other functions are used to construct
3790 the input for this function or to read off the output.
3791
3792 The input is collected in an C<isl_access_info>, which can
3793 be created through a call to C<isl_access_info_alloc>.
3794 The arguments to this functions are the sink access relation
3795 C<sink>, a token C<sink_user> used to identify the sink
3796 access to the user, a callback function for specifying the
3797 relative order of source and sink accesses, and the number
3798 of source access relations that will be added.
3799 The callback function has type C<int (*)(void *first, void *second)>.
3800 The function is called with two user supplied tokens identifying
3801 either a source or the sink and it should return the shared nesting
3802 level and the relative order of the two accesses.
3803 In particular, let I<n> be the number of loops shared by
3804 the two accesses.  If C<first> precedes C<second> textually,
3805 then the function should return I<2 * n + 1>; otherwise,
3806 it should return I<2 * n>.
3807 The sources can be added to the C<isl_access_info> by performing
3808 (at most) C<max_source> calls to C<isl_access_info_add_source>.
3809 C<must> indicates whether the source is a I<must> access
3810 or a I<may> access.  Note that a multi-valued access relation
3811 should only be marked I<must> if every iteration in the domain
3812 of the relation accesses I<all> elements in its image.
3813 The C<source_user> token is again used to identify
3814 the source access.  The range of the source access relation
3815 C<source> should have the same dimension as the range
3816 of the sink access relation.
3817 The C<isl_access_info_free> function should usually not be
3818 called explicitly, because it is called implicitly by
3819 C<isl_access_info_compute_flow>.
3820
3821 The result of the dependence analysis is collected in an
3822 C<isl_flow>.  There may be elements of
3823 the sink access for which no preceding source access could be
3824 found or for which all preceding sources are I<may> accesses.
3825 The relations containing these elements can be obtained through
3826 calls to C<isl_flow_get_no_source>, the first with C<must> set
3827 and the second with C<must> unset.
3828 In the case of standard flow dependence analysis,
3829 with the sink a read and the sources I<must> writes,
3830 the first relation corresponds to the reads from uninitialized
3831 array elements and the second relation is empty.
3832 The actual flow dependences can be extracted using
3833 C<isl_flow_foreach>.  This function will call the user-specified
3834 callback function C<fn> for each B<non-empty> dependence between
3835 a source and the sink.  The callback function is called
3836 with four arguments, the actual flow dependence relation
3837 mapping source iterations to sink iterations, a boolean that
3838 indicates whether it is a I<must> or I<may> dependence, a token
3839 identifying the source and an additional C<void *> with value
3840 equal to the third argument of the C<isl_flow_foreach> call.
3841 A dependence is marked I<must> if it originates from a I<must>
3842 source and if it is not followed by any I<may> sources.
3843
3844 After finishing with an C<isl_flow>, the user should call
3845 C<isl_flow_free> to free all associated memory.
3846
3847 A higher-level interface to dependence analysis is provided
3848 by the following function.
3849
3850         #include <isl/flow.h>
3851
3852         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
3853                 __isl_take isl_union_map *must_source,
3854                 __isl_take isl_union_map *may_source,
3855                 __isl_take isl_union_map *schedule,
3856                 __isl_give isl_union_map **must_dep,
3857                 __isl_give isl_union_map **may_dep,
3858                 __isl_give isl_union_map **must_no_source,
3859                 __isl_give isl_union_map **may_no_source);
3860
3861 The arrays are identified by the tuple names of the ranges
3862 of the accesses.  The iteration domains by the tuple names
3863 of the domains of the accesses and of the schedule.
3864 The relative order of the iteration domains is given by the
3865 schedule.  The relations returned through C<must_no_source>
3866 and C<may_no_source> are subsets of C<sink>.
3867 Any of C<must_dep>, C<may_dep>, C<must_no_source>
3868 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
3869 any of the other arguments is treated as an error.
3870
3871 =head2 Scheduling
3872
3873 B<The functionality described in this section is fairly new
3874 and may be subject to change.>
3875
3876 The following function can be used to compute a schedule
3877 for a union of domains.  The generated schedule respects
3878 all C<validity> dependences.  That is, all dependence distances
3879 over these dependences in the scheduled space are lexicographically
3880 positive.  The generated schedule schedule also tries to minimize
3881 the dependence distances over C<proximity> dependences.
3882 Moreover, it tries to obtain sequences (bands) of schedule dimensions
3883 for groups of domains where the dependence distances have only
3884 non-negative values.
3885 The algorithm used to construct the schedule is similar to that
3886 of C<Pluto>.
3887
3888         #include <isl/schedule.h>
3889         __isl_give isl_schedule *isl_union_set_compute_schedule(
3890                 __isl_take isl_union_set *domain,
3891                 __isl_take isl_union_map *validity,
3892                 __isl_take isl_union_map *proximity);
3893         void *isl_schedule_free(__isl_take isl_schedule *sched);
3894
3895 A mapping from the domains to the scheduled space can be obtained
3896 from an C<isl_schedule> using the following function.
3897
3898         __isl_give isl_union_map *isl_schedule_get_map(
3899                 __isl_keep isl_schedule *sched);
3900
3901 A representation of the schedule can be printed using
3902          
3903         __isl_give isl_printer *isl_printer_print_schedule(
3904                 __isl_take isl_printer *p,
3905                 __isl_keep isl_schedule *schedule);
3906
3907 A representation of the schedule as a forest of bands can be obtained
3908 using the following function.
3909
3910         __isl_give isl_band_list *isl_schedule_get_band_forest(
3911                 __isl_keep isl_schedule *schedule);
3912
3913 The list can be manipulated as explained in L<"Lists">.
3914 The bands inside the list can be copied and freed using the following
3915 functions.
3916
3917         #include <isl/band.h>
3918         __isl_give isl_band *isl_band_copy(
3919                 __isl_keep isl_band *band);
3920         void *isl_band_free(__isl_take isl_band *band);
3921
3922 Each band contains zero or more scheduling dimensions.
3923 These are referred to as the members of the band.
3924 The section of the schedule that corresponds to the band is
3925 referred to as the partial schedule of the band.
3926 For those nodes that participate in a band, the outer scheduling
3927 dimensions form the prefix schedule, while the inner scheduling
3928 dimensions form the suffix schedule.
3929 That is, if we take a cut of the band forest, then the union of
3930 the concatenations of the prefix, partial and suffix schedules of
3931 each band in the cut is equal to the entire schedule (modulo
3932 some possible padding at the end with zero scheduling dimensions).
3933 The properties of a band can be inspected using the following functions.
3934
3935         #include <isl/band.h>
3936         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
3937
3938         int isl_band_has_children(__isl_keep isl_band *band);
3939         __isl_give isl_band_list *isl_band_get_children(
3940                 __isl_keep isl_band *band);
3941
3942         __isl_give isl_union_map *isl_band_get_prefix_schedule(
3943                 __isl_keep isl_band *band);
3944         __isl_give isl_union_map *isl_band_get_partial_schedule(
3945                 __isl_keep isl_band *band);
3946         __isl_give isl_union_map *isl_band_get_suffix_schedule(
3947                 __isl_keep isl_band *band);
3948
3949         int isl_band_n_member(__isl_keep isl_band *band);
3950         int isl_band_member_is_zero_distance(
3951                 __isl_keep isl_band *band, int pos);
3952
3953 Note that a scheduling dimension is considered to be ``zero
3954 distance'' if it does not carry any proximity dependences
3955 within its band.
3956 That is, if the dependence distances of the proximity
3957 dependences are all zero in that direction (for fixed
3958 iterations of outer bands).
3959
3960 A representation of the band can be printed using
3961
3962         #include <isl/band.h>
3963         __isl_give isl_printer *isl_printer_print_band(
3964                 __isl_take isl_printer *p,
3965                 __isl_keep isl_band *band);
3966
3967 =head2 Parametric Vertex Enumeration
3968
3969 The parametric vertex enumeration described in this section
3970 is mainly intended to be used internally and by the C<barvinok>
3971 library.
3972
3973         #include <isl/vertices.h>
3974         __isl_give isl_vertices *isl_basic_set_compute_vertices(
3975                 __isl_keep isl_basic_set *bset);
3976
3977 The function C<isl_basic_set_compute_vertices> performs the
3978 actual computation of the parametric vertices and the chamber
3979 decomposition and store the result in an C<isl_vertices> object.
3980 This information can be queried by either iterating over all
3981 the vertices or iterating over all the chambers or cells
3982 and then iterating over all vertices that are active on the chamber.
3983
3984         int isl_vertices_foreach_vertex(
3985                 __isl_keep isl_vertices *vertices,
3986                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
3987                 void *user);
3988
3989         int isl_vertices_foreach_cell(
3990                 __isl_keep isl_vertices *vertices,
3991                 int (*fn)(__isl_take isl_cell *cell, void *user),
3992                 void *user);
3993         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
3994                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
3995                 void *user);
3996
3997 Other operations that can be performed on an C<isl_vertices> object are
3998 the following.
3999
4000         isl_ctx *isl_vertices_get_ctx(
4001                 __isl_keep isl_vertices *vertices);
4002         int isl_vertices_get_n_vertices(
4003                 __isl_keep isl_vertices *vertices);
4004         void isl_vertices_free(__isl_take isl_vertices *vertices);
4005
4006 Vertices can be inspected and destroyed using the following functions.
4007
4008         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
4009         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
4010         __isl_give isl_basic_set *isl_vertex_get_domain(
4011                 __isl_keep isl_vertex *vertex);
4012         __isl_give isl_basic_set *isl_vertex_get_expr(
4013                 __isl_keep isl_vertex *vertex);
4014         void isl_vertex_free(__isl_take isl_vertex *vertex);
4015
4016 C<isl_vertex_get_expr> returns a singleton parametric set describing
4017 the vertex, while C<isl_vertex_get_domain> returns the activity domain
4018 of the vertex.
4019 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
4020 B<rational> basic sets, so they should mainly be used for inspection
4021 and should not be mixed with integer sets.
4022
4023 Chambers can be inspected and destroyed using the following functions.
4024
4025         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
4026         __isl_give isl_basic_set *isl_cell_get_domain(
4027                 __isl_keep isl_cell *cell);
4028         void isl_cell_free(__isl_take isl_cell *cell);
4029
4030 =head1 Applications
4031
4032 Although C<isl> is mainly meant to be used as a library,
4033 it also contains some basic applications that use some
4034 of the functionality of C<isl>.
4035 The input may be specified in either the L<isl format>
4036 or the L<PolyLib format>.
4037
4038 =head2 C<isl_polyhedron_sample>
4039
4040 C<isl_polyhedron_sample> takes a polyhedron as input and prints
4041 an integer element of the polyhedron, if there is any.
4042 The first column in the output is the denominator and is always
4043 equal to 1.  If the polyhedron contains no integer points,
4044 then a vector of length zero is printed.
4045
4046 =head2 C<isl_pip>
4047
4048 C<isl_pip> takes the same input as the C<example> program
4049 from the C<piplib> distribution, i.e., a set of constraints
4050 on the parameters, a line containing only -1 and finally a set
4051 of constraints on a parametric polyhedron.
4052 The coefficients of the parameters appear in the last columns
4053 (but before the final constant column).
4054 The output is the lexicographic minimum of the parametric polyhedron.
4055 As C<isl> currently does not have its own output format, the output
4056 is just a dump of the internal state.
4057
4058 =head2 C<isl_polyhedron_minimize>
4059
4060 C<isl_polyhedron_minimize> computes the minimum of some linear
4061 or affine objective function over the integer points in a polyhedron.
4062 If an affine objective function
4063 is given, then the constant should appear in the last column.
4064
4065 =head2 C<isl_polytope_scan>
4066
4067 Given a polytope, C<isl_polytope_scan> prints
4068 all integer points in the polytope.