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