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