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