2e3c0261a4a29b4ec6ffa7ab48e603f835efd39c
[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 the dimension specification
72 of a B<map> as input.  An old call
73 C<isl_map_identity(dim)> can be rewritten to
74 C<isl_map_identity(isl_dim_map_from_set(dim))>.
75
76 =item * The function C<isl_map_power> no longer takes
77 a parameter position as input.  Instead, the exponent
78 is now expressed as the domain of the resulting relation.
79
80 =back
81
82 =head3 Changes since isl-0.06
83
84 =over
85
86 =item * The format of C<isl_printer_print_qpolynomial>'s
87 C<ISL_FORMAT_ISL> output has changed.
88 Use C<ISL_FORMAT_C> to obtain the old output.
89
90 =back
91
92 =head1 Installation
93
94 The source of C<isl> can be obtained either as a tarball
95 or from the git repository.  Both are available from
96 L<http://freshmeat.net/projects/isl/>.
97 The installation process depends on how you obtained
98 the source.
99
100 =head2 Installation from the git repository
101
102 =over
103
104 =item 1 Clone or update the repository
105
106 The first time the source is obtained, you need to clone
107 the repository.
108
109         git clone git://repo.or.cz/isl.git
110
111 To obtain updates, you need to pull in the latest changes
112
113         git pull
114
115 =item 2 Generate C<configure>
116
117         ./autogen.sh
118
119 =back
120
121 After performing the above steps, continue
122 with the L<Common installation instructions>.
123
124 =head2 Common installation instructions
125
126 =over
127
128 =item 1 Obtain C<GMP>
129
130 Building C<isl> requires C<GMP>, including its headers files.
131 Your distribution may not provide these header files by default
132 and you may need to install a package called C<gmp-devel> or something
133 similar.  Alternatively, C<GMP> can be built from
134 source, available from L<http://gmplib.org/>.
135
136 =item 2 Configure
137
138 C<isl> uses the standard C<autoconf> C<configure> script.
139 To run it, just type
140
141         ./configure
142
143 optionally followed by some configure options.
144 A complete list of options can be obtained by running
145
146         ./configure --help
147
148 Below we discuss some of the more common options.
149
150 C<isl> can optionally use C<piplib>, but no
151 C<piplib> functionality is currently used by default.
152 The C<--with-piplib> option can
153 be used to specify which C<piplib>
154 library to use, either an installed version (C<system>),
155 an externally built version (C<build>)
156 or no version (C<no>).  The option C<build> is mostly useful
157 in C<configure> scripts of larger projects that bundle both C<isl>
158 and C<piplib>.
159
160 =over
161
162 =item C<--prefix>
163
164 Installation prefix for C<isl>
165
166 =item C<--with-gmp-prefix>
167
168 Installation prefix for C<GMP> (architecture-independent files).
169
170 =item C<--with-gmp-exec-prefix>
171
172 Installation prefix for C<GMP> (architecture-dependent files).
173
174 =item C<--with-piplib>
175
176 Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
177
178 =item C<--with-piplib-prefix>
179
180 Installation prefix for C<system> C<piplib> (architecture-independent files).
181
182 =item C<--with-piplib-exec-prefix>
183
184 Installation prefix for C<system> C<piplib> (architecture-dependent files).
185
186 =item C<--with-piplib-builddir>
187
188 Location where C<build> C<piplib> was built.
189
190 =back
191
192 =item 3 Compile
193
194         make
195
196 =item 4 Install (optional)
197
198         make install
199
200 =back
201
202 =head1 Library
203
204 =head2 Initialization
205
206 All manipulations of integer sets and relations occur within
207 the context of an C<isl_ctx>.
208 A given C<isl_ctx> can only be used within a single thread.
209 All arguments of a function are required to have been allocated
210 within the same context.
211 There are currently no functions available for moving an object
212 from one C<isl_ctx> to another C<isl_ctx>.  This means that
213 there is currently no way of safely moving an object from one
214 thread to another, unless the whole C<isl_ctx> is moved.
215
216 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
217 freed using C<isl_ctx_free>.
218 All objects allocated within an C<isl_ctx> should be freed
219 before the C<isl_ctx> itself is freed.
220
221         isl_ctx *isl_ctx_alloc();
222         void isl_ctx_free(isl_ctx *ctx);
223
224 =head2 Integers
225
226 All operations on integers, mainly the coefficients
227 of the constraints describing the sets and relations,
228 are performed in exact integer arithmetic using C<GMP>.
229 However, to allow future versions of C<isl> to optionally
230 support fixed integer arithmetic, all calls to C<GMP>
231 are wrapped inside C<isl> specific macros.
232 The basic type is C<isl_int> and the operations below
233 are available on this type.
234 The meanings of these operations are essentially the same
235 as their C<GMP> C<mpz_> counterparts.
236 As always with C<GMP> types, C<isl_int>s need to be
237 initialized with C<isl_int_init> before they can be used
238 and they need to be released with C<isl_int_clear>
239 after the last use.
240 The user should not assume that an C<isl_int> is represented
241 as a C<mpz_t>, but should instead explicitly convert between
242 C<mpz_t>s and C<isl_int>s using C<isl_int_set_gmp> and
243 C<isl_int_get_gmp> whenever a C<mpz_t> is required.
244
245 =over
246
247 =item isl_int_init(i)
248
249 =item isl_int_clear(i)
250
251 =item isl_int_set(r,i)
252
253 =item isl_int_set_si(r,i)
254
255 =item isl_int_set_gmp(r,g)
256
257 =item isl_int_get_gmp(i,g)
258
259 =item isl_int_abs(r,i)
260
261 =item isl_int_neg(r,i)
262
263 =item isl_int_swap(i,j)
264
265 =item isl_int_swap_or_set(i,j)
266
267 =item isl_int_add_ui(r,i,j)
268
269 =item isl_int_sub_ui(r,i,j)
270
271 =item isl_int_add(r,i,j)
272
273 =item isl_int_sub(r,i,j)
274
275 =item isl_int_mul(r,i,j)
276
277 =item isl_int_mul_ui(r,i,j)
278
279 =item isl_int_addmul(r,i,j)
280
281 =item isl_int_submul(r,i,j)
282
283 =item isl_int_gcd(r,i,j)
284
285 =item isl_int_lcm(r,i,j)
286
287 =item isl_int_divexact(r,i,j)
288
289 =item isl_int_cdiv_q(r,i,j)
290
291 =item isl_int_fdiv_q(r,i,j)
292
293 =item isl_int_fdiv_r(r,i,j)
294
295 =item isl_int_fdiv_q_ui(r,i,j)
296
297 =item isl_int_read(r,s)
298
299 =item isl_int_print(out,i,width)
300
301 =item isl_int_sgn(i)
302
303 =item isl_int_cmp(i,j)
304
305 =item isl_int_cmp_si(i,si)
306
307 =item isl_int_eq(i,j)
308
309 =item isl_int_ne(i,j)
310
311 =item isl_int_lt(i,j)
312
313 =item isl_int_le(i,j)
314
315 =item isl_int_gt(i,j)
316
317 =item isl_int_ge(i,j)
318
319 =item isl_int_abs_eq(i,j)
320
321 =item isl_int_abs_ne(i,j)
322
323 =item isl_int_abs_lt(i,j)
324
325 =item isl_int_abs_gt(i,j)
326
327 =item isl_int_abs_ge(i,j)
328
329 =item isl_int_is_zero(i)
330
331 =item isl_int_is_one(i)
332
333 =item isl_int_is_negone(i)
334
335 =item isl_int_is_pos(i)
336
337 =item isl_int_is_neg(i)
338
339 =item isl_int_is_nonpos(i)
340
341 =item isl_int_is_nonneg(i)
342
343 =item isl_int_is_divisible_by(i,j)
344
345 =back
346
347 =head2 Sets and Relations
348
349 C<isl> uses six types of objects for representing sets and relations,
350 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
351 C<isl_union_set> and C<isl_union_map>.
352 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
353 can be described as a conjunction of affine constraints, while
354 C<isl_set> and C<isl_map> represent unions of
355 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
356 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
357 to have the same dimension.  C<isl_union_set>s and C<isl_union_map>s
358 represent unions of C<isl_set>s or C<isl_map>s of I<different> dimensions,
359 where dimensions with different space names
360 (see L<Dimension Specifications>) are considered different as well.
361 The difference between sets and relations (maps) is that sets have
362 one set of variables, while relations have two sets of variables,
363 input variables and output variables.
364
365 =head2 Memory Management
366
367 Since a high-level operation on sets and/or relations usually involves
368 several substeps and since the user is usually not interested in
369 the intermediate results, most functions that return a new object
370 will also release all the objects passed as arguments.
371 If the user still wants to use one or more of these arguments
372 after the function call, she should pass along a copy of the
373 object rather than the object itself.
374 The user is then responsible for making sure that the original
375 object gets used somewhere else or is explicitly freed.
376
377 The arguments and return values of all documents functions are
378 annotated to make clear which arguments are released and which
379 arguments are preserved.  In particular, the following annotations
380 are used
381
382 =over
383
384 =item C<__isl_give>
385
386 C<__isl_give> means that a new object is returned.
387 The user should make sure that the returned pointer is
388 used exactly once as a value for an C<__isl_take> argument.
389 In between, it can be used as a value for as many
390 C<__isl_keep> arguments as the user likes.
391 There is one exception, and that is the case where the
392 pointer returned is C<NULL>.  Is this case, the user
393 is free to use it as an C<__isl_take> argument or not.
394
395 =item C<__isl_take>
396
397 C<__isl_take> means that the object the argument points to
398 is taken over by the function and may no longer be used
399 by the user as an argument to any other function.
400 The pointer value must be one returned by a function
401 returning an C<__isl_give> pointer.
402 If the user passes in a C<NULL> value, then this will
403 be treated as an error in the sense that the function will
404 not perform its usual operation.  However, it will still
405 make sure that all the the other C<__isl_take> arguments
406 are released.
407
408 =item C<__isl_keep>
409
410 C<__isl_keep> means that the function will only use the object
411 temporarily.  After the function has finished, the user
412 can still use it as an argument to other functions.
413 A C<NULL> value will be treated in the same way as
414 a C<NULL> value for an C<__isl_take> argument.
415
416 =back
417
418 =head2 Dimension Specifications
419
420 Whenever a new set or relation is created from scratch,
421 its dimension needs to be specified using an C<isl_dim>.
422
423         #include <isl/dim.h>
424         __isl_give isl_dim *isl_dim_alloc(isl_ctx *ctx,
425                 unsigned nparam, unsigned n_in, unsigned n_out);
426         __isl_give isl_dim *isl_dim_set_alloc(isl_ctx *ctx,
427                 unsigned nparam, unsigned dim);
428         __isl_give isl_dim *isl_dim_copy(__isl_keep isl_dim *dim);
429         void isl_dim_free(__isl_take isl_dim *dim);
430         unsigned isl_dim_size(__isl_keep isl_dim *dim,
431                 enum isl_dim_type type);
432
433 The dimension specification used for creating a set
434 needs to be created using C<isl_dim_set_alloc>, while
435 that for creating a relation
436 needs to be created using C<isl_dim_alloc>.
437 C<isl_dim_size> can be used
438 to find out the number of dimensions of each type in
439 a dimension specification, where type may be
440 C<isl_dim_param>, C<isl_dim_in> (only for relations),
441 C<isl_dim_out> (only for relations), C<isl_dim_set>
442 (only for sets) or C<isl_dim_all>.
443
444 It is often useful to create objects that live in the
445 same space as some other object.  This can be accomplished
446 by creating the new objects
447 (see L<Creating New Sets and Relations> or
448 L<Creating New (Piecewise) Quasipolynomials>) based on the dimension
449 specification of the original object.
450
451         #include <isl/set.h>
452         __isl_give isl_dim *isl_basic_set_get_dim(
453                 __isl_keep isl_basic_set *bset);
454         __isl_give isl_dim *isl_set_get_dim(__isl_keep isl_set *set);
455
456         #include <isl/union_set.h>
457         __isl_give isl_dim *isl_union_set_get_dim(
458                 __isl_keep isl_union_set *uset);
459
460         #include <isl/map.h>
461         __isl_give isl_dim *isl_basic_map_get_dim(
462                 __isl_keep isl_basic_map *bmap);
463         __isl_give isl_dim *isl_map_get_dim(__isl_keep isl_map *map);
464
465         #include <isl/union_map.h>
466         __isl_give isl_dim *isl_union_map_get_dim(
467                 __isl_keep isl_union_map *umap);
468
469         #include <isl/constraint.h>
470         __isl_give isl_dim *isl_constraint_get_dim(
471                 __isl_keep isl_constraint *constraint);
472
473         #include <isl/polynomial.h>
474         __isl_give isl_dim *isl_qpolynomial_get_dim(
475                 __isl_keep isl_qpolynomial *qp);
476         __isl_give isl_dim *isl_pw_qpolynomial_get_dim(
477                 __isl_keep isl_pw_qpolynomial *pwqp);
478         __isl_give isl_dim *isl_union_pw_qpolynomial_get_dim(
479                 __isl_keep isl_union_pw_qpolynomial *upwqp);
480         __isl_give isl_dim *isl_union_pw_qpolynomial_fold_get_dim(
481                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
482
483         #include <isl/aff.h>
484         __isl_give isl_dim *isl_aff_get_dim(
485                 __isl_keep isl_aff *aff);
486
487 The names of the individual dimensions may be set or read off
488 using the following functions.
489
490         #include <isl/dim.h>
491         __isl_give isl_dim *isl_dim_set_name(__isl_take isl_dim *dim,
492                                  enum isl_dim_type type, unsigned pos,
493                                  __isl_keep const char *name);
494         __isl_keep const char *isl_dim_get_name(__isl_keep isl_dim *dim,
495                                  enum isl_dim_type type, unsigned pos);
496
497 Note that C<isl_dim_get_name> returns a pointer to some internal
498 data structure, so the result can only be used while the
499 corresponding C<isl_dim> is alive.
500 Also note that every function that operates on two sets or relations
501 requires that both arguments have the same parameters.  This also
502 means that if one of the arguments has named parameters, then the
503 other needs to have named parameters too and the names need to match.
504 Pairs of C<isl_union_set> and/or C<isl_union_map> arguments may
505 have different parameters (as long as they are named), in which case
506 the result will have as parameters the union of the parameters of
507 the arguments.
508
509 The names of entire spaces may be set or read off
510 using the following functions.
511
512         #include <isl/dim.h>
513         __isl_give isl_dim *isl_dim_set_tuple_name(
514                 __isl_take isl_dim *dim,
515                 enum isl_dim_type type, const char *s);
516         const char *isl_dim_get_tuple_name(__isl_keep isl_dim *dim,
517                 enum isl_dim_type type);
518
519 The C<dim> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
520 or C<isl_dim_set>.  As with C<isl_dim_get_name>,
521 the C<isl_dim_get_tuple_name> function returns a pointer to some internal
522 data structure.
523 Binary operations require the corresponding spaces of their arguments
524 to have the same name.
525
526 Spaces can be nested.  In particular, the domain of a set or
527 the domain or range of a relation can be a nested relation.
528 The following functions can be used to construct and deconstruct
529 such nested dimension specifications.
530
531         #include <isl/dim.h>
532         int isl_dim_is_wrapping(__isl_keep isl_dim *dim);
533         __isl_give isl_dim *isl_dim_wrap(__isl_take isl_dim *dim);
534         __isl_give isl_dim *isl_dim_unwrap(__isl_take isl_dim *dim);
535
536 The input to C<isl_dim_is_wrapping> and C<isl_dim_unwrap> should
537 be the dimension specification of a set, while that of
538 C<isl_dim_wrap> should be the dimension specification of a relation.
539 Conversely, the output of C<isl_dim_unwrap> is the dimension specification
540 of a relation, while that of C<isl_dim_wrap> is the dimension specification
541 of a set.
542
543 Dimension specifications can be created from other dimension
544 specifications using the following functions.
545
546         __isl_give isl_dim *isl_dim_domain(__isl_take isl_dim *dim);
547         __isl_give isl_dim *isl_dim_from_domain(__isl_take isl_dim *dim);
548         __isl_give isl_dim *isl_dim_range(__isl_take isl_dim *dim);
549         __isl_give isl_dim *isl_dim_from_range(__isl_take isl_dim *dim);
550         __isl_give isl_dim *isl_dim_reverse(__isl_take isl_dim *dim);
551         __isl_give isl_dim *isl_dim_join(__isl_take isl_dim *left,
552                 __isl_take isl_dim *right);
553         __isl_give isl_dim *isl_dim_insert(__isl_take isl_dim *dim,
554                 enum isl_dim_type type, unsigned pos, unsigned n);
555         __isl_give isl_dim *isl_dim_add(__isl_take isl_dim *dim,
556                 enum isl_dim_type type, unsigned n);
557         __isl_give isl_dim *isl_dim_drop(__isl_take isl_dim *dim,
558                 enum isl_dim_type type, unsigned first, unsigned n);
559         __isl_give isl_dim *isl_dim_map_from_set(
560                 __isl_take isl_dim *dim);
561         __isl_give isl_dim *isl_dim_zip(__isl_take isl_dim *dim);
562
563 Note that if dimensions are added or removed from a space, then
564 the name and the internal structure are lost.
565
566 =head2 Local Spaces
567
568 A local space is essentially a dimension specification with
569 zero or more existentially quantified variables.
570 The local space of a basic set or relation can be obtained
571 using the following functions.
572
573         #include <isl/set.h>
574         __isl_give isl_local_space *isl_basic_set_get_local_space(
575                 __isl_keep isl_basic_set *bset);
576
577         #include <isl/map.h>
578         __isl_give isl_local_space *isl_basic_map_get_local_space(
579                 __isl_keep isl_basic_map *bmap);
580
581 A new local space can be created from a dimension specification using
582
583         #include <isl/local_space.h>
584         __isl_give isl_local_space *isl_local_space_from_dim(
585                 __isl_take isl_dim *dim);
586
587 They can be inspected, copied and freed using the following functions.
588
589         #include <isl/local_space.h>
590         isl_ctx *isl_local_space_get_ctx(
591                 __isl_keep isl_local_space *ls);
592         int isl_local_space_dim(__isl_keep isl_local_space *ls,
593                 enum isl_dim_type type);
594         const char *isl_local_space_get_dim_name(
595                 __isl_keep isl_local_space *ls,
596                 enum isl_dim_type type, unsigned pos);
597         __isl_give isl_dim *isl_local_space_get_dim(
598                 __isl_keep isl_local_space *ls);
599         __isl_give isl_div *isl_local_space_get_div(
600                 __isl_keep isl_local_space *ls, int pos);
601         __isl_give isl_local_space *isl_local_space_copy(
602                 __isl_keep isl_local_space *ls);
603         void *isl_local_space_free(__isl_take isl_local_space *ls);
604
605 =head2 Input and Output
606
607 C<isl> supports its own input/output format, which is similar
608 to the C<Omega> format, but also supports the C<PolyLib> format
609 in some cases.
610
611 =head3 C<isl> format
612
613 The C<isl> format is similar to that of C<Omega>, but has a different
614 syntax for describing the parameters and allows for the definition
615 of an existentially quantified variable as the integer division
616 of an affine expression.
617 For example, the set of integers C<i> between C<0> and C<n>
618 such that C<i % 10 <= 6> can be described as
619
620         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
621                                 i - 10 a <= 6) }
622
623 A set or relation can have several disjuncts, separated
624 by the keyword C<or>.  Each disjunct is either a conjunction
625 of constraints or a projection (C<exists>) of a conjunction
626 of constraints.  The constraints are separated by the keyword
627 C<and>.
628
629 =head3 C<PolyLib> format
630
631 If the represented set is a union, then the first line
632 contains a single number representing the number of disjuncts.
633 Otherwise, a line containing the number C<1> is optional.
634
635 Each disjunct is represented by a matrix of constraints.
636 The first line contains two numbers representing
637 the number of rows and columns,
638 where the number of rows is equal to the number of constraints
639 and the number of columns is equal to two plus the number of variables.
640 The following lines contain the actual rows of the constraint matrix.
641 In each row, the first column indicates whether the constraint
642 is an equality (C<0>) or inequality (C<1>).  The final column
643 corresponds to the constant term.
644
645 If the set is parametric, then the coefficients of the parameters
646 appear in the last columns before the constant column.
647 The coefficients of any existentially quantified variables appear
648 between those of the set variables and those of the parameters.
649
650 =head3 Extended C<PolyLib> format
651
652 The extended C<PolyLib> format is nearly identical to the
653 C<PolyLib> format.  The only difference is that the line
654 containing the number of rows and columns of a constraint matrix
655 also contains four additional numbers:
656 the number of output dimensions, the number of input dimensions,
657 the number of local dimensions (i.e., the number of existentially
658 quantified variables) and the number of parameters.
659 For sets, the number of ``output'' dimensions is equal
660 to the number of set dimensions, while the number of ``input''
661 dimensions is zero.
662
663 =head3 Input
664
665         #include <isl/set.h>
666         __isl_give isl_basic_set *isl_basic_set_read_from_file(
667                 isl_ctx *ctx, FILE *input, int nparam);
668         __isl_give isl_basic_set *isl_basic_set_read_from_str(
669                 isl_ctx *ctx, const char *str, int nparam);
670         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
671                 FILE *input, int nparam);
672         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
673                 const char *str, int nparam);
674
675         #include <isl/map.h>
676         __isl_give isl_basic_map *isl_basic_map_read_from_file(
677                 isl_ctx *ctx, FILE *input, int nparam);
678         __isl_give isl_basic_map *isl_basic_map_read_from_str(
679                 isl_ctx *ctx, const char *str, int nparam);
680         __isl_give isl_map *isl_map_read_from_file(
681                 struct isl_ctx *ctx, FILE *input, int nparam);
682         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
683                 const char *str, int nparam);
684
685         #include <isl/union_set.h>
686         __isl_give isl_union_set *isl_union_set_read_from_file(
687                 isl_ctx *ctx, FILE *input);
688         __isl_give isl_union_set *isl_union_set_read_from_str(
689                 struct isl_ctx *ctx, const char *str);
690
691         #include <isl/union_map.h>
692         __isl_give isl_union_map *isl_union_map_read_from_file(
693                 isl_ctx *ctx, FILE *input);
694         __isl_give isl_union_map *isl_union_map_read_from_str(
695                 struct isl_ctx *ctx, const char *str);
696
697 The input format is autodetected and may be either the C<PolyLib> format
698 or the C<isl> format.
699 C<nparam> specifies how many of the final columns in
700 the C<PolyLib> format correspond to parameters.
701 If input is given in the C<isl> format, then the number
702 of parameters needs to be equal to C<nparam>.
703 If C<nparam> is negative, then any number of parameters
704 is accepted in the C<isl> format and zero parameters
705 are assumed in the C<PolyLib> format.
706
707 =head3 Output
708
709 Before anything can be printed, an C<isl_printer> needs to
710 be created.
711
712         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
713                 FILE *file);
714         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
715         void isl_printer_free(__isl_take isl_printer *printer);
716         __isl_give char *isl_printer_get_str(
717                 __isl_keep isl_printer *printer);
718
719 The behavior of the printer can be modified in various ways
720
721         __isl_give isl_printer *isl_printer_set_output_format(
722                 __isl_take isl_printer *p, int output_format);
723         __isl_give isl_printer *isl_printer_set_indent(
724                 __isl_take isl_printer *p, int indent);
725         __isl_give isl_printer *isl_printer_set_prefix(
726                 __isl_take isl_printer *p, const char *prefix);
727         __isl_give isl_printer *isl_printer_set_suffix(
728                 __isl_take isl_printer *p, const char *suffix);
729
730 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
731 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
732 and defaults to C<ISL_FORMAT_ISL>.
733 Each line in the output is indented by C<indent> spaces
734 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
735 In the C<PolyLib> format output,
736 the coefficients of the existentially quantified variables
737 appear between those of the set variables and those
738 of the parameters.
739
740 To actually print something, use
741
742         #include <isl/set.h>
743         __isl_give isl_printer *isl_printer_print_basic_set(
744                 __isl_take isl_printer *printer,
745                 __isl_keep isl_basic_set *bset);
746         __isl_give isl_printer *isl_printer_print_set(
747                 __isl_take isl_printer *printer,
748                 __isl_keep isl_set *set);
749
750         #include <isl/map.h>
751         __isl_give isl_printer *isl_printer_print_basic_map(
752                 __isl_take isl_printer *printer,
753                 __isl_keep isl_basic_map *bmap);
754         __isl_give isl_printer *isl_printer_print_map(
755                 __isl_take isl_printer *printer,
756                 __isl_keep isl_map *map);
757
758         #include <isl/union_set.h>
759         __isl_give isl_printer *isl_printer_print_union_set(
760                 __isl_take isl_printer *p,
761                 __isl_keep isl_union_set *uset);
762
763         #include <isl/union_map.h>
764         __isl_give isl_printer *isl_printer_print_union_map(
765                 __isl_take isl_printer *p,
766                 __isl_keep isl_union_map *umap);
767
768 When called on a file printer, the following function flushes
769 the file.  When called on a string printer, the buffer is cleared.
770
771         __isl_give isl_printer *isl_printer_flush(
772                 __isl_take isl_printer *p);
773
774 =head2 Creating New Sets and Relations
775
776 C<isl> has functions for creating some standard sets and relations.
777
778 =over
779
780 =item * Empty sets and relations
781
782         __isl_give isl_basic_set *isl_basic_set_empty(
783                 __isl_take isl_dim *dim);
784         __isl_give isl_basic_map *isl_basic_map_empty(
785                 __isl_take isl_dim *dim);
786         __isl_give isl_set *isl_set_empty(
787                 __isl_take isl_dim *dim);
788         __isl_give isl_map *isl_map_empty(
789                 __isl_take isl_dim *dim);
790         __isl_give isl_union_set *isl_union_set_empty(
791                 __isl_take isl_dim *dim);
792         __isl_give isl_union_map *isl_union_map_empty(
793                 __isl_take isl_dim *dim);
794
795 For C<isl_union_set>s and C<isl_union_map>s, the dimensions specification
796 is only used to specify the parameters.
797
798 =item * Universe sets and relations
799
800         __isl_give isl_basic_set *isl_basic_set_universe(
801                 __isl_take isl_dim *dim);
802         __isl_give isl_basic_map *isl_basic_map_universe(
803                 __isl_take isl_dim *dim);
804         __isl_give isl_set *isl_set_universe(
805                 __isl_take isl_dim *dim);
806         __isl_give isl_map *isl_map_universe(
807                 __isl_take isl_dim *dim);
808         __isl_give isl_union_set *isl_union_set_universe(
809                 __isl_take isl_union_set *uset);
810         __isl_give isl_union_map *isl_union_map_universe(
811                 __isl_take isl_union_map *umap);
812
813 The sets and relations constructed by the functions above
814 contain all integer values, while those constructed by the
815 functions below only contain non-negative values.
816
817         __isl_give isl_basic_set *isl_basic_set_nat_universe(
818                 __isl_take isl_dim *dim);
819         __isl_give isl_basic_map *isl_basic_map_nat_universe(
820                 __isl_take isl_dim *dim);
821         __isl_give isl_set *isl_set_nat_universe(
822                 __isl_take isl_dim *dim);
823         __isl_give isl_map *isl_map_nat_universe(
824                 __isl_take isl_dim *dim);
825
826 =item * Identity relations
827
828         __isl_give isl_basic_map *isl_basic_map_identity(
829                 __isl_take isl_dim *dim);
830         __isl_give isl_map *isl_map_identity(
831                 __isl_take isl_dim *dim);
832
833 The number of input and output dimensions in C<dim> needs
834 to be the same.
835
836 =item * Lexicographic order
837
838         __isl_give isl_map *isl_map_lex_lt(
839                 __isl_take isl_dim *set_dim);
840         __isl_give isl_map *isl_map_lex_le(
841                 __isl_take isl_dim *set_dim);
842         __isl_give isl_map *isl_map_lex_gt(
843                 __isl_take isl_dim *set_dim);
844         __isl_give isl_map *isl_map_lex_ge(
845                 __isl_take isl_dim *set_dim);
846         __isl_give isl_map *isl_map_lex_lt_first(
847                 __isl_take isl_dim *dim, unsigned n);
848         __isl_give isl_map *isl_map_lex_le_first(
849                 __isl_take isl_dim *dim, unsigned n);
850         __isl_give isl_map *isl_map_lex_gt_first(
851                 __isl_take isl_dim *dim, unsigned n);
852         __isl_give isl_map *isl_map_lex_ge_first(
853                 __isl_take isl_dim *dim, unsigned n);
854
855 The first four functions take a dimension specification for a B<set>
856 and return relations that express that the elements in the domain
857 are lexicographically less
858 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
859 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
860 than the elements in the range.
861 The last four functions take a dimension specification for a map
862 and return relations that express that the first C<n> dimensions
863 in the domain are lexicographically less
864 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
865 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
866 than the first C<n> dimensions in the range.
867
868 =back
869
870 A basic set or relation can be converted to a set or relation
871 using the following functions.
872
873         __isl_give isl_set *isl_set_from_basic_set(
874                 __isl_take isl_basic_set *bset);
875         __isl_give isl_map *isl_map_from_basic_map(
876                 __isl_take isl_basic_map *bmap);
877
878 Sets and relations can be converted to union sets and relations
879 using the following functions.
880
881         __isl_give isl_union_map *isl_union_map_from_map(
882                 __isl_take isl_map *map);
883         __isl_give isl_union_set *isl_union_set_from_set(
884                 __isl_take isl_set *set);
885
886 Sets and relations can be copied and freed again using the following
887 functions.
888
889         __isl_give isl_basic_set *isl_basic_set_copy(
890                 __isl_keep isl_basic_set *bset);
891         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
892         __isl_give isl_union_set *isl_union_set_copy(
893                 __isl_keep isl_union_set *uset);
894         __isl_give isl_basic_map *isl_basic_map_copy(
895                 __isl_keep isl_basic_map *bmap);
896         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
897         __isl_give isl_union_map *isl_union_map_copy(
898                 __isl_keep isl_union_map *umap);
899         void isl_basic_set_free(__isl_take isl_basic_set *bset);
900         void isl_set_free(__isl_take isl_set *set);
901         void isl_union_set_free(__isl_take isl_union_set *uset);
902         void isl_basic_map_free(__isl_take isl_basic_map *bmap);
903         void isl_map_free(__isl_take isl_map *map);
904         void isl_union_map_free(__isl_take isl_union_map *umap);
905
906 Other sets and relations can be constructed by starting
907 from a universe set or relation, adding equality and/or
908 inequality constraints and then projecting out the
909 existentially quantified variables, if any.
910 Constraints can be constructed, manipulated and
911 added to (basic) sets and relations using the following functions.
912
913         #include <isl/constraint.h>
914         __isl_give isl_constraint *isl_equality_alloc(
915                 __isl_take isl_dim *dim);
916         __isl_give isl_constraint *isl_inequality_alloc(
917                 __isl_take isl_dim *dim);
918         void isl_constraint_set_constant(
919                 __isl_keep isl_constraint *constraint, isl_int v);
920         void isl_constraint_set_coefficient(
921                 __isl_keep isl_constraint *constraint,
922                 enum isl_dim_type type, int pos, isl_int v);
923         __isl_give isl_basic_map *isl_basic_map_add_constraint(
924                 __isl_take isl_basic_map *bmap,
925                 __isl_take isl_constraint *constraint);
926         __isl_give isl_basic_set *isl_basic_set_add_constraint(
927                 __isl_take isl_basic_set *bset,
928                 __isl_take isl_constraint *constraint);
929         __isl_give isl_map *isl_map_add_constraint(
930                 __isl_take isl_map *map,
931                 __isl_take isl_constraint *constraint);
932         __isl_give isl_set *isl_set_add_constraint(
933                 __isl_take isl_set *set,
934                 __isl_take isl_constraint *constraint);
935
936 For example, to create a set containing the even integers
937 between 10 and 42, you would use the following code.
938
939         isl_int v;
940         struct isl_dim *dim;
941         struct isl_constraint *c;
942         struct isl_basic_set *bset;
943
944         isl_int_init(v);
945         dim = isl_dim_set_alloc(ctx, 0, 2);
946         bset = isl_basic_set_universe(isl_dim_copy(dim));
947
948         c = isl_equality_alloc(isl_dim_copy(dim));
949         isl_int_set_si(v, -1);
950         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
951         isl_int_set_si(v, 2);
952         isl_constraint_set_coefficient(c, isl_dim_set, 1, v);
953         bset = isl_basic_set_add_constraint(bset, c);
954
955         c = isl_inequality_alloc(isl_dim_copy(dim));
956         isl_int_set_si(v, -10);
957         isl_constraint_set_constant(c, v);
958         isl_int_set_si(v, 1);
959         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
960         bset = isl_basic_set_add_constraint(bset, c);
961
962         c = isl_inequality_alloc(dim);
963         isl_int_set_si(v, 42);
964         isl_constraint_set_constant(c, v);
965         isl_int_set_si(v, -1);
966         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
967         bset = isl_basic_set_add_constraint(bset, c);
968
969         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
970
971         isl_int_clear(v);
972
973 Or, alternatively,
974
975         struct isl_basic_set *bset;
976         bset = isl_basic_set_read_from_str(ctx,
977                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}", -1);
978
979 A basic set or relation can also be constructed from two matrices
980 describing the equalities and the inequalities.
981
982         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
983                 __isl_take isl_dim *dim,
984                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
985                 enum isl_dim_type c1,
986                 enum isl_dim_type c2, enum isl_dim_type c3,
987                 enum isl_dim_type c4);
988         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
989                 __isl_take isl_dim *dim,
990                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
991                 enum isl_dim_type c1,
992                 enum isl_dim_type c2, enum isl_dim_type c3,
993                 enum isl_dim_type c4, enum isl_dim_type c5);
994
995 The C<isl_dim_type> arguments indicate the order in which
996 different kinds of variables appear in the input matrices
997 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
998 C<isl_dim_set> and C<isl_dim_div> for sets and
999 of C<isl_dim_cst>, C<isl_dim_param>,
1000 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1001
1002 =head2 Inspecting Sets and Relations
1003
1004 Usually, the user should not have to care about the actual constraints
1005 of the sets and maps, but should instead apply the abstract operations
1006 explained in the following sections.
1007 Occasionally, however, it may be required to inspect the individual
1008 coefficients of the constraints.  This section explains how to do so.
1009 In these cases, it may also be useful to have C<isl> compute
1010 an explicit representation of the existentially quantified variables.
1011
1012         __isl_give isl_set *isl_set_compute_divs(
1013                 __isl_take isl_set *set);
1014         __isl_give isl_map *isl_map_compute_divs(
1015                 __isl_take isl_map *map);
1016         __isl_give isl_union_set *isl_union_set_compute_divs(
1017                 __isl_take isl_union_set *uset);
1018         __isl_give isl_union_map *isl_union_map_compute_divs(
1019                 __isl_take isl_union_map *umap);
1020
1021 This explicit representation defines the existentially quantified
1022 variables as integer divisions of the other variables, possibly
1023 including earlier existentially quantified variables.
1024 An explicitly represented existentially quantified variable therefore
1025 has a unique value when the values of the other variables are known.
1026 If, furthermore, the same existentials, i.e., existentials
1027 with the same explicit representations, should appear in the
1028 same order in each of the disjuncts of a set or map, then the user should call
1029 either of the following functions.
1030
1031         __isl_give isl_set *isl_set_align_divs(
1032                 __isl_take isl_set *set);
1033         __isl_give isl_map *isl_map_align_divs(
1034                 __isl_take isl_map *map);
1035
1036 Alternatively, the existentially quantified variables can be removed
1037 using the following functions, which compute an overapproximation.
1038
1039         __isl_give isl_basic_set *isl_basic_set_remove_divs(
1040                 __isl_take isl_basic_set *bset);
1041         __isl_give isl_basic_map *isl_basic_map_remove_divs(
1042                 __isl_take isl_basic_map *bmap);
1043         __isl_give isl_set *isl_set_remove_divs(
1044                 __isl_take isl_set *set);
1045         __isl_give isl_map *isl_map_remove_divs(
1046                 __isl_take isl_map *map);
1047
1048 To iterate over all the sets or maps in a union set or map, use
1049
1050         int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1051                 int (*fn)(__isl_take isl_set *set, void *user),
1052                 void *user);
1053         int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1054                 int (*fn)(__isl_take isl_map *map, void *user),
1055                 void *user);
1056
1057 The number of sets or maps in a union set or map can be obtained
1058 from
1059
1060         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1061         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1062
1063 To extract the set or map from a union with a given dimension
1064 specification, use
1065
1066         __isl_give isl_set *isl_union_set_extract_set(
1067                 __isl_keep isl_union_set *uset,
1068                 __isl_take isl_dim *dim);
1069         __isl_give isl_map *isl_union_map_extract_map(
1070                 __isl_keep isl_union_map *umap,
1071                 __isl_take isl_dim *dim);
1072
1073 To iterate over all the basic sets or maps in a set or map, use
1074
1075         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1076                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1077                 void *user);
1078         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1079                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1080                 void *user);
1081
1082 The callback function C<fn> should return 0 if successful and
1083 -1 if an error occurs.  In the latter case, or if any other error
1084 occurs, the above functions will return -1.
1085
1086 It should be noted that C<isl> does not guarantee that
1087 the basic sets or maps passed to C<fn> are disjoint.
1088 If this is required, then the user should call one of
1089 the following functions first.
1090
1091         __isl_give isl_set *isl_set_make_disjoint(
1092                 __isl_take isl_set *set);
1093         __isl_give isl_map *isl_map_make_disjoint(
1094                 __isl_take isl_map *map);
1095
1096 The number of basic sets in a set can be obtained
1097 from
1098
1099         int isl_set_n_basic_set(__isl_keep isl_set *set);
1100
1101 To iterate over the constraints of a basic set or map, use
1102
1103         #include <isl/constraint.h>
1104
1105         int isl_basic_map_foreach_constraint(
1106                 __isl_keep isl_basic_map *bmap,
1107                 int (*fn)(__isl_take isl_constraint *c, void *user),
1108                 void *user);
1109         void isl_constraint_free(struct isl_constraint *c);
1110
1111 Again, the callback function C<fn> should return 0 if successful and
1112 -1 if an error occurs.  In the latter case, or if any other error
1113 occurs, the above functions will return -1.
1114 The constraint C<c> represents either an equality or an inequality.
1115 Use the following function to find out whether a constraint
1116 represents an equality.  If not, it represents an inequality.
1117
1118         int isl_constraint_is_equality(
1119                 __isl_keep isl_constraint *constraint);
1120
1121 The coefficients of the constraints can be inspected using
1122 the following functions.
1123
1124         void isl_constraint_get_constant(
1125                 __isl_keep isl_constraint *constraint, isl_int *v);
1126         void isl_constraint_get_coefficient(
1127                 __isl_keep isl_constraint *constraint,
1128                 enum isl_dim_type type, int pos, isl_int *v);
1129         int isl_constraint_involves_dims(
1130                 __isl_keep isl_constraint *constraint,
1131                 enum isl_dim_type type, unsigned first, unsigned n);
1132
1133 The explicit representations of the existentially quantified
1134 variables can be inspected using the following functions.
1135 Note that the user is only allowed to use these functions
1136 if the inspected set or map is the result of a call
1137 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1138
1139         __isl_give isl_div *isl_constraint_div(
1140                 __isl_keep isl_constraint *constraint, int pos);
1141         isl_ctx *isl_div_get_ctx(__isl_keep isl_div *div);
1142         void isl_div_get_constant(__isl_keep isl_div *div,
1143                 isl_int *v);
1144         void isl_div_get_denominator(__isl_keep isl_div *div,
1145                 isl_int *v);
1146         void isl_div_get_coefficient(__isl_keep isl_div *div,
1147                 enum isl_dim_type type, int pos, isl_int *v);
1148
1149 To obtain the constraints of a basic set or map in matrix
1150 form, use the following functions.
1151
1152         __isl_give isl_mat *isl_basic_set_equalities_matrix(
1153                 __isl_keep isl_basic_set *bset,
1154                 enum isl_dim_type c1, enum isl_dim_type c2,
1155                 enum isl_dim_type c3, enum isl_dim_type c4);
1156         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1157                 __isl_keep isl_basic_set *bset,
1158                 enum isl_dim_type c1, enum isl_dim_type c2,
1159                 enum isl_dim_type c3, enum isl_dim_type c4);
1160         __isl_give isl_mat *isl_basic_map_equalities_matrix(
1161                 __isl_keep isl_basic_map *bmap,
1162                 enum isl_dim_type c1,
1163                 enum isl_dim_type c2, enum isl_dim_type c3,
1164                 enum isl_dim_type c4, enum isl_dim_type c5);
1165         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1166                 __isl_keep isl_basic_map *bmap,
1167                 enum isl_dim_type c1,
1168                 enum isl_dim_type c2, enum isl_dim_type c3,
1169                 enum isl_dim_type c4, enum isl_dim_type c5);
1170
1171 The C<isl_dim_type> arguments dictate the order in which
1172 different kinds of variables appear in the resulting matrix
1173 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1174 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1175
1176 The names of the domain and range spaces of a set or relation can be
1177 read off using the following functions.
1178
1179         const char *isl_basic_set_get_tuple_name(
1180                 __isl_keep isl_basic_set *bset);
1181         const char *isl_set_get_tuple_name(
1182                 __isl_keep isl_set *set);
1183         const char *isl_basic_map_get_tuple_name(
1184                 __isl_keep isl_basic_map *bmap,
1185                 enum isl_dim_type type);
1186         const char *isl_map_get_tuple_name(
1187                 __isl_keep isl_map *map,
1188                 enum isl_dim_type type);
1189
1190 As with C<isl_dim_get_tuple_name>, the value returned points to
1191 an internal data structure.
1192 The names of individual dimensions can be read off using
1193 the following functions.
1194
1195         const char *isl_constraint_get_dim_name(
1196                 __isl_keep isl_constraint *constraint,
1197                 enum isl_dim_type type, unsigned pos);
1198         const char *isl_basic_set_get_dim_name(
1199                 __isl_keep isl_basic_set *bset,
1200                 enum isl_dim_type type, unsigned pos);
1201         const char *isl_set_get_dim_name(
1202                 __isl_keep isl_set *set,
1203                 enum isl_dim_type type, unsigned pos);
1204         const char *isl_basic_map_get_dim_name(
1205                 __isl_keep isl_basic_map *bmap,
1206                 enum isl_dim_type type, unsigned pos);
1207         const char *isl_map_get_dim_name(
1208                 __isl_keep isl_map *map,
1209                 enum isl_dim_type type, unsigned pos);
1210
1211 These functions are mostly useful to obtain the names
1212 of the parameters.
1213
1214 =head2 Properties
1215
1216 =head3 Unary Properties
1217
1218 =over
1219
1220 =item * Emptiness
1221
1222 The following functions test whether the given set or relation
1223 contains any integer points.  The ``plain'' variants do not perform
1224 any computations, but simply check if the given set or relation
1225 is already known to be empty.
1226
1227         int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
1228         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
1229         int isl_set_plain_is_empty(__isl_keep isl_set *set);
1230         int isl_set_is_empty(__isl_keep isl_set *set);
1231         int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
1232         int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
1233         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
1234         int isl_map_plain_is_empty(__isl_keep isl_map *map);
1235         int isl_map_is_empty(__isl_keep isl_map *map);
1236         int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
1237
1238 =item * Universality
1239
1240         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
1241         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
1242         int isl_set_plain_is_universe(__isl_keep isl_set *set);
1243
1244 =item * Single-valuedness
1245
1246         int isl_map_is_single_valued(__isl_keep isl_map *map);
1247         int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
1248
1249 =item * Injectivity
1250
1251         int isl_map_plain_is_injective(__isl_keep isl_map *map);
1252         int isl_map_is_injective(__isl_keep isl_map *map);
1253         int isl_union_map_plain_is_injective(
1254                 __isl_keep isl_union_map *umap);
1255         int isl_union_map_is_injective(
1256                 __isl_keep isl_union_map *umap);
1257
1258 =item * Bijectivity
1259
1260         int isl_map_is_bijective(__isl_keep isl_map *map);
1261         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
1262
1263 =item * Wrapping
1264
1265 The following functions check whether the domain of the given
1266 (basic) set is a wrapped relation.
1267
1268         int isl_basic_set_is_wrapping(
1269                 __isl_keep isl_basic_set *bset);
1270         int isl_set_is_wrapping(__isl_keep isl_set *set);
1271
1272 =item * Internal Product
1273
1274         int isl_basic_map_can_zip(
1275                 __isl_keep isl_basic_map *bmap);
1276         int isl_map_can_zip(__isl_keep isl_map *map);
1277
1278 Check whether the product of domain and range of the given relation
1279 can be computed,
1280 i.e., whether both domain and range are nested relations.
1281
1282 =back
1283
1284 =head3 Binary Properties
1285
1286 =over
1287
1288 =item * Equality
1289
1290         int isl_set_plain_is_equal(__isl_keep isl_set *set1,
1291                 __isl_keep isl_set *set2);
1292         int isl_set_is_equal(__isl_keep isl_set *set1,
1293                 __isl_keep isl_set *set2);
1294         int isl_union_set_is_equal(
1295                 __isl_keep isl_union_set *uset1,
1296                 __isl_keep isl_union_set *uset2);
1297         int isl_basic_map_is_equal(
1298                 __isl_keep isl_basic_map *bmap1,
1299                 __isl_keep isl_basic_map *bmap2);
1300         int isl_map_is_equal(__isl_keep isl_map *map1,
1301                 __isl_keep isl_map *map2);
1302         int isl_map_plain_is_equal(__isl_keep isl_map *map1,
1303                 __isl_keep isl_map *map2);
1304         int isl_union_map_is_equal(
1305                 __isl_keep isl_union_map *umap1,
1306                 __isl_keep isl_union_map *umap2);
1307
1308 =item * Disjointness
1309
1310         int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
1311                 __isl_keep isl_set *set2);
1312
1313 =item * Subset
1314
1315         int isl_set_is_subset(__isl_keep isl_set *set1,
1316                 __isl_keep isl_set *set2);
1317         int isl_set_is_strict_subset(
1318                 __isl_keep isl_set *set1,
1319                 __isl_keep isl_set *set2);
1320         int isl_union_set_is_subset(
1321                 __isl_keep isl_union_set *uset1,
1322                 __isl_keep isl_union_set *uset2);
1323         int isl_union_set_is_strict_subset(
1324                 __isl_keep isl_union_set *uset1,
1325                 __isl_keep isl_union_set *uset2);
1326         int isl_basic_map_is_subset(
1327                 __isl_keep isl_basic_map *bmap1,
1328                 __isl_keep isl_basic_map *bmap2);
1329         int isl_basic_map_is_strict_subset(
1330                 __isl_keep isl_basic_map *bmap1,
1331                 __isl_keep isl_basic_map *bmap2);
1332         int isl_map_is_subset(
1333                 __isl_keep isl_map *map1,
1334                 __isl_keep isl_map *map2);
1335         int isl_map_is_strict_subset(
1336                 __isl_keep isl_map *map1,
1337                 __isl_keep isl_map *map2);
1338         int isl_union_map_is_subset(
1339                 __isl_keep isl_union_map *umap1,
1340                 __isl_keep isl_union_map *umap2);
1341         int isl_union_map_is_strict_subset(
1342                 __isl_keep isl_union_map *umap1,
1343                 __isl_keep isl_union_map *umap2);
1344
1345 =back
1346
1347 =head2 Unary Operations
1348
1349 =over
1350
1351 =item * Complement
1352
1353         __isl_give isl_set *isl_set_complement(
1354                 __isl_take isl_set *set);
1355
1356 =item * Inverse map
1357
1358         __isl_give isl_basic_map *isl_basic_map_reverse(
1359                 __isl_take isl_basic_map *bmap);
1360         __isl_give isl_map *isl_map_reverse(
1361                 __isl_take isl_map *map);
1362         __isl_give isl_union_map *isl_union_map_reverse(
1363                 __isl_take isl_union_map *umap);
1364
1365 =item * Projection
1366
1367         __isl_give isl_basic_set *isl_basic_set_project_out(
1368                 __isl_take isl_basic_set *bset,
1369                 enum isl_dim_type type, unsigned first, unsigned n);
1370         __isl_give isl_basic_map *isl_basic_map_project_out(
1371                 __isl_take isl_basic_map *bmap,
1372                 enum isl_dim_type type, unsigned first, unsigned n);
1373         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
1374                 enum isl_dim_type type, unsigned first, unsigned n);
1375         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
1376                 enum isl_dim_type type, unsigned first, unsigned n);
1377         __isl_give isl_basic_set *isl_basic_map_domain(
1378                 __isl_take isl_basic_map *bmap);
1379         __isl_give isl_basic_set *isl_basic_map_range(
1380                 __isl_take isl_basic_map *bmap);
1381         __isl_give isl_set *isl_map_domain(
1382                 __isl_take isl_map *bmap);
1383         __isl_give isl_set *isl_map_range(
1384                 __isl_take isl_map *map);
1385         __isl_give isl_union_set *isl_union_map_domain(
1386                 __isl_take isl_union_map *umap);
1387         __isl_give isl_union_set *isl_union_map_range(
1388                 __isl_take isl_union_map *umap);
1389
1390         __isl_give isl_basic_map *isl_basic_map_domain_map(
1391                 __isl_take isl_basic_map *bmap);
1392         __isl_give isl_basic_map *isl_basic_map_range_map(
1393                 __isl_take isl_basic_map *bmap);
1394         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
1395         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
1396         __isl_give isl_union_map *isl_union_map_domain_map(
1397                 __isl_take isl_union_map *umap);
1398         __isl_give isl_union_map *isl_union_map_range_map(
1399                 __isl_take isl_union_map *umap);
1400
1401 The functions above construct a (basic, regular or union) relation
1402 that maps (a wrapped version of) the input relation to its domain or range.
1403
1404 =item * Elimination
1405
1406         __isl_give isl_set *isl_set_eliminate(
1407                 __isl_take isl_set *set, enum isl_dim_type type,
1408                 unsigned first, unsigned n);
1409
1410 Eliminate the coefficients for the given dimensions from the constraints,
1411 without removing the dimensions.
1412
1413 =item * Identity
1414
1415         __isl_give isl_map *isl_set_identity(
1416                 __isl_take isl_set *set);
1417         __isl_give isl_union_map *isl_union_set_identity(
1418                 __isl_take isl_union_set *uset);
1419
1420 Construct an identity relation on the given (union) set.
1421
1422 =item * Deltas
1423
1424         __isl_give isl_basic_set *isl_basic_map_deltas(
1425                 __isl_take isl_basic_map *bmap);
1426         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
1427         __isl_give isl_union_set *isl_union_map_deltas(
1428                 __isl_take isl_union_map *umap);
1429
1430 These functions return a (basic) set containing the differences
1431 between image elements and corresponding domain elements in the input.
1432
1433         __isl_give isl_basic_map *isl_basic_map_deltas_map(
1434                 __isl_take isl_basic_map *bmap);
1435         __isl_give isl_map *isl_map_deltas_map(
1436                 __isl_take isl_map *map);
1437         __isl_give isl_union_map *isl_union_map_deltas_map(
1438                 __isl_take isl_union_map *umap);
1439
1440 The functions above construct a (basic, regular or union) relation
1441 that maps (a wrapped version of) the input relation to its delta set.
1442
1443 =item * Coalescing
1444
1445 Simplify the representation of a set or relation by trying
1446 to combine pairs of basic sets or relations into a single
1447 basic set or relation.
1448
1449         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
1450         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
1451         __isl_give isl_union_set *isl_union_set_coalesce(
1452                 __isl_take isl_union_set *uset);
1453         __isl_give isl_union_map *isl_union_map_coalesce(
1454                 __isl_take isl_union_map *umap);
1455
1456 =item * Detecting equalities
1457
1458         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
1459                 __isl_take isl_basic_set *bset);
1460         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
1461                 __isl_take isl_basic_map *bmap);
1462         __isl_give isl_set *isl_set_detect_equalities(
1463                 __isl_take isl_set *set);
1464         __isl_give isl_map *isl_map_detect_equalities(
1465                 __isl_take isl_map *map);
1466         __isl_give isl_union_set *isl_union_set_detect_equalities(
1467                 __isl_take isl_union_set *uset);
1468         __isl_give isl_union_map *isl_union_map_detect_equalities(
1469                 __isl_take isl_union_map *umap);
1470
1471 Simplify the representation of a set or relation by detecting implicit
1472 equalities.
1473
1474 =item * Removing redundant constraints
1475
1476         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
1477                 __isl_take isl_basic_set *bset);
1478         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
1479                 __isl_take isl_basic_map *bmap);
1480
1481 =item * Convex hull
1482
1483         __isl_give isl_basic_set *isl_set_convex_hull(
1484                 __isl_take isl_set *set);
1485         __isl_give isl_basic_map *isl_map_convex_hull(
1486                 __isl_take isl_map *map);
1487
1488 If the input set or relation has any existentially quantified
1489 variables, then the result of these operations is currently undefined.
1490
1491 =item * Simple hull
1492
1493         __isl_give isl_basic_set *isl_set_simple_hull(
1494                 __isl_take isl_set *set);
1495         __isl_give isl_basic_map *isl_map_simple_hull(
1496                 __isl_take isl_map *map);
1497         __isl_give isl_union_map *isl_union_map_simple_hull(
1498                 __isl_take isl_union_map *umap);
1499
1500 These functions compute a single basic set or relation
1501 that contains the whole input set or relation.
1502 In particular, the output is described by translates
1503 of the constraints describing the basic sets or relations in the input.
1504
1505 =begin latex
1506
1507 (See \autoref{s:simple hull}.)
1508
1509 =end latex
1510
1511 =item * Affine hull
1512
1513         __isl_give isl_basic_set *isl_basic_set_affine_hull(
1514                 __isl_take isl_basic_set *bset);
1515         __isl_give isl_basic_set *isl_set_affine_hull(
1516                 __isl_take isl_set *set);
1517         __isl_give isl_union_set *isl_union_set_affine_hull(
1518                 __isl_take isl_union_set *uset);
1519         __isl_give isl_basic_map *isl_basic_map_affine_hull(
1520                 __isl_take isl_basic_map *bmap);
1521         __isl_give isl_basic_map *isl_map_affine_hull(
1522                 __isl_take isl_map *map);
1523         __isl_give isl_union_map *isl_union_map_affine_hull(
1524                 __isl_take isl_union_map *umap);
1525
1526 In case of union sets and relations, the affine hull is computed
1527 per space.
1528
1529 =item * Polyhedral hull
1530
1531         __isl_give isl_basic_set *isl_set_polyhedral_hull(
1532                 __isl_take isl_set *set);
1533         __isl_give isl_basic_map *isl_map_polyhedral_hull(
1534                 __isl_take isl_map *map);
1535         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
1536                 __isl_take isl_union_set *uset);
1537         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
1538                 __isl_take isl_union_map *umap);
1539
1540 These functions compute a single basic set or relation
1541 not involving any existentially quantified variables
1542 that contains the whole input set or relation.
1543 In case of union sets and relations, the polyhedral hull is computed
1544 per space.
1545
1546 =item * Optimization
1547
1548         #include <isl/ilp.h>
1549         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
1550                 __isl_keep isl_aff *obj, isl_int *opt);
1551
1552 Compute the maximum of the integer affine expression C<obj>
1553 over the points in C<set>, returning the result in C<opt>.
1554 The return value may be one of C<isl_lp_error>,
1555 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
1556
1557 =item * Dual
1558
1559 The following functions compute either the set of (rational) coefficient
1560 values of valid constraints for the given set or the set of (rational)
1561 values satisfying the constraints with coefficients from the given set.
1562 Internally, these two sets of functions perform essentially the
1563 same operations, except that the set of coefficients is assumed to
1564 be a cone, while the set of values may be any polyhedron.
1565 The current implementation is based on the Farkas lemma and
1566 Fourier-Motzkin elimination, but this may change or be made optional
1567 in future.  In particular, future implementations may use different
1568 dualization algorithms or skip the elimination step.
1569
1570         __isl_give isl_basic_set *isl_basic_set_coefficients(
1571                 __isl_take isl_basic_set *bset);
1572         __isl_give isl_basic_set *isl_set_coefficients(
1573                 __isl_take isl_set *set);
1574         __isl_give isl_union_set *isl_union_set_coefficients(
1575                 __isl_take isl_union_set *bset);
1576         __isl_give isl_basic_set *isl_basic_set_solutions(
1577                 __isl_take isl_basic_set *bset);
1578         __isl_give isl_basic_set *isl_set_solutions(
1579                 __isl_take isl_set *set);
1580         __isl_give isl_union_set *isl_union_set_solutions(
1581                 __isl_take isl_union_set *bset);
1582
1583 =item * Power
1584
1585         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
1586                 int *exact);
1587         __isl_give isl_union_map *isl_union_map_power(
1588                 __isl_take isl_union_map *umap, int *exact);
1589
1590 Compute a parametric representation for all positive powers I<k> of C<map>.
1591 The result maps I<k> to a nested relation corresponding to the
1592 I<k>th power of C<map>.
1593 The result may be an overapproximation.  If the result is known to be exact,
1594 then C<*exact> is set to C<1>.
1595
1596 =item * Transitive closure
1597
1598         __isl_give isl_map *isl_map_transitive_closure(
1599                 __isl_take isl_map *map, int *exact);
1600         __isl_give isl_union_map *isl_union_map_transitive_closure(
1601                 __isl_take isl_union_map *umap, int *exact);
1602
1603 Compute the transitive closure of C<map>.
1604 The result may be an overapproximation.  If the result is known to be exact,
1605 then C<*exact> is set to C<1>.
1606
1607 =item * Reaching path lengths
1608
1609         __isl_give isl_map *isl_map_reaching_path_lengths(
1610                 __isl_take isl_map *map, int *exact);
1611
1612 Compute a relation that maps each element in the range of C<map>
1613 to the lengths of all paths composed of edges in C<map> that
1614 end up in the given element.
1615 The result may be an overapproximation.  If the result is known to be exact,
1616 then C<*exact> is set to C<1>.
1617 To compute the I<maximal> path length, the resulting relation
1618 should be postprocessed by C<isl_map_lexmax>.
1619 In particular, if the input relation is a dependence relation
1620 (mapping sources to sinks), then the maximal path length corresponds
1621 to the free schedule.
1622 Note, however, that C<isl_map_lexmax> expects the maximum to be
1623 finite, so if the path lengths are unbounded (possibly due to
1624 the overapproximation), then you will get an error message.
1625
1626 =item * Wrapping
1627
1628         __isl_give isl_basic_set *isl_basic_map_wrap(
1629                 __isl_take isl_basic_map *bmap);
1630         __isl_give isl_set *isl_map_wrap(
1631                 __isl_take isl_map *map);
1632         __isl_give isl_union_set *isl_union_map_wrap(
1633                 __isl_take isl_union_map *umap);
1634         __isl_give isl_basic_map *isl_basic_set_unwrap(
1635                 __isl_take isl_basic_set *bset);
1636         __isl_give isl_map *isl_set_unwrap(
1637                 __isl_take isl_set *set);
1638         __isl_give isl_union_map *isl_union_set_unwrap(
1639                 __isl_take isl_union_set *uset);
1640
1641 =item * Flattening
1642
1643 Remove any internal structure of domain (and range) of the given
1644 set or relation.  If there is any such internal structure in the input,
1645 then the name of the space is also removed.
1646
1647         __isl_give isl_basic_set *isl_basic_set_flatten(
1648                 __isl_take isl_basic_set *bset);
1649         __isl_give isl_set *isl_set_flatten(
1650                 __isl_take isl_set *set);
1651         __isl_give isl_basic_map *isl_basic_map_flatten(
1652                 __isl_take isl_basic_map *bmap);
1653         __isl_give isl_map *isl_map_flatten(
1654                 __isl_take isl_map *map);
1655
1656         __isl_give isl_map *isl_set_flatten_map(
1657                 __isl_take isl_set *set);
1658
1659 The function above constructs a relation
1660 that maps the input set to a flattened version of the set.
1661
1662 =item * Lifting
1663
1664 Lift the input set to a space with extra dimensions corresponding
1665 to the existentially quantified variables in the input.
1666 In particular, the result lives in a wrapped map where the domain
1667 is the original space and the range corresponds to the original
1668 existentially quantified variables.
1669
1670         __isl_give isl_basic_set *isl_basic_set_lift(
1671                 __isl_take isl_basic_set *bset);
1672         __isl_give isl_set *isl_set_lift(
1673                 __isl_take isl_set *set);
1674         __isl_give isl_union_set *isl_union_set_lift(
1675                 __isl_take isl_union_set *uset);
1676
1677 =item * Internal Product
1678
1679         __isl_give isl_basic_map *isl_basic_map_zip(
1680                 __isl_take isl_basic_map *bmap);
1681         __isl_give isl_map *isl_map_zip(
1682                 __isl_take isl_map *map);
1683         __isl_give isl_union_map *isl_union_map_zip(
1684                 __isl_take isl_union_map *umap);
1685
1686 Given a relation with nested relations for domain and range,
1687 interchange the range of the domain with the domain of the range.
1688
1689 =item * Aligning parameters
1690
1691         __isl_give isl_set *isl_set_align_params(
1692                 __isl_take isl_set *set,
1693                 __isl_take isl_dim *model);
1694         __isl_give isl_map *isl_map_align_params(
1695                 __isl_take isl_map *map,
1696                 __isl_take isl_dim *model);
1697
1698 Change the order of the parameters of the given set or relation
1699 such that the first parameters match those of C<model>.
1700 This may involve the introduction of extra parameters.
1701 All parameters need to be named.
1702
1703 =item * Dimension manipulation
1704
1705         __isl_give isl_set *isl_set_add_dims(
1706                 __isl_take isl_set *set,
1707                 enum isl_dim_type type, unsigned n);
1708         __isl_give isl_map *isl_map_add_dims(
1709                 __isl_take isl_map *map,
1710                 enum isl_dim_type type, unsigned n);
1711
1712 It is usually not advisable to directly change the (input or output)
1713 space of a set or a relation as this removes the name and the internal
1714 structure of the space.  However, the above functions can be useful
1715 to add new parameters, assuming
1716 C<isl_set_align_params> and C<isl_map_align_params>
1717 are not sufficient.
1718
1719 =back
1720
1721 =head2 Binary Operations
1722
1723 The two arguments of a binary operation not only need to live
1724 in the same C<isl_ctx>, they currently also need to have
1725 the same (number of) parameters.
1726
1727 =head3 Basic Operations
1728
1729 =over
1730
1731 =item * Intersection
1732
1733         __isl_give isl_basic_set *isl_basic_set_intersect(
1734                 __isl_take isl_basic_set *bset1,
1735                 __isl_take isl_basic_set *bset2);
1736         __isl_give isl_set *isl_set_intersect(
1737                 __isl_take isl_set *set1,
1738                 __isl_take isl_set *set2);
1739         __isl_give isl_union_set *isl_union_set_intersect(
1740                 __isl_take isl_union_set *uset1,
1741                 __isl_take isl_union_set *uset2);
1742         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
1743                 __isl_take isl_basic_map *bmap,
1744                 __isl_take isl_basic_set *bset);
1745         __isl_give isl_basic_map *isl_basic_map_intersect_range(
1746                 __isl_take isl_basic_map *bmap,
1747                 __isl_take isl_basic_set *bset);
1748         __isl_give isl_basic_map *isl_basic_map_intersect(
1749                 __isl_take isl_basic_map *bmap1,
1750                 __isl_take isl_basic_map *bmap2);
1751         __isl_give isl_map *isl_map_intersect_domain(
1752                 __isl_take isl_map *map,
1753                 __isl_take isl_set *set);
1754         __isl_give isl_map *isl_map_intersect_range(
1755                 __isl_take isl_map *map,
1756                 __isl_take isl_set *set);
1757         __isl_give isl_map *isl_map_intersect(
1758                 __isl_take isl_map *map1,
1759                 __isl_take isl_map *map2);
1760         __isl_give isl_union_map *isl_union_map_intersect_domain(
1761                 __isl_take isl_union_map *umap,
1762                 __isl_take isl_union_set *uset);
1763         __isl_give isl_union_map *isl_union_map_intersect_range(
1764                 __isl_take isl_union_map *umap,
1765                 __isl_take isl_union_set *uset);
1766         __isl_give isl_union_map *isl_union_map_intersect(
1767                 __isl_take isl_union_map *umap1,
1768                 __isl_take isl_union_map *umap2);
1769
1770 =item * Union
1771
1772         __isl_give isl_set *isl_basic_set_union(
1773                 __isl_take isl_basic_set *bset1,
1774                 __isl_take isl_basic_set *bset2);
1775         __isl_give isl_map *isl_basic_map_union(
1776                 __isl_take isl_basic_map *bmap1,
1777                 __isl_take isl_basic_map *bmap2);
1778         __isl_give isl_set *isl_set_union(
1779                 __isl_take isl_set *set1,
1780                 __isl_take isl_set *set2);
1781         __isl_give isl_map *isl_map_union(
1782                 __isl_take isl_map *map1,
1783                 __isl_take isl_map *map2);
1784         __isl_give isl_union_set *isl_union_set_union(
1785                 __isl_take isl_union_set *uset1,
1786                 __isl_take isl_union_set *uset2);
1787         __isl_give isl_union_map *isl_union_map_union(
1788                 __isl_take isl_union_map *umap1,
1789                 __isl_take isl_union_map *umap2);
1790
1791 =item * Set difference
1792
1793         __isl_give isl_set *isl_set_subtract(
1794                 __isl_take isl_set *set1,
1795                 __isl_take isl_set *set2);
1796         __isl_give isl_map *isl_map_subtract(
1797                 __isl_take isl_map *map1,
1798                 __isl_take isl_map *map2);
1799         __isl_give isl_union_set *isl_union_set_subtract(
1800                 __isl_take isl_union_set *uset1,
1801                 __isl_take isl_union_set *uset2);
1802         __isl_give isl_union_map *isl_union_map_subtract(
1803                 __isl_take isl_union_map *umap1,
1804                 __isl_take isl_union_map *umap2);
1805
1806 =item * Application
1807
1808         __isl_give isl_basic_set *isl_basic_set_apply(
1809                 __isl_take isl_basic_set *bset,
1810                 __isl_take isl_basic_map *bmap);
1811         __isl_give isl_set *isl_set_apply(
1812                 __isl_take isl_set *set,
1813                 __isl_take isl_map *map);
1814         __isl_give isl_union_set *isl_union_set_apply(
1815                 __isl_take isl_union_set *uset,
1816                 __isl_take isl_union_map *umap);
1817         __isl_give isl_basic_map *isl_basic_map_apply_domain(
1818                 __isl_take isl_basic_map *bmap1,
1819                 __isl_take isl_basic_map *bmap2);
1820         __isl_give isl_basic_map *isl_basic_map_apply_range(
1821                 __isl_take isl_basic_map *bmap1,
1822                 __isl_take isl_basic_map *bmap2);
1823         __isl_give isl_map *isl_map_apply_domain(
1824                 __isl_take isl_map *map1,
1825                 __isl_take isl_map *map2);
1826         __isl_give isl_union_map *isl_union_map_apply_domain(
1827                 __isl_take isl_union_map *umap1,
1828                 __isl_take isl_union_map *umap2);
1829         __isl_give isl_map *isl_map_apply_range(
1830                 __isl_take isl_map *map1,
1831                 __isl_take isl_map *map2);
1832         __isl_give isl_union_map *isl_union_map_apply_range(
1833                 __isl_take isl_union_map *umap1,
1834                 __isl_take isl_union_map *umap2);
1835
1836 =item * Cartesian Product
1837
1838         __isl_give isl_set *isl_set_product(
1839                 __isl_take isl_set *set1,
1840                 __isl_take isl_set *set2);
1841         __isl_give isl_union_set *isl_union_set_product(
1842                 __isl_take isl_union_set *uset1,
1843                 __isl_take isl_union_set *uset2);
1844         __isl_give isl_basic_map *isl_basic_map_range_product(
1845                 __isl_take isl_basic_map *bmap1,
1846                 __isl_take isl_basic_map *bmap2);
1847         __isl_give isl_map *isl_map_range_product(
1848                 __isl_take isl_map *map1,
1849                 __isl_take isl_map *map2);
1850         __isl_give isl_union_map *isl_union_map_range_product(
1851                 __isl_take isl_union_map *umap1,
1852                 __isl_take isl_union_map *umap2);
1853         __isl_give isl_map *isl_map_product(
1854                 __isl_take isl_map *map1,
1855                 __isl_take isl_map *map2);
1856         __isl_give isl_union_map *isl_union_map_product(
1857                 __isl_take isl_union_map *umap1,
1858                 __isl_take isl_union_map *umap2);
1859
1860 The above functions compute the cross product of the given
1861 sets or relations.  The domains and ranges of the results
1862 are wrapped maps between domains and ranges of the inputs.
1863 To obtain a ``flat'' product, use the following functions
1864 instead.
1865
1866         __isl_give isl_basic_set *isl_basic_set_flat_product(
1867                 __isl_take isl_basic_set *bset1,
1868                 __isl_take isl_basic_set *bset2);
1869         __isl_give isl_set *isl_set_flat_product(
1870                 __isl_take isl_set *set1,
1871                 __isl_take isl_set *set2);
1872         __isl_give isl_basic_map *isl_basic_map_flat_product(
1873                 __isl_take isl_basic_map *bmap1,
1874                 __isl_take isl_basic_map *bmap2);
1875         __isl_give isl_map *isl_map_flat_product(
1876                 __isl_take isl_map *map1,
1877                 __isl_take isl_map *map2);
1878
1879 =item * Simplification
1880
1881         __isl_give isl_basic_set *isl_basic_set_gist(
1882                 __isl_take isl_basic_set *bset,
1883                 __isl_take isl_basic_set *context);
1884         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
1885                 __isl_take isl_set *context);
1886         __isl_give isl_union_set *isl_union_set_gist(
1887                 __isl_take isl_union_set *uset,
1888                 __isl_take isl_union_set *context);
1889         __isl_give isl_basic_map *isl_basic_map_gist(
1890                 __isl_take isl_basic_map *bmap,
1891                 __isl_take isl_basic_map *context);
1892         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
1893                 __isl_take isl_map *context);
1894         __isl_give isl_union_map *isl_union_map_gist(
1895                 __isl_take isl_union_map *umap,
1896                 __isl_take isl_union_map *context);
1897
1898 The gist operation returns a set or relation that has the
1899 same intersection with the context as the input set or relation.
1900 Any implicit equality in the intersection is made explicit in the result,
1901 while all inequalities that are redundant with respect to the intersection
1902 are removed.
1903 In case of union sets and relations, the gist operation is performed
1904 per space.
1905
1906 =back
1907
1908 =head3 Lexicographic Optimization
1909
1910 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
1911 the following functions
1912 compute a set that contains the lexicographic minimum or maximum
1913 of the elements in C<set> (or C<bset>) for those values of the parameters
1914 that satisfy C<dom>.
1915 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
1916 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
1917 has no elements.
1918 In other words, the union of the parameter values
1919 for which the result is non-empty and of C<*empty>
1920 is equal to C<dom>.
1921
1922         __isl_give isl_set *isl_basic_set_partial_lexmin(
1923                 __isl_take isl_basic_set *bset,
1924                 __isl_take isl_basic_set *dom,
1925                 __isl_give isl_set **empty);
1926         __isl_give isl_set *isl_basic_set_partial_lexmax(
1927                 __isl_take isl_basic_set *bset,
1928                 __isl_take isl_basic_set *dom,
1929                 __isl_give isl_set **empty);
1930         __isl_give isl_set *isl_set_partial_lexmin(
1931                 __isl_take isl_set *set, __isl_take isl_set *dom,
1932                 __isl_give isl_set **empty);
1933         __isl_give isl_set *isl_set_partial_lexmax(
1934                 __isl_take isl_set *set, __isl_take isl_set *dom,
1935                 __isl_give isl_set **empty);
1936
1937 Given a (basic) set C<set> (or C<bset>), the following functions simply
1938 return a set containing the lexicographic minimum or maximum
1939 of the elements in C<set> (or C<bset>).
1940 In case of union sets, the optimum is computed per space.
1941
1942         __isl_give isl_set *isl_basic_set_lexmin(
1943                 __isl_take isl_basic_set *bset);
1944         __isl_give isl_set *isl_basic_set_lexmax(
1945                 __isl_take isl_basic_set *bset);
1946         __isl_give isl_set *isl_set_lexmin(
1947                 __isl_take isl_set *set);
1948         __isl_give isl_set *isl_set_lexmax(
1949                 __isl_take isl_set *set);
1950         __isl_give isl_union_set *isl_union_set_lexmin(
1951                 __isl_take isl_union_set *uset);
1952         __isl_give isl_union_set *isl_union_set_lexmax(
1953                 __isl_take isl_union_set *uset);
1954
1955 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
1956 the following functions
1957 compute a relation that maps each element of C<dom>
1958 to the single lexicographic minimum or maximum
1959 of the elements that are associated to that same
1960 element in C<map> (or C<bmap>).
1961 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
1962 that contains the elements in C<dom> that do not map
1963 to any elements in C<map> (or C<bmap>).
1964 In other words, the union of the domain of the result and of C<*empty>
1965 is equal to C<dom>.
1966
1967         __isl_give isl_map *isl_basic_map_partial_lexmax(
1968                 __isl_take isl_basic_map *bmap,
1969                 __isl_take isl_basic_set *dom,
1970                 __isl_give isl_set **empty);
1971         __isl_give isl_map *isl_basic_map_partial_lexmin(
1972                 __isl_take isl_basic_map *bmap,
1973                 __isl_take isl_basic_set *dom,
1974                 __isl_give isl_set **empty);
1975         __isl_give isl_map *isl_map_partial_lexmax(
1976                 __isl_take isl_map *map, __isl_take isl_set *dom,
1977                 __isl_give isl_set **empty);
1978         __isl_give isl_map *isl_map_partial_lexmin(
1979                 __isl_take isl_map *map, __isl_take isl_set *dom,
1980                 __isl_give isl_set **empty);
1981
1982 Given a (basic) map C<map> (or C<bmap>), the following functions simply
1983 return a map mapping each element in the domain of
1984 C<map> (or C<bmap>) to the lexicographic minimum or maximum
1985 of all elements associated to that element.
1986 In case of union relations, the optimum is computed per space.
1987
1988         __isl_give isl_map *isl_basic_map_lexmin(
1989                 __isl_take isl_basic_map *bmap);
1990         __isl_give isl_map *isl_basic_map_lexmax(
1991                 __isl_take isl_basic_map *bmap);
1992         __isl_give isl_map *isl_map_lexmin(
1993                 __isl_take isl_map *map);
1994         __isl_give isl_map *isl_map_lexmax(
1995                 __isl_take isl_map *map);
1996         __isl_give isl_union_map *isl_union_map_lexmin(
1997                 __isl_take isl_union_map *umap);
1998         __isl_give isl_union_map *isl_union_map_lexmax(
1999                 __isl_take isl_union_map *umap);
2000
2001 =head2 Matrices
2002
2003 Matrices can be created, copied and freed using the following functions.
2004
2005         #include <isl/mat.h>
2006         __isl_give isl_mat *isl_mat_alloc(struct isl_ctx *ctx,
2007                 unsigned n_row, unsigned n_col);
2008         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
2009         void isl_mat_free(__isl_take isl_mat *mat);
2010
2011 Note that the elements of a newly created matrix may have arbitrary values.
2012 The elements can be changed and inspected using the following functions.
2013
2014         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
2015         int isl_mat_rows(__isl_keep isl_mat *mat);
2016         int isl_mat_cols(__isl_keep isl_mat *mat);
2017         int isl_mat_get_element(__isl_keep isl_mat *mat,
2018                 int row, int col, isl_int *v);
2019         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
2020                 int row, int col, isl_int v);
2021         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
2022                 int row, int col, int v);
2023
2024 C<isl_mat_get_element> will return a negative value if anything went wrong.
2025 In that case, the value of C<*v> is undefined.
2026
2027 The following function can be used to compute the (right) inverse
2028 of a matrix, i.e., a matrix such that the product of the original
2029 and the inverse (in that order) is a multiple of the identity matrix.
2030 The input matrix is assumed to be of full row-rank.
2031
2032         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
2033
2034 The following function can be used to compute the (right) kernel
2035 (or null space) of a matrix, i.e., a matrix such that the product of
2036 the original and the kernel (in that order) is the zero matrix.
2037
2038         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
2039
2040 =head2 Quasi Affine Expressions
2041
2042 The zero quasi affine expression can be created using
2043
2044         __isl_give isl_aff *isl_aff_zero(
2045                 __isl_take isl_local_space *ls);
2046
2047 Quasi affine expressions can be copied and free using
2048
2049         #include <isl/aff.h>
2050         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
2051         void *isl_aff_free(__isl_take isl_aff *aff);
2052
2053 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
2054 using the following function.  The constraint is required to have
2055 a non-zero coefficient for the specified dimension.
2056
2057         #include <isl/constraint.h>
2058         __isl_give isl_aff *isl_constraint_get_bound(
2059                 __isl_keep isl_constraint *constraint,
2060                 enum isl_dim_type type, int pos);
2061
2062 Conversely, an equality constraint can be constructed, equating
2063 the affine expression to zero, using
2064
2065         __isl_give isl_constraint *isl_equality_from_aff(
2066                 __isl_take isl_aff *aff);
2067
2068 The expression can be inspected using
2069
2070         #include <isl/aff.h>
2071         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
2072         int isl_aff_dim(__isl_keep isl_aff *aff,
2073                 enum isl_dim_type type);
2074         __isl_give isl_local_space *isl_aff_get_local_space(
2075                 __isl_keep isl_aff *aff);
2076         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
2077                 enum isl_dim_type type, unsigned pos);
2078         int isl_aff_get_constant(__isl_keep isl_aff *aff,
2079                 isl_int *v);
2080         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
2081                 enum isl_dim_type type, int pos, isl_int *v);
2082         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
2083                 isl_int *v);
2084         __isl_give isl_div *isl_aff_get_div(
2085                 __isl_keep isl_aff *aff, int pos);
2086
2087 It can be modified using
2088
2089         #include <isl/aff.h>
2090         __isl_give isl_aff *isl_aff_set_constant(
2091                 __isl_take isl_aff *aff, isl_int v);
2092         __isl_give isl_aff *isl_aff_set_constant_si(
2093                 __isl_take isl_aff *aff, int v);
2094         __isl_give isl_aff *isl_aff_set_coefficient(
2095                 __isl_take isl_aff *aff,
2096                 enum isl_dim_type type, int pos, isl_int v);
2097         __isl_give isl_aff *isl_aff_set_coefficient_si(
2098                 __isl_take isl_aff *aff,
2099                 enum isl_dim_type type, int pos, int v);
2100         __isl_give isl_aff *isl_aff_set_denominator(
2101                 __isl_take isl_aff *aff, isl_int v);
2102
2103         __isl_give isl_aff *isl_aff_add_constant(
2104                 __isl_take isl_aff *aff, isl_int v);
2105         __isl_give isl_aff *isl_aff_add_coefficient_si(
2106                 __isl_take isl_aff *aff,
2107                 enum isl_dim_type type, int pos, int v);
2108
2109 Note that the C<set_constant> and C<set_coefficient> functions
2110 set the I<numerator> of the constant or coefficient, while
2111 C<add_constant> and C<add_coefficient> add an integer value to
2112 the possibly rational constant or coefficient.
2113
2114 Operations include
2115
2116         #include <isl/aff.h>
2117         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
2118         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
2119
2120 An expression can be printed using
2121
2122         #include <isl/aff.h>
2123         __isl_give isl_printer *isl_printer_print_aff(
2124                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
2125
2126 =head2 Points
2127
2128 Points are elements of a set.  They can be used to construct
2129 simple sets (boxes) or they can be used to represent the
2130 individual elements of a set.
2131 The zero point (the origin) can be created using
2132
2133         __isl_give isl_point *isl_point_zero(__isl_take isl_dim *dim);
2134
2135 The coordinates of a point can be inspected, set and changed
2136 using
2137
2138         void isl_point_get_coordinate(__isl_keep isl_point *pnt,
2139                 enum isl_dim_type type, int pos, isl_int *v);
2140         __isl_give isl_point *isl_point_set_coordinate(
2141                 __isl_take isl_point *pnt,
2142                 enum isl_dim_type type, int pos, isl_int v);
2143
2144         __isl_give isl_point *isl_point_add_ui(
2145                 __isl_take isl_point *pnt,
2146                 enum isl_dim_type type, int pos, unsigned val);
2147         __isl_give isl_point *isl_point_sub_ui(
2148                 __isl_take isl_point *pnt,
2149                 enum isl_dim_type type, int pos, unsigned val);
2150
2151 Points can be copied or freed using
2152
2153         __isl_give isl_point *isl_point_copy(
2154                 __isl_keep isl_point *pnt);
2155         void isl_point_free(__isl_take isl_point *pnt);
2156
2157 A singleton set can be created from a point using
2158
2159         __isl_give isl_basic_set *isl_basic_set_from_point(
2160                 __isl_take isl_point *pnt);
2161         __isl_give isl_set *isl_set_from_point(
2162                 __isl_take isl_point *pnt);
2163
2164 and a box can be created from two opposite extremal points using
2165
2166         __isl_give isl_basic_set *isl_basic_set_box_from_points(
2167                 __isl_take isl_point *pnt1,
2168                 __isl_take isl_point *pnt2);
2169         __isl_give isl_set *isl_set_box_from_points(
2170                 __isl_take isl_point *pnt1,
2171                 __isl_take isl_point *pnt2);
2172
2173 All elements of a B<bounded> (union) set can be enumerated using
2174 the following functions.
2175
2176         int isl_set_foreach_point(__isl_keep isl_set *set,
2177                 int (*fn)(__isl_take isl_point *pnt, void *user),
2178                 void *user);
2179         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
2180                 int (*fn)(__isl_take isl_point *pnt, void *user),
2181                 void *user);
2182
2183 The function C<fn> is called for each integer point in
2184 C<set> with as second argument the last argument of
2185 the C<isl_set_foreach_point> call.  The function C<fn>
2186 should return C<0> on success and C<-1> on failure.
2187 In the latter case, C<isl_set_foreach_point> will stop
2188 enumerating and return C<-1> as well.
2189 If the enumeration is performed successfully and to completion,
2190 then C<isl_set_foreach_point> returns C<0>.
2191
2192 To obtain a single point of a (basic) set, use
2193
2194         __isl_give isl_point *isl_basic_set_sample_point(
2195                 __isl_take isl_basic_set *bset);
2196         __isl_give isl_point *isl_set_sample_point(
2197                 __isl_take isl_set *set);
2198
2199 If C<set> does not contain any (integer) points, then the
2200 resulting point will be ``void'', a property that can be
2201 tested using
2202
2203         int isl_point_is_void(__isl_keep isl_point *pnt);
2204
2205 =head2 Piecewise Quasipolynomials
2206
2207 A piecewise quasipolynomial is a particular kind of function that maps
2208 a parametric point to a rational value.
2209 More specifically, a quasipolynomial is a polynomial expression in greatest
2210 integer parts of affine expressions of parameters and variables.
2211 A piecewise quasipolynomial is a subdivision of a given parametric
2212 domain into disjoint cells with a quasipolynomial associated to
2213 each cell.  The value of the piecewise quasipolynomial at a given
2214 point is the value of the quasipolynomial associated to the cell
2215 that contains the point.  Outside of the union of cells,
2216 the value is assumed to be zero.
2217 For example, the piecewise quasipolynomial
2218
2219         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
2220
2221 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
2222 A given piecewise quasipolynomial has a fixed domain dimension.
2223 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
2224 defined over different domains.
2225 Piecewise quasipolynomials are mainly used by the C<barvinok>
2226 library for representing the number of elements in a parametric set or map.
2227 For example, the piecewise quasipolynomial above represents
2228 the number of points in the map
2229
2230         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
2231
2232 =head3 Printing (Piecewise) Quasipolynomials
2233
2234 Quasipolynomials and piecewise quasipolynomials can be printed
2235 using the following functions.
2236
2237         __isl_give isl_printer *isl_printer_print_qpolynomial(
2238                 __isl_take isl_printer *p,
2239                 __isl_keep isl_qpolynomial *qp);
2240
2241         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
2242                 __isl_take isl_printer *p,
2243                 __isl_keep isl_pw_qpolynomial *pwqp);
2244
2245         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
2246                 __isl_take isl_printer *p,
2247                 __isl_keep isl_union_pw_qpolynomial *upwqp);
2248
2249 The output format of the printer
2250 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
2251 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
2252 is supported.
2253 In case of printing in C<ISL_FORMAT_C>, the user may want
2254 to set the names of all dimensions
2255
2256         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
2257                 __isl_take isl_qpolynomial *qp,
2258                 enum isl_dim_type type, unsigned pos,
2259                 const char *s);
2260         __isl_give isl_pw_qpolynomial *
2261         isl_pw_qpolynomial_set_dim_name(
2262                 __isl_take isl_pw_qpolynomial *pwqp,
2263                 enum isl_dim_type type, unsigned pos,
2264                 const char *s);
2265
2266 =head3 Creating New (Piecewise) Quasipolynomials
2267
2268 Some simple quasipolynomials can be created using the following functions.
2269 More complicated quasipolynomials can be created by applying
2270 operations such as addition and multiplication
2271 on the resulting quasipolynomials
2272
2273         __isl_give isl_qpolynomial *isl_qpolynomial_zero(
2274                 __isl_take isl_dim *dim);
2275         __isl_give isl_qpolynomial *isl_qpolynomial_one(
2276                 __isl_take isl_dim *dim);
2277         __isl_give isl_qpolynomial *isl_qpolynomial_infty(
2278                 __isl_take isl_dim *dim);
2279         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty(
2280                 __isl_take isl_dim *dim);
2281         __isl_give isl_qpolynomial *isl_qpolynomial_nan(
2282                 __isl_take isl_dim *dim);
2283         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst(
2284                 __isl_take isl_dim *dim,
2285                 const isl_int n, const isl_int d);
2286         __isl_give isl_qpolynomial *isl_qpolynomial_div(
2287                 __isl_take isl_div *div);
2288         __isl_give isl_qpolynomial *isl_qpolynomial_var(
2289                 __isl_take isl_dim *dim,
2290                 enum isl_dim_type type, unsigned pos);
2291         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
2292                 __isl_take isl_aff *aff);
2293
2294 The zero piecewise quasipolynomial or a piecewise quasipolynomial
2295 with a single cell can be created using the following functions.
2296 Multiple of these single cell piecewise quasipolynomials can
2297 be combined to create more complicated piecewise quasipolynomials.
2298
2299         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
2300                 __isl_take isl_dim *dim);
2301         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
2302                 __isl_take isl_set *set,
2303                 __isl_take isl_qpolynomial *qp);
2304
2305         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
2306                 __isl_take isl_dim *dim);
2307         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
2308                 __isl_take isl_pw_qpolynomial *pwqp);
2309         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
2310                 __isl_take isl_union_pw_qpolynomial *upwqp,
2311                 __isl_take isl_pw_qpolynomial *pwqp);
2312
2313 Quasipolynomials can be copied and freed again using the following
2314 functions.
2315
2316         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
2317                 __isl_keep isl_qpolynomial *qp);
2318         void isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
2319
2320         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
2321                 __isl_keep isl_pw_qpolynomial *pwqp);
2322         void isl_pw_qpolynomial_free(
2323                 __isl_take isl_pw_qpolynomial *pwqp);
2324
2325         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
2326                 __isl_keep isl_union_pw_qpolynomial *upwqp);
2327         void isl_union_pw_qpolynomial_free(
2328                 __isl_take isl_union_pw_qpolynomial *upwqp);
2329
2330 =head3 Inspecting (Piecewise) Quasipolynomials
2331
2332 To iterate over all piecewise quasipolynomials in a union
2333 piecewise quasipolynomial, use the following function
2334
2335         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
2336                 __isl_keep isl_union_pw_qpolynomial *upwqp,
2337                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
2338                 void *user);
2339
2340 To extract the piecewise quasipolynomial from a union with a given dimension
2341 specification, use
2342
2343         __isl_give isl_pw_qpolynomial *
2344         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
2345                 __isl_keep isl_union_pw_qpolynomial *upwqp,
2346                 __isl_take isl_dim *dim);
2347
2348 To iterate over the cells in a piecewise quasipolynomial,
2349 use either of the following two functions
2350
2351         int isl_pw_qpolynomial_foreach_piece(
2352                 __isl_keep isl_pw_qpolynomial *pwqp,
2353                 int (*fn)(__isl_take isl_set *set,
2354                           __isl_take isl_qpolynomial *qp,
2355                           void *user), void *user);
2356         int isl_pw_qpolynomial_foreach_lifted_piece(
2357                 __isl_keep isl_pw_qpolynomial *pwqp,
2358                 int (*fn)(__isl_take isl_set *set,
2359                           __isl_take isl_qpolynomial *qp,
2360                           void *user), void *user);
2361
2362 As usual, the function C<fn> should return C<0> on success
2363 and C<-1> on failure.  The difference between
2364 C<isl_pw_qpolynomial_foreach_piece> and
2365 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
2366 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
2367 compute unique representations for all existentially quantified
2368 variables and then turn these existentially quantified variables
2369 into extra set variables, adapting the associated quasipolynomial
2370 accordingly.  This means that the C<set> passed to C<fn>
2371 will not have any existentially quantified variables, but that
2372 the dimensions of the sets may be different for different
2373 invocations of C<fn>.
2374
2375 To iterate over all terms in a quasipolynomial,
2376 use
2377
2378         int isl_qpolynomial_foreach_term(
2379                 __isl_keep isl_qpolynomial *qp,
2380                 int (*fn)(__isl_take isl_term *term,
2381                           void *user), void *user);
2382
2383 The terms themselves can be inspected and freed using
2384 these functions
2385
2386         unsigned isl_term_dim(__isl_keep isl_term *term,
2387                 enum isl_dim_type type);
2388         void isl_term_get_num(__isl_keep isl_term *term,
2389                 isl_int *n);
2390         void isl_term_get_den(__isl_keep isl_term *term,
2391                 isl_int *d);
2392         int isl_term_get_exp(__isl_keep isl_term *term,
2393                 enum isl_dim_type type, unsigned pos);
2394         __isl_give isl_div *isl_term_get_div(
2395                 __isl_keep isl_term *term, unsigned pos);
2396         void isl_term_free(__isl_take isl_term *term);
2397
2398 Each term is a product of parameters, set variables and
2399 integer divisions.  The function C<isl_term_get_exp>
2400 returns the exponent of a given dimensions in the given term.
2401 The C<isl_int>s in the arguments of C<isl_term_get_num>
2402 and C<isl_term_get_den> need to have been initialized
2403 using C<isl_int_init> before calling these functions.
2404
2405 =head3 Properties of (Piecewise) Quasipolynomials
2406
2407 To check whether a quasipolynomial is actually a constant,
2408 use the following function.
2409
2410         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
2411                 isl_int *n, isl_int *d);
2412
2413 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
2414 then the numerator and denominator of the constant
2415 are returned in C<*n> and C<*d>, respectively.
2416
2417 =head3 Operations on (Piecewise) Quasipolynomials
2418
2419         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
2420                 __isl_take isl_qpolynomial *qp);
2421         __isl_give isl_qpolynomial *isl_qpolynomial_add(
2422                 __isl_take isl_qpolynomial *qp1,
2423                 __isl_take isl_qpolynomial *qp2);
2424         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
2425                 __isl_take isl_qpolynomial *qp1,
2426                 __isl_take isl_qpolynomial *qp2);
2427         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
2428                 __isl_take isl_qpolynomial *qp1,
2429                 __isl_take isl_qpolynomial *qp2);
2430         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
2431                 __isl_take isl_qpolynomial *qp, unsigned exponent);
2432
2433         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
2434                 __isl_take isl_pw_qpolynomial *pwqp1,
2435                 __isl_take isl_pw_qpolynomial *pwqp2);
2436         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
2437                 __isl_take isl_pw_qpolynomial *pwqp1,
2438                 __isl_take isl_pw_qpolynomial *pwqp2);
2439         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
2440                 __isl_take isl_pw_qpolynomial *pwqp1,
2441                 __isl_take isl_pw_qpolynomial *pwqp2);
2442         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
2443                 __isl_take isl_pw_qpolynomial *pwqp);
2444         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
2445                 __isl_take isl_pw_qpolynomial *pwqp1,
2446                 __isl_take isl_pw_qpolynomial *pwqp2);
2447
2448         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
2449                 __isl_take isl_union_pw_qpolynomial *upwqp1,
2450                 __isl_take isl_union_pw_qpolynomial *upwqp2);
2451         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
2452                 __isl_take isl_union_pw_qpolynomial *upwqp1,
2453                 __isl_take isl_union_pw_qpolynomial *upwqp2);
2454         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
2455                 __isl_take isl_union_pw_qpolynomial *upwqp1,
2456                 __isl_take isl_union_pw_qpolynomial *upwqp2);
2457
2458         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
2459                 __isl_take isl_pw_qpolynomial *pwqp,
2460                 __isl_take isl_point *pnt);
2461
2462         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
2463                 __isl_take isl_union_pw_qpolynomial *upwqp,
2464                 __isl_take isl_point *pnt);
2465
2466         __isl_give isl_set *isl_pw_qpolynomial_domain(
2467                 __isl_take isl_pw_qpolynomial *pwqp);
2468         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
2469                 __isl_take isl_pw_qpolynomial *pwpq,
2470                 __isl_take isl_set *set);
2471
2472         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
2473                 __isl_take isl_union_pw_qpolynomial *upwqp);
2474         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
2475                 __isl_take isl_union_pw_qpolynomial *upwpq,
2476                 __isl_take isl_union_set *uset);
2477
2478         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
2479                 __isl_take isl_qpolynomial *qp,
2480                 __isl_take isl_dim *model);
2481
2482         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
2483                 __isl_take isl_union_pw_qpolynomial *upwqp);
2484
2485         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
2486                 __isl_take isl_qpolynomial *qp,
2487                 __isl_take isl_set *context);
2488
2489         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
2490                 __isl_take isl_pw_qpolynomial *pwqp,
2491                 __isl_take isl_set *context);
2492
2493         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
2494                 __isl_take isl_union_pw_qpolynomial *upwqp,
2495                 __isl_take isl_union_set *context);
2496
2497 The gist operation applies the gist operation to each of
2498 the cells in the domain of the input piecewise quasipolynomial.
2499 The context is also exploited
2500 to simplify the quasipolynomials associated to each cell.
2501
2502         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
2503                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
2504         __isl_give isl_union_pw_qpolynomial *
2505         isl_union_pw_qpolynomial_to_polynomial(
2506                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
2507
2508 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
2509 the polynomial will be an overapproximation.  If C<sign> is negative,
2510 it will be an underapproximation.  If C<sign> is zero, the approximation
2511 will lie somewhere in between.
2512
2513 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
2514
2515 A piecewise quasipolynomial reduction is a piecewise
2516 reduction (or fold) of quasipolynomials.
2517 In particular, the reduction can be maximum or a minimum.
2518 The objects are mainly used to represent the result of
2519 an upper or lower bound on a quasipolynomial over its domain,
2520 i.e., as the result of the following function.
2521
2522         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
2523                 __isl_take isl_pw_qpolynomial *pwqp,
2524                 enum isl_fold type, int *tight);
2525
2526         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
2527                 __isl_take isl_union_pw_qpolynomial *upwqp,
2528                 enum isl_fold type, int *tight);
2529
2530 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
2531 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
2532 is the returned bound is known be tight, i.e., for each value
2533 of the parameters there is at least
2534 one element in the domain that reaches the bound.
2535 If the domain of C<pwqp> is not wrapping, then the bound is computed
2536 over all elements in that domain and the result has a purely parametric
2537 domain.  If the domain of C<pwqp> is wrapping, then the bound is
2538 computed over the range of the wrapped relation.  The domain of the
2539 wrapped relation becomes the domain of the result.
2540
2541 A (piecewise) quasipolynomial reduction can be copied or freed using the
2542 following functions.
2543
2544         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
2545                 __isl_keep isl_qpolynomial_fold *fold);
2546         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
2547                 __isl_keep isl_pw_qpolynomial_fold *pwf);
2548         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
2549                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
2550         void isl_qpolynomial_fold_free(
2551                 __isl_take isl_qpolynomial_fold *fold);
2552         void isl_pw_qpolynomial_fold_free(
2553                 __isl_take isl_pw_qpolynomial_fold *pwf);
2554         void isl_union_pw_qpolynomial_fold_free(
2555                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
2556
2557 =head3 Printing Piecewise Quasipolynomial Reductions
2558
2559 Piecewise quasipolynomial reductions can be printed
2560 using the following function.
2561
2562         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
2563                 __isl_take isl_printer *p,
2564                 __isl_keep isl_pw_qpolynomial_fold *pwf);
2565         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
2566                 __isl_take isl_printer *p,
2567                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
2568
2569 For C<isl_printer_print_pw_qpolynomial_fold>,
2570 output format of the printer
2571 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
2572 For C<isl_printer_print_union_pw_qpolynomial_fold>,
2573 output format of the printer
2574 needs to be set to C<ISL_FORMAT_ISL>.
2575 In case of printing in C<ISL_FORMAT_C>, the user may want
2576 to set the names of all dimensions
2577
2578         __isl_give isl_pw_qpolynomial_fold *
2579         isl_pw_qpolynomial_fold_set_dim_name(
2580                 __isl_take isl_pw_qpolynomial_fold *pwf,
2581                 enum isl_dim_type type, unsigned pos,
2582                 const char *s);
2583
2584 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
2585
2586 To iterate over all piecewise quasipolynomial reductions in a union
2587 piecewise quasipolynomial reduction, use the following function
2588
2589         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
2590                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
2591                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
2592                             void *user), void *user);
2593
2594 To iterate over the cells in a piecewise quasipolynomial reduction,
2595 use either of the following two functions
2596
2597         int isl_pw_qpolynomial_fold_foreach_piece(
2598                 __isl_keep isl_pw_qpolynomial_fold *pwf,
2599                 int (*fn)(__isl_take isl_set *set,
2600                           __isl_take isl_qpolynomial_fold *fold,
2601                           void *user), void *user);
2602         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
2603                 __isl_keep isl_pw_qpolynomial_fold *pwf,
2604                 int (*fn)(__isl_take isl_set *set,
2605                           __isl_take isl_qpolynomial_fold *fold,
2606                           void *user), void *user);
2607
2608 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
2609 of the difference between these two functions.
2610
2611 To iterate over all quasipolynomials in a reduction, use
2612
2613         int isl_qpolynomial_fold_foreach_qpolynomial(
2614                 __isl_keep isl_qpolynomial_fold *fold,
2615                 int (*fn)(__isl_take isl_qpolynomial *qp,
2616                           void *user), void *user);
2617
2618 =head3 Operations on Piecewise Quasipolynomial Reductions
2619
2620         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
2621                 __isl_take isl_pw_qpolynomial_fold *pwf1,
2622                 __isl_take isl_pw_qpolynomial_fold *pwf2);
2623
2624         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
2625                 __isl_take isl_pw_qpolynomial_fold *pwf1,
2626                 __isl_take isl_pw_qpolynomial_fold *pwf2);
2627
2628         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
2629                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
2630                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
2631
2632         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
2633                 __isl_take isl_pw_qpolynomial_fold *pwf,
2634                 __isl_take isl_point *pnt);
2635
2636         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
2637                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
2638                 __isl_take isl_point *pnt);
2639
2640         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
2641                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
2642         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
2643                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
2644                 __isl_take isl_union_set *uset);
2645
2646         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
2647                 __isl_take isl_pw_qpolynomial_fold *pwf);
2648
2649         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
2650                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
2651
2652         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
2653                 __isl_take isl_pw_qpolynomial_fold *pwf,
2654                 __isl_take isl_set *context);
2655
2656         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
2657                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
2658                 __isl_take isl_union_set *context);
2659
2660 The gist operation applies the gist operation to each of
2661 the cells in the domain of the input piecewise quasipolynomial reduction.
2662 In future, the operation will also exploit the context
2663 to simplify the quasipolynomial reductions associated to each cell.
2664
2665         __isl_give isl_pw_qpolynomial_fold *
2666         isl_set_apply_pw_qpolynomial_fold(
2667                 __isl_take isl_set *set,
2668                 __isl_take isl_pw_qpolynomial_fold *pwf,
2669                 int *tight);
2670         __isl_give isl_pw_qpolynomial_fold *
2671         isl_map_apply_pw_qpolynomial_fold(
2672                 __isl_take isl_map *map,
2673                 __isl_take isl_pw_qpolynomial_fold *pwf,
2674                 int *tight);
2675         __isl_give isl_union_pw_qpolynomial_fold *
2676         isl_union_set_apply_union_pw_qpolynomial_fold(
2677                 __isl_take isl_union_set *uset,
2678                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
2679                 int *tight);
2680         __isl_give isl_union_pw_qpolynomial_fold *
2681         isl_union_map_apply_union_pw_qpolynomial_fold(
2682                 __isl_take isl_union_map *umap,
2683                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
2684                 int *tight);
2685
2686 The functions taking a map
2687 compose the given map with the given piecewise quasipolynomial reduction.
2688 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
2689 over all elements in the intersection of the range of the map
2690 and the domain of the piecewise quasipolynomial reduction
2691 as a function of an element in the domain of the map.
2692 The functions taking a set compute a bound over all elements in the
2693 intersection of the set and the domain of the
2694 piecewise quasipolynomial reduction.
2695
2696 =head2 Dependence Analysis
2697
2698 C<isl> contains specialized functionality for performing
2699 array dataflow analysis.  That is, given a I<sink> access relation
2700 and a collection of possible I<source> access relations,
2701 C<isl> can compute relations that describe
2702 for each iteration of the sink access, which iteration
2703 of which of the source access relations was the last
2704 to access the same data element before the given iteration
2705 of the sink access.
2706 To compute standard flow dependences, the sink should be
2707 a read, while the sources should be writes.
2708 If any of the source accesses are marked as being I<may>
2709 accesses, then there will be a dependence to the last
2710 I<must> access B<and> to any I<may> access that follows
2711 this last I<must> access.
2712 In particular, if I<all> sources are I<may> accesses,
2713 then memory based dependence analysis is performed.
2714 If, on the other hand, all sources are I<must> accesses,
2715 then value based dependence analysis is performed.
2716
2717         #include <isl/flow.h>
2718
2719         typedef int (*isl_access_level_before)(void *first, void *second);
2720
2721         __isl_give isl_access_info *isl_access_info_alloc(
2722                 __isl_take isl_map *sink,
2723                 void *sink_user, isl_access_level_before fn,
2724                 int max_source);
2725         __isl_give isl_access_info *isl_access_info_add_source(
2726                 __isl_take isl_access_info *acc,
2727                 __isl_take isl_map *source, int must,
2728                 void *source_user);
2729         void isl_access_info_free(__isl_take isl_access_info *acc);
2730
2731         __isl_give isl_flow *isl_access_info_compute_flow(
2732                 __isl_take isl_access_info *acc);
2733
2734         int isl_flow_foreach(__isl_keep isl_flow *deps,
2735                 int (*fn)(__isl_take isl_map *dep, int must,
2736                           void *dep_user, void *user),
2737                 void *user);
2738         __isl_give isl_map *isl_flow_get_no_source(
2739                 __isl_keep isl_flow *deps, int must);
2740         void isl_flow_free(__isl_take isl_flow *deps);
2741
2742 The function C<isl_access_info_compute_flow> performs the actual
2743 dependence analysis.  The other functions are used to construct
2744 the input for this function or to read off the output.
2745
2746 The input is collected in an C<isl_access_info>, which can
2747 be created through a call to C<isl_access_info_alloc>.
2748 The arguments to this functions are the sink access relation
2749 C<sink>, a token C<sink_user> used to identify the sink
2750 access to the user, a callback function for specifying the
2751 relative order of source and sink accesses, and the number
2752 of source access relations that will be added.
2753 The callback function has type C<int (*)(void *first, void *second)>.
2754 The function is called with two user supplied tokens identifying
2755 either a source or the sink and it should return the shared nesting
2756 level and the relative order of the two accesses.
2757 In particular, let I<n> be the number of loops shared by
2758 the two accesses.  If C<first> precedes C<second> textually,
2759 then the function should return I<2 * n + 1>; otherwise,
2760 it should return I<2 * n>.
2761 The sources can be added to the C<isl_access_info> by performing
2762 (at most) C<max_source> calls to C<isl_access_info_add_source>.
2763 C<must> indicates whether the source is a I<must> access
2764 or a I<may> access.  Note that a multi-valued access relation
2765 should only be marked I<must> if every iteration in the domain
2766 of the relation accesses I<all> elements in its image.
2767 The C<source_user> token is again used to identify
2768 the source access.  The range of the source access relation
2769 C<source> should have the same dimension as the range
2770 of the sink access relation.
2771 The C<isl_access_info_free> function should usually not be
2772 called explicitly, because it is called implicitly by
2773 C<isl_access_info_compute_flow>.
2774
2775 The result of the dependence analysis is collected in an
2776 C<isl_flow>.  There may be elements of
2777 the sink access for which no preceding source access could be
2778 found or for which all preceding sources are I<may> accesses.
2779 The relations containing these elements can be obtained through
2780 calls to C<isl_flow_get_no_source>, the first with C<must> set
2781 and the second with C<must> unset.
2782 In the case of standard flow dependence analysis,
2783 with the sink a read and the sources I<must> writes,
2784 the first relation corresponds to the reads from uninitialized
2785 array elements and the second relation is empty.
2786 The actual flow dependences can be extracted using
2787 C<isl_flow_foreach>.  This function will call the user-specified
2788 callback function C<fn> for each B<non-empty> dependence between
2789 a source and the sink.  The callback function is called
2790 with four arguments, the actual flow dependence relation
2791 mapping source iterations to sink iterations, a boolean that
2792 indicates whether it is a I<must> or I<may> dependence, a token
2793 identifying the source and an additional C<void *> with value
2794 equal to the third argument of the C<isl_flow_foreach> call.
2795 A dependence is marked I<must> if it originates from a I<must>
2796 source and if it is not followed by any I<may> sources.
2797
2798 After finishing with an C<isl_flow>, the user should call
2799 C<isl_flow_free> to free all associated memory.
2800
2801 A higher-level interface to dependence analysis is provided
2802 by the following function.
2803
2804         #include <isl/flow.h>
2805
2806         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
2807                 __isl_take isl_union_map *must_source,
2808                 __isl_take isl_union_map *may_source,
2809                 __isl_take isl_union_map *schedule,
2810                 __isl_give isl_union_map **must_dep,
2811                 __isl_give isl_union_map **may_dep,
2812                 __isl_give isl_union_map **must_no_source,
2813                 __isl_give isl_union_map **may_no_source);
2814
2815 The arrays are identified by the tuple names of the ranges
2816 of the accesses.  The iteration domains by the tuple names
2817 of the domains of the accesses and of the schedule.
2818 The relative order of the iteration domains is given by the
2819 schedule.  The relations returned through C<must_no_source>
2820 and C<may_no_source> are subsets of C<sink>.
2821 Any of C<must_dep>, C<may_dep>, C<must_no_source>
2822 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
2823 any of the other arguments is treated as an error.
2824
2825 =head2 Scheduling
2826
2827 B<The functionality described in this section is fairly new
2828 and may be subject to change.>
2829
2830 The following function can be used to compute a schedule
2831 for a union of domains.  The generated schedule respects
2832 all C<validity> dependences.  That is, all dependence distances
2833 over these dependences in the scheduled space are lexicographically
2834 positive.  The generated schedule schedule also tries to minimize
2835 the dependence distances over C<proximity> dependences.
2836 Moreover, it tries to obtain sequences (bands) of schedule dimensions
2837 for groups of domains where the dependence distances have only
2838 non-negative values.
2839 The algorithm used to construct the schedule is similar to that
2840 of C<Pluto>.
2841
2842         #include <isl/schedule.h>
2843         __isl_give isl_schedule *isl_union_set_compute_schedule(
2844                 __isl_take isl_union_set *domain,
2845                 __isl_take isl_union_map *validity,
2846                 __isl_take isl_union_map *proximity);
2847         void *isl_schedule_free(__isl_take isl_schedule *sched);
2848
2849 A mapping from the domains to the scheduled space can be obtained
2850 from an C<isl_schedule> using the following function.
2851
2852         __isl_give isl_union_map *isl_schedule_get_map(
2853                 __isl_keep isl_schedule *sched);
2854
2855 This mapping can also be obtained in pieces using the following functions.
2856
2857         int isl_schedule_n_band(__isl_keep isl_schedule *sched);
2858         __isl_give isl_union_map *isl_schedule_get_band(
2859                 __isl_keep isl_schedule *sched, unsigned band);
2860
2861 C<isl_schedule_n_band> returns the maximal number of bands.
2862 C<isl_schedule_get_band> returns a union of mappings from a domain to
2863 the band of consecutive schedule dimensions with the given sequence
2864 number for that domain.  Bands with the same sequence number but for
2865 different domains may be completely unrelated.
2866 Within a band, the corresponding coordinates of the distance vectors
2867 are all non-negative, assuming that the coordinates for all previous
2868 bands are all zero.
2869
2870 =head2 Parametric Vertex Enumeration
2871
2872 The parametric vertex enumeration described in this section
2873 is mainly intended to be used internally and by the C<barvinok>
2874 library.
2875
2876         #include <isl/vertices.h>
2877         __isl_give isl_vertices *isl_basic_set_compute_vertices(
2878                 __isl_keep isl_basic_set *bset);
2879
2880 The function C<isl_basic_set_compute_vertices> performs the
2881 actual computation of the parametric vertices and the chamber
2882 decomposition and store the result in an C<isl_vertices> object.
2883 This information can be queried by either iterating over all
2884 the vertices or iterating over all the chambers or cells
2885 and then iterating over all vertices that are active on the chamber.
2886
2887         int isl_vertices_foreach_vertex(
2888                 __isl_keep isl_vertices *vertices,
2889                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
2890                 void *user);
2891
2892         int isl_vertices_foreach_cell(
2893                 __isl_keep isl_vertices *vertices,
2894                 int (*fn)(__isl_take isl_cell *cell, void *user),
2895                 void *user);
2896         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
2897                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
2898                 void *user);
2899
2900 Other operations that can be performed on an C<isl_vertices> object are
2901 the following.
2902
2903         isl_ctx *isl_vertices_get_ctx(
2904                 __isl_keep isl_vertices *vertices);
2905         int isl_vertices_get_n_vertices(
2906                 __isl_keep isl_vertices *vertices);
2907         void isl_vertices_free(__isl_take isl_vertices *vertices);
2908
2909 Vertices can be inspected and destroyed using the following functions.
2910
2911         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
2912         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
2913         __isl_give isl_basic_set *isl_vertex_get_domain(
2914                 __isl_keep isl_vertex *vertex);
2915         __isl_give isl_basic_set *isl_vertex_get_expr(
2916                 __isl_keep isl_vertex *vertex);
2917         void isl_vertex_free(__isl_take isl_vertex *vertex);
2918
2919 C<isl_vertex_get_expr> returns a singleton parametric set describing
2920 the vertex, while C<isl_vertex_get_domain> returns the activity domain
2921 of the vertex.
2922 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
2923 B<rational> basic sets, so they should mainly be used for inspection
2924 and should not be mixed with integer sets.
2925
2926 Chambers can be inspected and destroyed using the following functions.
2927
2928         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
2929         __isl_give isl_basic_set *isl_cell_get_domain(
2930                 __isl_keep isl_cell *cell);
2931         void isl_cell_free(__isl_take isl_cell *cell);
2932
2933 =head1 Applications
2934
2935 Although C<isl> is mainly meant to be used as a library,
2936 it also contains some basic applications that use some
2937 of the functionality of C<isl>.
2938 The input may be specified in either the L<isl format>
2939 or the L<PolyLib format>.
2940
2941 =head2 C<isl_polyhedron_sample>
2942
2943 C<isl_polyhedron_sample> takes a polyhedron as input and prints
2944 an integer element of the polyhedron, if there is any.
2945 The first column in the output is the denominator and is always
2946 equal to 1.  If the polyhedron contains no integer points,
2947 then a vector of length zero is printed.
2948
2949 =head2 C<isl_pip>
2950
2951 C<isl_pip> takes the same input as the C<example> program
2952 from the C<piplib> distribution, i.e., a set of constraints
2953 on the parameters, a line containing only -1 and finally a set
2954 of constraints on a parametric polyhedron.
2955 The coefficients of the parameters appear in the last columns
2956 (but before the final constant column).
2957 The output is the lexicographic minimum of the parametric polyhedron.
2958 As C<isl> currently does not have its own output format, the output
2959 is just a dump of the internal state.
2960
2961 =head2 C<isl_polyhedron_minimize>
2962
2963 C<isl_polyhedron_minimize> computes the minimum of some linear
2964 or affine objective function over the integer points in a polyhedron.
2965 If an affine objective function
2966 is given, then the constant should appear in the last column.
2967
2968 =head2 C<isl_polytope_scan>
2969
2970 Given a polytope, C<isl_polytope_scan> prints
2971 all integer points in the polytope.