add isl_basic_set_is_subset
[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_basic_set_is_subset(
1719                 __isl_keep isl_basic_set *bset1,
1720                 __isl_keep isl_basic_set *bset2);
1721         int isl_set_is_subset(__isl_keep isl_set *set1,
1722                 __isl_keep isl_set *set2);
1723         int isl_set_is_strict_subset(
1724                 __isl_keep isl_set *set1,
1725                 __isl_keep isl_set *set2);
1726         int isl_union_set_is_subset(
1727                 __isl_keep isl_union_set *uset1,
1728                 __isl_keep isl_union_set *uset2);
1729         int isl_union_set_is_strict_subset(
1730                 __isl_keep isl_union_set *uset1,
1731                 __isl_keep isl_union_set *uset2);
1732         int isl_basic_map_is_subset(
1733                 __isl_keep isl_basic_map *bmap1,
1734                 __isl_keep isl_basic_map *bmap2);
1735         int isl_basic_map_is_strict_subset(
1736                 __isl_keep isl_basic_map *bmap1,
1737                 __isl_keep isl_basic_map *bmap2);
1738         int isl_map_is_subset(
1739                 __isl_keep isl_map *map1,
1740                 __isl_keep isl_map *map2);
1741         int isl_map_is_strict_subset(
1742                 __isl_keep isl_map *map1,
1743                 __isl_keep isl_map *map2);
1744         int isl_union_map_is_subset(
1745                 __isl_keep isl_union_map *umap1,
1746                 __isl_keep isl_union_map *umap2);
1747         int isl_union_map_is_strict_subset(
1748                 __isl_keep isl_union_map *umap1,
1749                 __isl_keep isl_union_map *umap2);
1750
1751 =back
1752
1753 =head2 Unary Operations
1754
1755 =over
1756
1757 =item * Complement
1758
1759         __isl_give isl_set *isl_set_complement(
1760                 __isl_take isl_set *set);
1761         __isl_give isl_map *isl_map_complement(
1762                 __isl_take isl_map *map);
1763
1764 =item * Inverse map
1765
1766         __isl_give isl_basic_map *isl_basic_map_reverse(
1767                 __isl_take isl_basic_map *bmap);
1768         __isl_give isl_map *isl_map_reverse(
1769                 __isl_take isl_map *map);
1770         __isl_give isl_union_map *isl_union_map_reverse(
1771                 __isl_take isl_union_map *umap);
1772
1773 =item * Projection
1774
1775         __isl_give isl_basic_set *isl_basic_set_project_out(
1776                 __isl_take isl_basic_set *bset,
1777                 enum isl_dim_type type, unsigned first, unsigned n);
1778         __isl_give isl_basic_map *isl_basic_map_project_out(
1779                 __isl_take isl_basic_map *bmap,
1780                 enum isl_dim_type type, unsigned first, unsigned n);
1781         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
1782                 enum isl_dim_type type, unsigned first, unsigned n);
1783         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
1784                 enum isl_dim_type type, unsigned first, unsigned n);
1785         __isl_give isl_basic_set *isl_basic_set_params(
1786                 __isl_take isl_basic_set *bset);
1787         __isl_give isl_basic_set *isl_basic_map_domain(
1788                 __isl_take isl_basic_map *bmap);
1789         __isl_give isl_basic_set *isl_basic_map_range(
1790                 __isl_take isl_basic_map *bmap);
1791         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
1792         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
1793         __isl_give isl_set *isl_map_domain(
1794                 __isl_take isl_map *bmap);
1795         __isl_give isl_set *isl_map_range(
1796                 __isl_take isl_map *map);
1797         __isl_give isl_set *isl_union_set_params(
1798                 __isl_take isl_union_set *uset);
1799         __isl_give isl_set *isl_union_map_params(
1800                 __isl_take isl_union_map *umap);
1801         __isl_give isl_union_set *isl_union_map_domain(
1802                 __isl_take isl_union_map *umap);
1803         __isl_give isl_union_set *isl_union_map_range(
1804                 __isl_take isl_union_map *umap);
1805
1806         __isl_give isl_basic_map *isl_basic_map_domain_map(
1807                 __isl_take isl_basic_map *bmap);
1808         __isl_give isl_basic_map *isl_basic_map_range_map(
1809                 __isl_take isl_basic_map *bmap);
1810         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
1811         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
1812         __isl_give isl_union_map *isl_union_map_domain_map(
1813                 __isl_take isl_union_map *umap);
1814         __isl_give isl_union_map *isl_union_map_range_map(
1815                 __isl_take isl_union_map *umap);
1816
1817 The functions above construct a (basic, regular or union) relation
1818 that maps (a wrapped version of) the input relation to its domain or range.
1819
1820 =item * Elimination
1821
1822         __isl_give isl_set *isl_set_eliminate(
1823                 __isl_take isl_set *set, enum isl_dim_type type,
1824                 unsigned first, unsigned n);
1825         __isl_give isl_basic_map *isl_basic_map_eliminate(
1826                 __isl_take isl_basic_map *bmap,
1827                 enum isl_dim_type type,
1828                 unsigned first, unsigned n);
1829         __isl_give isl_map *isl_map_eliminate(
1830                 __isl_take isl_map *map, enum isl_dim_type type,
1831                 unsigned first, unsigned n);
1832
1833 Eliminate the coefficients for the given dimensions from the constraints,
1834 without removing the dimensions.
1835
1836 =item * Slicing
1837
1838         __isl_give isl_basic_set *isl_basic_set_fix(
1839                 __isl_take isl_basic_set *bset,
1840                 enum isl_dim_type type, unsigned pos,
1841                 isl_int value);
1842         __isl_give isl_basic_set *isl_basic_set_fix_si(
1843                 __isl_take isl_basic_set *bset,
1844                 enum isl_dim_type type, unsigned pos, int value);
1845         __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
1846                 enum isl_dim_type type, unsigned pos,
1847                 isl_int value);
1848         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
1849                 enum isl_dim_type type, unsigned pos, int value);
1850         __isl_give isl_basic_map *isl_basic_map_fix_si(
1851                 __isl_take isl_basic_map *bmap,
1852                 enum isl_dim_type type, unsigned pos, int value);
1853         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
1854                 enum isl_dim_type type, unsigned pos, int value);
1855
1856 Intersect the set or relation with the hyperplane where the given
1857 dimension has the fixed given value.
1858
1859         __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
1860                 __isl_take isl_basic_map *bmap,
1861                 enum isl_dim_type type, unsigned pos, int value);
1862         __isl_give isl_set *isl_set_lower_bound_si(
1863                 __isl_take isl_set *set,
1864                 enum isl_dim_type type, unsigned pos, int value);
1865         __isl_give isl_map *isl_map_lower_bound_si(
1866                 __isl_take isl_map *map,
1867                 enum isl_dim_type type, unsigned pos, int value);
1868         __isl_give isl_set *isl_set_upper_bound_si(
1869                 __isl_take isl_set *set,
1870                 enum isl_dim_type type, unsigned pos, int value);
1871         __isl_give isl_map *isl_map_upper_bound_si(
1872                 __isl_take isl_map *map,
1873                 enum isl_dim_type type, unsigned pos, int value);
1874
1875 Intersect the set or relation with the half-space where the given
1876 dimension has a value bounded the fixed given value.
1877
1878         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
1879                 enum isl_dim_type type1, int pos1,
1880                 enum isl_dim_type type2, int pos2);
1881         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
1882                 enum isl_dim_type type1, int pos1,
1883                 enum isl_dim_type type2, int pos2);
1884
1885 Intersect the set or relation with the hyperplane where the given
1886 dimensions are equal to each other.
1887
1888         __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
1889                 enum isl_dim_type type1, int pos1,
1890                 enum isl_dim_type type2, int pos2);
1891
1892 Intersect the relation with the hyperplane where the given
1893 dimensions have opposite values.
1894
1895 =item * Identity
1896
1897         __isl_give isl_map *isl_set_identity(
1898                 __isl_take isl_set *set);
1899         __isl_give isl_union_map *isl_union_set_identity(
1900                 __isl_take isl_union_set *uset);
1901
1902 Construct an identity relation on the given (union) set.
1903
1904 =item * Deltas
1905
1906         __isl_give isl_basic_set *isl_basic_map_deltas(
1907                 __isl_take isl_basic_map *bmap);
1908         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
1909         __isl_give isl_union_set *isl_union_map_deltas(
1910                 __isl_take isl_union_map *umap);
1911
1912 These functions return a (basic) set containing the differences
1913 between image elements and corresponding domain elements in the input.
1914
1915         __isl_give isl_basic_map *isl_basic_map_deltas_map(
1916                 __isl_take isl_basic_map *bmap);
1917         __isl_give isl_map *isl_map_deltas_map(
1918                 __isl_take isl_map *map);
1919         __isl_give isl_union_map *isl_union_map_deltas_map(
1920                 __isl_take isl_union_map *umap);
1921
1922 The functions above construct a (basic, regular or union) relation
1923 that maps (a wrapped version of) the input relation to its delta set.
1924
1925 =item * Coalescing
1926
1927 Simplify the representation of a set or relation by trying
1928 to combine pairs of basic sets or relations into a single
1929 basic set or relation.
1930
1931         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
1932         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
1933         __isl_give isl_union_set *isl_union_set_coalesce(
1934                 __isl_take isl_union_set *uset);
1935         __isl_give isl_union_map *isl_union_map_coalesce(
1936                 __isl_take isl_union_map *umap);
1937
1938 =item * Detecting equalities
1939
1940         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
1941                 __isl_take isl_basic_set *bset);
1942         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
1943                 __isl_take isl_basic_map *bmap);
1944         __isl_give isl_set *isl_set_detect_equalities(
1945                 __isl_take isl_set *set);
1946         __isl_give isl_map *isl_map_detect_equalities(
1947                 __isl_take isl_map *map);
1948         __isl_give isl_union_set *isl_union_set_detect_equalities(
1949                 __isl_take isl_union_set *uset);
1950         __isl_give isl_union_map *isl_union_map_detect_equalities(
1951                 __isl_take isl_union_map *umap);
1952
1953 Simplify the representation of a set or relation by detecting implicit
1954 equalities.
1955
1956 =item * Removing redundant constraints
1957
1958         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
1959                 __isl_take isl_basic_set *bset);
1960         __isl_give isl_set *isl_set_remove_redundancies(
1961                 __isl_take isl_set *set);
1962         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
1963                 __isl_take isl_basic_map *bmap);
1964         __isl_give isl_map *isl_map_remove_redundancies(
1965                 __isl_take isl_map *map);
1966
1967 =item * Convex hull
1968
1969         __isl_give isl_basic_set *isl_set_convex_hull(
1970                 __isl_take isl_set *set);
1971         __isl_give isl_basic_map *isl_map_convex_hull(
1972                 __isl_take isl_map *map);
1973
1974 If the input set or relation has any existentially quantified
1975 variables, then the result of these operations is currently undefined.
1976
1977 =item * Simple hull
1978
1979         __isl_give isl_basic_set *isl_set_simple_hull(
1980                 __isl_take isl_set *set);
1981         __isl_give isl_basic_map *isl_map_simple_hull(
1982                 __isl_take isl_map *map);
1983         __isl_give isl_union_map *isl_union_map_simple_hull(
1984                 __isl_take isl_union_map *umap);
1985
1986 These functions compute a single basic set or relation
1987 that contains the whole input set or relation.
1988 In particular, the output is described by translates
1989 of the constraints describing the basic sets or relations in the input.
1990
1991 =begin latex
1992
1993 (See \autoref{s:simple hull}.)
1994
1995 =end latex
1996
1997 =item * Affine hull
1998
1999         __isl_give isl_basic_set *isl_basic_set_affine_hull(
2000                 __isl_take isl_basic_set *bset);
2001         __isl_give isl_basic_set *isl_set_affine_hull(
2002                 __isl_take isl_set *set);
2003         __isl_give isl_union_set *isl_union_set_affine_hull(
2004                 __isl_take isl_union_set *uset);
2005         __isl_give isl_basic_map *isl_basic_map_affine_hull(
2006                 __isl_take isl_basic_map *bmap);
2007         __isl_give isl_basic_map *isl_map_affine_hull(
2008                 __isl_take isl_map *map);
2009         __isl_give isl_union_map *isl_union_map_affine_hull(
2010                 __isl_take isl_union_map *umap);
2011
2012 In case of union sets and relations, the affine hull is computed
2013 per space.
2014
2015 =item * Polyhedral hull
2016
2017         __isl_give isl_basic_set *isl_set_polyhedral_hull(
2018                 __isl_take isl_set *set);
2019         __isl_give isl_basic_map *isl_map_polyhedral_hull(
2020                 __isl_take isl_map *map);
2021         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2022                 __isl_take isl_union_set *uset);
2023         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2024                 __isl_take isl_union_map *umap);
2025
2026 These functions compute a single basic set or relation
2027 not involving any existentially quantified variables
2028 that contains the whole input set or relation.
2029 In case of union sets and relations, the polyhedral hull is computed
2030 per space.
2031
2032 =item * Feasibility
2033
2034         __isl_give isl_basic_set *isl_basic_set_sample(
2035                 __isl_take isl_basic_set *bset);
2036         __isl_give isl_basic_set *isl_set_sample(
2037                 __isl_take isl_set *set);
2038         __isl_give isl_basic_map *isl_basic_map_sample(
2039                 __isl_take isl_basic_map *bmap);
2040         __isl_give isl_basic_map *isl_map_sample(
2041                 __isl_take isl_map *map);
2042
2043 If the input (basic) set or relation is non-empty, then return
2044 a singleton subset of the input.  Otherwise, return an empty set.
2045
2046 =item * Optimization
2047
2048         #include <isl/ilp.h>
2049         enum isl_lp_result isl_basic_set_max(
2050                 __isl_keep isl_basic_set *bset,
2051                 __isl_keep isl_aff *obj, isl_int *opt)
2052         enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
2053                 __isl_keep isl_aff *obj, isl_int *opt);
2054         enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
2055                 __isl_keep isl_aff *obj, isl_int *opt);
2056
2057 Compute the minimum or maximum of the integer affine expression C<obj>
2058 over the points in C<set>, returning the result in C<opt>.
2059 The return value may be one of C<isl_lp_error>,
2060 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
2061
2062 =item * Parametric optimization
2063
2064         __isl_give isl_pw_aff *isl_set_dim_min(
2065                 __isl_take isl_set *set, int pos);
2066         __isl_give isl_pw_aff *isl_set_dim_max(
2067                 __isl_take isl_set *set, int pos);
2068         __isl_give isl_pw_aff *isl_map_dim_max(
2069                 __isl_take isl_map *map, int pos);
2070
2071 Compute the minimum or maximum of the given set or output dimension
2072 as a function of the parameters (and input dimensions), but independently
2073 of the other set or output dimensions.
2074 For lexicographic optimization, see L<"Lexicographic Optimization">.
2075
2076 =item * Dual
2077
2078 The following functions compute either the set of (rational) coefficient
2079 values of valid constraints for the given set or the set of (rational)
2080 values satisfying the constraints with coefficients from the given set.
2081 Internally, these two sets of functions perform essentially the
2082 same operations, except that the set of coefficients is assumed to
2083 be a cone, while the set of values may be any polyhedron.
2084 The current implementation is based on the Farkas lemma and
2085 Fourier-Motzkin elimination, but this may change or be made optional
2086 in future.  In particular, future implementations may use different
2087 dualization algorithms or skip the elimination step.
2088
2089         __isl_give isl_basic_set *isl_basic_set_coefficients(
2090                 __isl_take isl_basic_set *bset);
2091         __isl_give isl_basic_set *isl_set_coefficients(
2092                 __isl_take isl_set *set);
2093         __isl_give isl_union_set *isl_union_set_coefficients(
2094                 __isl_take isl_union_set *bset);
2095         __isl_give isl_basic_set *isl_basic_set_solutions(
2096                 __isl_take isl_basic_set *bset);
2097         __isl_give isl_basic_set *isl_set_solutions(
2098                 __isl_take isl_set *set);
2099         __isl_give isl_union_set *isl_union_set_solutions(
2100                 __isl_take isl_union_set *bset);
2101
2102 =item * Power
2103
2104         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2105                 int *exact);
2106         __isl_give isl_union_map *isl_union_map_power(
2107                 __isl_take isl_union_map *umap, int *exact);
2108
2109 Compute a parametric representation for all positive powers I<k> of C<map>.
2110 The result maps I<k> to a nested relation corresponding to the
2111 I<k>th power of C<map>.
2112 The result may be an overapproximation.  If the result is known to be exact,
2113 then C<*exact> is set to C<1>.
2114
2115 =item * Transitive closure
2116
2117         __isl_give isl_map *isl_map_transitive_closure(
2118                 __isl_take isl_map *map, int *exact);
2119         __isl_give isl_union_map *isl_union_map_transitive_closure(
2120                 __isl_take isl_union_map *umap, int *exact);
2121
2122 Compute the transitive closure of C<map>.
2123 The result may be an overapproximation.  If the result is known to be exact,
2124 then C<*exact> is set to C<1>.
2125
2126 =item * Reaching path lengths
2127
2128         __isl_give isl_map *isl_map_reaching_path_lengths(
2129                 __isl_take isl_map *map, int *exact);
2130
2131 Compute a relation that maps each element in the range of C<map>
2132 to the lengths of all paths composed of edges in C<map> that
2133 end up in the given element.
2134 The result may be an overapproximation.  If the result is known to be exact,
2135 then C<*exact> is set to C<1>.
2136 To compute the I<maximal> path length, the resulting relation
2137 should be postprocessed by C<isl_map_lexmax>.
2138 In particular, if the input relation is a dependence relation
2139 (mapping sources to sinks), then the maximal path length corresponds
2140 to the free schedule.
2141 Note, however, that C<isl_map_lexmax> expects the maximum to be
2142 finite, so if the path lengths are unbounded (possibly due to
2143 the overapproximation), then you will get an error message.
2144
2145 =item * Wrapping
2146
2147         __isl_give isl_basic_set *isl_basic_map_wrap(
2148                 __isl_take isl_basic_map *bmap);
2149         __isl_give isl_set *isl_map_wrap(
2150                 __isl_take isl_map *map);
2151         __isl_give isl_union_set *isl_union_map_wrap(
2152                 __isl_take isl_union_map *umap);
2153         __isl_give isl_basic_map *isl_basic_set_unwrap(
2154                 __isl_take isl_basic_set *bset);
2155         __isl_give isl_map *isl_set_unwrap(
2156                 __isl_take isl_set *set);
2157         __isl_give isl_union_map *isl_union_set_unwrap(
2158                 __isl_take isl_union_set *uset);
2159
2160 =item * Flattening
2161
2162 Remove any internal structure of domain (and range) of the given
2163 set or relation.  If there is any such internal structure in the input,
2164 then the name of the space is also removed.
2165
2166         __isl_give isl_basic_set *isl_basic_set_flatten(
2167                 __isl_take isl_basic_set *bset);
2168         __isl_give isl_set *isl_set_flatten(
2169                 __isl_take isl_set *set);
2170         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2171                 __isl_take isl_basic_map *bmap);
2172         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2173                 __isl_take isl_basic_map *bmap);
2174         __isl_give isl_map *isl_map_flatten_range(
2175                 __isl_take isl_map *map);
2176         __isl_give isl_map *isl_map_flatten_domain(
2177                 __isl_take isl_map *map);
2178         __isl_give isl_basic_map *isl_basic_map_flatten(
2179                 __isl_take isl_basic_map *bmap);
2180         __isl_give isl_map *isl_map_flatten(
2181                 __isl_take isl_map *map);
2182
2183         __isl_give isl_map *isl_set_flatten_map(
2184                 __isl_take isl_set *set);
2185
2186 The function above constructs a relation
2187 that maps the input set to a flattened version of the set.
2188
2189 =item * Lifting
2190
2191 Lift the input set to a space with extra dimensions corresponding
2192 to the existentially quantified variables in the input.
2193 In particular, the result lives in a wrapped map where the domain
2194 is the original space and the range corresponds to the original
2195 existentially quantified variables.
2196
2197         __isl_give isl_basic_set *isl_basic_set_lift(
2198                 __isl_take isl_basic_set *bset);
2199         __isl_give isl_set *isl_set_lift(
2200                 __isl_take isl_set *set);
2201         __isl_give isl_union_set *isl_union_set_lift(
2202                 __isl_take isl_union_set *uset);
2203
2204 Given a local space that contains the existentially quantified
2205 variables of a set, a basic relation that, when applied to
2206 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2207 can be constructed using the following function.
2208
2209         #include <isl/local_space.h>
2210         __isl_give isl_basic_map *isl_local_space_lifting(
2211                 __isl_take isl_local_space *ls);
2212
2213 =item * Internal Product
2214
2215         __isl_give isl_basic_map *isl_basic_map_zip(
2216                 __isl_take isl_basic_map *bmap);
2217         __isl_give isl_map *isl_map_zip(
2218                 __isl_take isl_map *map);
2219         __isl_give isl_union_map *isl_union_map_zip(
2220                 __isl_take isl_union_map *umap);
2221
2222 Given a relation with nested relations for domain and range,
2223 interchange the range of the domain with the domain of the range.
2224
2225 =item * Aligning parameters
2226
2227         __isl_give isl_set *isl_set_align_params(
2228                 __isl_take isl_set *set,
2229                 __isl_take isl_space *model);
2230         __isl_give isl_map *isl_map_align_params(
2231                 __isl_take isl_map *map,
2232                 __isl_take isl_space *model);
2233
2234 Change the order of the parameters of the given set or relation
2235 such that the first parameters match those of C<model>.
2236 This may involve the introduction of extra parameters.
2237 All parameters need to be named.
2238
2239 =item * Dimension manipulation
2240
2241         __isl_give isl_set *isl_set_add_dims(
2242                 __isl_take isl_set *set,
2243                 enum isl_dim_type type, unsigned n);
2244         __isl_give isl_map *isl_map_add_dims(
2245                 __isl_take isl_map *map,
2246                 enum isl_dim_type type, unsigned n);
2247         __isl_give isl_set *isl_set_insert_dims(
2248                 __isl_take isl_set *set,
2249                 enum isl_dim_type type, unsigned pos, unsigned n);
2250         __isl_give isl_map *isl_map_insert_dims(
2251                 __isl_take isl_map *map,
2252                 enum isl_dim_type type, unsigned pos, unsigned n);
2253         __isl_give isl_basic_set *isl_basic_set_move_dims(
2254                 __isl_take isl_basic_set *bset,
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_basic_map *isl_basic_map_move_dims(
2259                 __isl_take isl_basic_map *bmap,
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_set *isl_set_move_dims(
2264                 __isl_take isl_set *set,
2265                 enum isl_dim_type dst_type, unsigned dst_pos,
2266                 enum isl_dim_type src_type, unsigned src_pos,
2267                 unsigned n);
2268         __isl_give isl_map *isl_map_move_dims(
2269                 __isl_take isl_map *map,
2270                 enum isl_dim_type dst_type, unsigned dst_pos,
2271                 enum isl_dim_type src_type, unsigned src_pos,
2272                 unsigned n);
2273
2274 It is usually not advisable to directly change the (input or output)
2275 space of a set or a relation as this removes the name and the internal
2276 structure of the space.  However, the above functions can be useful
2277 to add new parameters, assuming
2278 C<isl_set_align_params> and C<isl_map_align_params>
2279 are not sufficient.
2280
2281 =back
2282
2283 =head2 Binary Operations
2284
2285 The two arguments of a binary operation not only need to live
2286 in the same C<isl_ctx>, they currently also need to have
2287 the same (number of) parameters.
2288
2289 =head3 Basic Operations
2290
2291 =over
2292
2293 =item * Intersection
2294
2295         __isl_give isl_basic_set *isl_basic_set_intersect_params(
2296                 __isl_take isl_basic_set *bset1,
2297                 __isl_take isl_basic_set *bset2);
2298         __isl_give isl_basic_set *isl_basic_set_intersect(
2299                 __isl_take isl_basic_set *bset1,
2300                 __isl_take isl_basic_set *bset2);
2301         __isl_give isl_set *isl_set_intersect_params(
2302                 __isl_take isl_set *set,
2303                 __isl_take isl_set *params);
2304         __isl_give isl_set *isl_set_intersect(
2305                 __isl_take isl_set *set1,
2306                 __isl_take isl_set *set2);
2307         __isl_give isl_union_set *isl_union_set_intersect_params(
2308                 __isl_take isl_union_set *uset,
2309                 __isl_take isl_set *set);
2310         __isl_give isl_union_map *isl_union_map_intersect_params(
2311                 __isl_take isl_union_map *umap,
2312                 __isl_take isl_set *set);
2313         __isl_give isl_union_set *isl_union_set_intersect(
2314                 __isl_take isl_union_set *uset1,
2315                 __isl_take isl_union_set *uset2);
2316         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2317                 __isl_take isl_basic_map *bmap,
2318                 __isl_take isl_basic_set *bset);
2319         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2320                 __isl_take isl_basic_map *bmap,
2321                 __isl_take isl_basic_set *bset);
2322         __isl_give isl_basic_map *isl_basic_map_intersect(
2323                 __isl_take isl_basic_map *bmap1,
2324                 __isl_take isl_basic_map *bmap2);
2325         __isl_give isl_map *isl_map_intersect_params(
2326                 __isl_take isl_map *map,
2327                 __isl_take isl_set *params);
2328         __isl_give isl_map *isl_map_intersect_domain(
2329                 __isl_take isl_map *map,
2330                 __isl_take isl_set *set);
2331         __isl_give isl_map *isl_map_intersect_range(
2332                 __isl_take isl_map *map,
2333                 __isl_take isl_set *set);
2334         __isl_give isl_map *isl_map_intersect(
2335                 __isl_take isl_map *map1,
2336                 __isl_take isl_map *map2);
2337         __isl_give isl_union_map *isl_union_map_intersect_domain(
2338                 __isl_take isl_union_map *umap,
2339                 __isl_take isl_union_set *uset);
2340         __isl_give isl_union_map *isl_union_map_intersect_range(
2341                 __isl_take isl_union_map *umap,
2342                 __isl_take isl_union_set *uset);
2343         __isl_give isl_union_map *isl_union_map_intersect(
2344                 __isl_take isl_union_map *umap1,
2345                 __isl_take isl_union_map *umap2);
2346
2347 =item * Union
2348
2349         __isl_give isl_set *isl_basic_set_union(
2350                 __isl_take isl_basic_set *bset1,
2351                 __isl_take isl_basic_set *bset2);
2352         __isl_give isl_map *isl_basic_map_union(
2353                 __isl_take isl_basic_map *bmap1,
2354                 __isl_take isl_basic_map *bmap2);
2355         __isl_give isl_set *isl_set_union(
2356                 __isl_take isl_set *set1,
2357                 __isl_take isl_set *set2);
2358         __isl_give isl_map *isl_map_union(
2359                 __isl_take isl_map *map1,
2360                 __isl_take isl_map *map2);
2361         __isl_give isl_union_set *isl_union_set_union(
2362                 __isl_take isl_union_set *uset1,
2363                 __isl_take isl_union_set *uset2);
2364         __isl_give isl_union_map *isl_union_map_union(
2365                 __isl_take isl_union_map *umap1,
2366                 __isl_take isl_union_map *umap2);
2367
2368 =item * Set difference
2369
2370         __isl_give isl_set *isl_set_subtract(
2371                 __isl_take isl_set *set1,
2372                 __isl_take isl_set *set2);
2373         __isl_give isl_map *isl_map_subtract(
2374                 __isl_take isl_map *map1,
2375                 __isl_take isl_map *map2);
2376         __isl_give isl_map *isl_map_subtract_domain(
2377                 __isl_take isl_map *map,
2378                 __isl_take isl_set *dom);
2379         __isl_give isl_map *isl_map_subtract_range(
2380                 __isl_take isl_map *map,
2381                 __isl_take isl_set *dom);
2382         __isl_give isl_union_set *isl_union_set_subtract(
2383                 __isl_take isl_union_set *uset1,
2384                 __isl_take isl_union_set *uset2);
2385         __isl_give isl_union_map *isl_union_map_subtract(
2386                 __isl_take isl_union_map *umap1,
2387                 __isl_take isl_union_map *umap2);
2388
2389 =item * Application
2390
2391         __isl_give isl_basic_set *isl_basic_set_apply(
2392                 __isl_take isl_basic_set *bset,
2393                 __isl_take isl_basic_map *bmap);
2394         __isl_give isl_set *isl_set_apply(
2395                 __isl_take isl_set *set,
2396                 __isl_take isl_map *map);
2397         __isl_give isl_union_set *isl_union_set_apply(
2398                 __isl_take isl_union_set *uset,
2399                 __isl_take isl_union_map *umap);
2400         __isl_give isl_basic_map *isl_basic_map_apply_domain(
2401                 __isl_take isl_basic_map *bmap1,
2402                 __isl_take isl_basic_map *bmap2);
2403         __isl_give isl_basic_map *isl_basic_map_apply_range(
2404                 __isl_take isl_basic_map *bmap1,
2405                 __isl_take isl_basic_map *bmap2);
2406         __isl_give isl_map *isl_map_apply_domain(
2407                 __isl_take isl_map *map1,
2408                 __isl_take isl_map *map2);
2409         __isl_give isl_union_map *isl_union_map_apply_domain(
2410                 __isl_take isl_union_map *umap1,
2411                 __isl_take isl_union_map *umap2);
2412         __isl_give isl_map *isl_map_apply_range(
2413                 __isl_take isl_map *map1,
2414                 __isl_take isl_map *map2);
2415         __isl_give isl_union_map *isl_union_map_apply_range(
2416                 __isl_take isl_union_map *umap1,
2417                 __isl_take isl_union_map *umap2);
2418
2419 =item * Cartesian Product
2420
2421         __isl_give isl_set *isl_set_product(
2422                 __isl_take isl_set *set1,
2423                 __isl_take isl_set *set2);
2424         __isl_give isl_union_set *isl_union_set_product(
2425                 __isl_take isl_union_set *uset1,
2426                 __isl_take isl_union_set *uset2);
2427         __isl_give isl_basic_map *isl_basic_map_domain_product(
2428                 __isl_take isl_basic_map *bmap1,
2429                 __isl_take isl_basic_map *bmap2);
2430         __isl_give isl_basic_map *isl_basic_map_range_product(
2431                 __isl_take isl_basic_map *bmap1,
2432                 __isl_take isl_basic_map *bmap2);
2433         __isl_give isl_map *isl_map_domain_product(
2434                 __isl_take isl_map *map1,
2435                 __isl_take isl_map *map2);
2436         __isl_give isl_map *isl_map_range_product(
2437                 __isl_take isl_map *map1,
2438                 __isl_take isl_map *map2);
2439         __isl_give isl_union_map *isl_union_map_range_product(
2440                 __isl_take isl_union_map *umap1,
2441                 __isl_take isl_union_map *umap2);
2442         __isl_give isl_map *isl_map_product(
2443                 __isl_take isl_map *map1,
2444                 __isl_take isl_map *map2);
2445         __isl_give isl_union_map *isl_union_map_product(
2446                 __isl_take isl_union_map *umap1,
2447                 __isl_take isl_union_map *umap2);
2448
2449 The above functions compute the cross product of the given
2450 sets or relations.  The domains and ranges of the results
2451 are wrapped maps between domains and ranges of the inputs.
2452 To obtain a ``flat'' product, use the following functions
2453 instead.
2454
2455         __isl_give isl_basic_set *isl_basic_set_flat_product(
2456                 __isl_take isl_basic_set *bset1,
2457                 __isl_take isl_basic_set *bset2);
2458         __isl_give isl_set *isl_set_flat_product(
2459                 __isl_take isl_set *set1,
2460                 __isl_take isl_set *set2);
2461         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
2462                 __isl_take isl_basic_map *bmap1,
2463                 __isl_take isl_basic_map *bmap2);
2464         __isl_give isl_map *isl_map_flat_domain_product(
2465                 __isl_take isl_map *map1,
2466                 __isl_take isl_map *map2);
2467         __isl_give isl_map *isl_map_flat_range_product(
2468                 __isl_take isl_map *map1,
2469                 __isl_take isl_map *map2);
2470         __isl_give isl_union_map *isl_union_map_flat_range_product(
2471                 __isl_take isl_union_map *umap1,
2472                 __isl_take isl_union_map *umap2);
2473         __isl_give isl_basic_map *isl_basic_map_flat_product(
2474                 __isl_take isl_basic_map *bmap1,
2475                 __isl_take isl_basic_map *bmap2);
2476         __isl_give isl_map *isl_map_flat_product(
2477                 __isl_take isl_map *map1,
2478                 __isl_take isl_map *map2);
2479
2480 =item * Simplification
2481
2482         __isl_give isl_basic_set *isl_basic_set_gist(
2483                 __isl_take isl_basic_set *bset,
2484                 __isl_take isl_basic_set *context);
2485         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
2486                 __isl_take isl_set *context);
2487         __isl_give isl_set *isl_set_gist_params(
2488                 __isl_take isl_set *set,
2489                 __isl_take isl_set *context);
2490         __isl_give isl_union_set *isl_union_set_gist(
2491                 __isl_take isl_union_set *uset,
2492                 __isl_take isl_union_set *context);
2493         __isl_give isl_union_set *isl_union_set_gist_params(
2494                 __isl_take isl_union_set *uset,
2495                 __isl_take isl_set *set);
2496         __isl_give isl_basic_map *isl_basic_map_gist(
2497                 __isl_take isl_basic_map *bmap,
2498                 __isl_take isl_basic_map *context);
2499         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
2500                 __isl_take isl_map *context);
2501         __isl_give isl_map *isl_map_gist_params(
2502                 __isl_take isl_map *map,
2503                 __isl_take isl_set *context);
2504         __isl_give isl_map *isl_map_gist_domain(
2505                 __isl_take isl_map *map,
2506                 __isl_take isl_set *context);
2507         __isl_give isl_map *isl_map_gist_range(
2508                 __isl_take isl_map *map,
2509                 __isl_take isl_set *context);
2510         __isl_give isl_union_map *isl_union_map_gist(
2511                 __isl_take isl_union_map *umap,
2512                 __isl_take isl_union_map *context);
2513         __isl_give isl_union_map *isl_union_map_gist_params(
2514                 __isl_take isl_union_map *umap,
2515                 __isl_take isl_set *set);
2516         __isl_give isl_union_map *isl_union_map_gist_domain(
2517                 __isl_take isl_union_map *umap,
2518                 __isl_take isl_union_set *uset);
2519         __isl_give isl_union_map *isl_union_map_gist_range(
2520                 __isl_take isl_union_map *umap,
2521                 __isl_take isl_union_set *uset);
2522
2523 The gist operation returns a set or relation that has the
2524 same intersection with the context as the input set or relation.
2525 Any implicit equality in the intersection is made explicit in the result,
2526 while all inequalities that are redundant with respect to the intersection
2527 are removed.
2528 In case of union sets and relations, the gist operation is performed
2529 per space.
2530
2531 =back
2532
2533 =head3 Lexicographic Optimization
2534
2535 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
2536 the following functions
2537 compute a set that contains the lexicographic minimum or maximum
2538 of the elements in C<set> (or C<bset>) for those values of the parameters
2539 that satisfy C<dom>.
2540 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2541 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
2542 has no elements.
2543 In other words, the union of the parameter values
2544 for which the result is non-empty and of C<*empty>
2545 is equal to C<dom>.
2546
2547         __isl_give isl_set *isl_basic_set_partial_lexmin(
2548                 __isl_take isl_basic_set *bset,
2549                 __isl_take isl_basic_set *dom,
2550                 __isl_give isl_set **empty);
2551         __isl_give isl_set *isl_basic_set_partial_lexmax(
2552                 __isl_take isl_basic_set *bset,
2553                 __isl_take isl_basic_set *dom,
2554                 __isl_give isl_set **empty);
2555         __isl_give isl_set *isl_set_partial_lexmin(
2556                 __isl_take isl_set *set, __isl_take isl_set *dom,
2557                 __isl_give isl_set **empty);
2558         __isl_give isl_set *isl_set_partial_lexmax(
2559                 __isl_take isl_set *set, __isl_take isl_set *dom,
2560                 __isl_give isl_set **empty);
2561
2562 Given a (basic) set C<set> (or C<bset>), the following functions simply
2563 return a set containing the lexicographic minimum or maximum
2564 of the elements in C<set> (or C<bset>).
2565 In case of union sets, the optimum is computed per space.
2566
2567         __isl_give isl_set *isl_basic_set_lexmin(
2568                 __isl_take isl_basic_set *bset);
2569         __isl_give isl_set *isl_basic_set_lexmax(
2570                 __isl_take isl_basic_set *bset);
2571         __isl_give isl_set *isl_set_lexmin(
2572                 __isl_take isl_set *set);
2573         __isl_give isl_set *isl_set_lexmax(
2574                 __isl_take isl_set *set);
2575         __isl_give isl_union_set *isl_union_set_lexmin(
2576                 __isl_take isl_union_set *uset);
2577         __isl_give isl_union_set *isl_union_set_lexmax(
2578                 __isl_take isl_union_set *uset);
2579
2580 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
2581 the following functions
2582 compute a relation that maps each element of C<dom>
2583 to the single lexicographic minimum or maximum
2584 of the elements that are associated to that same
2585 element in C<map> (or C<bmap>).
2586 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
2587 that contains the elements in C<dom> that do not map
2588 to any elements in C<map> (or C<bmap>).
2589 In other words, the union of the domain of the result and of C<*empty>
2590 is equal to C<dom>.
2591
2592         __isl_give isl_map *isl_basic_map_partial_lexmax(
2593                 __isl_take isl_basic_map *bmap,
2594                 __isl_take isl_basic_set *dom,
2595                 __isl_give isl_set **empty);
2596         __isl_give isl_map *isl_basic_map_partial_lexmin(
2597                 __isl_take isl_basic_map *bmap,
2598                 __isl_take isl_basic_set *dom,
2599                 __isl_give isl_set **empty);
2600         __isl_give isl_map *isl_map_partial_lexmax(
2601                 __isl_take isl_map *map, __isl_take isl_set *dom,
2602                 __isl_give isl_set **empty);
2603         __isl_give isl_map *isl_map_partial_lexmin(
2604                 __isl_take isl_map *map, __isl_take isl_set *dom,
2605                 __isl_give isl_set **empty);
2606
2607 Given a (basic) map C<map> (or C<bmap>), the following functions simply
2608 return a map mapping each element in the domain of
2609 C<map> (or C<bmap>) to the lexicographic minimum or maximum
2610 of all elements associated to that element.
2611 In case of union relations, the optimum is computed per space.
2612
2613         __isl_give isl_map *isl_basic_map_lexmin(
2614                 __isl_take isl_basic_map *bmap);
2615         __isl_give isl_map *isl_basic_map_lexmax(
2616                 __isl_take isl_basic_map *bmap);
2617         __isl_give isl_map *isl_map_lexmin(
2618                 __isl_take isl_map *map);
2619         __isl_give isl_map *isl_map_lexmax(
2620                 __isl_take isl_map *map);
2621         __isl_give isl_union_map *isl_union_map_lexmin(
2622                 __isl_take isl_union_map *umap);
2623         __isl_give isl_union_map *isl_union_map_lexmax(
2624                 __isl_take isl_union_map *umap);
2625
2626 The following functions return their result in the form of
2627 a piecewise multi-affine expression
2628 (See L<"Piecewise Multiple Quasi Affine Expressions">),
2629 but are otherwise equivalent to the corresponding functions
2630 returning a basic set or relation.
2631
2632         __isl_give isl_pw_multi_aff *
2633         isl_basic_map_lexmin_pw_multi_aff(
2634                 __isl_take isl_basic_map *bmap);
2635         __isl_give isl_pw_multi_aff *
2636         isl_basic_set_partial_lexmin_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_set_partial_lexmax_pw_multi_aff(
2642                 __isl_take isl_basic_set *bset,
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_lexmin_pw_multi_aff(
2647                 __isl_take isl_basic_map *bmap,
2648                 __isl_take isl_basic_set *dom,
2649                 __isl_give isl_set **empty);
2650         __isl_give isl_pw_multi_aff *
2651         isl_basic_map_partial_lexmax_pw_multi_aff(
2652                 __isl_take isl_basic_map *bmap,
2653                 __isl_take isl_basic_set *dom,
2654                 __isl_give isl_set **empty);
2655
2656 =head2 Lists
2657
2658 Lists are defined over several element types, including
2659 C<isl_aff>, C<isl_pw_aff>, C<isl_basic_set> and C<isl_set>.
2660 Here we take lists of C<isl_set>s as an example.
2661 Lists can be created, copied and freed using the following functions.
2662
2663         #include <isl/list.h>
2664         __isl_give isl_set_list *isl_set_list_from_set(
2665                 __isl_take isl_set *el);
2666         __isl_give isl_set_list *isl_set_list_alloc(
2667                 isl_ctx *ctx, int n);
2668         __isl_give isl_set_list *isl_set_list_copy(
2669                 __isl_keep isl_set_list *list);
2670         __isl_give isl_set_list *isl_set_list_add(
2671                 __isl_take isl_set_list *list,
2672                 __isl_take isl_set *el);
2673         __isl_give isl_set_list *isl_set_list_concat(
2674                 __isl_take isl_set_list *list1,
2675                 __isl_take isl_set_list *list2);
2676         void *isl_set_list_free(__isl_take isl_set_list *list);
2677
2678 C<isl_set_list_alloc> creates an empty list with a capacity for
2679 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
2680 element.
2681
2682 Lists can be inspected using the following functions.
2683
2684         #include <isl/list.h>
2685         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
2686         int isl_set_list_n_set(__isl_keep isl_set_list *list);
2687         __isl_give isl_set *isl_set_list_get_set(
2688                 __isl_keep isl_set_list *list, int index);
2689         int isl_set_list_foreach(__isl_keep isl_set_list *list,
2690                 int (*fn)(__isl_take isl_set *el, void *user),
2691                 void *user);
2692
2693 Lists can be printed using
2694
2695         #include <isl/list.h>
2696         __isl_give isl_printer *isl_printer_print_set_list(
2697                 __isl_take isl_printer *p,
2698                 __isl_keep isl_set_list *list);
2699
2700 =head2 Matrices
2701
2702 Matrices can be created, copied and freed using the following functions.
2703
2704         #include <isl/mat.h>
2705         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
2706                 unsigned n_row, unsigned n_col);
2707         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
2708         void isl_mat_free(__isl_take isl_mat *mat);
2709
2710 Note that the elements of a newly created matrix may have arbitrary values.
2711 The elements can be changed and inspected using the following functions.
2712
2713         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
2714         int isl_mat_rows(__isl_keep isl_mat *mat);
2715         int isl_mat_cols(__isl_keep isl_mat *mat);
2716         int isl_mat_get_element(__isl_keep isl_mat *mat,
2717                 int row, int col, isl_int *v);
2718         __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
2719                 int row, int col, isl_int v);
2720         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
2721                 int row, int col, int v);
2722
2723 C<isl_mat_get_element> will return a negative value if anything went wrong.
2724 In that case, the value of C<*v> is undefined.
2725
2726 The following function can be used to compute the (right) inverse
2727 of a matrix, i.e., a matrix such that the product of the original
2728 and the inverse (in that order) is a multiple of the identity matrix.
2729 The input matrix is assumed to be of full row-rank.
2730
2731         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
2732
2733 The following function can be used to compute the (right) kernel
2734 (or null space) of a matrix, i.e., a matrix such that the product of
2735 the original and the kernel (in that order) is the zero matrix.
2736
2737         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
2738
2739 =head2 Piecewise Quasi Affine Expressions
2740
2741 The zero quasi affine expression on a given domain can be created using
2742
2743         __isl_give isl_aff *isl_aff_zero_on_domain(
2744                 __isl_take isl_local_space *ls);
2745
2746 Note that the space in which the resulting object lives is a map space
2747 with the given space as domain and a one-dimensional range.
2748
2749 An empty piecewise quasi affine expression (one with no cells)
2750 or a piecewise quasi affine expression with a single cell can
2751 be created using the following functions.
2752
2753         #include <isl/aff.h>
2754         __isl_give isl_pw_aff *isl_pw_aff_empty(
2755                 __isl_take isl_space *space);
2756         __isl_give isl_pw_aff *isl_pw_aff_alloc(
2757                 __isl_take isl_set *set, __isl_take isl_aff *aff);
2758         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
2759                 __isl_take isl_aff *aff);
2760
2761 Quasi affine expressions can be copied and freed using
2762
2763         #include <isl/aff.h>
2764         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
2765         void *isl_aff_free(__isl_take isl_aff *aff);
2766
2767         __isl_give isl_pw_aff *isl_pw_aff_copy(
2768                 __isl_keep isl_pw_aff *pwaff);
2769         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
2770
2771 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
2772 using the following function.  The constraint is required to have
2773 a non-zero coefficient for the specified dimension.
2774
2775         #include <isl/constraint.h>
2776         __isl_give isl_aff *isl_constraint_get_bound(
2777                 __isl_keep isl_constraint *constraint,
2778                 enum isl_dim_type type, int pos);
2779
2780 The entire affine expression of the constraint can also be extracted
2781 using the following function.
2782
2783         #include <isl/constraint.h>
2784         __isl_give isl_aff *isl_constraint_get_aff(
2785                 __isl_keep isl_constraint *constraint);
2786
2787 Conversely, an equality constraint equating
2788 the affine expression to zero or an inequality constraint enforcing
2789 the affine expression to be non-negative, can be constructed using
2790
2791         __isl_give isl_constraint *isl_equality_from_aff(
2792                 __isl_take isl_aff *aff);
2793         __isl_give isl_constraint *isl_inequality_from_aff(
2794                 __isl_take isl_aff *aff);
2795
2796 The expression can be inspected using
2797
2798         #include <isl/aff.h>
2799         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
2800         int isl_aff_dim(__isl_keep isl_aff *aff,
2801                 enum isl_dim_type type);
2802         __isl_give isl_local_space *isl_aff_get_domain_local_space(
2803                 __isl_keep isl_aff *aff);
2804         __isl_give isl_local_space *isl_aff_get_local_space(
2805                 __isl_keep isl_aff *aff);
2806         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
2807                 enum isl_dim_type type, unsigned pos);
2808         const char *isl_pw_aff_get_dim_name(
2809                 __isl_keep isl_pw_aff *pa,
2810                 enum isl_dim_type type, unsigned pos);
2811         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
2812                 enum isl_dim_type type, unsigned pos);
2813         __isl_give isl_id *isl_pw_aff_get_dim_id(
2814                 __isl_keep isl_pw_aff *pa,
2815                 enum isl_dim_type type, unsigned pos);
2816         int isl_aff_get_constant(__isl_keep isl_aff *aff,
2817                 isl_int *v);
2818         int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
2819                 enum isl_dim_type type, int pos, isl_int *v);
2820         int isl_aff_get_denominator(__isl_keep isl_aff *aff,
2821                 isl_int *v);
2822         __isl_give isl_aff *isl_aff_get_div(
2823                 __isl_keep isl_aff *aff, int pos);
2824
2825         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
2826                 int (*fn)(__isl_take isl_set *set,
2827                           __isl_take isl_aff *aff,
2828                           void *user), void *user);
2829
2830         int isl_aff_is_cst(__isl_keep isl_aff *aff);
2831         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
2832
2833         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
2834                 enum isl_dim_type type, unsigned first, unsigned n);
2835         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
2836                 enum isl_dim_type type, unsigned first, unsigned n);
2837
2838         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
2839         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
2840                 enum isl_dim_type type);
2841         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
2842
2843 It can be modified using
2844
2845         #include <isl/aff.h>
2846         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
2847                 __isl_take isl_pw_aff *pwaff,
2848                 enum isl_dim_type type, __isl_take isl_id *id);
2849         __isl_give isl_aff *isl_aff_set_dim_name(
2850                 __isl_take isl_aff *aff, enum isl_dim_type type,
2851                 unsigned pos, const char *s);
2852         __isl_give isl_aff *isl_aff_set_dim_id(
2853                 __isl_take isl_aff *aff, enum isl_dim_type type,
2854                 unsigned pos, __isl_take isl_id *id);
2855         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
2856                 __isl_take isl_pw_aff *pma,
2857                 enum isl_dim_type type, unsigned pos,
2858                 __isl_take isl_id *id);
2859         __isl_give isl_aff *isl_aff_set_constant(
2860                 __isl_take isl_aff *aff, isl_int v);
2861         __isl_give isl_aff *isl_aff_set_constant_si(
2862                 __isl_take isl_aff *aff, int v);
2863         __isl_give isl_aff *isl_aff_set_coefficient(
2864                 __isl_take isl_aff *aff,
2865                 enum isl_dim_type type, int pos, isl_int v);
2866         __isl_give isl_aff *isl_aff_set_coefficient_si(
2867                 __isl_take isl_aff *aff,
2868                 enum isl_dim_type type, int pos, int v);
2869         __isl_give isl_aff *isl_aff_set_denominator(
2870                 __isl_take isl_aff *aff, isl_int v);
2871
2872         __isl_give isl_aff *isl_aff_add_constant(
2873                 __isl_take isl_aff *aff, isl_int v);
2874         __isl_give isl_aff *isl_aff_add_constant_si(
2875                 __isl_take isl_aff *aff, int v);
2876         __isl_give isl_aff *isl_aff_add_coefficient(
2877                 __isl_take isl_aff *aff,
2878                 enum isl_dim_type type, int pos, isl_int v);
2879         __isl_give isl_aff *isl_aff_add_coefficient_si(
2880                 __isl_take isl_aff *aff,
2881                 enum isl_dim_type type, int pos, int v);
2882
2883         __isl_give isl_aff *isl_aff_insert_dims(
2884                 __isl_take isl_aff *aff,
2885                 enum isl_dim_type type, unsigned first, unsigned n);
2886         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
2887                 __isl_take isl_pw_aff *pwaff,
2888                 enum isl_dim_type type, unsigned first, unsigned n);
2889         __isl_give isl_aff *isl_aff_add_dims(
2890                 __isl_take isl_aff *aff,
2891                 enum isl_dim_type type, unsigned n);
2892         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
2893                 __isl_take isl_pw_aff *pwaff,
2894                 enum isl_dim_type type, unsigned n);
2895         __isl_give isl_aff *isl_aff_drop_dims(
2896                 __isl_take isl_aff *aff,
2897                 enum isl_dim_type type, unsigned first, unsigned n);
2898         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
2899                 __isl_take isl_pw_aff *pwaff,
2900                 enum isl_dim_type type, unsigned first, unsigned n);
2901
2902 Note that the C<set_constant> and C<set_coefficient> functions
2903 set the I<numerator> of the constant or coefficient, while
2904 C<add_constant> and C<add_coefficient> add an integer value to
2905 the possibly rational constant or coefficient.
2906
2907 To check whether an affine expressions is obviously zero
2908 or obviously equal to some other affine expression, use
2909
2910         #include <isl/aff.h>
2911         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
2912         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
2913                 __isl_keep isl_aff *aff2);
2914         int isl_pw_aff_plain_is_equal(
2915                 __isl_keep isl_pw_aff *pwaff1,
2916                 __isl_keep isl_pw_aff *pwaff2);
2917
2918 Operations include
2919
2920         #include <isl/aff.h>
2921         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
2922                 __isl_take isl_aff *aff2);
2923         __isl_give isl_pw_aff *isl_pw_aff_add(
2924                 __isl_take isl_pw_aff *pwaff1,
2925                 __isl_take isl_pw_aff *pwaff2);
2926         __isl_give isl_pw_aff *isl_pw_aff_min(
2927                 __isl_take isl_pw_aff *pwaff1,
2928                 __isl_take isl_pw_aff *pwaff2);
2929         __isl_give isl_pw_aff *isl_pw_aff_max(
2930                 __isl_take isl_pw_aff *pwaff1,
2931                 __isl_take isl_pw_aff *pwaff2);
2932         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
2933                 __isl_take isl_aff *aff2);
2934         __isl_give isl_pw_aff *isl_pw_aff_sub(
2935                 __isl_take isl_pw_aff *pwaff1,
2936                 __isl_take isl_pw_aff *pwaff2);
2937         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
2938         __isl_give isl_pw_aff *isl_pw_aff_neg(
2939                 __isl_take isl_pw_aff *pwaff);
2940         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
2941         __isl_give isl_pw_aff *isl_pw_aff_ceil(
2942                 __isl_take isl_pw_aff *pwaff);
2943         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
2944         __isl_give isl_pw_aff *isl_pw_aff_floor(
2945                 __isl_take isl_pw_aff *pwaff);
2946         __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
2947                 isl_int mod);
2948         __isl_give isl_pw_aff *isl_pw_aff_mod(
2949                 __isl_take isl_pw_aff *pwaff, isl_int mod);
2950         __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
2951                 isl_int f);
2952         __isl_give isl_pw_aff *isl_pw_aff_scale(
2953                 __isl_take isl_pw_aff *pwaff, isl_int f);
2954         __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
2955                 isl_int f);
2956         __isl_give isl_aff *isl_aff_scale_down_ui(
2957                 __isl_take isl_aff *aff, unsigned f);
2958         __isl_give isl_pw_aff *isl_pw_aff_scale_down(
2959                 __isl_take isl_pw_aff *pwaff, isl_int f);
2960
2961         __isl_give isl_pw_aff *isl_pw_aff_list_min(
2962                 __isl_take isl_pw_aff_list *list);
2963         __isl_give isl_pw_aff *isl_pw_aff_list_max(
2964                 __isl_take isl_pw_aff_list *list);
2965
2966         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
2967                 __isl_take isl_pw_aff *pwqp);
2968
2969         __isl_give isl_aff *isl_aff_align_params(
2970                 __isl_take isl_aff *aff,
2971                 __isl_take isl_space *model);
2972         __isl_give isl_pw_aff *isl_pw_aff_align_params(
2973                 __isl_take isl_pw_aff *pwaff,
2974                 __isl_take isl_space *model);
2975
2976         __isl_give isl_aff *isl_aff_project_domain_on_params(
2977                 __isl_take isl_aff *aff);
2978
2979         __isl_give isl_aff *isl_aff_gist_params(
2980                 __isl_take isl_aff *aff,
2981                 __isl_take isl_set *context);
2982         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
2983                 __isl_take isl_set *context);
2984         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
2985                 __isl_take isl_pw_aff *pwaff,
2986                 __isl_take isl_set *context);
2987         __isl_give isl_pw_aff *isl_pw_aff_gist(
2988                 __isl_take isl_pw_aff *pwaff,
2989                 __isl_take isl_set *context);
2990
2991         __isl_give isl_set *isl_pw_aff_domain(
2992                 __isl_take isl_pw_aff *pwaff);
2993         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
2994                 __isl_take isl_pw_aff *pa,
2995                 __isl_take isl_set *set);
2996         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
2997                 __isl_take isl_pw_aff *pa,
2998                 __isl_take isl_set *set);
2999
3000         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3001                 __isl_take isl_aff *aff2);
3002         __isl_give isl_pw_aff *isl_pw_aff_mul(
3003                 __isl_take isl_pw_aff *pwaff1,
3004                 __isl_take isl_pw_aff *pwaff2);
3005
3006 When multiplying two affine expressions, at least one of the two needs
3007 to be a constant.
3008
3009         #include <isl/aff.h>
3010         __isl_give isl_basic_set *isl_aff_le_basic_set(
3011                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3012         __isl_give isl_basic_set *isl_aff_ge_basic_set(
3013                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3014         __isl_give isl_set *isl_pw_aff_eq_set(
3015                 __isl_take isl_pw_aff *pwaff1,
3016                 __isl_take isl_pw_aff *pwaff2);
3017         __isl_give isl_set *isl_pw_aff_ne_set(
3018                 __isl_take isl_pw_aff *pwaff1,
3019                 __isl_take isl_pw_aff *pwaff2);
3020         __isl_give isl_set *isl_pw_aff_le_set(
3021                 __isl_take isl_pw_aff *pwaff1,
3022                 __isl_take isl_pw_aff *pwaff2);
3023         __isl_give isl_set *isl_pw_aff_lt_set(
3024                 __isl_take isl_pw_aff *pwaff1,
3025                 __isl_take isl_pw_aff *pwaff2);
3026         __isl_give isl_set *isl_pw_aff_ge_set(
3027                 __isl_take isl_pw_aff *pwaff1,
3028                 __isl_take isl_pw_aff *pwaff2);
3029         __isl_give isl_set *isl_pw_aff_gt_set(
3030                 __isl_take isl_pw_aff *pwaff1,
3031                 __isl_take isl_pw_aff *pwaff2);
3032
3033         __isl_give isl_set *isl_pw_aff_list_eq_set(
3034                 __isl_take isl_pw_aff_list *list1,
3035                 __isl_take isl_pw_aff_list *list2);
3036         __isl_give isl_set *isl_pw_aff_list_ne_set(
3037                 __isl_take isl_pw_aff_list *list1,
3038                 __isl_take isl_pw_aff_list *list2);
3039         __isl_give isl_set *isl_pw_aff_list_le_set(
3040                 __isl_take isl_pw_aff_list *list1,
3041                 __isl_take isl_pw_aff_list *list2);
3042         __isl_give isl_set *isl_pw_aff_list_lt_set(
3043                 __isl_take isl_pw_aff_list *list1,
3044                 __isl_take isl_pw_aff_list *list2);
3045         __isl_give isl_set *isl_pw_aff_list_ge_set(
3046                 __isl_take isl_pw_aff_list *list1,
3047                 __isl_take isl_pw_aff_list *list2);
3048         __isl_give isl_set *isl_pw_aff_list_gt_set(
3049                 __isl_take isl_pw_aff_list *list1,
3050                 __isl_take isl_pw_aff_list *list2);
3051
3052 The function C<isl_aff_ge_basic_set> returns a basic set
3053 containing those elements in the shared space
3054 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3055 The function C<isl_aff_ge_set> returns a set
3056 containing those elements in the shared domain
3057 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3058 The functions operating on C<isl_pw_aff_list> apply the corresponding
3059 C<isl_pw_aff> function to each pair of elements in the two lists.
3060
3061         #include <isl/aff.h>
3062         __isl_give isl_set *isl_pw_aff_nonneg_set(
3063                 __isl_take isl_pw_aff *pwaff);
3064         __isl_give isl_set *isl_pw_aff_zero_set(
3065                 __isl_take isl_pw_aff *pwaff);
3066         __isl_give isl_set *isl_pw_aff_non_zero_set(
3067                 __isl_take isl_pw_aff *pwaff);
3068
3069 The function C<isl_pw_aff_nonneg_set> returns a set
3070 containing those elements in the domain
3071 of C<pwaff> where C<pwaff> is non-negative.
3072
3073         #include <isl/aff.h>
3074         __isl_give isl_pw_aff *isl_pw_aff_cond(
3075                 __isl_take isl_set *cond,
3076                 __isl_take isl_pw_aff *pwaff_true,
3077                 __isl_take isl_pw_aff *pwaff_false);
3078
3079 The function C<isl_pw_aff_cond> performs a conditional operator
3080 and returns an expression that is equal to C<pwaff_true>
3081 for elements in C<cond> and equal to C<pwaff_false> for elements
3082 not in C<cond>.
3083
3084         #include <isl/aff.h>
3085         __isl_give isl_pw_aff *isl_pw_aff_union_min(
3086                 __isl_take isl_pw_aff *pwaff1,
3087                 __isl_take isl_pw_aff *pwaff2);
3088         __isl_give isl_pw_aff *isl_pw_aff_union_max(
3089                 __isl_take isl_pw_aff *pwaff1,
3090                 __isl_take isl_pw_aff *pwaff2);
3091         __isl_give isl_pw_aff *isl_pw_aff_union_add(
3092                 __isl_take isl_pw_aff *pwaff1,
3093                 __isl_take isl_pw_aff *pwaff2);
3094
3095 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3096 expression with a domain that is the union of those of C<pwaff1> and
3097 C<pwaff2> and such that on each cell, the quasi-affine expression is
3098 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
3099 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
3100 associated expression is the defined one.
3101
3102 An expression can be read from input using
3103
3104         #include <isl/aff.h>
3105         __isl_give isl_aff *isl_aff_read_from_str(
3106                 isl_ctx *ctx, const char *str);
3107         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3108                 isl_ctx *ctx, const char *str);
3109
3110 An expression can be printed using
3111
3112         #include <isl/aff.h>
3113         __isl_give isl_printer *isl_printer_print_aff(
3114                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3115
3116         __isl_give isl_printer *isl_printer_print_pw_aff(
3117                 __isl_take isl_printer *p,
3118                 __isl_keep isl_pw_aff *pwaff);
3119
3120 =head2 Piecewise Multiple Quasi Affine Expressions
3121
3122 An C<isl_multi_aff> object represents a sequence of
3123 zero or more affine expressions, all defined on the same domain space.
3124
3125 An C<isl_multi_aff> can be constructed from a C<isl_aff_list> using the
3126 following function.
3127
3128         #include <isl/aff.h>
3129         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
3130                 __isl_take isl_space *space,
3131                 __isl_take isl_aff_list *list);
3132
3133 An empty piecewise multiple quasi affine expression (one with no cells) or
3134 a piecewise multiple quasi affine expression with a single cell can
3135 be created using the following functions.
3136
3137         #include <isl/aff.h>
3138         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
3139                 __isl_take isl_space *space);
3140         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
3141                 __isl_take isl_set *set,
3142                 __isl_take isl_multi_aff *maff);
3143
3144 A piecewise multiple quasi affine expression can also be initialized
3145 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
3146 and the C<isl_map> is single-valued.
3147
3148         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
3149                 __isl_take isl_set *set);
3150         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
3151                 __isl_take isl_map *map);
3152
3153 Multiple quasi affine expressions can be copied and freed using
3154
3155         #include <isl/aff.h>
3156         __isl_give isl_multi_aff *isl_multi_aff_copy(
3157                 __isl_keep isl_multi_aff *maff);
3158         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
3159
3160         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
3161                 __isl_keep isl_pw_multi_aff *pma);
3162         void *isl_pw_multi_aff_free(
3163                 __isl_take isl_pw_multi_aff *pma);
3164
3165 The expression can be inspected using
3166
3167         #include <isl/aff.h>
3168         isl_ctx *isl_multi_aff_get_ctx(
3169                 __isl_keep isl_multi_aff *maff);
3170         isl_ctx *isl_pw_multi_aff_get_ctx(
3171                 __isl_keep isl_pw_multi_aff *pma);
3172         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
3173                 enum isl_dim_type type);
3174         unsigned isl_pw_multi_aff_dim(
3175                 __isl_keep isl_pw_multi_aff *pma,
3176                 enum isl_dim_type type);
3177         __isl_give isl_aff *isl_multi_aff_get_aff(
3178                 __isl_keep isl_multi_aff *multi, int pos);
3179         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
3180                 __isl_keep isl_pw_multi_aff *pma, int pos);
3181         const char *isl_pw_multi_aff_get_dim_name(
3182                 __isl_keep isl_pw_multi_aff *pma,
3183                 enum isl_dim_type type, unsigned pos);
3184         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
3185                 __isl_keep isl_pw_multi_aff *pma,
3186                 enum isl_dim_type type, unsigned pos);
3187         const char *isl_multi_aff_get_tuple_name(
3188                 __isl_keep isl_multi_aff *multi,
3189                 enum isl_dim_type type);
3190         const char *isl_pw_multi_aff_get_tuple_name(
3191                 __isl_keep isl_pw_multi_aff *pma,
3192                 enum isl_dim_type type);
3193         int isl_pw_multi_aff_has_tuple_id(
3194                 __isl_keep isl_pw_multi_aff *pma,
3195                 enum isl_dim_type type);
3196         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
3197                 __isl_keep isl_pw_multi_aff *pma,
3198                 enum isl_dim_type type);
3199
3200         int isl_pw_multi_aff_foreach_piece(
3201                 __isl_keep isl_pw_multi_aff *pma,
3202                 int (*fn)(__isl_take isl_set *set,
3203                             __isl_take isl_multi_aff *maff,
3204                             void *user), void *user);
3205
3206 It can be modified using
3207
3208         #include <isl/aff.h>
3209         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
3210                 __isl_take isl_multi_aff *maff,
3211                 enum isl_dim_type type, unsigned pos, const char *s);
3212         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
3213                 __isl_take isl_multi_aff *maff,
3214                 enum isl_dim_type type, __isl_take isl_id *id);
3215         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
3216                 __isl_take isl_pw_multi_aff *pma,
3217                 enum isl_dim_type type, __isl_take isl_id *id);
3218
3219         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
3220                 __isl_take isl_multi_aff *maff,
3221                 enum isl_dim_type type, unsigned first, unsigned n);
3222
3223 To check whether two multiple affine expressions are
3224 obviously equal to each other, use
3225
3226         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
3227                 __isl_keep isl_multi_aff *maff2);
3228         int isl_pw_multi_aff_plain_is_equal(
3229                 __isl_keep isl_pw_multi_aff *pma1,
3230                 __isl_keep isl_pw_multi_aff *pma2);
3231
3232 Operations include
3233
3234         #include <isl/aff.h>
3235         __isl_give isl_multi_aff *isl_multi_aff_add(
3236                 __isl_take isl_multi_aff *maff1,
3237                 __isl_take isl_multi_aff *maff2);
3238         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
3239                 __isl_take isl_pw_multi_aff *pma1,
3240                 __isl_take isl_pw_multi_aff *pma2);
3241         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
3242                 __isl_take isl_pw_multi_aff *pma1,
3243                 __isl_take isl_pw_multi_aff *pma2);
3244         __isl_give isl_multi_aff *isl_multi_aff_scale(
3245                 __isl_take isl_multi_aff *maff,
3246                 isl_int f);
3247         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
3248                 __isl_take isl_pw_multi_aff *pma,
3249                 __isl_take isl_set *set);
3250         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
3251                 __isl_take isl_pw_multi_aff *pma,
3252                 __isl_take isl_set *set);
3253         __isl_give isl_multi_aff *isl_multi_aff_lift(
3254                 __isl_take isl_multi_aff *maff,
3255                 __isl_give isl_local_space **ls);
3256         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
3257                 __isl_take isl_pw_multi_aff *pma);
3258         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
3259                 __isl_take isl_multi_aff *maff,
3260                 __isl_take isl_set *context);
3261         __isl_give isl_multi_aff *isl_multi_aff_gist(
3262                 __isl_take isl_multi_aff *maff,
3263                 __isl_take isl_set *context);
3264         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
3265                 __isl_take isl_pw_multi_aff *pma,
3266                 __isl_take isl_set *set);
3267         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
3268                 __isl_take isl_pw_multi_aff *pma,
3269                 __isl_take isl_set *set);
3270         __isl_give isl_set *isl_pw_multi_aff_domain(
3271                 __isl_take isl_pw_multi_aff *pma);
3272
3273 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
3274 then it is assigned the local space that lies at the basis of
3275 the lifting applied.
3276
3277 An expression can be read from input using
3278
3279         #include <isl/aff.h>
3280         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
3281                 isl_ctx *ctx, const char *str);
3282         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
3283                 isl_ctx *ctx, const char *str);
3284
3285 An expression can be printed using
3286
3287         #include <isl/aff.h>
3288         __isl_give isl_printer *isl_printer_print_multi_aff(
3289                 __isl_take isl_printer *p,
3290                 __isl_keep isl_multi_aff *maff);
3291         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
3292                 __isl_take isl_printer *p,
3293                 __isl_keep isl_pw_multi_aff *pma);
3294
3295 =head2 Points
3296
3297 Points are elements of a set.  They can be used to construct
3298 simple sets (boxes) or they can be used to represent the
3299 individual elements of a set.
3300 The zero point (the origin) can be created using
3301
3302         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
3303
3304 The coordinates of a point can be inspected, set and changed
3305 using
3306
3307         int isl_point_get_coordinate(__isl_keep isl_point *pnt,
3308                 enum isl_dim_type type, int pos, isl_int *v);
3309         __isl_give isl_point *isl_point_set_coordinate(
3310                 __isl_take isl_point *pnt,
3311                 enum isl_dim_type type, int pos, isl_int v);
3312
3313         __isl_give isl_point *isl_point_add_ui(
3314                 __isl_take isl_point *pnt,
3315                 enum isl_dim_type type, int pos, unsigned val);
3316         __isl_give isl_point *isl_point_sub_ui(
3317                 __isl_take isl_point *pnt,
3318                 enum isl_dim_type type, int pos, unsigned val);
3319
3320 Other properties can be obtained using
3321
3322         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
3323
3324 Points can be copied or freed using
3325
3326         __isl_give isl_point *isl_point_copy(
3327                 __isl_keep isl_point *pnt);
3328         void isl_point_free(__isl_take isl_point *pnt);
3329
3330 A singleton set can be created from a point using
3331
3332         __isl_give isl_basic_set *isl_basic_set_from_point(
3333                 __isl_take isl_point *pnt);
3334         __isl_give isl_set *isl_set_from_point(
3335                 __isl_take isl_point *pnt);
3336
3337 and a box can be created from two opposite extremal points using
3338
3339         __isl_give isl_basic_set *isl_basic_set_box_from_points(
3340                 __isl_take isl_point *pnt1,
3341                 __isl_take isl_point *pnt2);
3342         __isl_give isl_set *isl_set_box_from_points(
3343                 __isl_take isl_point *pnt1,
3344                 __isl_take isl_point *pnt2);
3345
3346 All elements of a B<bounded> (union) set can be enumerated using
3347 the following functions.
3348
3349         int isl_set_foreach_point(__isl_keep isl_set *set,
3350                 int (*fn)(__isl_take isl_point *pnt, void *user),
3351                 void *user);
3352         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
3353                 int (*fn)(__isl_take isl_point *pnt, void *user),
3354                 void *user);
3355
3356 The function C<fn> is called for each integer point in
3357 C<set> with as second argument the last argument of
3358 the C<isl_set_foreach_point> call.  The function C<fn>
3359 should return C<0> on success and C<-1> on failure.
3360 In the latter case, C<isl_set_foreach_point> will stop
3361 enumerating and return C<-1> as well.
3362 If the enumeration is performed successfully and to completion,
3363 then C<isl_set_foreach_point> returns C<0>.
3364
3365 To obtain a single point of a (basic) set, use
3366
3367         __isl_give isl_point *isl_basic_set_sample_point(
3368                 __isl_take isl_basic_set *bset);
3369         __isl_give isl_point *isl_set_sample_point(
3370                 __isl_take isl_set *set);
3371
3372 If C<set> does not contain any (integer) points, then the
3373 resulting point will be ``void'', a property that can be
3374 tested using
3375
3376         int isl_point_is_void(__isl_keep isl_point *pnt);
3377
3378 =head2 Piecewise Quasipolynomials
3379
3380 A piecewise quasipolynomial is a particular kind of function that maps
3381 a parametric point to a rational value.
3382 More specifically, a quasipolynomial is a polynomial expression in greatest
3383 integer parts of affine expressions of parameters and variables.
3384 A piecewise quasipolynomial is a subdivision of a given parametric
3385 domain into disjoint cells with a quasipolynomial associated to
3386 each cell.  The value of the piecewise quasipolynomial at a given
3387 point is the value of the quasipolynomial associated to the cell
3388 that contains the point.  Outside of the union of cells,
3389 the value is assumed to be zero.
3390 For example, the piecewise quasipolynomial
3391
3392         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
3393
3394 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
3395 A given piecewise quasipolynomial has a fixed domain dimension.
3396 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
3397 defined over different domains.
3398 Piecewise quasipolynomials are mainly used by the C<barvinok>
3399 library for representing the number of elements in a parametric set or map.
3400 For example, the piecewise quasipolynomial above represents
3401 the number of points in the map
3402
3403         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
3404
3405 =head3 Input and Output
3406
3407 Piecewise quasipolynomials can be read from input using
3408
3409         __isl_give isl_union_pw_qpolynomial *
3410         isl_union_pw_qpolynomial_read_from_str(
3411                 isl_ctx *ctx, const char *str);
3412
3413 Quasipolynomials and piecewise quasipolynomials can be printed
3414 using the following functions.
3415
3416         __isl_give isl_printer *isl_printer_print_qpolynomial(
3417                 __isl_take isl_printer *p,
3418                 __isl_keep isl_qpolynomial *qp);
3419
3420         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
3421                 __isl_take isl_printer *p,
3422                 __isl_keep isl_pw_qpolynomial *pwqp);
3423
3424         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
3425                 __isl_take isl_printer *p,
3426                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3427
3428 The output format of the printer
3429 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3430 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
3431 is supported.
3432 In case of printing in C<ISL_FORMAT_C>, the user may want
3433 to set the names of all dimensions
3434
3435         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
3436                 __isl_take isl_qpolynomial *qp,
3437                 enum isl_dim_type type, unsigned pos,
3438                 const char *s);
3439         __isl_give isl_pw_qpolynomial *
3440         isl_pw_qpolynomial_set_dim_name(
3441                 __isl_take isl_pw_qpolynomial *pwqp,
3442                 enum isl_dim_type type, unsigned pos,
3443                 const char *s);
3444
3445 =head3 Creating New (Piecewise) Quasipolynomials
3446
3447 Some simple quasipolynomials can be created using the following functions.
3448 More complicated quasipolynomials can be created by applying
3449 operations such as addition and multiplication
3450 on the resulting quasipolynomials
3451
3452         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
3453                 __isl_take isl_space *domain);
3454         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
3455                 __isl_take isl_space *domain);
3456         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
3457                 __isl_take isl_space *domain);
3458         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
3459                 __isl_take isl_space *domain);
3460         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
3461                 __isl_take isl_space *domain);
3462         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
3463                 __isl_take isl_space *domain,
3464                 const isl_int n, const isl_int d);
3465         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
3466                 __isl_take isl_space *domain,
3467                 enum isl_dim_type type, unsigned pos);
3468         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
3469                 __isl_take isl_aff *aff);
3470
3471 Note that the space in which a quasipolynomial lives is a map space
3472 with a one-dimensional range.  The C<domain> argument in some of
3473 the functions above corresponds to the domain of this map space.
3474
3475 The zero piecewise quasipolynomial or a piecewise quasipolynomial
3476 with a single cell can be created using the following functions.
3477 Multiple of these single cell piecewise quasipolynomials can
3478 be combined to create more complicated piecewise quasipolynomials.
3479
3480         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
3481                 __isl_take isl_space *space);
3482         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
3483                 __isl_take isl_set *set,
3484                 __isl_take isl_qpolynomial *qp);
3485         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
3486                 __isl_take isl_qpolynomial *qp);
3487         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
3488                 __isl_take isl_pw_aff *pwaff);
3489
3490         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
3491                 __isl_take isl_space *space);
3492         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
3493                 __isl_take isl_pw_qpolynomial *pwqp);
3494         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
3495                 __isl_take isl_union_pw_qpolynomial *upwqp,
3496                 __isl_take isl_pw_qpolynomial *pwqp);
3497
3498 Quasipolynomials can be copied and freed again using the following
3499 functions.
3500
3501         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
3502                 __isl_keep isl_qpolynomial *qp);
3503         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
3504
3505         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
3506                 __isl_keep isl_pw_qpolynomial *pwqp);
3507         void *isl_pw_qpolynomial_free(
3508                 __isl_take isl_pw_qpolynomial *pwqp);
3509
3510         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
3511                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3512         void isl_union_pw_qpolynomial_free(
3513                 __isl_take isl_union_pw_qpolynomial *upwqp);
3514
3515 =head3 Inspecting (Piecewise) Quasipolynomials
3516
3517 To iterate over all piecewise quasipolynomials in a union
3518 piecewise quasipolynomial, use the following function
3519
3520         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
3521                 __isl_keep isl_union_pw_qpolynomial *upwqp,
3522                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
3523                 void *user);
3524
3525 To extract the piecewise quasipolynomial in a given space from a union, use
3526
3527         __isl_give isl_pw_qpolynomial *
3528         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
3529                 __isl_keep isl_union_pw_qpolynomial *upwqp,
3530                 __isl_take isl_space *space);
3531
3532 To iterate over the cells in a piecewise quasipolynomial,
3533 use either of the following two functions
3534
3535         int isl_pw_qpolynomial_foreach_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         int isl_pw_qpolynomial_foreach_lifted_piece(
3541                 __isl_keep isl_pw_qpolynomial *pwqp,
3542                 int (*fn)(__isl_take isl_set *set,
3543                           __isl_take isl_qpolynomial *qp,
3544                           void *user), void *user);
3545
3546 As usual, the function C<fn> should return C<0> on success
3547 and C<-1> on failure.  The difference between
3548 C<isl_pw_qpolynomial_foreach_piece> and
3549 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
3550 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
3551 compute unique representations for all existentially quantified
3552 variables and then turn these existentially quantified variables
3553 into extra set variables, adapting the associated quasipolynomial
3554 accordingly.  This means that the C<set> passed to C<fn>
3555 will not have any existentially quantified variables, but that
3556 the dimensions of the sets may be different for different
3557 invocations of C<fn>.
3558
3559 To iterate over all terms in a quasipolynomial,
3560 use
3561
3562         int isl_qpolynomial_foreach_term(
3563                 __isl_keep isl_qpolynomial *qp,
3564                 int (*fn)(__isl_take isl_term *term,
3565                           void *user), void *user);
3566
3567 The terms themselves can be inspected and freed using
3568 these functions
3569
3570         unsigned isl_term_dim(__isl_keep isl_term *term,
3571                 enum isl_dim_type type);
3572         void isl_term_get_num(__isl_keep isl_term *term,
3573                 isl_int *n);
3574         void isl_term_get_den(__isl_keep isl_term *term,
3575                 isl_int *d);
3576         int isl_term_get_exp(__isl_keep isl_term *term,
3577                 enum isl_dim_type type, unsigned pos);
3578         __isl_give isl_aff *isl_term_get_div(
3579                 __isl_keep isl_term *term, unsigned pos);
3580         void isl_term_free(__isl_take isl_term *term);
3581
3582 Each term is a product of parameters, set variables and
3583 integer divisions.  The function C<isl_term_get_exp>
3584 returns the exponent of a given dimensions in the given term.
3585 The C<isl_int>s in the arguments of C<isl_term_get_num>
3586 and C<isl_term_get_den> need to have been initialized
3587 using C<isl_int_init> before calling these functions.
3588
3589 =head3 Properties of (Piecewise) Quasipolynomials
3590
3591 To check whether a quasipolynomial is actually a constant,
3592 use the following function.
3593
3594         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
3595                 isl_int *n, isl_int *d);
3596
3597 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
3598 then the numerator and denominator of the constant
3599 are returned in C<*n> and C<*d>, respectively.
3600
3601 To check whether two union piecewise quasipolynomials are
3602 obviously equal, use
3603
3604         int isl_union_pw_qpolynomial_plain_is_equal(
3605                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
3606                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
3607
3608 =head3 Operations on (Piecewise) Quasipolynomials
3609
3610         __isl_give isl_qpolynomial *isl_qpolynomial_scale(
3611                 __isl_take isl_qpolynomial *qp, isl_int v);
3612         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
3613                 __isl_take isl_qpolynomial *qp);
3614         __isl_give isl_qpolynomial *isl_qpolynomial_add(
3615                 __isl_take isl_qpolynomial *qp1,
3616                 __isl_take isl_qpolynomial *qp2);
3617         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
3618                 __isl_take isl_qpolynomial *qp1,
3619                 __isl_take isl_qpolynomial *qp2);
3620         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
3621                 __isl_take isl_qpolynomial *qp1,
3622                 __isl_take isl_qpolynomial *qp2);
3623         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
3624                 __isl_take isl_qpolynomial *qp, unsigned exponent);
3625
3626         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
3627                 __isl_take isl_pw_qpolynomial *pwqp1,
3628                 __isl_take isl_pw_qpolynomial *pwqp2);
3629         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
3630                 __isl_take isl_pw_qpolynomial *pwqp1,
3631                 __isl_take isl_pw_qpolynomial *pwqp2);
3632         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
3633                 __isl_take isl_pw_qpolynomial *pwqp1,
3634                 __isl_take isl_pw_qpolynomial *pwqp2);
3635         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
3636                 __isl_take isl_pw_qpolynomial *pwqp);
3637         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
3638                 __isl_take isl_pw_qpolynomial *pwqp1,
3639                 __isl_take isl_pw_qpolynomial *pwqp2);
3640         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
3641                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
3642
3643         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
3644                 __isl_take isl_union_pw_qpolynomial *upwqp1,
3645                 __isl_take isl_union_pw_qpolynomial *upwqp2);
3646         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
3647                 __isl_take isl_union_pw_qpolynomial *upwqp1,
3648                 __isl_take isl_union_pw_qpolynomial *upwqp2);
3649         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
3650                 __isl_take isl_union_pw_qpolynomial *upwqp1,
3651                 __isl_take isl_union_pw_qpolynomial *upwqp2);
3652
3653         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
3654                 __isl_take isl_pw_qpolynomial *pwqp,
3655                 __isl_take isl_point *pnt);
3656
3657         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
3658                 __isl_take isl_union_pw_qpolynomial *upwqp,
3659                 __isl_take isl_point *pnt);
3660
3661         __isl_give isl_set *isl_pw_qpolynomial_domain(
3662                 __isl_take isl_pw_qpolynomial *pwqp);
3663         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
3664                 __isl_take isl_pw_qpolynomial *pwpq,
3665                 __isl_take isl_set *set);
3666         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
3667                 __isl_take isl_pw_qpolynomial *pwpq,
3668                 __isl_take isl_set *set);
3669
3670         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
3671                 __isl_take isl_union_pw_qpolynomial *upwqp);
3672         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
3673                 __isl_take isl_union_pw_qpolynomial *upwpq,
3674                 __isl_take isl_union_set *uset);
3675         __isl_give isl_union_pw_qpolynomial *
3676         isl_union_pw_qpolynomial_intersect_params(
3677                 __isl_take isl_union_pw_qpolynomial *upwpq,
3678                 __isl_take isl_set *set);
3679
3680         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
3681                 __isl_take isl_qpolynomial *qp,
3682                 __isl_take isl_space *model);
3683
3684         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
3685                 __isl_take isl_qpolynomial *qp);
3686         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
3687                 __isl_take isl_pw_qpolynomial *pwqp);
3688
3689         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
3690                 __isl_take isl_union_pw_qpolynomial *upwqp);
3691
3692         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
3693                 __isl_take isl_qpolynomial *qp,
3694                 __isl_take isl_set *context);
3695         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
3696                 __isl_take isl_qpolynomial *qp,
3697                 __isl_take isl_set *context);
3698
3699         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
3700                 __isl_take isl_pw_qpolynomial *pwqp,
3701                 __isl_take isl_set *context);
3702         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
3703                 __isl_take isl_pw_qpolynomial *pwqp,
3704                 __isl_take isl_set *context);
3705
3706         __isl_give isl_union_pw_qpolynomial *
3707         isl_union_pw_qpolynomial_gist_params(
3708                 __isl_take isl_union_pw_qpolynomial *upwqp,
3709                 __isl_take isl_set *context);
3710         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
3711                 __isl_take isl_union_pw_qpolynomial *upwqp,
3712                 __isl_take isl_union_set *context);
3713
3714 The gist operation applies the gist operation to each of
3715 the cells in the domain of the input piecewise quasipolynomial.
3716 The context is also exploited
3717 to simplify the quasipolynomials associated to each cell.
3718
3719         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
3720                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
3721         __isl_give isl_union_pw_qpolynomial *
3722         isl_union_pw_qpolynomial_to_polynomial(
3723                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
3724
3725 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
3726 the polynomial will be an overapproximation.  If C<sign> is negative,
3727 it will be an underapproximation.  If C<sign> is zero, the approximation
3728 will lie somewhere in between.
3729
3730 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
3731
3732 A piecewise quasipolynomial reduction is a piecewise
3733 reduction (or fold) of quasipolynomials.
3734 In particular, the reduction can be maximum or a minimum.
3735 The objects are mainly used to represent the result of
3736 an upper or lower bound on a quasipolynomial over its domain,
3737 i.e., as the result of the following function.
3738
3739         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
3740                 __isl_take isl_pw_qpolynomial *pwqp,
3741                 enum isl_fold type, int *tight);
3742
3743         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
3744                 __isl_take isl_union_pw_qpolynomial *upwqp,
3745                 enum isl_fold type, int *tight);
3746
3747 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
3748 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
3749 is the returned bound is known be tight, i.e., for each value
3750 of the parameters there is at least
3751 one element in the domain that reaches the bound.
3752 If the domain of C<pwqp> is not wrapping, then the bound is computed
3753 over all elements in that domain and the result has a purely parametric
3754 domain.  If the domain of C<pwqp> is wrapping, then the bound is
3755 computed over the range of the wrapped relation.  The domain of the
3756 wrapped relation becomes the domain of the result.
3757
3758 A (piecewise) quasipolynomial reduction can be copied or freed using the
3759 following functions.
3760
3761         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
3762                 __isl_keep isl_qpolynomial_fold *fold);
3763         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
3764                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3765         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
3766                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3767         void isl_qpolynomial_fold_free(
3768                 __isl_take isl_qpolynomial_fold *fold);
3769         void *isl_pw_qpolynomial_fold_free(
3770                 __isl_take isl_pw_qpolynomial_fold *pwf);
3771         void isl_union_pw_qpolynomial_fold_free(
3772                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3773
3774 =head3 Printing Piecewise Quasipolynomial Reductions
3775
3776 Piecewise quasipolynomial reductions can be printed
3777 using the following function.
3778
3779         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
3780                 __isl_take isl_printer *p,
3781                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3782         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
3783                 __isl_take isl_printer *p,
3784                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3785
3786 For C<isl_printer_print_pw_qpolynomial_fold>,
3787 output format of the printer
3788 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3789 For C<isl_printer_print_union_pw_qpolynomial_fold>,
3790 output format of the printer
3791 needs to be set to C<ISL_FORMAT_ISL>.
3792 In case of printing in C<ISL_FORMAT_C>, the user may want
3793 to set the names of all dimensions
3794
3795         __isl_give isl_pw_qpolynomial_fold *
3796         isl_pw_qpolynomial_fold_set_dim_name(
3797                 __isl_take isl_pw_qpolynomial_fold *pwf,
3798                 enum isl_dim_type type, unsigned pos,
3799                 const char *s);
3800
3801 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
3802
3803 To iterate over all piecewise quasipolynomial reductions in a union
3804 piecewise quasipolynomial reduction, use the following function
3805
3806         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
3807                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
3808                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
3809                             void *user), void *user);
3810
3811 To iterate over the cells in a piecewise quasipolynomial reduction,
3812 use either of the following two functions
3813
3814         int isl_pw_qpolynomial_fold_foreach_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         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
3820                 __isl_keep isl_pw_qpolynomial_fold *pwf,
3821                 int (*fn)(__isl_take isl_set *set,
3822                           __isl_take isl_qpolynomial_fold *fold,
3823                           void *user), void *user);
3824
3825 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
3826 of the difference between these two functions.
3827
3828 To iterate over all quasipolynomials in a reduction, use
3829
3830         int isl_qpolynomial_fold_foreach_qpolynomial(
3831                 __isl_keep isl_qpolynomial_fold *fold,
3832                 int (*fn)(__isl_take isl_qpolynomial *qp,
3833                           void *user), void *user);
3834
3835 =head3 Properties of Piecewise Quasipolynomial Reductions
3836
3837 To check whether two union piecewise quasipolynomial reductions are
3838 obviously equal, use
3839
3840         int isl_union_pw_qpolynomial_fold_plain_is_equal(
3841                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
3842                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
3843
3844 =head3 Operations on Piecewise Quasipolynomial Reductions
3845
3846         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
3847                 __isl_take isl_qpolynomial_fold *fold, isl_int v);
3848
3849         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
3850                 __isl_take isl_pw_qpolynomial_fold *pwf1,
3851                 __isl_take isl_pw_qpolynomial_fold *pwf2);
3852
3853         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
3854                 __isl_take isl_pw_qpolynomial_fold *pwf1,
3855                 __isl_take isl_pw_qpolynomial_fold *pwf2);
3856
3857         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
3858                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
3859                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
3860
3861         __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
3862                 __isl_take isl_pw_qpolynomial_fold *pwf,
3863                 __isl_take isl_point *pnt);
3864
3865         __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
3866                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3867                 __isl_take isl_point *pnt);
3868
3869         __isl_give isl_pw_qpolynomial_fold *
3870         sl_pw_qpolynomial_fold_intersect_params(
3871                 __isl_take isl_pw_qpolynomial_fold *pwf,
3872                 __isl_take isl_set *set);
3873
3874         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
3875                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3876         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
3877                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3878                 __isl_take isl_union_set *uset);
3879         __isl_give isl_union_pw_qpolynomial_fold *
3880         isl_union_pw_qpolynomial_fold_intersect_params(
3881                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3882                 __isl_take isl_set *set);
3883
3884         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
3885                 __isl_take isl_pw_qpolynomial_fold *pwf);
3886
3887         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
3888                 __isl_take isl_pw_qpolynomial_fold *pwf);
3889
3890         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
3891                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3892
3893         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
3894                 __isl_take isl_qpolynomial_fold *fold,
3895                 __isl_take isl_set *context);
3896         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
3897                 __isl_take isl_qpolynomial_fold *fold,
3898                 __isl_take isl_set *context);
3899
3900         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
3901                 __isl_take isl_pw_qpolynomial_fold *pwf,
3902                 __isl_take isl_set *context);
3903         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
3904                 __isl_take isl_pw_qpolynomial_fold *pwf,
3905                 __isl_take isl_set *context);
3906
3907         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
3908                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3909                 __isl_take isl_union_set *context);
3910         __isl_give isl_union_pw_qpolynomial_fold *
3911         isl_union_pw_qpolynomial_fold_gist_params(
3912                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3913                 __isl_take isl_set *context);
3914
3915 The gist operation applies the gist operation to each of
3916 the cells in the domain of the input piecewise quasipolynomial reduction.
3917 In future, the operation will also exploit the context
3918 to simplify the quasipolynomial reductions associated to each cell.
3919
3920         __isl_give isl_pw_qpolynomial_fold *
3921         isl_set_apply_pw_qpolynomial_fold(
3922                 __isl_take isl_set *set,
3923                 __isl_take isl_pw_qpolynomial_fold *pwf,
3924                 int *tight);
3925         __isl_give isl_pw_qpolynomial_fold *
3926         isl_map_apply_pw_qpolynomial_fold(
3927                 __isl_take isl_map *map,
3928                 __isl_take isl_pw_qpolynomial_fold *pwf,
3929                 int *tight);
3930         __isl_give isl_union_pw_qpolynomial_fold *
3931         isl_union_set_apply_union_pw_qpolynomial_fold(
3932                 __isl_take isl_union_set *uset,
3933                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3934                 int *tight);
3935         __isl_give isl_union_pw_qpolynomial_fold *
3936         isl_union_map_apply_union_pw_qpolynomial_fold(
3937                 __isl_take isl_union_map *umap,
3938                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
3939                 int *tight);
3940
3941 The functions taking a map
3942 compose the given map with the given piecewise quasipolynomial reduction.
3943 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
3944 over all elements in the intersection of the range of the map
3945 and the domain of the piecewise quasipolynomial reduction
3946 as a function of an element in the domain of the map.
3947 The functions taking a set compute a bound over all elements in the
3948 intersection of the set and the domain of the
3949 piecewise quasipolynomial reduction.
3950
3951 =head2 Dependence Analysis
3952
3953 C<isl> contains specialized functionality for performing
3954 array dataflow analysis.  That is, given a I<sink> access relation
3955 and a collection of possible I<source> access relations,
3956 C<isl> can compute relations that describe
3957 for each iteration of the sink access, which iteration
3958 of which of the source access relations was the last
3959 to access the same data element before the given iteration
3960 of the sink access.
3961 The resulting dependence relations map source iterations
3962 to the corresponding sink iterations.
3963 To compute standard flow dependences, the sink should be
3964 a read, while the sources should be writes.
3965 If any of the source accesses are marked as being I<may>
3966 accesses, then there will be a dependence from the last
3967 I<must> access B<and> from any I<may> access that follows
3968 this last I<must> access.
3969 In particular, if I<all> sources are I<may> accesses,
3970 then memory based dependence analysis is performed.
3971 If, on the other hand, all sources are I<must> accesses,
3972 then value based dependence analysis is performed.
3973
3974         #include <isl/flow.h>
3975
3976         typedef int (*isl_access_level_before)(void *first, void *second);
3977
3978         __isl_give isl_access_info *isl_access_info_alloc(
3979                 __isl_take isl_map *sink,
3980                 void *sink_user, isl_access_level_before fn,
3981                 int max_source);
3982         __isl_give isl_access_info *isl_access_info_add_source(
3983                 __isl_take isl_access_info *acc,
3984                 __isl_take isl_map *source, int must,
3985                 void *source_user);
3986         void isl_access_info_free(__isl_take isl_access_info *acc);
3987
3988         __isl_give isl_flow *isl_access_info_compute_flow(
3989                 __isl_take isl_access_info *acc);
3990
3991         int isl_flow_foreach(__isl_keep isl_flow *deps,
3992                 int (*fn)(__isl_take isl_map *dep, int must,
3993                           void *dep_user, void *user),
3994                 void *user);
3995         __isl_give isl_map *isl_flow_get_no_source(
3996                 __isl_keep isl_flow *deps, int must);
3997         void isl_flow_free(__isl_take isl_flow *deps);
3998
3999 The function C<isl_access_info_compute_flow> performs the actual
4000 dependence analysis.  The other functions are used to construct
4001 the input for this function or to read off the output.
4002
4003 The input is collected in an C<isl_access_info>, which can
4004 be created through a call to C<isl_access_info_alloc>.
4005 The arguments to this functions are the sink access relation
4006 C<sink>, a token C<sink_user> used to identify the sink
4007 access to the user, a callback function for specifying the
4008 relative order of source and sink accesses, and the number
4009 of source access relations that will be added.
4010 The callback function has type C<int (*)(void *first, void *second)>.
4011 The function is called with two user supplied tokens identifying
4012 either a source or the sink and it should return the shared nesting
4013 level and the relative order of the two accesses.
4014 In particular, let I<n> be the number of loops shared by
4015 the two accesses.  If C<first> precedes C<second> textually,
4016 then the function should return I<2 * n + 1>; otherwise,
4017 it should return I<2 * n>.
4018 The sources can be added to the C<isl_access_info> by performing
4019 (at most) C<max_source> calls to C<isl_access_info_add_source>.
4020 C<must> indicates whether the source is a I<must> access
4021 or a I<may> access.  Note that a multi-valued access relation
4022 should only be marked I<must> if every iteration in the domain
4023 of the relation accesses I<all> elements in its image.
4024 The C<source_user> token is again used to identify
4025 the source access.  The range of the source access relation
4026 C<source> should have the same dimension as the range
4027 of the sink access relation.
4028 The C<isl_access_info_free> function should usually not be
4029 called explicitly, because it is called implicitly by
4030 C<isl_access_info_compute_flow>.
4031
4032 The result of the dependence analysis is collected in an
4033 C<isl_flow>.  There may be elements of
4034 the sink access for which no preceding source access could be
4035 found or for which all preceding sources are I<may> accesses.
4036 The relations containing these elements can be obtained through
4037 calls to C<isl_flow_get_no_source>, the first with C<must> set
4038 and the second with C<must> unset.
4039 In the case of standard flow dependence analysis,
4040 with the sink a read and the sources I<must> writes,
4041 the first relation corresponds to the reads from uninitialized
4042 array elements and the second relation is empty.
4043 The actual flow dependences can be extracted using
4044 C<isl_flow_foreach>.  This function will call the user-specified
4045 callback function C<fn> for each B<non-empty> dependence between
4046 a source and the sink.  The callback function is called
4047 with four arguments, the actual flow dependence relation
4048 mapping source iterations to sink iterations, a boolean that
4049 indicates whether it is a I<must> or I<may> dependence, a token
4050 identifying the source and an additional C<void *> with value
4051 equal to the third argument of the C<isl_flow_foreach> call.
4052 A dependence is marked I<must> if it originates from a I<must>
4053 source and if it is not followed by any I<may> sources.
4054
4055 After finishing with an C<isl_flow>, the user should call
4056 C<isl_flow_free> to free all associated memory.
4057
4058 A higher-level interface to dependence analysis is provided
4059 by the following function.
4060
4061         #include <isl/flow.h>
4062
4063         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
4064                 __isl_take isl_union_map *must_source,
4065                 __isl_take isl_union_map *may_source,
4066                 __isl_take isl_union_map *schedule,
4067                 __isl_give isl_union_map **must_dep,
4068                 __isl_give isl_union_map **may_dep,
4069                 __isl_give isl_union_map **must_no_source,
4070                 __isl_give isl_union_map **may_no_source);
4071
4072 The arrays are identified by the tuple names of the ranges
4073 of the accesses.  The iteration domains by the tuple names
4074 of the domains of the accesses and of the schedule.
4075 The relative order of the iteration domains is given by the
4076 schedule.  The relations returned through C<must_no_source>
4077 and C<may_no_source> are subsets of C<sink>.
4078 Any of C<must_dep>, C<may_dep>, C<must_no_source>
4079 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
4080 any of the other arguments is treated as an error.
4081
4082 =head3 Interaction with Dependence Analysis
4083
4084 During the dependence analysis, we frequently need to perform
4085 the following operation.  Given a relation between sink iterations
4086 and potential soure iterations from a particular source domain,
4087 what is the last potential source iteration corresponding to each
4088 sink iteration.  It can sometimes be convenient to adjust
4089 the set of potential source iterations before each such operation.
4090 The prototypical example is fuzzy array dataflow analysis,
4091 where we need to analyze if, based on data-dependent constraints,
4092 the sink iteration can ever be executed without one or more of
4093 the corresponding potential source iterations being executed.
4094 If so, we can introduce extra parameters and select an unknown
4095 but fixed source iteration from the potential source iterations.
4096 To be able to perform such manipulations, C<isl> provides the following
4097 function.
4098
4099         #include <isl/flow.h>
4100
4101         typedef __isl_give isl_set *(*isl_access_restrict_sources)(
4102                 __isl_take isl_map *source_map,
4103                 void *sink_user, void *source_user);
4104         __isl_give isl_access_info *
4105         isl_access_info_set_restrict_sources(
4106                 __isl_take isl_access_info *acc,
4107                 isl_access_restrict_sources fn);
4108
4109 The function C<isl_access_info_set_restrict_sources> should be called
4110 before C<isl_access_info_compute_flow> and registers a callback function
4111 that will be called any time C<isl> is about to compute the last
4112 potential source.  The first argument is the (reverse) proto-dependence,
4113 mapping sink iterations to potential source iterations.
4114 The other two arguments are the tokens corresponding to the sink
4115 and the source.  The callback is expected to return a set
4116 that restricts the source iterations.  The potential source iterations
4117 will be intersected with this set.  If no restrictions are required
4118 for a given C<source_map>, then the callback should return
4119
4120         isl_set_universe(
4121             isl_space_range(isl_map_get_space(source_map)));
4122
4123 If any error occurs, the callback should return C<NULL>.
4124
4125 =head2 Scheduling
4126
4127 B<The functionality described in this section is fairly new
4128 and may be subject to change.>
4129
4130 The following function can be used to compute a schedule
4131 for a union of domains.
4132 By default, the algorithm used to construct the schedule is similar
4133 to that of C<Pluto>.
4134 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
4135 be selected.
4136 The generated schedule respects all C<validity> dependences.
4137 That is, all dependence distances over these dependences in the
4138 scheduled space are lexicographically positive.
4139 The default algorithm tries to minimize the dependence distances over
4140 C<proximity> dependences.
4141 Moreover, it tries to obtain sequences (bands) of schedule dimensions
4142 for groups of domains where the dependence distances have only
4143 non-negative values.
4144 When using Feautrier's algorithm, the C<proximity> dependence
4145 distances are only minimized during the extension to a
4146 full-dimensional schedule.
4147
4148         #include <isl/schedule.h>
4149         __isl_give isl_schedule *isl_union_set_compute_schedule(
4150                 __isl_take isl_union_set *domain,
4151                 __isl_take isl_union_map *validity,
4152                 __isl_take isl_union_map *proximity);
4153         void *isl_schedule_free(__isl_take isl_schedule *sched);
4154
4155 A mapping from the domains to the scheduled space can be obtained
4156 from an C<isl_schedule> using the following function.
4157
4158         __isl_give isl_union_map *isl_schedule_get_map(
4159                 __isl_keep isl_schedule *sched);
4160
4161 A representation of the schedule can be printed using
4162          
4163         __isl_give isl_printer *isl_printer_print_schedule(
4164                 __isl_take isl_printer *p,
4165                 __isl_keep isl_schedule *schedule);
4166
4167 A representation of the schedule as a forest of bands can be obtained
4168 using the following function.
4169
4170         __isl_give isl_band_list *isl_schedule_get_band_forest(
4171                 __isl_keep isl_schedule *schedule);
4172
4173 The list can be manipulated as explained in L<"Lists">.
4174 The bands inside the list can be copied and freed using the following
4175 functions.
4176
4177         #include <isl/band.h>
4178         __isl_give isl_band *isl_band_copy(
4179                 __isl_keep isl_band *band);
4180         void *isl_band_free(__isl_take isl_band *band);
4181
4182 Each band contains zero or more scheduling dimensions.
4183 These are referred to as the members of the band.
4184 The section of the schedule that corresponds to the band is
4185 referred to as the partial schedule of the band.
4186 For those nodes that participate in a band, the outer scheduling
4187 dimensions form the prefix schedule, while the inner scheduling
4188 dimensions form the suffix schedule.
4189 That is, if we take a cut of the band forest, then the union of
4190 the concatenations of the prefix, partial and suffix schedules of
4191 each band in the cut is equal to the entire schedule (modulo
4192 some possible padding at the end with zero scheduling dimensions).
4193 The properties of a band can be inspected using the following functions.
4194
4195         #include <isl/band.h>
4196         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
4197
4198         int isl_band_has_children(__isl_keep isl_band *band);
4199         __isl_give isl_band_list *isl_band_get_children(
4200                 __isl_keep isl_band *band);
4201
4202         __isl_give isl_union_map *isl_band_get_prefix_schedule(
4203                 __isl_keep isl_band *band);
4204         __isl_give isl_union_map *isl_band_get_partial_schedule(
4205                 __isl_keep isl_band *band);
4206         __isl_give isl_union_map *isl_band_get_suffix_schedule(
4207                 __isl_keep isl_band *band);
4208
4209         int isl_band_n_member(__isl_keep isl_band *band);
4210         int isl_band_member_is_zero_distance(
4211                 __isl_keep isl_band *band, int pos);
4212
4213 Note that a scheduling dimension is considered to be ``zero
4214 distance'' if it does not carry any proximity dependences
4215 within its band.
4216 That is, if the dependence distances of the proximity
4217 dependences are all zero in that direction (for fixed
4218 iterations of outer bands).
4219
4220 A representation of the band can be printed using
4221
4222         #include <isl/band.h>
4223         __isl_give isl_printer *isl_printer_print_band(
4224                 __isl_take isl_printer *p,
4225                 __isl_keep isl_band *band);
4226
4227 =head3 Options
4228
4229         #include <isl/schedule.h>
4230         int isl_options_set_schedule_max_coefficient(
4231                 isl_ctx *ctx, int val);
4232         int isl_options_get_schedule_max_coefficient(
4233                 isl_ctx *ctx);
4234         int isl_options_set_schedule_max_constant_term(
4235                 isl_ctx *ctx, int val);
4236         int isl_options_get_schedule_max_constant_term(
4237                 isl_ctx *ctx);
4238         int isl_options_set_schedule_maximize_band_depth(
4239                 isl_ctx *ctx, int val);
4240         int isl_options_get_schedule_maximize_band_depth(
4241                 isl_ctx *ctx);
4242         int isl_options_set_schedule_outer_zero_distance(
4243                 isl_ctx *ctx, int val);
4244         int isl_options_get_schedule_outer_zero_distance(
4245                 isl_ctx *ctx);
4246         int isl_options_set_schedule_split_scaled(
4247                 isl_ctx *ctx, int val);
4248         int isl_options_get_schedule_split_scaled(
4249                 isl_ctx *ctx);
4250         int isl_options_set_schedule_algorithm(
4251                 isl_ctx *ctx, int val);
4252         int isl_options_get_schedule_algorithm(
4253                 isl_ctx *ctx);
4254
4255
4256 =over
4257
4258 =item * schedule_max_coefficient
4259
4260 This option enforces that the coefficients for variable and parameter
4261 dimensions in the calculated schedule are not larger than the specified value.
4262 This option can significantly increase the speed of the scheduling calculation
4263 and may also prevent fusing of unrelated dimensions. A value of -1 means that
4264 this option does not introduce bounds on the variable or parameter
4265 coefficients.
4266
4267 =item * schedule_max_constant_term
4268
4269 This option enforces that the constant coefficients in the calculated schedule
4270 are not larger than the maximal constant term. This option can significantly
4271 increase the speed of the scheduling calculation and may also prevent fusing of
4272 unrelated dimensions. A value of -1 means that this option does not introduce
4273 bounds on the constant coefficients.
4274
4275 =item * schedule_maximize_band_depth
4276
4277 If this option is set, we do not split bands at the point
4278 where we detect splitting is necessary. Instead, we
4279 backtrack and split bands as early as possible. This
4280 reduces the number of splits and maximizes the width of
4281 the bands. Wider bands give more possibilities for tiling.
4282
4283 =item * schedule_outer_zero_distance
4284
4285 If this option is set, then we try to construct schedules
4286 where the outermost scheduling dimension in each band
4287 results in a zero dependence distance over the proximity
4288 dependences.
4289
4290 =item * schedule_split_scaled
4291
4292 If this option is set, then we try to construct schedules in which the
4293 constant term is split off from the linear part if the linear parts of
4294 the scheduling rows for all nodes in the graphs have a common non-trivial
4295 divisor.
4296 The constant term is then placed in a separate band and the linear
4297 part is reduced.
4298
4299 =item * schedule_algorithm
4300
4301 Selects the scheduling algorithm to be used.
4302 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
4303 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
4304
4305 =back
4306
4307 =head2 Parametric Vertex Enumeration
4308
4309 The parametric vertex enumeration described in this section
4310 is mainly intended to be used internally and by the C<barvinok>
4311 library.
4312
4313         #include <isl/vertices.h>
4314         __isl_give isl_vertices *isl_basic_set_compute_vertices(
4315                 __isl_keep isl_basic_set *bset);
4316
4317 The function C<isl_basic_set_compute_vertices> performs the
4318 actual computation of the parametric vertices and the chamber
4319 decomposition and store the result in an C<isl_vertices> object.
4320 This information can be queried by either iterating over all
4321 the vertices or iterating over all the chambers or cells
4322 and then iterating over all vertices that are active on the chamber.
4323
4324         int isl_vertices_foreach_vertex(
4325                 __isl_keep isl_vertices *vertices,
4326                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4327                 void *user);
4328
4329         int isl_vertices_foreach_cell(
4330                 __isl_keep isl_vertices *vertices,
4331                 int (*fn)(__isl_take isl_cell *cell, void *user),
4332                 void *user);
4333         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
4334                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
4335                 void *user);
4336
4337 Other operations that can be performed on an C<isl_vertices> object are
4338 the following.
4339
4340         isl_ctx *isl_vertices_get_ctx(
4341                 __isl_keep isl_vertices *vertices);
4342         int isl_vertices_get_n_vertices(
4343                 __isl_keep isl_vertices *vertices);
4344         void isl_vertices_free(__isl_take isl_vertices *vertices);
4345
4346 Vertices can be inspected and destroyed using the following functions.
4347
4348         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
4349         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
4350         __isl_give isl_basic_set *isl_vertex_get_domain(
4351                 __isl_keep isl_vertex *vertex);
4352         __isl_give isl_basic_set *isl_vertex_get_expr(
4353                 __isl_keep isl_vertex *vertex);
4354         void isl_vertex_free(__isl_take isl_vertex *vertex);
4355
4356 C<isl_vertex_get_expr> returns a singleton parametric set describing
4357 the vertex, while C<isl_vertex_get_domain> returns the activity domain
4358 of the vertex.
4359 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
4360 B<rational> basic sets, so they should mainly be used for inspection
4361 and should not be mixed with integer sets.
4362
4363 Chambers can be inspected and destroyed using the following functions.
4364
4365         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
4366         __isl_give isl_basic_set *isl_cell_get_domain(
4367                 __isl_keep isl_cell *cell);
4368         void isl_cell_free(__isl_take isl_cell *cell);
4369
4370 =head1 Applications
4371
4372 Although C<isl> is mainly meant to be used as a library,
4373 it also contains some basic applications that use some
4374 of the functionality of C<isl>.
4375 The input may be specified in either the L<isl format>
4376 or the L<PolyLib format>.
4377
4378 =head2 C<isl_polyhedron_sample>
4379
4380 C<isl_polyhedron_sample> takes a polyhedron as input and prints
4381 an integer element of the polyhedron, if there is any.
4382 The first column in the output is the denominator and is always
4383 equal to 1.  If the polyhedron contains no integer points,
4384 then a vector of length zero is printed.
4385
4386 =head2 C<isl_pip>
4387
4388 C<isl_pip> takes the same input as the C<example> program
4389 from the C<piplib> distribution, i.e., a set of constraints
4390 on the parameters, a line containing only -1 and finally a set
4391 of constraints on a parametric polyhedron.
4392 The coefficients of the parameters appear in the last columns
4393 (but before the final constant column).
4394 The output is the lexicographic minimum of the parametric polyhedron.
4395 As C<isl> currently does not have its own output format, the output
4396 is just a dump of the internal state.
4397
4398 =head2 C<isl_polyhedron_minimize>
4399
4400 C<isl_polyhedron_minimize> computes the minimum of some linear
4401 or affine objective function over the integer points in a polyhedron.
4402 If an affine objective function
4403 is given, then the constant should appear in the last column.
4404
4405 =head2 C<isl_polytope_scan>
4406
4407 Given a polytope, C<isl_polytope_scan> prints
4408 all integer points in the polytope.