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