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