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