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