add isl_union_set_preimage_multi_aff
[isl.git] / doc / user.pod
blobae1ff2e1bfd862306ba1f719eb5c53070b29957e
1 =head1 Introduction
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.
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>.
23 =head2 Backward Incompatible Changes
25 =head3 Changes since isl-0.02
27 =over
29 =item * The old printing functions have been deprecated
30 and replaced by C<isl_printer> functions, see L<Input and Output>.
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>.
36 =back
38 =head3 Changes since isl-0.03
40 =over
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>.
47 =back
49 =head3 Changes since isl-0.04
51 =over
53 =item * All header files have been renamed from C<isl_header.h>
54 to C<isl/header.h>.
56 =back
58 =head3 Changes since isl-0.05
60 =over
62 =item * The functions C<isl_printer_print_basic_set> and
63 C<isl_printer_print_basic_map> no longer print a newline.
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.
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))>.
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.
79 =back
81 =head3 Changes since isl-0.06
83 =over
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.
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.
93 =back
95 =head3 Changes since isl-0.07
97 =over
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>.
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.
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>.
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.
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>.
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
142         isl_qpolynomial_from_aff(isl_aff_floor(div))
144 The function C<isl_constraint_div> has also been renamed
145 to C<isl_constraint_get_div>.
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.
154 =back
156 =head3 Changes since isl-0.09
158 =over
160 =item * The C<schedule_split_parallel> option has been replaced
161 by the C<schedule_split_scaled> option.
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
167         isl_pw_aff_cond(isl_set_indicator_function(a), b, c)
169 =back
171 =head3 Changes since isl-0.10
173 =over
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 The new C<isl_set_dim_has_lower_bound> and
180 C<isl_set_dim_has_upper_bound> have slightly different meanings.
182 =back
184 =head3 Changes since isl-0.12
186 =over
188 =item * C<isl_int> has been replaced by C<isl_val>.
189 Some of the old functions are still available in C<isl/deprecated/*.h>
190 but they will be removed in the future.
192 =item * The functions C<isl_pw_qpolynomial_eval>,
193 C<isl_union_pw_qpolynomial_eval>, C<isl_pw_qpolynomial_fold_eval>
194 and C<isl_union_pw_qpolynomial_fold_eval> have been changed to return
195 an C<isl_val> instead of an C<isl_qpolynomial>.
197 =item * The function C<isl_band_member_is_zero_distance>
198 has been removed.  Essentially the same functionality is available
199 through C<isl_band_member_is_coincident>, except that is requires
200 setting up coincidence constraints.
201 The option C<schedule_outer_zero_distance> has accordingly been
202 replaced by the option C<schedule_outer_coincidence>.
204 =back
206 =head1 License
208 C<isl> is released under the MIT license.
210 =over
212 Permission is hereby granted, free of charge, to any person obtaining a copy of
213 this software and associated documentation files (the "Software"), to deal in
214 the Software without restriction, including without limitation the rights to
215 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
216 of the Software, and to permit persons to whom the Software is furnished to do
217 so, subject to the following conditions:
219 The above copyright notice and this permission notice shall be included in all
220 copies or substantial portions of the Software.
222 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
223 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
224 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
225 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
226 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
227 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
228 SOFTWARE.
230 =back
232 Note that C<isl> currently requires C<GMP>, which is released
233 under the GNU Lesser General Public License (LGPL).  This means
234 that code linked against C<isl> is also linked against LGPL code.
236 =head1 Installation
238 The source of C<isl> can be obtained either as a tarball
239 or from the git repository.  Both are available from
240 L<http://freshmeat.net/projects/isl/>.
241 The installation process depends on how you obtained
242 the source.
244 =head2 Installation from the git repository
246 =over
248 =item 1 Clone or update the repository
250 The first time the source is obtained, you need to clone
251 the repository.
253         git clone git://repo.or.cz/isl.git
255 To obtain updates, you need to pull in the latest changes
257         git pull
259 =item 2 Generate C<configure>
261         ./autogen.sh
263 =back
265 After performing the above steps, continue
266 with the L<Common installation instructions>.
268 =head2 Common installation instructions
270 =over
272 =item 1 Obtain C<GMP>
274 Building C<isl> requires C<GMP>, including its headers files.
275 Your distribution may not provide these header files by default
276 and you may need to install a package called C<gmp-devel> or something
277 similar.  Alternatively, C<GMP> can be built from
278 source, available from L<http://gmplib.org/>.
280 =item 2 Configure
282 C<isl> uses the standard C<autoconf> C<configure> script.
283 To run it, just type
285         ./configure
287 optionally followed by some configure options.
288 A complete list of options can be obtained by running
290         ./configure --help
292 Below we discuss some of the more common options.
294 =over
296 =item C<--prefix>
298 Installation prefix for C<isl>
300 =item C<--with-gmp-prefix>
302 Installation prefix for C<GMP> (architecture-independent files).
304 =item C<--with-gmp-exec-prefix>
306 Installation prefix for C<GMP> (architecture-dependent files).
308 =back
310 =item 3 Compile
312         make
314 =item 4 Install (optional)
316         make install
318 =back
320 =head1 Integer Set Library
322 =head2 Initialization
324 All manipulations of integer sets and relations occur within
325 the context of an C<isl_ctx>.
326 A given C<isl_ctx> can only be used within a single thread.
327 All arguments of a function are required to have been allocated
328 within the same context.
329 There are currently no functions available for moving an object
330 from one C<isl_ctx> to another C<isl_ctx>.  This means that
331 there is currently no way of safely moving an object from one
332 thread to another, unless the whole C<isl_ctx> is moved.
334 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
335 freed using C<isl_ctx_free>.
336 All objects allocated within an C<isl_ctx> should be freed
337 before the C<isl_ctx> itself is freed.
339         isl_ctx *isl_ctx_alloc();
340         void isl_ctx_free(isl_ctx *ctx);
342 The user can impose a bound on the number of low-level I<operations>
343 that can be performed by an C<isl_ctx>.  This bound can be set and
344 retrieved using the following functions.  A bound of zero means that
345 no bound is imposed.  The number of operations performed can be
346 reset using C<isl_ctx_reset_operations>.  Note that the number
347 of low-level operations needed to perform a high-level computation
348 may differ significantly across different versions
349 of C<isl>, but it should be the same across different platforms
350 for the same version of C<isl>.
352         void isl_ctx_set_max_operations(isl_ctx *ctx,
353                 unsigned long max_operations);
354         unsigned long isl_ctx_get_max_operations(isl_ctx *ctx);
355         void isl_ctx_reset_operations(isl_ctx *ctx);
357 =head2 Values
359 An C<isl_val> represents an integer value, a rational value
360 or one of three special values, infinity, negative infinity and NaN.
361 Some predefined values can be created using the following functions.
363         #include <isl/val.h>
364         __isl_give isl_val *isl_val_zero(isl_ctx *ctx);
365         __isl_give isl_val *isl_val_one(isl_ctx *ctx);
366         __isl_give isl_val *isl_val_negone(isl_ctx *ctx);
367         __isl_give isl_val *isl_val_nan(isl_ctx *ctx);
368         __isl_give isl_val *isl_val_infty(isl_ctx *ctx);
369         __isl_give isl_val *isl_val_neginfty(isl_ctx *ctx);
371 Specific integer values can be created using the following functions.
373         #include <isl/val.h>
374         __isl_give isl_val *isl_val_int_from_si(isl_ctx *ctx,
375                 long i);
376         __isl_give isl_val *isl_val_int_from_ui(isl_ctx *ctx,
377                 unsigned long u);
378         __isl_give isl_val *isl_val_int_from_chunks(isl_ctx *ctx,
379                 size_t n, size_t size, const void *chunks);
381 The function C<isl_val_int_from_chunks> constructs an C<isl_val>
382 from the C<n> I<digits>, each consisting of C<size> bytes, stored at C<chunks>.
383 The least significant digit is assumed to be stored first.
385 Value objects can be copied and freed using the following functions.
387         #include <isl/val.h>
388         __isl_give isl_val *isl_val_copy(__isl_keep isl_val *v);
389         void *isl_val_free(__isl_take isl_val *v);
391 They can be inspected using the following functions.
393         #include <isl/val.h>
394         isl_ctx *isl_val_get_ctx(__isl_keep isl_val *val);
395         long isl_val_get_num_si(__isl_keep isl_val *v);
396         long isl_val_get_den_si(__isl_keep isl_val *v);
397         double isl_val_get_d(__isl_keep isl_val *v);
398         size_t isl_val_n_abs_num_chunks(__isl_keep isl_val *v,
399                 size_t size);
400         int isl_val_get_abs_num_chunks(__isl_keep isl_val *v,
401                 size_t size, void *chunks);
403 C<isl_val_n_abs_num_chunks> returns the number of I<digits>
404 of C<size> bytes needed to store the absolute value of the
405 numerator of C<v>.
406 C<isl_val_get_abs_num_chunks> stores these digits at C<chunks>,
407 which is assumed to have been preallocated by the caller.
408 The least significant digit is stored first.
409 Note that C<isl_val_get_num_si>, C<isl_val_get_den_si>,
410 C<isl_val_get_d>, C<isl_val_n_abs_num_chunks>
411 and C<isl_val_get_abs_num_chunks> can only be applied to rational values.
413 An C<isl_val> can be modified using the following function.
415         #include <isl/val.h>
416         __isl_give isl_val *isl_val_set_si(__isl_take isl_val *v,
417                 long i);
419 The following unary properties are defined on C<isl_val>s.
421         #include <isl/val.h>
422         int isl_val_sgn(__isl_keep isl_val *v);
423         int isl_val_is_zero(__isl_keep isl_val *v);
424         int isl_val_is_one(__isl_keep isl_val *v);
425         int isl_val_is_negone(__isl_keep isl_val *v);
426         int isl_val_is_nonneg(__isl_keep isl_val *v);
427         int isl_val_is_nonpos(__isl_keep isl_val *v);
428         int isl_val_is_pos(__isl_keep isl_val *v);
429         int isl_val_is_neg(__isl_keep isl_val *v);
430         int isl_val_is_int(__isl_keep isl_val *v);
431         int isl_val_is_rat(__isl_keep isl_val *v);
432         int isl_val_is_nan(__isl_keep isl_val *v);
433         int isl_val_is_infty(__isl_keep isl_val *v);
434         int isl_val_is_neginfty(__isl_keep isl_val *v);
436 Note that the sign of NaN is undefined.
438 The following binary properties are defined on pairs of C<isl_val>s.
440         #include <isl/val.h>
441         int isl_val_lt(__isl_keep isl_val *v1,
442                 __isl_keep isl_val *v2);
443         int isl_val_le(__isl_keep isl_val *v1,
444                 __isl_keep isl_val *v2);
445         int isl_val_gt(__isl_keep isl_val *v1,
446                 __isl_keep isl_val *v2);
447         int isl_val_ge(__isl_keep isl_val *v1,
448                 __isl_keep isl_val *v2);
449         int isl_val_eq(__isl_keep isl_val *v1,
450                 __isl_keep isl_val *v2);
451         int isl_val_ne(__isl_keep isl_val *v1,
452                 __isl_keep isl_val *v2);
454 For integer C<isl_val>s we additionally have the following binary property.
456         #include <isl/val.h>
457         int isl_val_is_divisible_by(__isl_keep isl_val *v1,
458                 __isl_keep isl_val *v2);
460 An C<isl_val> can also be compared to an integer using the following
461 function.  The result is undefined for NaN.
463         #include <isl/val.h>
464         int isl_val_cmp_si(__isl_keep isl_val *v, long i);
466 The following unary operations are available on C<isl_val>s.
468         #include <isl/val.h>
469         __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
470         __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
471         __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
472         __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
473         __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
475 The following binary operations are available on C<isl_val>s.
477         #include <isl/val.h>
478         __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
479         __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
480         __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
481         __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
482         __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
483         __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
484         __isl_give isl_val *isl_val_min(__isl_take isl_val *v1,
485                 __isl_take isl_val *v2);
486         __isl_give isl_val *isl_val_max(__isl_take isl_val *v1,
487                 __isl_take isl_val *v2);
488         __isl_give isl_val *isl_val_add(__isl_take isl_val *v1,
489                 __isl_take isl_val *v2);
490         __isl_give isl_val *isl_val_add_ui(__isl_take isl_val *v1,
491                 unsigned long v2);
492         __isl_give isl_val *isl_val_sub(__isl_take isl_val *v1,
493                 __isl_take isl_val *v2);
494         __isl_give isl_val *isl_val_sub_ui(__isl_take isl_val *v1,
495                 unsigned long v2);
496         __isl_give isl_val *isl_val_mul(__isl_take isl_val *v1,
497                 __isl_take isl_val *v2);
498         __isl_give isl_val *isl_val_mul_ui(__isl_take isl_val *v1,
499                 unsigned long v2);
500         __isl_give isl_val *isl_val_div(__isl_take isl_val *v1,
501                 __isl_take isl_val *v2);
503 On integer values, we additionally have the following operations.
505         #include <isl/val.h>
506         __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
507         __isl_give isl_val *isl_val_mod(__isl_take isl_val *v1,
508                 __isl_take isl_val *v2);
509         __isl_give isl_val *isl_val_gcd(__isl_take isl_val *v1,
510                 __isl_take isl_val *v2);
511         __isl_give isl_val *isl_val_gcdext(__isl_take isl_val *v1,
512                 __isl_take isl_val *v2, __isl_give isl_val **x,
513                 __isl_give isl_val **y);
515 The function C<isl_val_gcdext> returns the greatest common divisor g
516 of C<v1> and C<v2> as well as two integers C<*x> and C<*y> such
517 that C<*x> * C<v1> + C<*y> * C<v2> = g.
519 A value can be read from input using
521         #include <isl/val.h>
522         __isl_give isl_val *isl_val_read_from_str(isl_ctx *ctx,
523                 const char *str);
525 A value can be printed using
527         #include <isl/val.h>
528         __isl_give isl_printer *isl_printer_print_val(
529                 __isl_take isl_printer *p, __isl_keep isl_val *v);
531 =head3 GMP specific functions
533 These functions are only available if C<isl> has been compiled with C<GMP>
534 support.
536 Specific integer and rational values can be created from C<GMP> values using
537 the following functions.
539         #include <isl/val_gmp.h>
540         __isl_give isl_val *isl_val_int_from_gmp(isl_ctx *ctx,
541                 mpz_t z);
542         __isl_give isl_val *isl_val_from_gmp(isl_ctx *ctx,
543                 const mpz_t n, const mpz_t d);
545 The numerator and denominator of a rational value can be extracted as
546 C<GMP> values using the following functions.
548         #include <isl/val_gmp.h>
549         int isl_val_get_num_gmp(__isl_keep isl_val *v, mpz_t z);
550         int isl_val_get_den_gmp(__isl_keep isl_val *v, mpz_t z);
552 =head2 Sets and Relations
554 C<isl> uses six types of objects for representing sets and relations,
555 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
556 C<isl_union_set> and C<isl_union_map>.
557 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
558 can be described as a conjunction of affine constraints, while
559 C<isl_set> and C<isl_map> represent unions of
560 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
561 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
562 to live in the same space.  C<isl_union_set>s and C<isl_union_map>s
563 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
564 where spaces are considered different if they have a different number
565 of dimensions and/or different names (see L<"Spaces">).
566 The difference between sets and relations (maps) is that sets have
567 one set of variables, while relations have two sets of variables,
568 input variables and output variables.
570 =head2 Memory Management
572 Since a high-level operation on sets and/or relations usually involves
573 several substeps and since the user is usually not interested in
574 the intermediate results, most functions that return a new object
575 will also release all the objects passed as arguments.
576 If the user still wants to use one or more of these arguments
577 after the function call, she should pass along a copy of the
578 object rather than the object itself.
579 The user is then responsible for making sure that the original
580 object gets used somewhere else or is explicitly freed.
582 The arguments and return values of all documented functions are
583 annotated to make clear which arguments are released and which
584 arguments are preserved.  In particular, the following annotations
585 are used
587 =over
589 =item C<__isl_give>
591 C<__isl_give> means that a new object is returned.
592 The user should make sure that the returned pointer is
593 used exactly once as a value for an C<__isl_take> argument.
594 In between, it can be used as a value for as many
595 C<__isl_keep> arguments as the user likes.
596 There is one exception, and that is the case where the
597 pointer returned is C<NULL>.  Is this case, the user
598 is free to use it as an C<__isl_take> argument or not.
600 =item C<__isl_take>
602 C<__isl_take> means that the object the argument points to
603 is taken over by the function and may no longer be used
604 by the user as an argument to any other function.
605 The pointer value must be one returned by a function
606 returning an C<__isl_give> pointer.
607 If the user passes in a C<NULL> value, then this will
608 be treated as an error in the sense that the function will
609 not perform its usual operation.  However, it will still
610 make sure that all the other C<__isl_take> arguments
611 are released.
613 =item C<__isl_keep>
615 C<__isl_keep> means that the function will only use the object
616 temporarily.  After the function has finished, the user
617 can still use it as an argument to other functions.
618 A C<NULL> value will be treated in the same way as
619 a C<NULL> value for an C<__isl_take> argument.
621 =back
623 =head2 Error Handling
625 C<isl> supports different ways to react in case a runtime error is triggered.
626 Runtime errors arise, e.g., if a function such as C<isl_map_intersect> is called
627 with two maps that have incompatible spaces. There are three possible ways
628 to react on error: to warn, to continue or to abort.
630 The default behavior is to warn. In this mode, C<isl> prints a warning, stores
631 the last error in the corresponding C<isl_ctx> and the function in which the
632 error was triggered returns C<NULL>. An error does not corrupt internal state,
633 such that isl can continue to be used. C<isl> also provides functions to
634 read the last error and to reset the memory that stores the last error. The
635 last error is only stored for information purposes. Its presence does not
636 change the behavior of C<isl>. Hence, resetting an error is not required to
637 continue to use isl, but only to observe new errors.
639         #include <isl/ctx.h>
640         enum isl_error isl_ctx_last_error(isl_ctx *ctx);
641         void isl_ctx_reset_error(isl_ctx *ctx);
643 Another option is to continue on error. This is similar to warn on error mode,
644 except that C<isl> does not print any warning. This allows a program to
645 implement its own error reporting.
647 The last option is to directly abort the execution of the program from within
648 the isl library. This makes it obviously impossible to recover from an error,
649 but it allows to directly spot the error location. By aborting on error,
650 debuggers break at the location the error occurred and can provide a stack
651 trace. Other tools that automatically provide stack traces on abort or that do
652 not want to continue execution after an error was triggered may also prefer to
653 abort on error.
655 The on error behavior of isl can be specified by calling
656 C<isl_options_set_on_error> or by setting the command line option
657 C<--isl-on-error>. Valid arguments for the function call are
658 C<ISL_ON_ERROR_WARN>, C<ISL_ON_ERROR_CONTINUE> and C<ISL_ON_ERROR_ABORT>. The
659 choices for the command line option are C<warn>, C<continue> and C<abort>.
660 It is also possible to query the current error mode.
662         #include <isl/options.h>
663         int isl_options_set_on_error(isl_ctx *ctx, int val);
664         int isl_options_get_on_error(isl_ctx *ctx);
666 =head2 Identifiers
668 Identifiers are used to identify both individual dimensions
669 and tuples of dimensions.  They consist of an optional name and an optional
670 user pointer.  The name and the user pointer cannot both be C<NULL>, however.
671 Identifiers with the same name but different pointer values
672 are considered to be distinct.
673 Similarly, identifiers with different names but the same pointer value
674 are also considered to be distinct.
675 Equal identifiers are represented using the same object.
676 Pairs of identifiers can therefore be tested for equality using the
677 C<==> operator.
678 Identifiers can be constructed, copied, freed, inspected and printed
679 using the following functions.
681         #include <isl/id.h>
682         __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
683                 __isl_keep const char *name, void *user);
684         __isl_give isl_id *isl_id_set_free_user(
685                 __isl_take isl_id *id,
686                 __isl_give void (*free_user)(void *user));
687         __isl_give isl_id *isl_id_copy(isl_id *id);
688         void *isl_id_free(__isl_take isl_id *id);
690         isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
691         void *isl_id_get_user(__isl_keep isl_id *id);
692         __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
694         __isl_give isl_printer *isl_printer_print_id(
695                 __isl_take isl_printer *p, __isl_keep isl_id *id);
697 The callback set by C<isl_id_set_free_user> is called on the user
698 pointer when the last reference to the C<isl_id> is freed.
699 Note that C<isl_id_get_name> returns a pointer to some internal
700 data structure, so the result can only be used while the
701 corresponding C<isl_id> is alive.
703 =head2 Spaces
705 Whenever a new set, relation or similiar object is created from scratch,
706 the space in which it lives needs to be specified using an C<isl_space>.
707 Each space involves zero or more parameters and zero, one or two
708 tuples of set or input/output dimensions.  The parameters and dimensions
709 are identified by an C<isl_dim_type> and a position.
710 The type C<isl_dim_param> refers to parameters,
711 the type C<isl_dim_set> refers to set dimensions (for spaces
712 with a single tuple of dimensions) and the types C<isl_dim_in>
713 and C<isl_dim_out> refer to input and output dimensions
714 (for spaces with two tuples of dimensions).
715 Local spaces (see L</"Local Spaces">) also contain dimensions
716 of type C<isl_dim_div>.
717 Note that parameters are only identified by their position within
718 a given object.  Across different objects, parameters are (usually)
719 identified by their names or identifiers.  Only unnamed parameters
720 are identified by their positions across objects.  The use of unnamed
721 parameters is discouraged.
723         #include <isl/space.h>
724         __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
725                 unsigned nparam, unsigned n_in, unsigned n_out);
726         __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
727                 unsigned nparam);
728         __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
729                 unsigned nparam, unsigned dim);
730         __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
731         void *isl_space_free(__isl_take isl_space *space);
732         unsigned isl_space_dim(__isl_keep isl_space *space,
733                 enum isl_dim_type type);
735 The space used for creating a parameter domain
736 needs to be created using C<isl_space_params_alloc>.
737 For other sets, the space
738 needs to be created using C<isl_space_set_alloc>, while
739 for a relation, the space
740 needs to be created using C<isl_space_alloc>.
741 C<isl_space_dim> can be used
742 to find out the number of dimensions of each type in
743 a space, where type may be
744 C<isl_dim_param>, C<isl_dim_in> (only for relations),
745 C<isl_dim_out> (only for relations), C<isl_dim_set>
746 (only for sets) or C<isl_dim_all>.
748 To check whether a given space is that of a set or a map
749 or whether it is a parameter space, use these functions:
751         #include <isl/space.h>
752         int isl_space_is_params(__isl_keep isl_space *space);
753         int isl_space_is_set(__isl_keep isl_space *space);
754         int isl_space_is_map(__isl_keep isl_space *space);
756 Spaces can be compared using the following functions:
758         #include <isl/space.h>
759         int isl_space_is_equal(__isl_keep isl_space *space1,
760                 __isl_keep isl_space *space2);
761         int isl_space_is_domain(__isl_keep isl_space *space1,
762                 __isl_keep isl_space *space2);
763         int isl_space_is_range(__isl_keep isl_space *space1,
764                 __isl_keep isl_space *space2);
766 C<isl_space_is_domain> checks whether the first argument is equal
767 to the domain of the second argument.  This requires in particular that
768 the first argument is a set space and that the second argument
769 is a map space.
771 It is often useful to create objects that live in the
772 same space as some other object.  This can be accomplished
773 by creating the new objects
774 (see L</"Creating New Sets and Relations"> or
775 L</"Creating New (Piecewise) Quasipolynomials">) based on the space
776 of the original object.
778         #include <isl/set.h>
779         __isl_give isl_space *isl_basic_set_get_space(
780                 __isl_keep isl_basic_set *bset);
781         __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
783         #include <isl/union_set.h>
784         __isl_give isl_space *isl_union_set_get_space(
785                 __isl_keep isl_union_set *uset);
787         #include <isl/map.h>
788         __isl_give isl_space *isl_basic_map_get_space(
789                 __isl_keep isl_basic_map *bmap);
790         __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
792         #include <isl/union_map.h>
793         __isl_give isl_space *isl_union_map_get_space(
794                 __isl_keep isl_union_map *umap);
796         #include <isl/constraint.h>
797         __isl_give isl_space *isl_constraint_get_space(
798                 __isl_keep isl_constraint *constraint);
800         #include <isl/polynomial.h>
801         __isl_give isl_space *isl_qpolynomial_get_domain_space(
802                 __isl_keep isl_qpolynomial *qp);
803         __isl_give isl_space *isl_qpolynomial_get_space(
804                 __isl_keep isl_qpolynomial *qp);
805         __isl_give isl_space *isl_qpolynomial_fold_get_space(
806                 __isl_keep isl_qpolynomial_fold *fold);
807         __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
808                 __isl_keep isl_pw_qpolynomial *pwqp);
809         __isl_give isl_space *isl_pw_qpolynomial_get_space(
810                 __isl_keep isl_pw_qpolynomial *pwqp);
811         __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
812                 __isl_keep isl_pw_qpolynomial_fold *pwf);
813         __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
814                 __isl_keep isl_pw_qpolynomial_fold *pwf);
815         __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
816                 __isl_keep isl_union_pw_qpolynomial *upwqp);
817         __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
818                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
820         #include <isl/val.h>
821         __isl_give isl_space *isl_multi_val_get_space(
822                 __isl_keep isl_multi_val *mv);
824         #include <isl/aff.h>
825         __isl_give isl_space *isl_aff_get_domain_space(
826                 __isl_keep isl_aff *aff);
827         __isl_give isl_space *isl_aff_get_space(
828                 __isl_keep isl_aff *aff);
829         __isl_give isl_space *isl_pw_aff_get_domain_space(
830                 __isl_keep isl_pw_aff *pwaff);
831         __isl_give isl_space *isl_pw_aff_get_space(
832                 __isl_keep isl_pw_aff *pwaff);
833         __isl_give isl_space *isl_multi_aff_get_domain_space(
834                 __isl_keep isl_multi_aff *maff);
835         __isl_give isl_space *isl_multi_aff_get_space(
836                 __isl_keep isl_multi_aff *maff);
837         __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
838                 __isl_keep isl_pw_multi_aff *pma);
839         __isl_give isl_space *isl_pw_multi_aff_get_space(
840                 __isl_keep isl_pw_multi_aff *pma);
841         __isl_give isl_space *isl_union_pw_multi_aff_get_space(
842                 __isl_keep isl_union_pw_multi_aff *upma);
843         __isl_give isl_space *isl_multi_pw_aff_get_domain_space(
844                 __isl_keep isl_multi_pw_aff *mpa);
845         __isl_give isl_space *isl_multi_pw_aff_get_space(
846                 __isl_keep isl_multi_pw_aff *mpa);
848         #include <isl/point.h>
849         __isl_give isl_space *isl_point_get_space(
850                 __isl_keep isl_point *pnt);
852 The identifiers or names of the individual dimensions may be set or read off
853 using the following functions.
855         #include <isl/space.h>
856         __isl_give isl_space *isl_space_set_dim_id(
857                 __isl_take isl_space *space,
858                 enum isl_dim_type type, unsigned pos,
859                 __isl_take isl_id *id);
860         int isl_space_has_dim_id(__isl_keep isl_space *space,
861                 enum isl_dim_type type, unsigned pos);
862         __isl_give isl_id *isl_space_get_dim_id(
863                 __isl_keep isl_space *space,
864                 enum isl_dim_type type, unsigned pos);
865         __isl_give isl_space *isl_space_set_dim_name(
866                 __isl_take isl_space *space,
867                  enum isl_dim_type type, unsigned pos,
868                  __isl_keep const char *name);
869         int isl_space_has_dim_name(__isl_keep isl_space *space,
870                 enum isl_dim_type type, unsigned pos);
871         __isl_keep const char *isl_space_get_dim_name(
872                 __isl_keep isl_space *space,
873                 enum isl_dim_type type, unsigned pos);
875 Note that C<isl_space_get_name> returns a pointer to some internal
876 data structure, so the result can only be used while the
877 corresponding C<isl_space> is alive.
878 Also note that every function that operates on two sets or relations
879 requires that both arguments have the same parameters.  This also
880 means that if one of the arguments has named parameters, then the
881 other needs to have named parameters too and the names need to match.
882 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
883 arguments may have different parameters (as long as they are named),
884 in which case the result will have as parameters the union of the parameters of
885 the arguments.
887 Given the identifier or name of a dimension (typically a parameter),
888 its position can be obtained from the following function.
890         #include <isl/space.h>
891         int isl_space_find_dim_by_id(__isl_keep isl_space *space,
892                 enum isl_dim_type type, __isl_keep isl_id *id);
893         int isl_space_find_dim_by_name(__isl_keep isl_space *space,
894                 enum isl_dim_type type, const char *name);
896 The identifiers or names of entire spaces may be set or read off
897 using the following functions.
899         #include <isl/space.h>
900         __isl_give isl_space *isl_space_set_tuple_id(
901                 __isl_take isl_space *space,
902                 enum isl_dim_type type, __isl_take isl_id *id);
903         __isl_give isl_space *isl_space_reset_tuple_id(
904                 __isl_take isl_space *space, enum isl_dim_type type);
905         int isl_space_has_tuple_id(__isl_keep isl_space *space,
906                 enum isl_dim_type type);
907         __isl_give isl_id *isl_space_get_tuple_id(
908                 __isl_keep isl_space *space, enum isl_dim_type type);
909         __isl_give isl_space *isl_space_set_tuple_name(
910                 __isl_take isl_space *space,
911                 enum isl_dim_type type, const char *s);
912         int isl_space_has_tuple_name(__isl_keep isl_space *space,
913                 enum isl_dim_type type);
914         const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
915                 enum isl_dim_type type);
917 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
918 or C<isl_dim_set>.  As with C<isl_space_get_name>,
919 the C<isl_space_get_tuple_name> function returns a pointer to some internal
920 data structure.
921 Binary operations require the corresponding spaces of their arguments
922 to have the same name.
924 To keep the names of all parameters and tuples, but reset the user pointers
925 of all the corresponding identifiers, use the following function.
927         __isl_give isl_space *isl_space_reset_user(
928                 __isl_take isl_space *space);
930 Spaces can be nested.  In particular, the domain of a set or
931 the domain or range of a relation can be a nested relation.
932 This process is also called I<wrapping>.
933 The functions for detecting, constructing and deconstructing
934 such nested spaces can be found in the wrapping properties
935 of L</"Unary Properties">, the wrapping operations
936 of L</"Unary Operations"> and the Cartesian product operations
937 of L</"Basic Operations">.
939 Spaces can be created from other spaces
940 using the following functions.
942         __isl_give isl_space *isl_space_domain(__isl_take isl_space *space);
943         __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *space);
944         __isl_give isl_space *isl_space_range(__isl_take isl_space *space);
945         __isl_give isl_space *isl_space_from_range(__isl_take isl_space *space);
946         __isl_give isl_space *isl_space_domain_map(
947                 __isl_take isl_space *space);
948         __isl_give isl_space *isl_space_range_map(
949                 __isl_take isl_space *space);
950         __isl_give isl_space *isl_space_params(
951                 __isl_take isl_space *space);
952         __isl_give isl_space *isl_space_set_from_params(
953                 __isl_take isl_space *space);
954         __isl_give isl_space *isl_space_reverse(__isl_take isl_space *space);
955         __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
956                 __isl_take isl_space *right);
957         __isl_give isl_space *isl_space_align_params(
958                 __isl_take isl_space *space1, __isl_take isl_space *space2)
959         __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *space,
960                 enum isl_dim_type type, unsigned pos, unsigned n);
961         __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *space,
962                 enum isl_dim_type type, unsigned n);
963         __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *space,
964                 enum isl_dim_type type, unsigned first, unsigned n);
965         __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *space,
966                 enum isl_dim_type dst_type, unsigned dst_pos,
967                 enum isl_dim_type src_type, unsigned src_pos,
968                 unsigned n);
969         __isl_give isl_space *isl_space_map_from_set(
970                 __isl_take isl_space *space);
971         __isl_give isl_space *isl_space_map_from_domain_and_range(
972                 __isl_take isl_space *domain,
973                 __isl_take isl_space *range);
974         __isl_give isl_space *isl_space_zip(__isl_take isl_space *space);
975         __isl_give isl_space *isl_space_curry(
976                 __isl_take isl_space *space);
977         __isl_give isl_space *isl_space_uncurry(
978                 __isl_take isl_space *space);
980 Note that if dimensions are added or removed from a space, then
981 the name and the internal structure are lost.
983 =head2 Local Spaces
985 A local space is essentially a space with
986 zero or more existentially quantified variables.
987 The local space of a (constraint of a) basic set or relation can be obtained
988 using the following functions.
990         #include <isl/constraint.h>
991         __isl_give isl_local_space *isl_constraint_get_local_space(
992                 __isl_keep isl_constraint *constraint);
994         #include <isl/set.h>
995         __isl_give isl_local_space *isl_basic_set_get_local_space(
996                 __isl_keep isl_basic_set *bset);
998         #include <isl/map.h>
999         __isl_give isl_local_space *isl_basic_map_get_local_space(
1000                 __isl_keep isl_basic_map *bmap);
1002 A new local space can be created from a space using
1004         #include <isl/local_space.h>
1005         __isl_give isl_local_space *isl_local_space_from_space(
1006                 __isl_take isl_space *space);
1008 They can be inspected, modified, copied and freed using the following functions.
1010         #include <isl/local_space.h>
1011         isl_ctx *isl_local_space_get_ctx(
1012                 __isl_keep isl_local_space *ls);
1013         int isl_local_space_is_set(__isl_keep isl_local_space *ls);
1014         int isl_local_space_dim(__isl_keep isl_local_space *ls,
1015                 enum isl_dim_type type);
1016         __isl_give isl_local_space *isl_local_space_set_tuple_id(
1017                 __isl_take isl_local_space *ls,
1018                 enum isl_dim_type type, __isl_take isl_id *id);
1019         int isl_local_space_has_dim_id(
1020                 __isl_keep isl_local_space *ls,
1021                 enum isl_dim_type type, unsigned pos);
1022         __isl_give isl_id *isl_local_space_get_dim_id(
1023                 __isl_keep isl_local_space *ls,
1024                 enum isl_dim_type type, unsigned pos);
1025         int isl_local_space_has_dim_name(
1026                 __isl_keep isl_local_space *ls,
1027                 enum isl_dim_type type, unsigned pos)
1028         const char *isl_local_space_get_dim_name(
1029                 __isl_keep isl_local_space *ls,
1030                 enum isl_dim_type type, unsigned pos);
1031         __isl_give isl_local_space *isl_local_space_set_dim_name(
1032                 __isl_take isl_local_space *ls,
1033                 enum isl_dim_type type, unsigned pos, const char *s);
1034         __isl_give isl_local_space *isl_local_space_set_dim_id(
1035                 __isl_take isl_local_space *ls,
1036                 enum isl_dim_type type, unsigned pos,
1037                 __isl_take isl_id *id);
1038         __isl_give isl_space *isl_local_space_get_space(
1039                 __isl_keep isl_local_space *ls);
1040         __isl_give isl_aff *isl_local_space_get_div(
1041                 __isl_keep isl_local_space *ls, int pos);
1042         __isl_give isl_local_space *isl_local_space_copy(
1043                 __isl_keep isl_local_space *ls);
1044         void *isl_local_space_free(__isl_take isl_local_space *ls);
1046 Note that C<isl_local_space_get_div> can only be used on local spaces
1047 of sets.
1049 Two local spaces can be compared using
1051         int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
1052                 __isl_keep isl_local_space *ls2);
1054 Local spaces can be created from other local spaces
1055 using the functions described in L</"Unary Operations">
1056 and L</"Binary Operations">.
1058 =head2 Input and Output
1060 C<isl> supports its own input/output format, which is similar
1061 to the C<Omega> format, but also supports the C<PolyLib> format
1062 in some cases.
1064 =head3 C<isl> format
1066 The C<isl> format is similar to that of C<Omega>, but has a different
1067 syntax for describing the parameters and allows for the definition
1068 of an existentially quantified variable as the integer division
1069 of an affine expression.
1070 For example, the set of integers C<i> between C<0> and C<n>
1071 such that C<i % 10 <= 6> can be described as
1073         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
1074                                 i - 10 a <= 6) }
1076 A set or relation can have several disjuncts, separated
1077 by the keyword C<or>.  Each disjunct is either a conjunction
1078 of constraints or a projection (C<exists>) of a conjunction
1079 of constraints.  The constraints are separated by the keyword
1080 C<and>.
1082 =head3 C<PolyLib> format
1084 If the represented set is a union, then the first line
1085 contains a single number representing the number of disjuncts.
1086 Otherwise, a line containing the number C<1> is optional.
1088 Each disjunct is represented by a matrix of constraints.
1089 The first line contains two numbers representing
1090 the number of rows and columns,
1091 where the number of rows is equal to the number of constraints
1092 and the number of columns is equal to two plus the number of variables.
1093 The following lines contain the actual rows of the constraint matrix.
1094 In each row, the first column indicates whether the constraint
1095 is an equality (C<0>) or inequality (C<1>).  The final column
1096 corresponds to the constant term.
1098 If the set is parametric, then the coefficients of the parameters
1099 appear in the last columns before the constant column.
1100 The coefficients of any existentially quantified variables appear
1101 between those of the set variables and those of the parameters.
1103 =head3 Extended C<PolyLib> format
1105 The extended C<PolyLib> format is nearly identical to the
1106 C<PolyLib> format.  The only difference is that the line
1107 containing the number of rows and columns of a constraint matrix
1108 also contains four additional numbers:
1109 the number of output dimensions, the number of input dimensions,
1110 the number of local dimensions (i.e., the number of existentially
1111 quantified variables) and the number of parameters.
1112 For sets, the number of ``output'' dimensions is equal
1113 to the number of set dimensions, while the number of ``input''
1114 dimensions is zero.
1116 =head3 Input
1118         #include <isl/set.h>
1119         __isl_give isl_basic_set *isl_basic_set_read_from_file(
1120                 isl_ctx *ctx, FILE *input);
1121         __isl_give isl_basic_set *isl_basic_set_read_from_str(
1122                 isl_ctx *ctx, const char *str);
1123         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
1124                 FILE *input);
1125         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
1126                 const char *str);
1128         #include <isl/map.h>
1129         __isl_give isl_basic_map *isl_basic_map_read_from_file(
1130                 isl_ctx *ctx, FILE *input);
1131         __isl_give isl_basic_map *isl_basic_map_read_from_str(
1132                 isl_ctx *ctx, const char *str);
1133         __isl_give isl_map *isl_map_read_from_file(
1134                 isl_ctx *ctx, FILE *input);
1135         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
1136                 const char *str);
1138         #include <isl/union_set.h>
1139         __isl_give isl_union_set *isl_union_set_read_from_file(
1140                 isl_ctx *ctx, FILE *input);
1141         __isl_give isl_union_set *isl_union_set_read_from_str(
1142                 isl_ctx *ctx, const char *str);
1144         #include <isl/union_map.h>
1145         __isl_give isl_union_map *isl_union_map_read_from_file(
1146                 isl_ctx *ctx, FILE *input);
1147         __isl_give isl_union_map *isl_union_map_read_from_str(
1148                 isl_ctx *ctx, const char *str);
1150 The input format is autodetected and may be either the C<PolyLib> format
1151 or the C<isl> format.
1153 =head3 Output
1155 Before anything can be printed, an C<isl_printer> needs to
1156 be created.
1158         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
1159                 FILE *file);
1160         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
1161         void *isl_printer_free(__isl_take isl_printer *printer);
1162         __isl_give char *isl_printer_get_str(
1163                 __isl_keep isl_printer *printer);
1165 The printer can be inspected using the following functions.
1167         FILE *isl_printer_get_file(
1168                 __isl_keep isl_printer *printer);
1169         int isl_printer_get_output_format(
1170                 __isl_keep isl_printer *p);
1172 The behavior of the printer can be modified in various ways
1174         __isl_give isl_printer *isl_printer_set_output_format(
1175                 __isl_take isl_printer *p, int output_format);
1176         __isl_give isl_printer *isl_printer_set_indent(
1177                 __isl_take isl_printer *p, int indent);
1178         __isl_give isl_printer *isl_printer_indent(
1179                 __isl_take isl_printer *p, int indent);
1180         __isl_give isl_printer *isl_printer_set_prefix(
1181                 __isl_take isl_printer *p, const char *prefix);
1182         __isl_give isl_printer *isl_printer_set_suffix(
1183                 __isl_take isl_printer *p, const char *suffix);
1185 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
1186 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
1187 and defaults to C<ISL_FORMAT_ISL>.
1188 Each line in the output is indented by C<indent> (set by
1189 C<isl_printer_set_indent>) spaces
1190 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
1191 In the C<PolyLib> format output,
1192 the coefficients of the existentially quantified variables
1193 appear between those of the set variables and those
1194 of the parameters.
1195 The function C<isl_printer_indent> increases the indentation
1196 by the specified amount (which may be negative).
1198 To actually print something, use
1200         #include <isl/printer.h>
1201         __isl_give isl_printer *isl_printer_print_double(
1202                 __isl_take isl_printer *p, double d);
1204         #include <isl/set.h>
1205         __isl_give isl_printer *isl_printer_print_basic_set(
1206                 __isl_take isl_printer *printer,
1207                 __isl_keep isl_basic_set *bset);
1208         __isl_give isl_printer *isl_printer_print_set(
1209                 __isl_take isl_printer *printer,
1210                 __isl_keep isl_set *set);
1212         #include <isl/map.h>
1213         __isl_give isl_printer *isl_printer_print_basic_map(
1214                 __isl_take isl_printer *printer,
1215                 __isl_keep isl_basic_map *bmap);
1216         __isl_give isl_printer *isl_printer_print_map(
1217                 __isl_take isl_printer *printer,
1218                 __isl_keep isl_map *map);
1220         #include <isl/union_set.h>
1221         __isl_give isl_printer *isl_printer_print_union_set(
1222                 __isl_take isl_printer *p,
1223                 __isl_keep isl_union_set *uset);
1225         #include <isl/union_map.h>
1226         __isl_give isl_printer *isl_printer_print_union_map(
1227                 __isl_take isl_printer *p,
1228                 __isl_keep isl_union_map *umap);
1230 When called on a file printer, the following function flushes
1231 the file.  When called on a string printer, the buffer is cleared.
1233         __isl_give isl_printer *isl_printer_flush(
1234                 __isl_take isl_printer *p);
1236 =head2 Creating New Sets and Relations
1238 C<isl> has functions for creating some standard sets and relations.
1240 =over
1242 =item * Empty sets and relations
1244         __isl_give isl_basic_set *isl_basic_set_empty(
1245                 __isl_take isl_space *space);
1246         __isl_give isl_basic_map *isl_basic_map_empty(
1247                 __isl_take isl_space *space);
1248         __isl_give isl_set *isl_set_empty(
1249                 __isl_take isl_space *space);
1250         __isl_give isl_map *isl_map_empty(
1251                 __isl_take isl_space *space);
1252         __isl_give isl_union_set *isl_union_set_empty(
1253                 __isl_take isl_space *space);
1254         __isl_give isl_union_map *isl_union_map_empty(
1255                 __isl_take isl_space *space);
1257 For C<isl_union_set>s and C<isl_union_map>s, the space
1258 is only used to specify the parameters.
1260 =item * Universe sets and relations
1262         __isl_give isl_basic_set *isl_basic_set_universe(
1263                 __isl_take isl_space *space);
1264         __isl_give isl_basic_map *isl_basic_map_universe(
1265                 __isl_take isl_space *space);
1266         __isl_give isl_set *isl_set_universe(
1267                 __isl_take isl_space *space);
1268         __isl_give isl_map *isl_map_universe(
1269                 __isl_take isl_space *space);
1270         __isl_give isl_union_set *isl_union_set_universe(
1271                 __isl_take isl_union_set *uset);
1272         __isl_give isl_union_map *isl_union_map_universe(
1273                 __isl_take isl_union_map *umap);
1275 The sets and relations constructed by the functions above
1276 contain all integer values, while those constructed by the
1277 functions below only contain non-negative values.
1279         __isl_give isl_basic_set *isl_basic_set_nat_universe(
1280                 __isl_take isl_space *space);
1281         __isl_give isl_basic_map *isl_basic_map_nat_universe(
1282                 __isl_take isl_space *space);
1283         __isl_give isl_set *isl_set_nat_universe(
1284                 __isl_take isl_space *space);
1285         __isl_give isl_map *isl_map_nat_universe(
1286                 __isl_take isl_space *space);
1288 =item * Identity relations
1290         __isl_give isl_basic_map *isl_basic_map_identity(
1291                 __isl_take isl_space *space);
1292         __isl_give isl_map *isl_map_identity(
1293                 __isl_take isl_space *space);
1295 The number of input and output dimensions in C<space> needs
1296 to be the same.
1298 =item * Lexicographic order
1300         __isl_give isl_map *isl_map_lex_lt(
1301                 __isl_take isl_space *set_space);
1302         __isl_give isl_map *isl_map_lex_le(
1303                 __isl_take isl_space *set_space);
1304         __isl_give isl_map *isl_map_lex_gt(
1305                 __isl_take isl_space *set_space);
1306         __isl_give isl_map *isl_map_lex_ge(
1307                 __isl_take isl_space *set_space);
1308         __isl_give isl_map *isl_map_lex_lt_first(
1309                 __isl_take isl_space *space, unsigned n);
1310         __isl_give isl_map *isl_map_lex_le_first(
1311                 __isl_take isl_space *space, unsigned n);
1312         __isl_give isl_map *isl_map_lex_gt_first(
1313                 __isl_take isl_space *space, unsigned n);
1314         __isl_give isl_map *isl_map_lex_ge_first(
1315                 __isl_take isl_space *space, unsigned n);
1317 The first four functions take a space for a B<set>
1318 and return relations that express that the elements in the domain
1319 are lexicographically less
1320 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1321 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1322 than the elements in the range.
1323 The last four functions take a space for a map
1324 and return relations that express that the first C<n> dimensions
1325 in the domain are lexicographically less
1326 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1327 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1328 than the first C<n> dimensions in the range.
1330 =back
1332 A basic set or relation can be converted to a set or relation
1333 using the following functions.
1335         __isl_give isl_set *isl_set_from_basic_set(
1336                 __isl_take isl_basic_set *bset);
1337         __isl_give isl_map *isl_map_from_basic_map(
1338                 __isl_take isl_basic_map *bmap);
1340 Sets and relations can be converted to union sets and relations
1341 using the following functions.
1343         __isl_give isl_union_set *isl_union_set_from_basic_set(
1344                 __isl_take isl_basic_set *bset);
1345         __isl_give isl_union_map *isl_union_map_from_basic_map(
1346                 __isl_take isl_basic_map *bmap);
1347         __isl_give isl_union_set *isl_union_set_from_set(
1348                 __isl_take isl_set *set);
1349         __isl_give isl_union_map *isl_union_map_from_map(
1350                 __isl_take isl_map *map);
1352 The inverse conversions below can only be used if the input
1353 union set or relation is known to contain elements in exactly one
1354 space.
1356         __isl_give isl_set *isl_set_from_union_set(
1357                 __isl_take isl_union_set *uset);
1358         __isl_give isl_map *isl_map_from_union_map(
1359                 __isl_take isl_union_map *umap);
1361 A zero-dimensional (basic) set can be constructed on a given parameter domain
1362 using the following function.
1364         __isl_give isl_basic_set *isl_basic_set_from_params(
1365                 __isl_take isl_basic_set *bset);
1366         __isl_give isl_set *isl_set_from_params(
1367                 __isl_take isl_set *set);
1369 Sets and relations can be copied and freed again using the following
1370 functions.
1372         __isl_give isl_basic_set *isl_basic_set_copy(
1373                 __isl_keep isl_basic_set *bset);
1374         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1375         __isl_give isl_union_set *isl_union_set_copy(
1376                 __isl_keep isl_union_set *uset);
1377         __isl_give isl_basic_map *isl_basic_map_copy(
1378                 __isl_keep isl_basic_map *bmap);
1379         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1380         __isl_give isl_union_map *isl_union_map_copy(
1381                 __isl_keep isl_union_map *umap);
1382         void *isl_basic_set_free(__isl_take isl_basic_set *bset);
1383         void *isl_set_free(__isl_take isl_set *set);
1384         void *isl_union_set_free(__isl_take isl_union_set *uset);
1385         void *isl_basic_map_free(__isl_take isl_basic_map *bmap);
1386         void *isl_map_free(__isl_take isl_map *map);
1387         void *isl_union_map_free(__isl_take isl_union_map *umap);
1389 Other sets and relations can be constructed by starting
1390 from a universe set or relation, adding equality and/or
1391 inequality constraints and then projecting out the
1392 existentially quantified variables, if any.
1393 Constraints can be constructed, manipulated and
1394 added to (or removed from) (basic) sets and relations
1395 using the following functions.
1397         #include <isl/constraint.h>
1398         __isl_give isl_constraint *isl_equality_alloc(
1399                 __isl_take isl_local_space *ls);
1400         __isl_give isl_constraint *isl_inequality_alloc(
1401                 __isl_take isl_local_space *ls);
1402         __isl_give isl_constraint *isl_constraint_set_constant_si(
1403                 __isl_take isl_constraint *constraint, int v);
1404         __isl_give isl_constraint *isl_constraint_set_constant_val(
1405                 __isl_take isl_constraint *constraint,
1406                 __isl_take isl_val *v);
1407         __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1408                 __isl_take isl_constraint *constraint,
1409                 enum isl_dim_type type, int pos, int v);
1410         __isl_give isl_constraint *
1411         isl_constraint_set_coefficient_val(
1412                 __isl_take isl_constraint *constraint,
1413                 enum isl_dim_type type, int pos,
1414                 __isl_take isl_val *v);
1415         __isl_give isl_basic_map *isl_basic_map_add_constraint(
1416                 __isl_take isl_basic_map *bmap,
1417                 __isl_take isl_constraint *constraint);
1418         __isl_give isl_basic_set *isl_basic_set_add_constraint(
1419                 __isl_take isl_basic_set *bset,
1420                 __isl_take isl_constraint *constraint);
1421         __isl_give isl_map *isl_map_add_constraint(
1422                 __isl_take isl_map *map,
1423                 __isl_take isl_constraint *constraint);
1424         __isl_give isl_set *isl_set_add_constraint(
1425                 __isl_take isl_set *set,
1426                 __isl_take isl_constraint *constraint);
1427         __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1428                 __isl_take isl_basic_set *bset,
1429                 __isl_take isl_constraint *constraint);
1431 For example, to create a set containing the even integers
1432 between 10 and 42, you would use the following code.
1434         isl_space *space;
1435         isl_local_space *ls;
1436         isl_constraint *c;
1437         isl_basic_set *bset;
1439         space = isl_space_set_alloc(ctx, 0, 2);
1440         bset = isl_basic_set_universe(isl_space_copy(space));
1441         ls = isl_local_space_from_space(space);
1443         c = isl_equality_alloc(isl_local_space_copy(ls));
1444         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1445         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1446         bset = isl_basic_set_add_constraint(bset, c);
1448         c = isl_inequality_alloc(isl_local_space_copy(ls));
1449         c = isl_constraint_set_constant_si(c, -10);
1450         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1451         bset = isl_basic_set_add_constraint(bset, c);
1453         c = isl_inequality_alloc(ls);
1454         c = isl_constraint_set_constant_si(c, 42);
1455         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1456         bset = isl_basic_set_add_constraint(bset, c);
1458         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1460 Or, alternatively,
1462         isl_basic_set *bset;
1463         bset = isl_basic_set_read_from_str(ctx,
1464                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1466 A basic set or relation can also be constructed from two matrices
1467 describing the equalities and the inequalities.
1469         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1470                 __isl_take isl_space *space,
1471                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1472                 enum isl_dim_type c1,
1473                 enum isl_dim_type c2, enum isl_dim_type c3,
1474                 enum isl_dim_type c4);
1475         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1476                 __isl_take isl_space *space,
1477                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1478                 enum isl_dim_type c1,
1479                 enum isl_dim_type c2, enum isl_dim_type c3,
1480                 enum isl_dim_type c4, enum isl_dim_type c5);
1482 The C<isl_dim_type> arguments indicate the order in which
1483 different kinds of variables appear in the input matrices
1484 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1485 C<isl_dim_set> and C<isl_dim_div> for sets and
1486 of C<isl_dim_cst>, C<isl_dim_param>,
1487 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1489 A (basic or union) set or relation can also be constructed from a
1490 (union) (piecewise) (multiple) affine expression
1491 or a list of affine expressions
1492 (See L<"Piecewise Quasi Affine Expressions"> and
1493 L<"Piecewise Multiple Quasi Affine Expressions">).
1495         __isl_give isl_basic_map *isl_basic_map_from_aff(
1496                 __isl_take isl_aff *aff);
1497         __isl_give isl_map *isl_map_from_aff(
1498                 __isl_take isl_aff *aff);
1499         __isl_give isl_set *isl_set_from_pw_aff(
1500                 __isl_take isl_pw_aff *pwaff);
1501         __isl_give isl_map *isl_map_from_pw_aff(
1502                 __isl_take isl_pw_aff *pwaff);
1503         __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1504                 __isl_take isl_space *domain_space,
1505                 __isl_take isl_aff_list *list);
1506         __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1507                 __isl_take isl_multi_aff *maff)
1508         __isl_give isl_map *isl_map_from_multi_aff(
1509                 __isl_take isl_multi_aff *maff)
1510         __isl_give isl_set *isl_set_from_pw_multi_aff(
1511                 __isl_take isl_pw_multi_aff *pma);
1512         __isl_give isl_map *isl_map_from_pw_multi_aff(
1513                 __isl_take isl_pw_multi_aff *pma);
1514         __isl_give isl_set *isl_set_from_multi_pw_aff(
1515                 __isl_take isl_multi_pw_aff *mpa);
1516         __isl_give isl_map *isl_map_from_multi_pw_aff(
1517                 __isl_take isl_multi_pw_aff *mpa);
1518         __isl_give isl_union_map *
1519         isl_union_map_from_union_pw_multi_aff(
1520                 __isl_take isl_union_pw_multi_aff *upma);
1522 The C<domain_space> argument describes the domain of the resulting
1523 basic relation.  It is required because the C<list> may consist
1524 of zero affine expressions.
1526 =head2 Inspecting Sets and Relations
1528 Usually, the user should not have to care about the actual constraints
1529 of the sets and maps, but should instead apply the abstract operations
1530 explained in the following sections.
1531 Occasionally, however, it may be required to inspect the individual
1532 coefficients of the constraints.  This section explains how to do so.
1533 In these cases, it may also be useful to have C<isl> compute
1534 an explicit representation of the existentially quantified variables.
1536         __isl_give isl_set *isl_set_compute_divs(
1537                 __isl_take isl_set *set);
1538         __isl_give isl_map *isl_map_compute_divs(
1539                 __isl_take isl_map *map);
1540         __isl_give isl_union_set *isl_union_set_compute_divs(
1541                 __isl_take isl_union_set *uset);
1542         __isl_give isl_union_map *isl_union_map_compute_divs(
1543                 __isl_take isl_union_map *umap);
1545 This explicit representation defines the existentially quantified
1546 variables as integer divisions of the other variables, possibly
1547 including earlier existentially quantified variables.
1548 An explicitly represented existentially quantified variable therefore
1549 has a unique value when the values of the other variables are known.
1550 If, furthermore, the same existentials, i.e., existentials
1551 with the same explicit representations, should appear in the
1552 same order in each of the disjuncts of a set or map, then the user should call
1553 either of the following functions.
1555         __isl_give isl_set *isl_set_align_divs(
1556                 __isl_take isl_set *set);
1557         __isl_give isl_map *isl_map_align_divs(
1558                 __isl_take isl_map *map);
1560 Alternatively, the existentially quantified variables can be removed
1561 using the following functions, which compute an overapproximation.
1563         __isl_give isl_basic_set *isl_basic_set_remove_divs(
1564                 __isl_take isl_basic_set *bset);
1565         __isl_give isl_basic_map *isl_basic_map_remove_divs(
1566                 __isl_take isl_basic_map *bmap);
1567         __isl_give isl_set *isl_set_remove_divs(
1568                 __isl_take isl_set *set);
1569         __isl_give isl_map *isl_map_remove_divs(
1570                 __isl_take isl_map *map);
1572 It is also possible to only remove those divs that are defined
1573 in terms of a given range of dimensions or only those for which
1574 no explicit representation is known.
1576         __isl_give isl_basic_set *
1577         isl_basic_set_remove_divs_involving_dims(
1578                 __isl_take isl_basic_set *bset,
1579                 enum isl_dim_type type,
1580                 unsigned first, unsigned n);
1581         __isl_give isl_basic_map *
1582         isl_basic_map_remove_divs_involving_dims(
1583                 __isl_take isl_basic_map *bmap,
1584                 enum isl_dim_type type,
1585                 unsigned first, unsigned n);
1586         __isl_give isl_set *isl_set_remove_divs_involving_dims(
1587                 __isl_take isl_set *set, enum isl_dim_type type,
1588                 unsigned first, unsigned n);
1589         __isl_give isl_map *isl_map_remove_divs_involving_dims(
1590                 __isl_take isl_map *map, enum isl_dim_type type,
1591                 unsigned first, unsigned n);
1593         __isl_give isl_basic_set *
1594         isl_basic_set_remove_unknown_divs(
1595                 __isl_take isl_basic_set *bset);
1596         __isl_give isl_set *isl_set_remove_unknown_divs(
1597                 __isl_take isl_set *set);
1598         __isl_give isl_map *isl_map_remove_unknown_divs(
1599                 __isl_take isl_map *map);
1601 To iterate over all the sets or maps in a union set or map, use
1603         int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1604                 int (*fn)(__isl_take isl_set *set, void *user),
1605                 void *user);
1606         int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1607                 int (*fn)(__isl_take isl_map *map, void *user),
1608                 void *user);
1610 The number of sets or maps in a union set or map can be obtained
1611 from
1613         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1614         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1616 To extract the set or map in a given space from a union, use
1618         __isl_give isl_set *isl_union_set_extract_set(
1619                 __isl_keep isl_union_set *uset,
1620                 __isl_take isl_space *space);
1621         __isl_give isl_map *isl_union_map_extract_map(
1622                 __isl_keep isl_union_map *umap,
1623                 __isl_take isl_space *space);
1625 To iterate over all the basic sets or maps in a set or map, use
1627         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1628                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1629                 void *user);
1630         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1631                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1632                 void *user);
1634 The callback function C<fn> should return 0 if successful and
1635 -1 if an error occurs.  In the latter case, or if any other error
1636 occurs, the above functions will return -1.
1638 It should be noted that C<isl> does not guarantee that
1639 the basic sets or maps passed to C<fn> are disjoint.
1640 If this is required, then the user should call one of
1641 the following functions first.
1643         __isl_give isl_set *isl_set_make_disjoint(
1644                 __isl_take isl_set *set);
1645         __isl_give isl_map *isl_map_make_disjoint(
1646                 __isl_take isl_map *map);
1648 The number of basic sets in a set can be obtained
1649 from
1651         int isl_set_n_basic_set(__isl_keep isl_set *set);
1653 To iterate over the constraints of a basic set or map, use
1655         #include <isl/constraint.h>
1657         int isl_basic_set_n_constraint(
1658                 __isl_keep isl_basic_set *bset);
1659         int isl_basic_set_foreach_constraint(
1660                 __isl_keep isl_basic_set *bset,
1661                 int (*fn)(__isl_take isl_constraint *c, void *user),
1662                 void *user);
1663         int isl_basic_map_foreach_constraint(
1664                 __isl_keep isl_basic_map *bmap,
1665                 int (*fn)(__isl_take isl_constraint *c, void *user),
1666                 void *user);
1667         void *isl_constraint_free(__isl_take isl_constraint *c);
1669 Again, the callback function C<fn> should return 0 if successful and
1670 -1 if an error occurs.  In the latter case, or if any other error
1671 occurs, the above functions will return -1.
1672 The constraint C<c> represents either an equality or an inequality.
1673 Use the following function to find out whether a constraint
1674 represents an equality.  If not, it represents an inequality.
1676         int isl_constraint_is_equality(
1677                 __isl_keep isl_constraint *constraint);
1679 The coefficients of the constraints can be inspected using
1680 the following functions.
1682         int isl_constraint_is_lower_bound(
1683                 __isl_keep isl_constraint *constraint,
1684                 enum isl_dim_type type, unsigned pos);
1685         int isl_constraint_is_upper_bound(
1686                 __isl_keep isl_constraint *constraint,
1687                 enum isl_dim_type type, unsigned pos);
1688         __isl_give isl_val *isl_constraint_get_constant_val(
1689                 __isl_keep isl_constraint *constraint);
1690         __isl_give isl_val *isl_constraint_get_coefficient_val(
1691                 __isl_keep isl_constraint *constraint,
1692                 enum isl_dim_type type, int pos);
1693         int isl_constraint_involves_dims(
1694                 __isl_keep isl_constraint *constraint,
1695                 enum isl_dim_type type, unsigned first, unsigned n);
1697 The explicit representations of the existentially quantified
1698 variables can be inspected using the following function.
1699 Note that the user is only allowed to use this function
1700 if the inspected set or map is the result of a call
1701 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1702 The existentially quantified variable is equal to the floor
1703 of the returned affine expression.  The affine expression
1704 itself can be inspected using the functions in
1705 L<"Piecewise Quasi Affine Expressions">.
1707         __isl_give isl_aff *isl_constraint_get_div(
1708                 __isl_keep isl_constraint *constraint, int pos);
1710 To obtain the constraints of a basic set or map in matrix
1711 form, use the following functions.
1713         __isl_give isl_mat *isl_basic_set_equalities_matrix(
1714                 __isl_keep isl_basic_set *bset,
1715                 enum isl_dim_type c1, enum isl_dim_type c2,
1716                 enum isl_dim_type c3, enum isl_dim_type c4);
1717         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1718                 __isl_keep isl_basic_set *bset,
1719                 enum isl_dim_type c1, enum isl_dim_type c2,
1720                 enum isl_dim_type c3, enum isl_dim_type c4);
1721         __isl_give isl_mat *isl_basic_map_equalities_matrix(
1722                 __isl_keep isl_basic_map *bmap,
1723                 enum isl_dim_type c1,
1724                 enum isl_dim_type c2, enum isl_dim_type c3,
1725                 enum isl_dim_type c4, enum isl_dim_type c5);
1726         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1727                 __isl_keep isl_basic_map *bmap,
1728                 enum isl_dim_type c1,
1729                 enum isl_dim_type c2, enum isl_dim_type c3,
1730                 enum isl_dim_type c4, enum isl_dim_type c5);
1732 The C<isl_dim_type> arguments dictate the order in which
1733 different kinds of variables appear in the resulting matrix
1734 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1735 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1737 The number of parameters, input, output or set dimensions can
1738 be obtained using the following functions.
1740         unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1741                 enum isl_dim_type type);
1742         unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1743                 enum isl_dim_type type);
1744         unsigned isl_set_dim(__isl_keep isl_set *set,
1745                 enum isl_dim_type type);
1746         unsigned isl_map_dim(__isl_keep isl_map *map,
1747                 enum isl_dim_type type);
1749 To check whether the description of a set or relation depends
1750 on one or more given dimensions, it is not necessary to iterate over all
1751 constraints.  Instead the following functions can be used.
1753         int isl_basic_set_involves_dims(
1754                 __isl_keep isl_basic_set *bset,
1755                 enum isl_dim_type type, unsigned first, unsigned n);
1756         int isl_set_involves_dims(__isl_keep isl_set *set,
1757                 enum isl_dim_type type, unsigned first, unsigned n);
1758         int isl_basic_map_involves_dims(
1759                 __isl_keep isl_basic_map *bmap,
1760                 enum isl_dim_type type, unsigned first, unsigned n);
1761         int isl_map_involves_dims(__isl_keep isl_map *map,
1762                 enum isl_dim_type type, unsigned first, unsigned n);
1764 Similarly, the following functions can be used to check whether
1765 a given dimension is involved in any lower or upper bound.
1767         int isl_set_dim_has_any_lower_bound(__isl_keep isl_set *set,
1768                 enum isl_dim_type type, unsigned pos);
1769         int isl_set_dim_has_any_upper_bound(__isl_keep isl_set *set,
1770                 enum isl_dim_type type, unsigned pos);
1772 Note that these functions return true even if there is a bound on
1773 the dimension on only some of the basic sets of C<set>.
1774 To check if they have a bound for all of the basic sets in C<set>,
1775 use the following functions instead.
1777         int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
1778                 enum isl_dim_type type, unsigned pos);
1779         int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
1780                 enum isl_dim_type type, unsigned pos);
1782 The identifiers or names of the domain and range spaces of a set
1783 or relation can be read off or set using the following functions.
1785         __isl_give isl_basic_set *isl_basic_set_set_tuple_id(
1786                 __isl_take isl_basic_set *bset,
1787                 __isl_take isl_id *id);
1788         __isl_give isl_set *isl_set_set_tuple_id(
1789                 __isl_take isl_set *set, __isl_take isl_id *id);
1790         __isl_give isl_set *isl_set_reset_tuple_id(
1791                 __isl_take isl_set *set);
1792         int isl_set_has_tuple_id(__isl_keep isl_set *set);
1793         __isl_give isl_id *isl_set_get_tuple_id(
1794                 __isl_keep isl_set *set);
1795         __isl_give isl_basic_map *isl_basic_map_set_tuple_id(
1796                 __isl_take isl_basic_map *bmap,
1797                 enum isl_dim_type type, __isl_take isl_id *id);
1798         __isl_give isl_map *isl_map_set_tuple_id(
1799                 __isl_take isl_map *map, enum isl_dim_type type,
1800                 __isl_take isl_id *id);
1801         __isl_give isl_map *isl_map_reset_tuple_id(
1802                 __isl_take isl_map *map, enum isl_dim_type type);
1803         int isl_map_has_tuple_id(__isl_keep isl_map *map,
1804                 enum isl_dim_type type);
1805         __isl_give isl_id *isl_map_get_tuple_id(
1806                 __isl_keep isl_map *map, enum isl_dim_type type);
1808         const char *isl_basic_set_get_tuple_name(
1809                 __isl_keep isl_basic_set *bset);
1810         __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1811                 __isl_take isl_basic_set *set, const char *s);
1812         int isl_set_has_tuple_name(__isl_keep isl_set *set);
1813         const char *isl_set_get_tuple_name(
1814                 __isl_keep isl_set *set);
1815         const char *isl_basic_map_get_tuple_name(
1816                 __isl_keep isl_basic_map *bmap,
1817                 enum isl_dim_type type);
1818         __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1819                 __isl_take isl_basic_map *bmap,
1820                 enum isl_dim_type type, const char *s);
1821         int isl_map_has_tuple_name(__isl_keep isl_map *map,
1822                 enum isl_dim_type type);
1823         const char *isl_map_get_tuple_name(
1824                 __isl_keep isl_map *map,
1825                 enum isl_dim_type type);
1827 As with C<isl_space_get_tuple_name>, the value returned points to
1828 an internal data structure.
1829 The identifiers, positions or names of individual dimensions can be
1830 read off using the following functions.
1832         __isl_give isl_id *isl_basic_set_get_dim_id(
1833                 __isl_keep isl_basic_set *bset,
1834                 enum isl_dim_type type, unsigned pos);
1835         __isl_give isl_set *isl_set_set_dim_id(
1836                 __isl_take isl_set *set, enum isl_dim_type type,
1837                 unsigned pos, __isl_take isl_id *id);
1838         int isl_set_has_dim_id(__isl_keep isl_set *set,
1839                 enum isl_dim_type type, unsigned pos);
1840         __isl_give isl_id *isl_set_get_dim_id(
1841                 __isl_keep isl_set *set, enum isl_dim_type type,
1842                 unsigned pos);
1843         int isl_basic_map_has_dim_id(
1844                 __isl_keep isl_basic_map *bmap,
1845                 enum isl_dim_type type, unsigned pos);
1846         __isl_give isl_map *isl_map_set_dim_id(
1847                 __isl_take isl_map *map, enum isl_dim_type type,
1848                 unsigned pos, __isl_take isl_id *id);
1849         int isl_map_has_dim_id(__isl_keep isl_map *map,
1850                 enum isl_dim_type type, unsigned pos);
1851         __isl_give isl_id *isl_map_get_dim_id(
1852                 __isl_keep isl_map *map, enum isl_dim_type type,
1853                 unsigned pos);
1855         int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1856                 enum isl_dim_type type, __isl_keep isl_id *id);
1857         int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1858                 enum isl_dim_type type, __isl_keep isl_id *id);
1859         int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1860                 enum isl_dim_type type, const char *name);
1861         int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1862                 enum isl_dim_type type, const char *name);
1864         const char *isl_constraint_get_dim_name(
1865                 __isl_keep isl_constraint *constraint,
1866                 enum isl_dim_type type, unsigned pos);
1867         const char *isl_basic_set_get_dim_name(
1868                 __isl_keep isl_basic_set *bset,
1869                 enum isl_dim_type type, unsigned pos);
1870         int isl_set_has_dim_name(__isl_keep isl_set *set,
1871                 enum isl_dim_type type, unsigned pos);
1872         const char *isl_set_get_dim_name(
1873                 __isl_keep isl_set *set,
1874                 enum isl_dim_type type, unsigned pos);
1875         const char *isl_basic_map_get_dim_name(
1876                 __isl_keep isl_basic_map *bmap,
1877                 enum isl_dim_type type, unsigned pos);
1878         int isl_map_has_dim_name(__isl_keep isl_map *map,
1879                 enum isl_dim_type type, unsigned pos);
1880         const char *isl_map_get_dim_name(
1881                 __isl_keep isl_map *map,
1882                 enum isl_dim_type type, unsigned pos);
1884 These functions are mostly useful to obtain the identifiers, positions
1885 or names of the parameters.  Identifiers of individual dimensions are
1886 essentially only useful for printing.  They are ignored by all other
1887 operations and may not be preserved across those operations.
1889 The user pointers on all parameters and tuples can be reset
1890 using the following functions.
1892         __isl_give isl_set *isl_set_reset_user(
1893                 __isl_take isl_set *set);
1894         __isl_give isl_map *isl_map_reset_user(
1895                 __isl_take isl_map *map);
1897 =head2 Properties
1899 =head3 Unary Properties
1901 =over
1903 =item * Emptiness
1905 The following functions test whether the given set or relation
1906 contains any integer points.  The ``plain'' variants do not perform
1907 any computations, but simply check if the given set or relation
1908 is already known to be empty.
1910         int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
1911         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
1912         int isl_set_plain_is_empty(__isl_keep isl_set *set);
1913         int isl_set_is_empty(__isl_keep isl_set *set);
1914         int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
1915         int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
1916         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
1917         int isl_map_plain_is_empty(__isl_keep isl_map *map);
1918         int isl_map_is_empty(__isl_keep isl_map *map);
1919         int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
1921 =item * Universality
1923         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
1924         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
1925         int isl_set_plain_is_universe(__isl_keep isl_set *set);
1927 =item * Single-valuedness
1929         int isl_basic_map_is_single_valued(
1930                 __isl_keep isl_basic_map *bmap);
1931         int isl_map_plain_is_single_valued(
1932                 __isl_keep isl_map *map);
1933         int isl_map_is_single_valued(__isl_keep isl_map *map);
1934         int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
1936 =item * Injectivity
1938         int isl_map_plain_is_injective(__isl_keep isl_map *map);
1939         int isl_map_is_injective(__isl_keep isl_map *map);
1940         int isl_union_map_plain_is_injective(
1941                 __isl_keep isl_union_map *umap);
1942         int isl_union_map_is_injective(
1943                 __isl_keep isl_union_map *umap);
1945 =item * Bijectivity
1947         int isl_map_is_bijective(__isl_keep isl_map *map);
1948         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
1950 =item * Position
1952         __isl_give isl_val *
1953         isl_basic_map_plain_get_val_if_fixed(
1954                 __isl_keep isl_basic_map *bmap,
1955                 enum isl_dim_type type, unsigned pos);
1956         __isl_give isl_val *isl_set_plain_get_val_if_fixed(
1957                 __isl_keep isl_set *set,
1958                 enum isl_dim_type type, unsigned pos);
1959         __isl_give isl_val *isl_map_plain_get_val_if_fixed(
1960                 __isl_keep isl_map *map,
1961                 enum isl_dim_type type, unsigned pos);
1963 If the set or relation obviously lies on a hyperplane where the given dimension
1964 has a fixed value, then return that value.
1965 Otherwise return NaN.
1967 =item * Stride
1969         int isl_set_dim_residue_class_val(
1970                 __isl_keep isl_set *set,
1971                 int pos, __isl_give isl_val **modulo,
1972                 __isl_give isl_val **residue);
1974 Check if the values of the given set dimension are equal to a fixed
1975 value modulo some integer value.  If so, assign the modulo to C<*modulo>
1976 and the fixed value to C<*residue>.  If the given dimension attains only
1977 a single value, then assign C<0> to C<*modulo> and the fixed value to
1978 C<*residue>.
1979 If the dimension does not attain only a single value and if no modulo
1980 can be found then assign C<1> to C<*modulo> and C<1> to C<*residue>.
1982 =item * Space
1984 To check whether a set is a parameter domain, use this function:
1986         int isl_set_is_params(__isl_keep isl_set *set);
1987         int isl_union_set_is_params(
1988                 __isl_keep isl_union_set *uset);
1990 =item * Wrapping
1992 The following functions check whether the space of the given
1993 (basic) set or relation range is a wrapped relation.
1995         #include <isl/space.h>
1996         int isl_space_is_wrapping(
1997                 __isl_keep isl_space *space);
1998         int isl_space_domain_is_wrapping(
1999                 __isl_keep isl_space *space);
2000         int isl_space_range_is_wrapping(
2001                 __isl_keep isl_space *space);
2003         #include <isl/set.h>
2004         int isl_basic_set_is_wrapping(
2005                 __isl_keep isl_basic_set *bset);
2006         int isl_set_is_wrapping(__isl_keep isl_set *set);
2008         #include <isl/map.h>
2009         int isl_map_domain_is_wrapping(
2010                 __isl_keep isl_map *map);
2011         int isl_map_range_is_wrapping(
2012                 __isl_keep isl_map *map);
2014 The input to C<isl_space_is_wrapping> should
2015 be the space of a set, while that of
2016 C<isl_space_domain_is_wrapping> and
2017 C<isl_space_range_is_wrapping> should be the space of a relation.
2019 =item * Internal Product
2021         int isl_basic_map_can_zip(
2022                 __isl_keep isl_basic_map *bmap);
2023         int isl_map_can_zip(__isl_keep isl_map *map);
2025 Check whether the product of domain and range of the given relation
2026 can be computed,
2027 i.e., whether both domain and range are nested relations.
2029 =item * Currying
2031         int isl_basic_map_can_curry(
2032                 __isl_keep isl_basic_map *bmap);
2033         int isl_map_can_curry(__isl_keep isl_map *map);
2035 Check whether the domain of the (basic) relation is a wrapped relation.
2037         int isl_basic_map_can_uncurry(
2038                 __isl_keep isl_basic_map *bmap);
2039         int isl_map_can_uncurry(__isl_keep isl_map *map);
2041 Check whether the range of the (basic) relation is a wrapped relation.
2043 =back
2045 =head3 Binary Properties
2047 =over
2049 =item * Equality
2051         int isl_basic_set_plain_is_equal(
2052                 __isl_keep isl_basic_set *bset1,
2053                 __isl_keep isl_basic_set *bset2);
2054         int isl_set_plain_is_equal(__isl_keep isl_set *set1,
2055                 __isl_keep isl_set *set2);
2056         int isl_set_is_equal(__isl_keep isl_set *set1,
2057                 __isl_keep isl_set *set2);
2058         int isl_union_set_is_equal(
2059                 __isl_keep isl_union_set *uset1,
2060                 __isl_keep isl_union_set *uset2);
2061         int isl_basic_map_is_equal(
2062                 __isl_keep isl_basic_map *bmap1,
2063                 __isl_keep isl_basic_map *bmap2);
2064         int isl_map_is_equal(__isl_keep isl_map *map1,
2065                 __isl_keep isl_map *map2);
2066         int isl_map_plain_is_equal(__isl_keep isl_map *map1,
2067                 __isl_keep isl_map *map2);
2068         int isl_union_map_is_equal(
2069                 __isl_keep isl_union_map *umap1,
2070                 __isl_keep isl_union_map *umap2);
2072 =item * Disjointness
2074         int isl_basic_set_is_disjoint(
2075                 __isl_keep isl_basic_set *bset1,
2076                 __isl_keep isl_basic_set *bset2);
2077         int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
2078                 __isl_keep isl_set *set2);
2079         int isl_set_is_disjoint(__isl_keep isl_set *set1,
2080                 __isl_keep isl_set *set2);
2081         int isl_basic_map_is_disjoint(
2082                 __isl_keep isl_basic_map *bmap1,
2083                 __isl_keep isl_basic_map *bmap2);
2084         int isl_map_is_disjoint(__isl_keep isl_map *map1,
2085                 __isl_keep isl_map *map2);
2087 =item * Subset
2089         int isl_basic_set_is_subset(
2090                 __isl_keep isl_basic_set *bset1,
2091                 __isl_keep isl_basic_set *bset2);
2092         int isl_set_is_subset(__isl_keep isl_set *set1,
2093                 __isl_keep isl_set *set2);
2094         int isl_set_is_strict_subset(
2095                 __isl_keep isl_set *set1,
2096                 __isl_keep isl_set *set2);
2097         int isl_union_set_is_subset(
2098                 __isl_keep isl_union_set *uset1,
2099                 __isl_keep isl_union_set *uset2);
2100         int isl_union_set_is_strict_subset(
2101                 __isl_keep isl_union_set *uset1,
2102                 __isl_keep isl_union_set *uset2);
2103         int isl_basic_map_is_subset(
2104                 __isl_keep isl_basic_map *bmap1,
2105                 __isl_keep isl_basic_map *bmap2);
2106         int isl_basic_map_is_strict_subset(
2107                 __isl_keep isl_basic_map *bmap1,
2108                 __isl_keep isl_basic_map *bmap2);
2109         int isl_map_is_subset(
2110                 __isl_keep isl_map *map1,
2111                 __isl_keep isl_map *map2);
2112         int isl_map_is_strict_subset(
2113                 __isl_keep isl_map *map1,
2114                 __isl_keep isl_map *map2);
2115         int isl_union_map_is_subset(
2116                 __isl_keep isl_union_map *umap1,
2117                 __isl_keep isl_union_map *umap2);
2118         int isl_union_map_is_strict_subset(
2119                 __isl_keep isl_union_map *umap1,
2120                 __isl_keep isl_union_map *umap2);
2122 Check whether the first argument is a (strict) subset of the
2123 second argument.
2125 =item * Order
2127         int isl_set_plain_cmp(__isl_keep isl_set *set1,
2128                 __isl_keep isl_set *set2);
2130 This function is useful for sorting C<isl_set>s.
2131 The order depends on the internal representation of the inputs.
2132 The order is fixed over different calls to the function (assuming
2133 the internal representation of the inputs has not changed), but may
2134 change over different versions of C<isl>.
2136 =back
2138 =head2 Unary Operations
2140 =over
2142 =item * Complement
2144         __isl_give isl_set *isl_set_complement(
2145                 __isl_take isl_set *set);
2146         __isl_give isl_map *isl_map_complement(
2147                 __isl_take isl_map *map);
2149 =item * Inverse map
2151         __isl_give isl_basic_map *isl_basic_map_reverse(
2152                 __isl_take isl_basic_map *bmap);
2153         __isl_give isl_map *isl_map_reverse(
2154                 __isl_take isl_map *map);
2155         __isl_give isl_union_map *isl_union_map_reverse(
2156                 __isl_take isl_union_map *umap);
2158 =item * Projection
2160         #include <isl/local_space.h>
2161         __isl_give isl_local_space *isl_local_space_domain(
2162                 __isl_take isl_local_space *ls);
2163         __isl_give isl_local_space *isl_local_space_range(
2164                 __isl_take isl_local_space *ls);
2166         #include <isl/set.h>
2167         __isl_give isl_basic_set *isl_basic_set_project_out(
2168                 __isl_take isl_basic_set *bset,
2169                 enum isl_dim_type type, unsigned first, unsigned n);
2170         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
2171                 enum isl_dim_type type, unsigned first, unsigned n);
2172         __isl_give isl_basic_set *isl_basic_set_params(
2173                 __isl_take isl_basic_set *bset);
2174         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
2176         #include <isl/map.h>
2177         __isl_give isl_basic_map *isl_basic_map_project_out(
2178                 __isl_take isl_basic_map *bmap,
2179                 enum isl_dim_type type, unsigned first, unsigned n);
2180         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
2181                 enum isl_dim_type type, unsigned first, unsigned n);
2182         __isl_give isl_basic_set *isl_basic_map_domain(
2183                 __isl_take isl_basic_map *bmap);
2184         __isl_give isl_basic_set *isl_basic_map_range(
2185                 __isl_take isl_basic_map *bmap);
2186         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
2187         __isl_give isl_set *isl_map_domain(
2188                 __isl_take isl_map *bmap);
2189         __isl_give isl_set *isl_map_range(
2190                 __isl_take isl_map *map);
2192         #include <isl/union_set.h>
2193         __isl_give isl_set *isl_union_set_params(
2194                 __isl_take isl_union_set *uset);
2196         #include <isl/union_map.h>
2197         __isl_give isl_set *isl_union_map_params(
2198                 __isl_take isl_union_map *umap);
2199         __isl_give isl_union_set *isl_union_map_domain(
2200                 __isl_take isl_union_map *umap);
2201         __isl_give isl_union_set *isl_union_map_range(
2202                 __isl_take isl_union_map *umap);
2204         #include <isl/map.h>
2205         __isl_give isl_basic_map *isl_basic_map_domain_map(
2206                 __isl_take isl_basic_map *bmap);
2207         __isl_give isl_basic_map *isl_basic_map_range_map(
2208                 __isl_take isl_basic_map *bmap);
2209         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
2210         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
2212         #include <isl/union_map.h>
2213         __isl_give isl_union_map *isl_union_map_domain_map(
2214                 __isl_take isl_union_map *umap);
2215         __isl_give isl_union_map *isl_union_map_range_map(
2216                 __isl_take isl_union_map *umap);
2218 The functions above construct a (basic, regular or union) relation
2219 that maps (a wrapped version of) the input relation to its domain or range.
2221 =item * Elimination
2223         __isl_give isl_basic_set *isl_basic_set_eliminate(
2224                 __isl_take isl_basic_set *bset,
2225                 enum isl_dim_type type,
2226                 unsigned first, unsigned n);
2227         __isl_give isl_set *isl_set_eliminate(
2228                 __isl_take isl_set *set, enum isl_dim_type type,
2229                 unsigned first, unsigned n);
2230         __isl_give isl_basic_map *isl_basic_map_eliminate(
2231                 __isl_take isl_basic_map *bmap,
2232                 enum isl_dim_type type,
2233                 unsigned first, unsigned n);
2234         __isl_give isl_map *isl_map_eliminate(
2235                 __isl_take isl_map *map, enum isl_dim_type type,
2236                 unsigned first, unsigned n);
2238 Eliminate the coefficients for the given dimensions from the constraints,
2239 without removing the dimensions.
2241 =item * Constructing a relation from a set
2243         #include <isl/local_space.h>
2244         __isl_give isl_local_space *isl_local_space_from_domain(
2245                 __isl_take isl_local_space *ls);
2247         #include <isl/map.h>
2248         __isl_give isl_map *isl_map_from_domain(
2249                 __isl_take isl_set *set);
2250         __isl_give isl_map *isl_map_from_range(
2251                 __isl_take isl_set *set);
2253 Create a relation with the given set as domain or range.
2254 The range or domain of the created relation is a zero-dimensional
2255 flat anonymous space.
2257 =item * Slicing
2259         __isl_give isl_basic_set *isl_basic_set_fix_si(
2260                 __isl_take isl_basic_set *bset,
2261                 enum isl_dim_type type, unsigned pos, int value);
2262         __isl_give isl_basic_set *isl_basic_set_fix_val(
2263                 __isl_take isl_basic_set *bset,
2264                 enum isl_dim_type type, unsigned pos,
2265                 __isl_take isl_val *v);
2266         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
2267                 enum isl_dim_type type, unsigned pos, int value);
2268         __isl_give isl_set *isl_set_fix_val(
2269                 __isl_take isl_set *set,
2270                 enum isl_dim_type type, unsigned pos,
2271                 __isl_take isl_val *v);
2272         __isl_give isl_basic_map *isl_basic_map_fix_si(
2273                 __isl_take isl_basic_map *bmap,
2274                 enum isl_dim_type type, unsigned pos, int value);
2275         __isl_give isl_basic_map *isl_basic_map_fix_val(
2276                 __isl_take isl_basic_map *bmap,
2277                 enum isl_dim_type type, unsigned pos,
2278                 __isl_take isl_val *v);
2279         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
2280                 enum isl_dim_type type, unsigned pos, int value);
2281         __isl_give isl_map *isl_map_fix_val(
2282                 __isl_take isl_map *map,
2283                 enum isl_dim_type type, unsigned pos,
2284                 __isl_take isl_val *v);
2286 Intersect the set or relation with the hyperplane where the given
2287 dimension has the fixed given value.
2289         __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
2290                 __isl_take isl_basic_map *bmap,
2291                 enum isl_dim_type type, unsigned pos, int value);
2292         __isl_give isl_basic_map *isl_basic_map_upper_bound_si(
2293                 __isl_take isl_basic_map *bmap,
2294                 enum isl_dim_type type, unsigned pos, int value);
2295         __isl_give isl_set *isl_set_lower_bound_si(
2296                 __isl_take isl_set *set,
2297                 enum isl_dim_type type, unsigned pos, int value);
2298         __isl_give isl_set *isl_set_lower_bound_val(
2299                 __isl_take isl_set *set,
2300                 enum isl_dim_type type, unsigned pos,
2301                 __isl_take isl_val *value);
2302         __isl_give isl_map *isl_map_lower_bound_si(
2303                 __isl_take isl_map *map,
2304                 enum isl_dim_type type, unsigned pos, int value);
2305         __isl_give isl_set *isl_set_upper_bound_si(
2306                 __isl_take isl_set *set,
2307                 enum isl_dim_type type, unsigned pos, int value);
2308         __isl_give isl_set *isl_set_upper_bound_val(
2309                 __isl_take isl_set *set,
2310                 enum isl_dim_type type, unsigned pos,
2311                 __isl_take isl_val *value);
2312         __isl_give isl_map *isl_map_upper_bound_si(
2313                 __isl_take isl_map *map,
2314                 enum isl_dim_type type, unsigned pos, int value);
2316 Intersect the set or relation with the half-space where the given
2317 dimension has a value bounded by the fixed given integer value.
2319         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
2320                 enum isl_dim_type type1, int pos1,
2321                 enum isl_dim_type type2, int pos2);
2322         __isl_give isl_basic_map *isl_basic_map_equate(
2323                 __isl_take isl_basic_map *bmap,
2324                 enum isl_dim_type type1, int pos1,
2325                 enum isl_dim_type type2, int pos2);
2326         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
2327                 enum isl_dim_type type1, int pos1,
2328                 enum isl_dim_type type2, int pos2);
2330 Intersect the set or relation with the hyperplane where the given
2331 dimensions are equal to each other.
2333         __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
2334                 enum isl_dim_type type1, int pos1,
2335                 enum isl_dim_type type2, int pos2);
2337 Intersect the relation with the hyperplane where the given
2338 dimensions have opposite values.
2340         __isl_give isl_map *isl_map_order_le(
2341                 __isl_take isl_map *map,
2342                 enum isl_dim_type type1, int pos1,
2343                 enum isl_dim_type type2, int pos2);
2344         __isl_give isl_basic_map *isl_basic_map_order_ge(
2345                 __isl_take isl_basic_map *bmap,
2346                 enum isl_dim_type type1, int pos1,
2347                 enum isl_dim_type type2, int pos2);
2348         __isl_give isl_map *isl_map_order_ge(
2349                 __isl_take isl_map *map,
2350                 enum isl_dim_type type1, int pos1,
2351                 enum isl_dim_type type2, int pos2);
2352         __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
2353                 enum isl_dim_type type1, int pos1,
2354                 enum isl_dim_type type2, int pos2);
2355         __isl_give isl_basic_map *isl_basic_map_order_gt(
2356                 __isl_take isl_basic_map *bmap,
2357                 enum isl_dim_type type1, int pos1,
2358                 enum isl_dim_type type2, int pos2);
2359         __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
2360                 enum isl_dim_type type1, int pos1,
2361                 enum isl_dim_type type2, int pos2);
2363 Intersect the relation with the half-space where the given
2364 dimensions satisfy the given ordering.
2366 =item * Identity
2368         __isl_give isl_map *isl_set_identity(
2369                 __isl_take isl_set *set);
2370         __isl_give isl_union_map *isl_union_set_identity(
2371                 __isl_take isl_union_set *uset);
2373 Construct an identity relation on the given (union) set.
2375 =item * Deltas
2377         __isl_give isl_basic_set *isl_basic_map_deltas(
2378                 __isl_take isl_basic_map *bmap);
2379         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
2380         __isl_give isl_union_set *isl_union_map_deltas(
2381                 __isl_take isl_union_map *umap);
2383 These functions return a (basic) set containing the differences
2384 between image elements and corresponding domain elements in the input.
2386         __isl_give isl_basic_map *isl_basic_map_deltas_map(
2387                 __isl_take isl_basic_map *bmap);
2388         __isl_give isl_map *isl_map_deltas_map(
2389                 __isl_take isl_map *map);
2390         __isl_give isl_union_map *isl_union_map_deltas_map(
2391                 __isl_take isl_union_map *umap);
2393 The functions above construct a (basic, regular or union) relation
2394 that maps (a wrapped version of) the input relation to its delta set.
2396 =item * Coalescing
2398 Simplify the representation of a set or relation by trying
2399 to combine pairs of basic sets or relations into a single
2400 basic set or relation.
2402         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
2403         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
2404         __isl_give isl_union_set *isl_union_set_coalesce(
2405                 __isl_take isl_union_set *uset);
2406         __isl_give isl_union_map *isl_union_map_coalesce(
2407                 __isl_take isl_union_map *umap);
2409 One of the methods for combining pairs of basic sets or relations
2410 can result in coefficients that are much larger than those that appear
2411 in the constraints of the input.  By default, the coefficients are
2412 not allowed to grow larger, but this can be changed by unsetting
2413 the following option.
2415         int isl_options_set_coalesce_bounded_wrapping(
2416                 isl_ctx *ctx, int val);
2417         int isl_options_get_coalesce_bounded_wrapping(
2418                 isl_ctx *ctx);
2420 =item * Detecting equalities
2422         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
2423                 __isl_take isl_basic_set *bset);
2424         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
2425                 __isl_take isl_basic_map *bmap);
2426         __isl_give isl_set *isl_set_detect_equalities(
2427                 __isl_take isl_set *set);
2428         __isl_give isl_map *isl_map_detect_equalities(
2429                 __isl_take isl_map *map);
2430         __isl_give isl_union_set *isl_union_set_detect_equalities(
2431                 __isl_take isl_union_set *uset);
2432         __isl_give isl_union_map *isl_union_map_detect_equalities(
2433                 __isl_take isl_union_map *umap);
2435 Simplify the representation of a set or relation by detecting implicit
2436 equalities.
2438 =item * Removing redundant constraints
2440         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
2441                 __isl_take isl_basic_set *bset);
2442         __isl_give isl_set *isl_set_remove_redundancies(
2443                 __isl_take isl_set *set);
2444         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
2445                 __isl_take isl_basic_map *bmap);
2446         __isl_give isl_map *isl_map_remove_redundancies(
2447                 __isl_take isl_map *map);
2449 =item * Convex hull
2451         __isl_give isl_basic_set *isl_set_convex_hull(
2452                 __isl_take isl_set *set);
2453         __isl_give isl_basic_map *isl_map_convex_hull(
2454                 __isl_take isl_map *map);
2456 If the input set or relation has any existentially quantified
2457 variables, then the result of these operations is currently undefined.
2459 =item * Simple hull
2461         __isl_give isl_basic_set *
2462         isl_set_unshifted_simple_hull(
2463                 __isl_take isl_set *set);
2464         __isl_give isl_basic_map *
2465         isl_map_unshifted_simple_hull(
2466                 __isl_take isl_map *map);
2467         __isl_give isl_basic_set *isl_set_simple_hull(
2468                 __isl_take isl_set *set);
2469         __isl_give isl_basic_map *isl_map_simple_hull(
2470                 __isl_take isl_map *map);
2471         __isl_give isl_union_map *isl_union_map_simple_hull(
2472                 __isl_take isl_union_map *umap);
2474 These functions compute a single basic set or relation
2475 that contains the whole input set or relation.
2476 In particular, the output is described by translates
2477 of the constraints describing the basic sets or relations in the input.
2478 In case of C<isl_set_unshifted_simple_hull>, only the original
2479 constraints are used, without any translation.
2481 =begin latex
2483 (See \autoref{s:simple hull}.)
2485 =end latex
2487 =item * Affine hull
2489         __isl_give isl_basic_set *isl_basic_set_affine_hull(
2490                 __isl_take isl_basic_set *bset);
2491         __isl_give isl_basic_set *isl_set_affine_hull(
2492                 __isl_take isl_set *set);
2493         __isl_give isl_union_set *isl_union_set_affine_hull(
2494                 __isl_take isl_union_set *uset);
2495         __isl_give isl_basic_map *isl_basic_map_affine_hull(
2496                 __isl_take isl_basic_map *bmap);
2497         __isl_give isl_basic_map *isl_map_affine_hull(
2498                 __isl_take isl_map *map);
2499         __isl_give isl_union_map *isl_union_map_affine_hull(
2500                 __isl_take isl_union_map *umap);
2502 In case of union sets and relations, the affine hull is computed
2503 per space.
2505 =item * Polyhedral hull
2507         __isl_give isl_basic_set *isl_set_polyhedral_hull(
2508                 __isl_take isl_set *set);
2509         __isl_give isl_basic_map *isl_map_polyhedral_hull(
2510                 __isl_take isl_map *map);
2511         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2512                 __isl_take isl_union_set *uset);
2513         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2514                 __isl_take isl_union_map *umap);
2516 These functions compute a single basic set or relation
2517 not involving any existentially quantified variables
2518 that contains the whole input set or relation.
2519 In case of union sets and relations, the polyhedral hull is computed
2520 per space.
2522 =item * Other approximations
2524         __isl_give isl_basic_set *
2525         isl_basic_set_drop_constraints_involving_dims(
2526                 __isl_take isl_basic_set *bset,
2527                 enum isl_dim_type type,
2528                 unsigned first, unsigned n);
2529         __isl_give isl_basic_map *
2530         isl_basic_map_drop_constraints_involving_dims(
2531                 __isl_take isl_basic_map *bmap,
2532                 enum isl_dim_type type,
2533                 unsigned first, unsigned n);
2534         __isl_give isl_basic_set *
2535         isl_basic_set_drop_constraints_not_involving_dims(
2536                 __isl_take isl_basic_set *bset,
2537                 enum isl_dim_type type,
2538                 unsigned first, unsigned n);
2539         __isl_give isl_set *
2540         isl_set_drop_constraints_involving_dims(
2541                 __isl_take isl_set *set,
2542                 enum isl_dim_type type,
2543                 unsigned first, unsigned n);
2544         __isl_give isl_map *
2545         isl_map_drop_constraints_involving_dims(
2546                 __isl_take isl_map *map,
2547                 enum isl_dim_type type,
2548                 unsigned first, unsigned n);
2550 These functions drop any constraints (not) involving the specified dimensions.
2551 Note that the result depends on the representation of the input.
2553 =item * Feasibility
2555         __isl_give isl_basic_set *isl_basic_set_sample(
2556                 __isl_take isl_basic_set *bset);
2557         __isl_give isl_basic_set *isl_set_sample(
2558                 __isl_take isl_set *set);
2559         __isl_give isl_basic_map *isl_basic_map_sample(
2560                 __isl_take isl_basic_map *bmap);
2561         __isl_give isl_basic_map *isl_map_sample(
2562                 __isl_take isl_map *map);
2564 If the input (basic) set or relation is non-empty, then return
2565 a singleton subset of the input.  Otherwise, return an empty set.
2567 =item * Optimization
2569         #include <isl/ilp.h>
2570         __isl_give isl_val *isl_basic_set_max_val(
2571                 __isl_keep isl_basic_set *bset,
2572                 __isl_keep isl_aff *obj);
2573         __isl_give isl_val *isl_set_min_val(
2574                 __isl_keep isl_set *set,
2575                 __isl_keep isl_aff *obj);
2576         __isl_give isl_val *isl_set_max_val(
2577                 __isl_keep isl_set *set,
2578                 __isl_keep isl_aff *obj);
2580 Compute the minimum or maximum of the integer affine expression C<obj>
2581 over the points in C<set>, returning the result in C<opt>.
2582 The result is C<NULL> in case of an error, the optimal value in case
2583 there is one, negative infinity or infinity if the problem is unbounded and
2584 NaN if the problem is empty.
2586 =item * Parametric optimization
2588         __isl_give isl_pw_aff *isl_set_dim_min(
2589                 __isl_take isl_set *set, int pos);
2590         __isl_give isl_pw_aff *isl_set_dim_max(
2591                 __isl_take isl_set *set, int pos);
2592         __isl_give isl_pw_aff *isl_map_dim_max(
2593                 __isl_take isl_map *map, int pos);
2595 Compute the minimum or maximum of the given set or output dimension
2596 as a function of the parameters (and input dimensions), but independently
2597 of the other set or output dimensions.
2598 For lexicographic optimization, see L<"Lexicographic Optimization">.
2600 =item * Dual
2602 The following functions compute either the set of (rational) coefficient
2603 values of valid constraints for the given set or the set of (rational)
2604 values satisfying the constraints with coefficients from the given set.
2605 Internally, these two sets of functions perform essentially the
2606 same operations, except that the set of coefficients is assumed to
2607 be a cone, while the set of values may be any polyhedron.
2608 The current implementation is based on the Farkas lemma and
2609 Fourier-Motzkin elimination, but this may change or be made optional
2610 in future.  In particular, future implementations may use different
2611 dualization algorithms or skip the elimination step.
2613         __isl_give isl_basic_set *isl_basic_set_coefficients(
2614                 __isl_take isl_basic_set *bset);
2615         __isl_give isl_basic_set *isl_set_coefficients(
2616                 __isl_take isl_set *set);
2617         __isl_give isl_union_set *isl_union_set_coefficients(
2618                 __isl_take isl_union_set *bset);
2619         __isl_give isl_basic_set *isl_basic_set_solutions(
2620                 __isl_take isl_basic_set *bset);
2621         __isl_give isl_basic_set *isl_set_solutions(
2622                 __isl_take isl_set *set);
2623         __isl_give isl_union_set *isl_union_set_solutions(
2624                 __isl_take isl_union_set *bset);
2626 =item * Power
2628         __isl_give isl_map *isl_map_fixed_power_val(
2629                 __isl_take isl_map *map,
2630                 __isl_take isl_val *exp);
2631         __isl_give isl_union_map *
2632         isl_union_map_fixed_power_val(
2633                 __isl_take isl_union_map *umap,
2634                 __isl_take isl_val *exp);
2636 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2637 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2638 of C<map> is computed.
2640         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2641                 int *exact);
2642         __isl_give isl_union_map *isl_union_map_power(
2643                 __isl_take isl_union_map *umap, int *exact);
2645 Compute a parametric representation for all positive powers I<k> of C<map>.
2646 The result maps I<k> to a nested relation corresponding to the
2647 I<k>th power of C<map>.
2648 The result may be an overapproximation.  If the result is known to be exact,
2649 then C<*exact> is set to C<1>.
2651 =item * Transitive closure
2653         __isl_give isl_map *isl_map_transitive_closure(
2654                 __isl_take isl_map *map, int *exact);
2655         __isl_give isl_union_map *isl_union_map_transitive_closure(
2656                 __isl_take isl_union_map *umap, int *exact);
2658 Compute the transitive closure of C<map>.
2659 The result may be an overapproximation.  If the result is known to be exact,
2660 then C<*exact> is set to C<1>.
2662 =item * Reaching path lengths
2664         __isl_give isl_map *isl_map_reaching_path_lengths(
2665                 __isl_take isl_map *map, int *exact);
2667 Compute a relation that maps each element in the range of C<map>
2668 to the lengths of all paths composed of edges in C<map> that
2669 end up in the given element.
2670 The result may be an overapproximation.  If the result is known to be exact,
2671 then C<*exact> is set to C<1>.
2672 To compute the I<maximal> path length, the resulting relation
2673 should be postprocessed by C<isl_map_lexmax>.
2674 In particular, if the input relation is a dependence relation
2675 (mapping sources to sinks), then the maximal path length corresponds
2676 to the free schedule.
2677 Note, however, that C<isl_map_lexmax> expects the maximum to be
2678 finite, so if the path lengths are unbounded (possibly due to
2679 the overapproximation), then you will get an error message.
2681 =item * Wrapping
2683         #include <isl/space.h>
2684         __isl_give isl_space *isl_space_wrap(
2685                 __isl_take isl_space *space);
2686         __isl_give isl_space *isl_space_unwrap(
2687                 __isl_take isl_space *space);
2689         #include <isl/set.h>
2690         __isl_give isl_basic_map *isl_basic_set_unwrap(
2691                 __isl_take isl_basic_set *bset);
2692         __isl_give isl_map *isl_set_unwrap(
2693                 __isl_take isl_set *set);
2695         #include <isl/map.h>
2696         __isl_give isl_basic_set *isl_basic_map_wrap(
2697                 __isl_take isl_basic_map *bmap);
2698         __isl_give isl_set *isl_map_wrap(
2699                 __isl_take isl_map *map);
2701         #include <isl/union_set.h>
2702         __isl_give isl_union_map *isl_union_set_unwrap(
2703                 __isl_take isl_union_set *uset);
2705         #include <isl/union_map.h>
2706         __isl_give isl_union_set *isl_union_map_wrap(
2707                 __isl_take isl_union_map *umap);
2709 The input to C<isl_space_unwrap> should
2710 be the space of a set, while that of
2711 C<isl_space_wrap> should be the space of a relation.
2712 Conversely, the output of C<isl_space_unwrap> is the space
2713 of a relation, while that of C<isl_space_wrap> is the space of a set.
2715 =item * Flattening
2717 Remove any internal structure of domain (and range) of the given
2718 set or relation.  If there is any such internal structure in the input,
2719 then the name of the space is also removed.
2721         #include <isl/local_space.h>
2722         __isl_give isl_local_space *
2723         isl_local_space_flatten_domain(
2724                 __isl_take isl_local_space *ls);
2725         __isl_give isl_local_space *
2726         isl_local_space_flatten_range(
2727                 __isl_take isl_local_space *ls);
2729         #include <isl/set.h>
2730         __isl_give isl_basic_set *isl_basic_set_flatten(
2731                 __isl_take isl_basic_set *bset);
2732         __isl_give isl_set *isl_set_flatten(
2733                 __isl_take isl_set *set);
2735         #include <isl/map.h>
2736         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2737                 __isl_take isl_basic_map *bmap);
2738         __isl_give isl_basic_map *isl_basic_map_flatten_range(
2739                 __isl_take isl_basic_map *bmap);
2740         __isl_give isl_map *isl_map_flatten_range(
2741                 __isl_take isl_map *map);
2742         __isl_give isl_map *isl_map_flatten_domain(
2743                 __isl_take isl_map *map);
2744         __isl_give isl_basic_map *isl_basic_map_flatten(
2745                 __isl_take isl_basic_map *bmap);
2746         __isl_give isl_map *isl_map_flatten(
2747                 __isl_take isl_map *map);
2749         #include <isl/map.h>
2750         __isl_give isl_map *isl_set_flatten_map(
2751                 __isl_take isl_set *set);
2753 The function above constructs a relation
2754 that maps the input set to a flattened version of the set.
2756 =item * Lifting
2758 Lift the input set to a space with extra dimensions corresponding
2759 to the existentially quantified variables in the input.
2760 In particular, the result lives in a wrapped map where the domain
2761 is the original space and the range corresponds to the original
2762 existentially quantified variables.
2764         __isl_give isl_basic_set *isl_basic_set_lift(
2765                 __isl_take isl_basic_set *bset);
2766         __isl_give isl_set *isl_set_lift(
2767                 __isl_take isl_set *set);
2768         __isl_give isl_union_set *isl_union_set_lift(
2769                 __isl_take isl_union_set *uset);
2771 Given a local space that contains the existentially quantified
2772 variables of a set, a basic relation that, when applied to
2773 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2774 can be constructed using the following function.
2776         #include <isl/local_space.h>
2777         __isl_give isl_basic_map *isl_local_space_lifting(
2778                 __isl_take isl_local_space *ls);
2780 =item * Internal Product
2782         __isl_give isl_basic_map *isl_basic_map_zip(
2783                 __isl_take isl_basic_map *bmap);
2784         __isl_give isl_map *isl_map_zip(
2785                 __isl_take isl_map *map);
2786         __isl_give isl_union_map *isl_union_map_zip(
2787                 __isl_take isl_union_map *umap);
2789 Given a relation with nested relations for domain and range,
2790 interchange the range of the domain with the domain of the range.
2792 =item * Currying
2794         __isl_give isl_basic_map *isl_basic_map_curry(
2795                 __isl_take isl_basic_map *bmap);
2796         __isl_give isl_basic_map *isl_basic_map_uncurry(
2797                 __isl_take isl_basic_map *bmap);
2798         __isl_give isl_map *isl_map_curry(
2799                 __isl_take isl_map *map);
2800         __isl_give isl_map *isl_map_uncurry(
2801                 __isl_take isl_map *map);
2802         __isl_give isl_union_map *isl_union_map_curry(
2803                 __isl_take isl_union_map *umap);
2804         __isl_give isl_union_map *isl_union_map_uncurry(
2805                 __isl_take isl_union_map *umap);
2807 Given a relation with a nested relation for domain,
2808 the C<curry> functions
2809 move the range of the nested relation out of the domain
2810 and use it as the domain of a nested relation in the range,
2811 with the original range as range of this nested relation.
2812 The C<uncurry> functions perform the inverse operation.
2814 =item * Aligning parameters
2816         __isl_give isl_basic_set *isl_basic_set_align_params(
2817                 __isl_take isl_basic_set *bset,
2818                 __isl_take isl_space *model);
2819         __isl_give isl_set *isl_set_align_params(
2820                 __isl_take isl_set *set,
2821                 __isl_take isl_space *model);
2822         __isl_give isl_basic_map *isl_basic_map_align_params(
2823                 __isl_take isl_basic_map *bmap,
2824                 __isl_take isl_space *model);
2825         __isl_give isl_map *isl_map_align_params(
2826                 __isl_take isl_map *map,
2827                 __isl_take isl_space *model);
2829 Change the order of the parameters of the given set or relation
2830 such that the first parameters match those of C<model>.
2831 This may involve the introduction of extra parameters.
2832 All parameters need to be named.
2834 =item * Dimension manipulation
2836         #include <isl/local_space.h>
2837         __isl_give isl_local_space *isl_local_space_add_dims(
2838                 __isl_take isl_local_space *ls,
2839                 enum isl_dim_type type, unsigned n);
2840         __isl_give isl_local_space *isl_local_space_insert_dims(
2841                 __isl_take isl_local_space *ls,
2842                 enum isl_dim_type type, unsigned first, unsigned n);
2843         __isl_give isl_local_space *isl_local_space_drop_dims(
2844                 __isl_take isl_local_space *ls,
2845                 enum isl_dim_type type, unsigned first, unsigned n);
2847         #include <isl/set.h>
2848         __isl_give isl_basic_set *isl_basic_set_add_dims(
2849                 __isl_take isl_basic_set *bset,
2850                 enum isl_dim_type type, unsigned n);
2851         __isl_give isl_set *isl_set_add_dims(
2852                 __isl_take isl_set *set,
2853                 enum isl_dim_type type, unsigned n);
2854         __isl_give isl_basic_set *isl_basic_set_insert_dims(
2855                 __isl_take isl_basic_set *bset,
2856                 enum isl_dim_type type, unsigned pos,
2857                 unsigned n);
2858         __isl_give isl_set *isl_set_insert_dims(
2859                 __isl_take isl_set *set,
2860                 enum isl_dim_type type, unsigned pos, unsigned n);
2861         __isl_give isl_basic_set *isl_basic_set_move_dims(
2862                 __isl_take isl_basic_set *bset,
2863                 enum isl_dim_type dst_type, unsigned dst_pos,
2864                 enum isl_dim_type src_type, unsigned src_pos,
2865                 unsigned n);
2866         __isl_give isl_set *isl_set_move_dims(
2867                 __isl_take isl_set *set,
2868                 enum isl_dim_type dst_type, unsigned dst_pos,
2869                 enum isl_dim_type src_type, unsigned src_pos,
2870                 unsigned n);
2872         #include <isl/map.h>
2873         __isl_give isl_map *isl_map_add_dims(
2874                 __isl_take isl_map *map,
2875                 enum isl_dim_type type, unsigned n);
2876         __isl_give isl_basic_map *isl_basic_map_insert_dims(
2877                 __isl_take isl_basic_map *bmap,
2878                 enum isl_dim_type type, unsigned pos,
2879                 unsigned n);
2880         __isl_give isl_map *isl_map_insert_dims(
2881                 __isl_take isl_map *map,
2882                 enum isl_dim_type type, unsigned pos, unsigned n);
2883         __isl_give isl_basic_map *isl_basic_map_move_dims(
2884                 __isl_take isl_basic_map *bmap,
2885                 enum isl_dim_type dst_type, unsigned dst_pos,
2886                 enum isl_dim_type src_type, unsigned src_pos,
2887                 unsigned n);
2888         __isl_give isl_map *isl_map_move_dims(
2889                 __isl_take isl_map *map,
2890                 enum isl_dim_type dst_type, unsigned dst_pos,
2891                 enum isl_dim_type src_type, unsigned src_pos,
2892                 unsigned n);
2894 It is usually not advisable to directly change the (input or output)
2895 space of a set or a relation as this removes the name and the internal
2896 structure of the space.  However, the above functions can be useful
2897 to add new parameters, assuming
2898 C<isl_set_align_params> and C<isl_map_align_params>
2899 are not sufficient.
2901 =back
2903 =head2 Binary Operations
2905 The two arguments of a binary operation not only need to live
2906 in the same C<isl_ctx>, they currently also need to have
2907 the same (number of) parameters.
2909 =head3 Basic Operations
2911 =over
2913 =item * Intersection
2915         #include <isl/local_space.h>
2916         __isl_give isl_local_space *isl_local_space_intersect(
2917                 __isl_take isl_local_space *ls1,
2918                 __isl_take isl_local_space *ls2);
2920         #include <isl/set.h>
2921         __isl_give isl_basic_set *isl_basic_set_intersect_params(
2922                 __isl_take isl_basic_set *bset1,
2923                 __isl_take isl_basic_set *bset2);
2924         __isl_give isl_basic_set *isl_basic_set_intersect(
2925                 __isl_take isl_basic_set *bset1,
2926                 __isl_take isl_basic_set *bset2);
2927         __isl_give isl_set *isl_set_intersect_params(
2928                 __isl_take isl_set *set,
2929                 __isl_take isl_set *params);
2930         __isl_give isl_set *isl_set_intersect(
2931                 __isl_take isl_set *set1,
2932                 __isl_take isl_set *set2);
2934         #include <isl/map.h>
2935         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2936                 __isl_take isl_basic_map *bmap,
2937                 __isl_take isl_basic_set *bset);
2938         __isl_give isl_basic_map *isl_basic_map_intersect_range(
2939                 __isl_take isl_basic_map *bmap,
2940                 __isl_take isl_basic_set *bset);
2941         __isl_give isl_basic_map *isl_basic_map_intersect(
2942                 __isl_take isl_basic_map *bmap1,
2943                 __isl_take isl_basic_map *bmap2);
2944         __isl_give isl_map *isl_map_intersect_params(
2945                 __isl_take isl_map *map,
2946                 __isl_take isl_set *params);
2947         __isl_give isl_map *isl_map_intersect_domain(
2948                 __isl_take isl_map *map,
2949                 __isl_take isl_set *set);
2950         __isl_give isl_map *isl_map_intersect_range(
2951                 __isl_take isl_map *map,
2952                 __isl_take isl_set *set);
2953         __isl_give isl_map *isl_map_intersect(
2954                 __isl_take isl_map *map1,
2955                 __isl_take isl_map *map2);
2957         #include <isl/union_set.h>
2958         __isl_give isl_union_set *isl_union_set_intersect_params(
2959                 __isl_take isl_union_set *uset,
2960                 __isl_take isl_set *set);
2961         __isl_give isl_union_set *isl_union_set_intersect(
2962                 __isl_take isl_union_set *uset1,
2963                 __isl_take isl_union_set *uset2);
2965         #include <isl/union_map.h>
2966         __isl_give isl_union_map *isl_union_map_intersect_params(
2967                 __isl_take isl_union_map *umap,
2968                 __isl_take isl_set *set);
2969         __isl_give isl_union_map *isl_union_map_intersect_domain(
2970                 __isl_take isl_union_map *umap,
2971                 __isl_take isl_union_set *uset);
2972         __isl_give isl_union_map *isl_union_map_intersect_range(
2973                 __isl_take isl_union_map *umap,
2974                 __isl_take isl_union_set *uset);
2975         __isl_give isl_union_map *isl_union_map_intersect(
2976                 __isl_take isl_union_map *umap1,
2977                 __isl_take isl_union_map *umap2);
2979 The second argument to the C<_params> functions needs to be
2980 a parametric (basic) set.  For the other functions, a parametric set
2981 for either argument is only allowed if the other argument is
2982 a parametric set as well.
2984 =item * Union
2986         __isl_give isl_set *isl_basic_set_union(
2987                 __isl_take isl_basic_set *bset1,
2988                 __isl_take isl_basic_set *bset2);
2989         __isl_give isl_map *isl_basic_map_union(
2990                 __isl_take isl_basic_map *bmap1,
2991                 __isl_take isl_basic_map *bmap2);
2992         __isl_give isl_set *isl_set_union(
2993                 __isl_take isl_set *set1,
2994                 __isl_take isl_set *set2);
2995         __isl_give isl_map *isl_map_union(
2996                 __isl_take isl_map *map1,
2997                 __isl_take isl_map *map2);
2998         __isl_give isl_union_set *isl_union_set_union(
2999                 __isl_take isl_union_set *uset1,
3000                 __isl_take isl_union_set *uset2);
3001         __isl_give isl_union_map *isl_union_map_union(
3002                 __isl_take isl_union_map *umap1,
3003                 __isl_take isl_union_map *umap2);
3005 =item * Set difference
3007         __isl_give isl_set *isl_set_subtract(
3008                 __isl_take isl_set *set1,
3009                 __isl_take isl_set *set2);
3010         __isl_give isl_map *isl_map_subtract(
3011                 __isl_take isl_map *map1,
3012                 __isl_take isl_map *map2);
3013         __isl_give isl_map *isl_map_subtract_domain(
3014                 __isl_take isl_map *map,
3015                 __isl_take isl_set *dom);
3016         __isl_give isl_map *isl_map_subtract_range(
3017                 __isl_take isl_map *map,
3018                 __isl_take isl_set *dom);
3019         __isl_give isl_union_set *isl_union_set_subtract(
3020                 __isl_take isl_union_set *uset1,
3021                 __isl_take isl_union_set *uset2);
3022         __isl_give isl_union_map *isl_union_map_subtract(
3023                 __isl_take isl_union_map *umap1,
3024                 __isl_take isl_union_map *umap2);
3025         __isl_give isl_union_map *isl_union_map_subtract_domain(
3026                 __isl_take isl_union_map *umap,
3027                 __isl_take isl_union_set *dom);
3028         __isl_give isl_union_map *isl_union_map_subtract_range(
3029                 __isl_take isl_union_map *umap,
3030                 __isl_take isl_union_set *dom);
3032 =item * Application
3034         __isl_give isl_basic_set *isl_basic_set_apply(
3035                 __isl_take isl_basic_set *bset,
3036                 __isl_take isl_basic_map *bmap);
3037         __isl_give isl_set *isl_set_apply(
3038                 __isl_take isl_set *set,
3039                 __isl_take isl_map *map);
3040         __isl_give isl_union_set *isl_union_set_apply(
3041                 __isl_take isl_union_set *uset,
3042                 __isl_take isl_union_map *umap);
3043         __isl_give isl_basic_map *isl_basic_map_apply_domain(
3044                 __isl_take isl_basic_map *bmap1,
3045                 __isl_take isl_basic_map *bmap2);
3046         __isl_give isl_basic_map *isl_basic_map_apply_range(
3047                 __isl_take isl_basic_map *bmap1,
3048                 __isl_take isl_basic_map *bmap2);
3049         __isl_give isl_map *isl_map_apply_domain(
3050                 __isl_take isl_map *map1,
3051                 __isl_take isl_map *map2);
3052         __isl_give isl_union_map *isl_union_map_apply_domain(
3053                 __isl_take isl_union_map *umap1,
3054                 __isl_take isl_union_map *umap2);
3055         __isl_give isl_map *isl_map_apply_range(
3056                 __isl_take isl_map *map1,
3057                 __isl_take isl_map *map2);
3058         __isl_give isl_union_map *isl_union_map_apply_range(
3059                 __isl_take isl_union_map *umap1,
3060                 __isl_take isl_union_map *umap2);
3062 =item * Preimage
3064         #include <isl/set.h>
3065         __isl_give isl_basic_set *
3066         isl_basic_set_preimage_multi_aff(
3067                 __isl_take isl_basic_set *bset,
3068                 __isl_take isl_multi_aff *ma);
3069         __isl_give isl_set *isl_set_preimage_multi_aff(
3070                 __isl_take isl_set *set,
3071                 __isl_take isl_multi_aff *ma);
3072         __isl_give isl_set *isl_set_preimage_pw_multi_aff(
3073                 __isl_take isl_set *set,
3074                 __isl_take isl_pw_multi_aff *pma);
3075         __isl_give isl_set *isl_set_preimage_multi_pw_aff(
3076                 __isl_take isl_set *set,
3077                 __isl_take isl_multi_pw_aff *mpa);
3079         #include <isl/union_set.h>
3080         __isl_give isl_union_set *
3081         isl_union_set_preimage_multi_aff(
3082                 __isl_take isl_union_set *uset,
3083                 __isl_take isl_multi_aff *ma);
3085         #include <isl/map.h>
3086         __isl_give isl_basic_map *
3087         isl_basic_map_preimage_domain_multi_aff(
3088                 __isl_take isl_basic_map *bmap,
3089                 __isl_take isl_multi_aff *ma);
3090         __isl_give isl_map *isl_map_preimage_domain_multi_aff(
3091                 __isl_take isl_map *map,
3092                 __isl_take isl_multi_aff *ma);
3093         __isl_give isl_map *isl_map_preimage_range_multi_aff(
3094                 __isl_take isl_map *map,
3095                 __isl_take isl_multi_aff *ma);
3096         __isl_give isl_map *
3097         isl_map_preimage_domain_pw_multi_aff(
3098                 __isl_take isl_map *map,
3099                 __isl_take isl_pw_multi_aff *pma);
3100         __isl_give isl_map *
3101         isl_map_preimage_range_pw_multi_aff(
3102                 __isl_take isl_map *map,
3103                 __isl_take isl_pw_multi_aff *pma);
3104         __isl_give isl_map *
3105         isl_map_preimage_domain_multi_pw_aff(
3106                 __isl_take isl_map *map,
3107                 __isl_take isl_multi_pw_aff *mpa);
3108         __isl_give isl_basic_map *
3109         isl_basic_map_preimage_range_multi_aff(
3110                 __isl_take isl_basic_map *bmap,
3111                 __isl_take isl_multi_aff *ma);
3113         #include <isl/union_map.h>
3114         __isl_give isl_union_map *
3115         isl_union_map_preimage_domain_multi_aff(
3116                 __isl_take isl_union_map *umap,
3117                 __isl_take isl_multi_aff *ma);
3118         __isl_give isl_union_map *
3119         isl_union_map_preimage_range_multi_aff(
3120                 __isl_take isl_union_map *umap,
3121                 __isl_take isl_multi_aff *ma);
3123 These functions compute the preimage of the given set or map domain/range under
3124 the given function.  In other words, the expression is plugged
3125 into the set description or into the domain/range of the map.
3126 Objects of types C<isl_multi_aff> and C<isl_pw_multi_aff> are described in
3127 L</"Piecewise Multiple Quasi Affine Expressions">.
3129 =item * Cartesian Product
3131         #include <isl/space.h>
3132         __isl_give isl_space *isl_space_product(
3133                 __isl_take isl_space *space1,
3134                 __isl_take isl_space *space2);
3135         __isl_give isl_space *isl_space_domain_product(
3136                 __isl_take isl_space *space1,
3137                 __isl_take isl_space *space2);
3138         __isl_give isl_space *isl_space_range_product(
3139                 __isl_take isl_space *space1,
3140                 __isl_take isl_space *space2);
3142 The functions
3143 C<isl_space_product>, C<isl_space_domain_product>
3144 and C<isl_space_range_product> take pairs or relation spaces and
3145 produce a single relations space, where either the domain, the range
3146 or both domain and range are wrapped spaces of relations between
3147 the domains and/or ranges of the input spaces.
3148 If the product is only constructed over the domain or the range
3149 then the ranges or the domains of the inputs should be the same.
3151         #include <isl/set.h>
3152         __isl_give isl_set *isl_set_product(
3153                 __isl_take isl_set *set1,
3154                 __isl_take isl_set *set2);
3156         #include <isl/map.h>
3157         __isl_give isl_basic_map *isl_basic_map_domain_product(
3158                 __isl_take isl_basic_map *bmap1,
3159                 __isl_take isl_basic_map *bmap2);
3160         __isl_give isl_basic_map *isl_basic_map_range_product(
3161                 __isl_take isl_basic_map *bmap1,
3162                 __isl_take isl_basic_map *bmap2);
3163         __isl_give isl_basic_map *isl_basic_map_product(
3164                 __isl_take isl_basic_map *bmap1,
3165                 __isl_take isl_basic_map *bmap2);
3166         __isl_give isl_map *isl_map_domain_product(
3167                 __isl_take isl_map *map1,
3168                 __isl_take isl_map *map2);
3169         __isl_give isl_map *isl_map_range_product(
3170                 __isl_take isl_map *map1,
3171                 __isl_take isl_map *map2);
3172         __isl_give isl_map *isl_map_product(
3173                 __isl_take isl_map *map1,
3174                 __isl_take isl_map *map2);
3176         #include <isl/union_set.h>
3177         __isl_give isl_union_set *isl_union_set_product(
3178                 __isl_take isl_union_set *uset1,
3179                 __isl_take isl_union_set *uset2);
3181         #include <isl/union_map.h>
3182         __isl_give isl_union_map *isl_union_map_domain_product(
3183                 __isl_take isl_union_map *umap1,
3184                 __isl_take isl_union_map *umap2);
3185         __isl_give isl_union_map *isl_union_map_range_product(
3186                 __isl_take isl_union_map *umap1,
3187                 __isl_take isl_union_map *umap2);
3188         __isl_give isl_union_map *isl_union_map_product(
3189                 __isl_take isl_union_map *umap1,
3190                 __isl_take isl_union_map *umap2);
3192 The above functions compute the cross product of the given
3193 sets or relations.  The domains and ranges of the results
3194 are wrapped maps between domains and ranges of the inputs.
3195 To obtain a ``flat'' product, use the following functions
3196 instead.
3198         __isl_give isl_basic_set *isl_basic_set_flat_product(
3199                 __isl_take isl_basic_set *bset1,
3200                 __isl_take isl_basic_set *bset2);
3201         __isl_give isl_set *isl_set_flat_product(
3202                 __isl_take isl_set *set1,
3203                 __isl_take isl_set *set2);
3204         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
3205                 __isl_take isl_basic_map *bmap1,
3206                 __isl_take isl_basic_map *bmap2);
3207         __isl_give isl_map *isl_map_flat_domain_product(
3208                 __isl_take isl_map *map1,
3209                 __isl_take isl_map *map2);
3210         __isl_give isl_map *isl_map_flat_range_product(
3211                 __isl_take isl_map *map1,
3212                 __isl_take isl_map *map2);
3213         __isl_give isl_union_map *isl_union_map_flat_range_product(
3214                 __isl_take isl_union_map *umap1,
3215                 __isl_take isl_union_map *umap2);
3216         __isl_give isl_basic_map *isl_basic_map_flat_product(
3217                 __isl_take isl_basic_map *bmap1,
3218                 __isl_take isl_basic_map *bmap2);
3219         __isl_give isl_map *isl_map_flat_product(
3220                 __isl_take isl_map *map1,
3221                 __isl_take isl_map *map2);
3223         #include <isl/space.h>
3224         __isl_give isl_space *isl_space_domain_factor_domain(
3225                 __isl_take isl_space *space);
3226         __isl_give isl_space *isl_space_range_factor_domain(
3227                 __isl_take isl_space *space);
3228         __isl_give isl_space *isl_space_range_factor_range(
3229                 __isl_take isl_space *space);
3231 The functions C<isl_space_range_factor_domain> and
3232 C<isl_space_range_factor_range> extract the two arguments from
3233 the result of a call to C<isl_space_range_product>.
3235 The arguments of a call to C<isl_map_range_product> can be extracted
3236 from the result using the following two functions.
3238         #include <isl/map.h>
3239         __isl_give isl_map *isl_map_range_factor_domain(
3240                 __isl_take isl_map *map);
3241         __isl_give isl_map *isl_map_range_factor_range(
3242                 __isl_take isl_map *map);
3244 =item * Simplification
3246         __isl_give isl_basic_set *isl_basic_set_gist(
3247                 __isl_take isl_basic_set *bset,
3248                 __isl_take isl_basic_set *context);
3249         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
3250                 __isl_take isl_set *context);
3251         __isl_give isl_set *isl_set_gist_params(
3252                 __isl_take isl_set *set,
3253                 __isl_take isl_set *context);
3254         __isl_give isl_union_set *isl_union_set_gist(
3255                 __isl_take isl_union_set *uset,
3256                 __isl_take isl_union_set *context);
3257         __isl_give isl_union_set *isl_union_set_gist_params(
3258                 __isl_take isl_union_set *uset,
3259                 __isl_take isl_set *set);
3260         __isl_give isl_basic_map *isl_basic_map_gist(
3261                 __isl_take isl_basic_map *bmap,
3262                 __isl_take isl_basic_map *context);
3263         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
3264                 __isl_take isl_map *context);
3265         __isl_give isl_map *isl_map_gist_params(
3266                 __isl_take isl_map *map,
3267                 __isl_take isl_set *context);
3268         __isl_give isl_map *isl_map_gist_domain(
3269                 __isl_take isl_map *map,
3270                 __isl_take isl_set *context);
3271         __isl_give isl_map *isl_map_gist_range(
3272                 __isl_take isl_map *map,
3273                 __isl_take isl_set *context);
3274         __isl_give isl_union_map *isl_union_map_gist(
3275                 __isl_take isl_union_map *umap,
3276                 __isl_take isl_union_map *context);
3277         __isl_give isl_union_map *isl_union_map_gist_params(
3278                 __isl_take isl_union_map *umap,
3279                 __isl_take isl_set *set);
3280         __isl_give isl_union_map *isl_union_map_gist_domain(
3281                 __isl_take isl_union_map *umap,
3282                 __isl_take isl_union_set *uset);
3283         __isl_give isl_union_map *isl_union_map_gist_range(
3284                 __isl_take isl_union_map *umap,
3285                 __isl_take isl_union_set *uset);
3287 The gist operation returns a set or relation that has the
3288 same intersection with the context as the input set or relation.
3289 Any implicit equality in the intersection is made explicit in the result,
3290 while all inequalities that are redundant with respect to the intersection
3291 are removed.
3292 In case of union sets and relations, the gist operation is performed
3293 per space.
3295 =back
3297 =head3 Lexicographic Optimization
3299 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
3300 the following functions
3301 compute a set that contains the lexicographic minimum or maximum
3302 of the elements in C<set> (or C<bset>) for those values of the parameters
3303 that satisfy C<dom>.
3304 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3305 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
3306 has no elements.
3307 In other words, the union of the parameter values
3308 for which the result is non-empty and of C<*empty>
3309 is equal to C<dom>.
3311         __isl_give isl_set *isl_basic_set_partial_lexmin(
3312                 __isl_take isl_basic_set *bset,
3313                 __isl_take isl_basic_set *dom,
3314                 __isl_give isl_set **empty);
3315         __isl_give isl_set *isl_basic_set_partial_lexmax(
3316                 __isl_take isl_basic_set *bset,
3317                 __isl_take isl_basic_set *dom,
3318                 __isl_give isl_set **empty);
3319         __isl_give isl_set *isl_set_partial_lexmin(
3320                 __isl_take isl_set *set, __isl_take isl_set *dom,
3321                 __isl_give isl_set **empty);
3322         __isl_give isl_set *isl_set_partial_lexmax(
3323                 __isl_take isl_set *set, __isl_take isl_set *dom,
3324                 __isl_give isl_set **empty);
3326 Given a (basic) set C<set> (or C<bset>), the following functions simply
3327 return a set containing the lexicographic minimum or maximum
3328 of the elements in C<set> (or C<bset>).
3329 In case of union sets, the optimum is computed per space.
3331         __isl_give isl_set *isl_basic_set_lexmin(
3332                 __isl_take isl_basic_set *bset);
3333         __isl_give isl_set *isl_basic_set_lexmax(
3334                 __isl_take isl_basic_set *bset);
3335         __isl_give isl_set *isl_set_lexmin(
3336                 __isl_take isl_set *set);
3337         __isl_give isl_set *isl_set_lexmax(
3338                 __isl_take isl_set *set);
3339         __isl_give isl_union_set *isl_union_set_lexmin(
3340                 __isl_take isl_union_set *uset);
3341         __isl_give isl_union_set *isl_union_set_lexmax(
3342                 __isl_take isl_union_set *uset);
3344 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
3345 the following functions
3346 compute a relation that maps each element of C<dom>
3347 to the single lexicographic minimum or maximum
3348 of the elements that are associated to that same
3349 element in C<map> (or C<bmap>).
3350 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3351 that contains the elements in C<dom> that do not map
3352 to any elements in C<map> (or C<bmap>).
3353 In other words, the union of the domain of the result and of C<*empty>
3354 is equal to C<dom>.
3356         __isl_give isl_map *isl_basic_map_partial_lexmax(
3357                 __isl_take isl_basic_map *bmap,
3358                 __isl_take isl_basic_set *dom,
3359                 __isl_give isl_set **empty);
3360         __isl_give isl_map *isl_basic_map_partial_lexmin(
3361                 __isl_take isl_basic_map *bmap,
3362                 __isl_take isl_basic_set *dom,
3363                 __isl_give isl_set **empty);
3364         __isl_give isl_map *isl_map_partial_lexmax(
3365                 __isl_take isl_map *map, __isl_take isl_set *dom,
3366                 __isl_give isl_set **empty);
3367         __isl_give isl_map *isl_map_partial_lexmin(
3368                 __isl_take isl_map *map, __isl_take isl_set *dom,
3369                 __isl_give isl_set **empty);
3371 Given a (basic) map C<map> (or C<bmap>), the following functions simply
3372 return a map mapping each element in the domain of
3373 C<map> (or C<bmap>) to the lexicographic minimum or maximum
3374 of all elements associated to that element.
3375 In case of union relations, the optimum is computed per space.
3377         __isl_give isl_map *isl_basic_map_lexmin(
3378                 __isl_take isl_basic_map *bmap);
3379         __isl_give isl_map *isl_basic_map_lexmax(
3380                 __isl_take isl_basic_map *bmap);
3381         __isl_give isl_map *isl_map_lexmin(
3382                 __isl_take isl_map *map);
3383         __isl_give isl_map *isl_map_lexmax(
3384                 __isl_take isl_map *map);
3385         __isl_give isl_union_map *isl_union_map_lexmin(
3386                 __isl_take isl_union_map *umap);
3387         __isl_give isl_union_map *isl_union_map_lexmax(
3388                 __isl_take isl_union_map *umap);
3390 The following functions return their result in the form of
3391 a piecewise multi-affine expression
3392 (See L<"Piecewise Multiple Quasi Affine Expressions">),
3393 but are otherwise equivalent to the corresponding functions
3394 returning a basic set or relation.
3396         __isl_give isl_pw_multi_aff *
3397         isl_basic_map_lexmin_pw_multi_aff(
3398                 __isl_take isl_basic_map *bmap);
3399         __isl_give isl_pw_multi_aff *
3400         isl_basic_set_partial_lexmin_pw_multi_aff(
3401                 __isl_take isl_basic_set *bset,
3402                 __isl_take isl_basic_set *dom,
3403                 __isl_give isl_set **empty);
3404         __isl_give isl_pw_multi_aff *
3405         isl_basic_set_partial_lexmax_pw_multi_aff(
3406                 __isl_take isl_basic_set *bset,
3407                 __isl_take isl_basic_set *dom,
3408                 __isl_give isl_set **empty);
3409         __isl_give isl_pw_multi_aff *
3410         isl_basic_map_partial_lexmin_pw_multi_aff(
3411                 __isl_take isl_basic_map *bmap,
3412                 __isl_take isl_basic_set *dom,
3413                 __isl_give isl_set **empty);
3414         __isl_give isl_pw_multi_aff *
3415         isl_basic_map_partial_lexmax_pw_multi_aff(
3416                 __isl_take isl_basic_map *bmap,
3417                 __isl_take isl_basic_set *dom,
3418                 __isl_give isl_set **empty);
3419         __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
3420                 __isl_take isl_set *set);
3421         __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
3422                 __isl_take isl_set *set);
3423         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
3424                 __isl_take isl_map *map);
3425         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
3426                 __isl_take isl_map *map);
3428 =head2 Lists
3430 Lists are defined over several element types, including
3431 C<isl_val>, C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_constraint>,
3432 C<isl_basic_set>, C<isl_set>, C<isl_ast_expr> and C<isl_ast_node>.
3433 Here we take lists of C<isl_set>s as an example.
3434 Lists can be created, copied, modified and freed using the following functions.
3436         #include <isl/list.h>
3437         __isl_give isl_set_list *isl_set_list_from_set(
3438                 __isl_take isl_set *el);
3439         __isl_give isl_set_list *isl_set_list_alloc(
3440                 isl_ctx *ctx, int n);
3441         __isl_give isl_set_list *isl_set_list_copy(
3442                 __isl_keep isl_set_list *list);
3443         __isl_give isl_set_list *isl_set_list_insert(
3444                 __isl_take isl_set_list *list, unsigned pos,
3445                 __isl_take isl_set *el);
3446         __isl_give isl_set_list *isl_set_list_add(
3447                 __isl_take isl_set_list *list,
3448                 __isl_take isl_set *el);
3449         __isl_give isl_set_list *isl_set_list_drop(
3450                 __isl_take isl_set_list *list,
3451                 unsigned first, unsigned n);
3452         __isl_give isl_set_list *isl_set_list_set_set(
3453                 __isl_take isl_set_list *list, int index,
3454                 __isl_take isl_set *set);
3455         __isl_give isl_set_list *isl_set_list_concat(
3456                 __isl_take isl_set_list *list1,
3457                 __isl_take isl_set_list *list2);
3458         __isl_give isl_set_list *isl_set_list_sort(
3459                 __isl_take isl_set_list *list,
3460                 int (*cmp)(__isl_keep isl_set *a,
3461                         __isl_keep isl_set *b, void *user),
3462                 void *user);
3463         void *isl_set_list_free(__isl_take isl_set_list *list);
3465 C<isl_set_list_alloc> creates an empty list with a capacity for
3466 C<n> elements.  C<isl_set_list_from_set> creates a list with a single
3467 element.
3469 Lists can be inspected using the following functions.
3471         #include <isl/list.h>
3472         isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
3473         int isl_set_list_n_set(__isl_keep isl_set_list *list);
3474         __isl_give isl_set *isl_set_list_get_set(
3475                 __isl_keep isl_set_list *list, int index);
3476         int isl_set_list_foreach(__isl_keep isl_set_list *list,
3477                 int (*fn)(__isl_take isl_set *el, void *user),
3478                 void *user);
3479         int isl_set_list_foreach_scc(__isl_keep isl_set_list *list,
3480                 int (*follows)(__isl_keep isl_set *a,
3481                         __isl_keep isl_set *b, void *user),
3482                 void *follows_user
3483                 int (*fn)(__isl_take isl_set *el, void *user),
3484                 void *fn_user);
3486 The function C<isl_set_list_foreach_scc> calls C<fn> on each of the
3487 strongly connected components of the graph with as vertices the elements
3488 of C<list> and a directed edge from vertex C<b> to vertex C<a>
3489 iff C<follows(a, b)> returns C<1>.  The callbacks C<follows> and C<fn>
3490 should return C<-1> on error.
3492 Lists can be printed using
3494         #include <isl/list.h>
3495         __isl_give isl_printer *isl_printer_print_set_list(
3496                 __isl_take isl_printer *p,
3497                 __isl_keep isl_set_list *list);
3499 =head2 Associative arrays
3501 Associative arrays map isl objects of a specific type to isl objects
3502 of some (other) specific type.  They are defined for several pairs
3503 of types, including (C<isl_map>, C<isl_basic_set>),
3504 (C<isl_id>, C<isl_ast_expr>) and.
3505 (C<isl_id>, C<isl_pw_aff>).
3506 Here, we take associative arrays that map C<isl_id>s to C<isl_ast_expr>s
3507 as an example.
3509 Associative arrays can be created, copied and freed using
3510 the following functions.
3512         #include <isl/id_to_ast_expr.h>
3513         __isl_give id_to_ast_expr *isl_id_to_ast_expr_alloc(
3514                 isl_ctx *ctx, int min_size);
3515         __isl_give id_to_ast_expr *isl_id_to_ast_expr_copy(
3516                 __isl_keep id_to_ast_expr *id2expr);
3517         void *isl_id_to_ast_expr_free(
3518                 __isl_take id_to_ast_expr *id2expr);
3520 The C<min_size> argument to C<isl_id_to_ast_expr_alloc> can be used
3521 to specify the expected size of the associative array.
3522 The associative array will be grown automatically as needed.
3524 Associative arrays can be inspected using the following functions.
3526         #include <isl/id_to_ast_expr.h>
3527         isl_ctx *isl_id_to_ast_expr_get_ctx(
3528                 __isl_keep id_to_ast_expr *id2expr);
3529         int isl_id_to_ast_expr_has(
3530                 __isl_keep id_to_ast_expr *id2expr,
3531                 __isl_keep isl_id *key);
3532         __isl_give isl_ast_expr *isl_id_to_ast_expr_get(
3533                 __isl_keep id_to_ast_expr *id2expr,
3534                 __isl_take isl_id *key);
3535         int isl_id_to_ast_expr_foreach(
3536                 __isl_keep id_to_ast_expr *id2expr,
3537                 int (*fn)(__isl_take isl_id *key,
3538                         __isl_take isl_ast_expr *val, void *user),
3539                 void *user);
3541 They can be modified using the following function.
3543         #include <isl/id_to_ast_expr.h>
3544         __isl_give id_to_ast_expr *isl_id_to_ast_expr_set(
3545                 __isl_take id_to_ast_expr *id2expr,
3546                 __isl_take isl_id *key,
3547                 __isl_take isl_ast_expr *val);
3548         __isl_give id_to_ast_expr *isl_id_to_ast_expr_drop(
3549                 __isl_take id_to_ast_expr *id2expr,
3550                 __isl_take isl_id *key);
3552 Associative arrays can be printed using the following function.
3554         #include <isl/id_to_ast_expr.h>
3555         __isl_give isl_printer *isl_printer_print_id_to_ast_expr(
3556                 __isl_take isl_printer *p,
3557                 __isl_keep id_to_ast_expr *id2expr);
3559 =head2 Multiple Values
3561 An C<isl_multi_val> object represents a sequence of zero or more values,
3562 living in a set space.
3564 An C<isl_multi_val> can be constructed from an C<isl_val_list>
3565 using the following function
3567         #include <isl/val.h>
3568         __isl_give isl_multi_val *isl_multi_val_from_val_list(
3569                 __isl_take isl_space *space,
3570                 __isl_take isl_val_list *list);
3572 The zero multiple value (with value zero for each set dimension)
3573 can be created using the following function.
3575         #include <isl/val.h>
3576         __isl_give isl_multi_val *isl_multi_val_zero(
3577                 __isl_take isl_space *space);
3579 Multiple values can be copied and freed using
3581         #include <isl/val.h>
3582         __isl_give isl_multi_val *isl_multi_val_copy(
3583                 __isl_keep isl_multi_val *mv);
3584         void *isl_multi_val_free(__isl_take isl_multi_val *mv);
3586 They can be inspected using
3588         #include <isl/val.h>
3589         isl_ctx *isl_multi_val_get_ctx(
3590                 __isl_keep isl_multi_val *mv);
3591         unsigned isl_multi_val_dim(__isl_keep isl_multi_val *mv,
3592                 enum isl_dim_type type);
3593         __isl_give isl_val *isl_multi_val_get_val(
3594                 __isl_keep isl_multi_val *mv, int pos);
3595         int isl_multi_val_find_dim_by_id(
3596                 __isl_keep isl_multi_val *mv,
3597                 enum isl_dim_type type, __isl_keep isl_id *id);
3598         __isl_give isl_id *isl_multi_val_get_dim_id(
3599                 __isl_keep isl_multi_val *mv,
3600                 enum isl_dim_type type, unsigned pos);
3601         const char *isl_multi_val_get_tuple_name(
3602                 __isl_keep isl_multi_val *mv,
3603                 enum isl_dim_type type);
3604         int isl_multi_val_has_tuple_id(__isl_keep isl_multi_val *mv,
3605                 enum isl_dim_type type);
3606         __isl_give isl_id *isl_multi_val_get_tuple_id(
3607                 __isl_keep isl_multi_val *mv,
3608                 enum isl_dim_type type);
3609         int isl_multi_val_range_is_wrapping(
3610                 __isl_keep isl_multi_val *mv);
3612 They can be modified using
3614         #include <isl/val.h>
3615         __isl_give isl_multi_val *isl_multi_val_set_val(
3616                 __isl_take isl_multi_val *mv, int pos,
3617                 __isl_take isl_val *val);
3618         __isl_give isl_multi_val *isl_multi_val_set_dim_name(
3619                 __isl_take isl_multi_val *mv,
3620                 enum isl_dim_type type, unsigned pos, const char *s);
3621         __isl_give isl_multi_val *isl_multi_val_set_dim_id(
3622                 __isl_take isl_multi_val *mv,
3623                 enum isl_dim_type type, unsigned pos,
3624                 __isl_take isl_id *id);
3625         __isl_give isl_multi_val *isl_multi_val_set_tuple_name(
3626                 __isl_take isl_multi_val *mv,
3627                 enum isl_dim_type type, const char *s);
3628         __isl_give isl_multi_val *isl_multi_val_set_tuple_id(
3629                 __isl_take isl_multi_val *mv,
3630                 enum isl_dim_type type, __isl_take isl_id *id);
3631         __isl_give isl_multi_val *isl_multi_val_reset_tuple_id(
3632                 __isl_take isl_multi_val *mv,
3633                 enum isl_dim_type type);
3634         __isl_give isl_multi_val *isl_multi_val_reset_user(
3635                 __isl_take isl_multi_val *mv);
3637         __isl_give isl_multi_val *isl_multi_val_insert_dims(
3638                 __isl_take isl_multi_val *mv,
3639                 enum isl_dim_type type, unsigned first, unsigned n);
3640         __isl_give isl_multi_val *isl_multi_val_add_dims(
3641                 __isl_take isl_multi_val *mv,
3642                 enum isl_dim_type type, unsigned n);
3643         __isl_give isl_multi_val *isl_multi_val_drop_dims(
3644                 __isl_take isl_multi_val *mv,
3645                 enum isl_dim_type type, unsigned first, unsigned n);
3647 Operations include
3649         #include <isl/val.h>
3650         __isl_give isl_multi_val *isl_multi_val_align_params(
3651                 __isl_take isl_multi_val *mv,
3652                 __isl_take isl_space *model);
3653         __isl_give isl_multi_val *isl_multi_val_from_range(
3654                 __isl_take isl_multi_val *mv);
3655         __isl_give isl_multi_val *isl_multi_val_range_splice(
3656                 __isl_take isl_multi_val *mv1, unsigned pos,
3657                 __isl_take isl_multi_val *mv2);
3658         __isl_give isl_multi_val *isl_multi_val_range_product(
3659                 __isl_take isl_multi_val *mv1,
3660                 __isl_take isl_multi_val *mv2);
3661         __isl_give isl_multi_val *
3662         isl_multi_val_range_factor_domain(
3663                 __isl_take isl_multi_val *mv);
3664         __isl_give isl_multi_val *
3665         isl_multi_val_range_factor_range(
3666                 __isl_take isl_multi_val *mv);
3667         __isl_give isl_multi_val *isl_multi_val_flat_range_product(
3668                 __isl_take isl_multi_val *mv1,
3669                 __isl_take isl_multi_aff *mv2);
3670         __isl_give isl_multi_val *isl_multi_val_product(
3671                 __isl_take isl_multi_val *mv1,
3672                 __isl_take isl_multi_val *mv2);
3673         __isl_give isl_multi_val *isl_multi_val_add_val(
3674                 __isl_take isl_multi_val *mv,
3675                 __isl_take isl_val *v);
3676         __isl_give isl_multi_val *isl_multi_val_mod_val(
3677                 __isl_take isl_multi_val *mv,
3678                 __isl_take isl_val *v);
3679         __isl_give isl_multi_val *isl_multi_val_scale_val(
3680                 __isl_take isl_multi_val *mv,
3681                 __isl_take isl_val *v);
3682         __isl_give isl_multi_val *isl_multi_val_scale_multi_val(
3683                 __isl_take isl_multi_val *mv1,
3684                 __isl_take isl_multi_val *mv2);
3685         __isl_give isl_multi_val *
3686         isl_multi_val_scale_down_multi_val(
3687                 __isl_take isl_multi_val *mv1,
3688                 __isl_take isl_multi_val *mv2);
3690 A multiple value can be printed using
3692         __isl_give isl_printer *isl_printer_print_multi_val(
3693                 __isl_take isl_printer *p,
3694                 __isl_keep isl_multi_val *mv);
3696 =head2 Vectors
3698 Vectors can be created, copied and freed using the following functions.
3700         #include <isl/vec.h>
3701         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
3702                 unsigned size);
3703         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
3704         void *isl_vec_free(__isl_take isl_vec *vec);
3706 Note that the elements of a newly created vector may have arbitrary values.
3707 The elements can be changed and inspected using the following functions.
3709         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
3710         int isl_vec_size(__isl_keep isl_vec *vec);
3711         __isl_give isl_val *isl_vec_get_element_val(
3712                 __isl_keep isl_vec *vec, int pos);
3713         __isl_give isl_vec *isl_vec_set_element_si(
3714                 __isl_take isl_vec *vec, int pos, int v);
3715         __isl_give isl_vec *isl_vec_set_element_val(
3716                 __isl_take isl_vec *vec, int pos,
3717                 __isl_take isl_val *v);
3718         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
3719                 int v);
3720         __isl_give isl_vec *isl_vec_set_val(
3721                 __isl_take isl_vec *vec, __isl_take isl_val *v);
3722         int isl_vec_cmp_element(__isl_keep isl_vec *vec1,
3723                 __isl_keep isl_vec *vec2, int pos);
3725 C<isl_vec_get_element> will return a negative value if anything went wrong.
3726 In that case, the value of C<*v> is undefined.
3728 The following function can be used to concatenate two vectors.
3730         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
3731                 __isl_take isl_vec *vec2);
3733 =head2 Matrices
3735 Matrices can be created, copied and freed using the following functions.
3737         #include <isl/mat.h>
3738         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
3739                 unsigned n_row, unsigned n_col);
3740         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
3741         void *isl_mat_free(__isl_take isl_mat *mat);
3743 Note that the elements of a newly created matrix may have arbitrary values.
3744 The elements can be changed and inspected using the following functions.
3746         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
3747         int isl_mat_rows(__isl_keep isl_mat *mat);
3748         int isl_mat_cols(__isl_keep isl_mat *mat);
3749         __isl_give isl_val *isl_mat_get_element_val(
3750                 __isl_keep isl_mat *mat, int row, int col);
3751         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
3752                 int row, int col, int v);
3753         __isl_give isl_mat *isl_mat_set_element_val(
3754                 __isl_take isl_mat *mat, int row, int col,
3755                 __isl_take isl_val *v);
3757 C<isl_mat_get_element> will return a negative value if anything went wrong.
3758 In that case, the value of C<*v> is undefined.
3760 The following function can be used to compute the (right) inverse
3761 of a matrix, i.e., a matrix such that the product of the original
3762 and the inverse (in that order) is a multiple of the identity matrix.
3763 The input matrix is assumed to be of full row-rank.
3765         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
3767 The following function can be used to compute the (right) kernel
3768 (or null space) of a matrix, i.e., a matrix such that the product of
3769 the original and the kernel (in that order) is the zero matrix.
3771         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
3773 =head2 Piecewise Quasi Affine Expressions
3775 The zero quasi affine expression or the quasi affine expression
3776 that is equal to a given value or
3777 a specified dimension on a given domain can be created using
3779         __isl_give isl_aff *isl_aff_zero_on_domain(
3780                 __isl_take isl_local_space *ls);
3781         __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
3782                 __isl_take isl_local_space *ls);
3783         __isl_give isl_aff *isl_aff_val_on_domain(
3784                 __isl_take isl_local_space *ls,
3785                 __isl_take isl_val *val);
3786         __isl_give isl_aff *isl_aff_var_on_domain(
3787                 __isl_take isl_local_space *ls,
3788                 enum isl_dim_type type, unsigned pos);
3789         __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
3790                 __isl_take isl_local_space *ls,
3791                 enum isl_dim_type type, unsigned pos);
3793 Note that the space in which the resulting objects live is a map space
3794 with the given space as domain and a one-dimensional range.
3796 An empty piecewise quasi affine expression (one with no cells)
3797 or a piecewise quasi affine expression with a single cell can
3798 be created using the following functions.
3800         #include <isl/aff.h>
3801         __isl_give isl_pw_aff *isl_pw_aff_empty(
3802                 __isl_take isl_space *space);
3803         __isl_give isl_pw_aff *isl_pw_aff_alloc(
3804                 __isl_take isl_set *set, __isl_take isl_aff *aff);
3805         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
3806                 __isl_take isl_aff *aff);
3808 A piecewise quasi affine expression that is equal to 1 on a set
3809 and 0 outside the set can be created using the following function.
3811         #include <isl/aff.h>
3812         __isl_give isl_pw_aff *isl_set_indicator_function(
3813                 __isl_take isl_set *set);
3815 Quasi affine expressions can be copied and freed using
3817         #include <isl/aff.h>
3818         __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
3819         void *isl_aff_free(__isl_take isl_aff *aff);
3821         __isl_give isl_pw_aff *isl_pw_aff_copy(
3822                 __isl_keep isl_pw_aff *pwaff);
3823         void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
3825 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
3826 using the following function.  The constraint is required to have
3827 a non-zero coefficient for the specified dimension.
3829         #include <isl/constraint.h>
3830         __isl_give isl_aff *isl_constraint_get_bound(
3831                 __isl_keep isl_constraint *constraint,
3832                 enum isl_dim_type type, int pos);
3834 The entire affine expression of the constraint can also be extracted
3835 using the following function.
3837         #include <isl/constraint.h>
3838         __isl_give isl_aff *isl_constraint_get_aff(
3839                 __isl_keep isl_constraint *constraint);
3841 Conversely, an equality constraint equating
3842 the affine expression to zero or an inequality constraint enforcing
3843 the affine expression to be non-negative, can be constructed using
3845         __isl_give isl_constraint *isl_equality_from_aff(
3846                 __isl_take isl_aff *aff);
3847         __isl_give isl_constraint *isl_inequality_from_aff(
3848                 __isl_take isl_aff *aff);
3850 The expression can be inspected using
3852         #include <isl/aff.h>
3853         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
3854         int isl_aff_dim(__isl_keep isl_aff *aff,
3855                 enum isl_dim_type type);
3856         __isl_give isl_local_space *isl_aff_get_domain_local_space(
3857                 __isl_keep isl_aff *aff);
3858         __isl_give isl_local_space *isl_aff_get_local_space(
3859                 __isl_keep isl_aff *aff);
3860         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3861                 enum isl_dim_type type, unsigned pos);
3862         const char *isl_pw_aff_get_dim_name(
3863                 __isl_keep isl_pw_aff *pa,
3864                 enum isl_dim_type type, unsigned pos);
3865         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3866                 enum isl_dim_type type, unsigned pos);
3867         __isl_give isl_id *isl_pw_aff_get_dim_id(
3868                 __isl_keep isl_pw_aff *pa,
3869                 enum isl_dim_type type, unsigned pos);
3870         int isl_pw_aff_has_tuple_id(__isl_keep isl_pw_aff *pa,
3871                 enum isl_dim_type type);
3872         __isl_give isl_id *isl_pw_aff_get_tuple_id(
3873                 __isl_keep isl_pw_aff *pa,
3874                 enum isl_dim_type type);
3875         __isl_give isl_val *isl_aff_get_constant_val(
3876                 __isl_keep isl_aff *aff);
3877         __isl_give isl_val *isl_aff_get_coefficient_val(
3878                 __isl_keep isl_aff *aff,
3879                 enum isl_dim_type type, int pos);
3880         __isl_give isl_val *isl_aff_get_denominator_val(
3881                 __isl_keep isl_aff *aff);
3882         __isl_give isl_aff *isl_aff_get_div(
3883                 __isl_keep isl_aff *aff, int pos);
3885         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3886         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3887                 int (*fn)(__isl_take isl_set *set,
3888                           __isl_take isl_aff *aff,
3889                           void *user), void *user);
3891         int isl_aff_is_cst(__isl_keep isl_aff *aff);
3892         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3894         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3895                 enum isl_dim_type type, unsigned first, unsigned n);
3896         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3897                 enum isl_dim_type type, unsigned first, unsigned n);
3899         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3900         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3901                 enum isl_dim_type type);
3902         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3904 It can be modified using
3906         #include <isl/aff.h>
3907         __isl_give isl_aff *isl_aff_set_tuple_id(
3908                 __isl_take isl_aff *aff,
3909                 enum isl_dim_type type, __isl_take isl_id *id);
3910         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3911                 __isl_take isl_pw_aff *pwaff,
3912                 enum isl_dim_type type, __isl_take isl_id *id);
3913         __isl_give isl_aff *isl_aff_set_dim_name(
3914                 __isl_take isl_aff *aff, enum isl_dim_type type,
3915                 unsigned pos, const char *s);
3916         __isl_give isl_aff *isl_aff_set_dim_id(
3917                 __isl_take isl_aff *aff, enum isl_dim_type type,
3918                 unsigned pos, __isl_take isl_id *id);
3919         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3920                 __isl_take isl_pw_aff *pma,
3921                 enum isl_dim_type type, unsigned pos,
3922                 __isl_take isl_id *id);
3923         __isl_give isl_aff *isl_aff_set_constant_si(
3924                 __isl_take isl_aff *aff, int v);
3925         __isl_give isl_aff *isl_aff_set_constant_val(
3926                 __isl_take isl_aff *aff, __isl_take isl_val *v);
3927         __isl_give isl_aff *isl_aff_set_coefficient_si(
3928                 __isl_take isl_aff *aff,
3929                 enum isl_dim_type type, int pos, int v);
3930         __isl_give isl_aff *isl_aff_set_coefficient_val(
3931                 __isl_take isl_aff *aff,
3932                 enum isl_dim_type type, int pos,
3933                 __isl_take isl_val *v);
3935         __isl_give isl_aff *isl_aff_add_constant_si(
3936                 __isl_take isl_aff *aff, int v);
3937         __isl_give isl_aff *isl_aff_add_constant_val(
3938                 __isl_take isl_aff *aff, __isl_take isl_val *v);
3939         __isl_give isl_aff *isl_aff_add_constant_num_si(
3940                 __isl_take isl_aff *aff, int v);
3941         __isl_give isl_aff *isl_aff_add_coefficient_si(
3942                 __isl_take isl_aff *aff,
3943                 enum isl_dim_type type, int pos, int v);
3944         __isl_give isl_aff *isl_aff_add_coefficient_val(
3945                 __isl_take isl_aff *aff,
3946                 enum isl_dim_type type, int pos,
3947                 __isl_take isl_val *v);
3949         __isl_give isl_aff *isl_aff_insert_dims(
3950                 __isl_take isl_aff *aff,
3951                 enum isl_dim_type type, unsigned first, unsigned n);
3952         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3953                 __isl_take isl_pw_aff *pwaff,
3954                 enum isl_dim_type type, unsigned first, unsigned n);
3955         __isl_give isl_aff *isl_aff_add_dims(
3956                 __isl_take isl_aff *aff,
3957                 enum isl_dim_type type, unsigned n);
3958         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3959                 __isl_take isl_pw_aff *pwaff,
3960                 enum isl_dim_type type, unsigned n);
3961         __isl_give isl_aff *isl_aff_drop_dims(
3962                 __isl_take isl_aff *aff,
3963                 enum isl_dim_type type, unsigned first, unsigned n);
3964         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
3965                 __isl_take isl_pw_aff *pwaff,
3966                 enum isl_dim_type type, unsigned first, unsigned n);
3967         __isl_give isl_aff *isl_aff_move_dims(
3968                 __isl_take isl_aff *aff,
3969                 enum isl_dim_type dst_type, unsigned dst_pos,
3970                 enum isl_dim_type src_type, unsigned src_pos,
3971                 unsigned n);
3972         __isl_give isl_pw_aff *isl_pw_aff_move_dims(
3973                 __isl_take isl_pw_aff *pa,
3974                 enum isl_dim_type dst_type, unsigned dst_pos,
3975                 enum isl_dim_type src_type, unsigned src_pos,
3976                 unsigned n);
3978 Note that C<isl_aff_set_constant_si> and C<isl_aff_set_coefficient_si>
3979 set the I<numerator> of the constant or coefficient, while
3980 C<isl_aff_set_constant_val> and C<isl_aff_set_coefficient_val> set
3981 the constant or coefficient as a whole.
3982 The C<add_constant> and C<add_coefficient> functions add an integer
3983 or rational value to
3984 the possibly rational constant or coefficient.
3985 The C<add_constant_num> functions add an integer value to
3986 the numerator.
3988 To check whether an affine expressions is obviously zero
3989 or (obviously) equal to some other affine expression, use
3991         #include <isl/aff.h>
3992         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3993         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3994                 __isl_keep isl_aff *aff2);
3995         int isl_pw_aff_plain_is_equal(
3996                 __isl_keep isl_pw_aff *pwaff1,
3997                 __isl_keep isl_pw_aff *pwaff2);
3998         int isl_pw_aff_is_equal(__isl_keep isl_pw_aff *pa1,
3999                 __isl_keep isl_pw_aff *pa2);
4001 Operations include
4003         #include <isl/aff.h>
4004         __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
4005                 __isl_take isl_aff *aff2);
4006         __isl_give isl_pw_aff *isl_pw_aff_add(
4007                 __isl_take isl_pw_aff *pwaff1,
4008                 __isl_take isl_pw_aff *pwaff2);
4009         __isl_give isl_pw_aff *isl_pw_aff_min(
4010                 __isl_take isl_pw_aff *pwaff1,
4011                 __isl_take isl_pw_aff *pwaff2);
4012         __isl_give isl_pw_aff *isl_pw_aff_max(
4013                 __isl_take isl_pw_aff *pwaff1,
4014                 __isl_take isl_pw_aff *pwaff2);
4015         __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
4016                 __isl_take isl_aff *aff2);
4017         __isl_give isl_pw_aff *isl_pw_aff_sub(
4018                 __isl_take isl_pw_aff *pwaff1,
4019                 __isl_take isl_pw_aff *pwaff2);
4020         __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
4021         __isl_give isl_pw_aff *isl_pw_aff_neg(
4022                 __isl_take isl_pw_aff *pwaff);
4023         __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
4024         __isl_give isl_pw_aff *isl_pw_aff_ceil(
4025                 __isl_take isl_pw_aff *pwaff);
4026         __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
4027         __isl_give isl_pw_aff *isl_pw_aff_floor(
4028                 __isl_take isl_pw_aff *pwaff);
4029         __isl_give isl_aff *isl_aff_mod_val(__isl_take isl_aff *aff,
4030                 __isl_take isl_val *mod);
4031         __isl_give isl_pw_aff *isl_pw_aff_mod_val(
4032                 __isl_take isl_pw_aff *pa,
4033                 __isl_take isl_val *mod);
4034         __isl_give isl_aff *isl_aff_scale_val(__isl_take isl_aff *aff,
4035                 __isl_take isl_val *v);
4036         __isl_give isl_pw_aff *isl_pw_aff_scale_val(
4037                 __isl_take isl_pw_aff *pa, __isl_take isl_val *v);
4038         __isl_give isl_aff *isl_aff_scale_down_ui(
4039                 __isl_take isl_aff *aff, unsigned f);
4040         __isl_give isl_aff *isl_aff_scale_down_val(
4041                 __isl_take isl_aff *aff, __isl_take isl_val *v);
4042         __isl_give isl_pw_aff *isl_pw_aff_scale_down_val(
4043                 __isl_take isl_pw_aff *pa,
4044                 __isl_take isl_val *f);
4046         __isl_give isl_pw_aff *isl_pw_aff_list_min(
4047                 __isl_take isl_pw_aff_list *list);
4048         __isl_give isl_pw_aff *isl_pw_aff_list_max(
4049                 __isl_take isl_pw_aff_list *list);
4051         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
4052                 __isl_take isl_pw_aff *pwqp);
4054         __isl_give isl_aff *isl_aff_align_params(
4055                 __isl_take isl_aff *aff,
4056                 __isl_take isl_space *model);
4057         __isl_give isl_pw_aff *isl_pw_aff_align_params(
4058                 __isl_take isl_pw_aff *pwaff,
4059                 __isl_take isl_space *model);
4061         __isl_give isl_aff *isl_aff_project_domain_on_params(
4062                 __isl_take isl_aff *aff);
4063         __isl_give isl_pw_aff *isl_pw_aff_from_range(
4064                 __isl_take isl_pw_aff *pwa);
4066         __isl_give isl_aff *isl_aff_gist_params(
4067                 __isl_take isl_aff *aff,
4068                 __isl_take isl_set *context);
4069         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
4070                 __isl_take isl_set *context);
4071         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
4072                 __isl_take isl_pw_aff *pwaff,
4073                 __isl_take isl_set *context);
4074         __isl_give isl_pw_aff *isl_pw_aff_gist(
4075                 __isl_take isl_pw_aff *pwaff,
4076                 __isl_take isl_set *context);
4078         __isl_give isl_set *isl_pw_aff_domain(
4079                 __isl_take isl_pw_aff *pwaff);
4080         __isl_give isl_set *isl_pw_aff_params(
4081                 __isl_take isl_pw_aff *pwa);
4082         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
4083                 __isl_take isl_pw_aff *pa,
4084                 __isl_take isl_set *set);
4085         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
4086                 __isl_take isl_pw_aff *pa,
4087                 __isl_take isl_set *set);
4089         __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
4090                 __isl_take isl_aff *aff2);
4091         __isl_give isl_aff *isl_aff_div(__isl_take isl_aff *aff1,
4092                 __isl_take isl_aff *aff2);
4093         __isl_give isl_pw_aff *isl_pw_aff_mul(
4094                 __isl_take isl_pw_aff *pwaff1,
4095                 __isl_take isl_pw_aff *pwaff2);
4096         __isl_give isl_pw_aff *isl_pw_aff_div(
4097                 __isl_take isl_pw_aff *pa1,
4098                 __isl_take isl_pw_aff *pa2);
4099         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
4100                 __isl_take isl_pw_aff *pa1,
4101                 __isl_take isl_pw_aff *pa2);
4102         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
4103                 __isl_take isl_pw_aff *pa1,
4104                 __isl_take isl_pw_aff *pa2);
4106 When multiplying two affine expressions, at least one of the two needs
4107 to be a constant.  Similarly, when dividing an affine expression by another,
4108 the second expression needs to be a constant.
4109 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
4110 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
4111 remainder.
4113         #include <isl/aff.h>
4114         __isl_give isl_aff *isl_aff_pullback_aff(
4115                 __isl_take isl_aff *aff1,
4116                 __isl_take isl_aff *aff2);
4117         __isl_give isl_aff *isl_aff_pullback_multi_aff(
4118                 __isl_take isl_aff *aff,
4119                 __isl_take isl_multi_aff *ma);
4120         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
4121                 __isl_take isl_pw_aff *pa,
4122                 __isl_take isl_multi_aff *ma);
4123         __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
4124                 __isl_take isl_pw_aff *pa,
4125                 __isl_take isl_pw_multi_aff *pma);
4126         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_pw_aff(
4127                 __isl_take isl_pw_aff *pa,
4128                 __isl_take isl_multi_pw_aff *mpa);
4130 These functions precompose the input expression by the given
4131 C<isl_aff>, C<isl_multi_aff> or C<isl_pw_multi_aff>.  In other words,
4132 the C<isl_aff>, C<isl_multi_aff> or C<isl_pw_multi_aff> is plugged
4133 into the (piecewise) affine expression.
4134 Objects of type C<isl_multi_aff> are described in
4135 L</"Piecewise Multiple Quasi Affine Expressions">.
4137         #include <isl/aff.h>
4138         __isl_give isl_basic_set *isl_aff_zero_basic_set(
4139                 __isl_take isl_aff *aff);
4140         __isl_give isl_basic_set *isl_aff_neg_basic_set(
4141                 __isl_take isl_aff *aff);
4142         __isl_give isl_basic_set *isl_aff_le_basic_set(
4143                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
4144         __isl_give isl_basic_set *isl_aff_ge_basic_set(
4145                 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
4146         __isl_give isl_set *isl_pw_aff_eq_set(
4147                 __isl_take isl_pw_aff *pwaff1,
4148                 __isl_take isl_pw_aff *pwaff2);
4149         __isl_give isl_set *isl_pw_aff_ne_set(
4150                 __isl_take isl_pw_aff *pwaff1,
4151                 __isl_take isl_pw_aff *pwaff2);
4152         __isl_give isl_set *isl_pw_aff_le_set(
4153                 __isl_take isl_pw_aff *pwaff1,
4154                 __isl_take isl_pw_aff *pwaff2);
4155         __isl_give isl_set *isl_pw_aff_lt_set(
4156                 __isl_take isl_pw_aff *pwaff1,
4157                 __isl_take isl_pw_aff *pwaff2);
4158         __isl_give isl_set *isl_pw_aff_ge_set(
4159                 __isl_take isl_pw_aff *pwaff1,
4160                 __isl_take isl_pw_aff *pwaff2);
4161         __isl_give isl_set *isl_pw_aff_gt_set(
4162                 __isl_take isl_pw_aff *pwaff1,
4163                 __isl_take isl_pw_aff *pwaff2);
4165         __isl_give isl_set *isl_pw_aff_list_eq_set(
4166                 __isl_take isl_pw_aff_list *list1,
4167                 __isl_take isl_pw_aff_list *list2);
4168         __isl_give isl_set *isl_pw_aff_list_ne_set(
4169                 __isl_take isl_pw_aff_list *list1,
4170                 __isl_take isl_pw_aff_list *list2);
4171         __isl_give isl_set *isl_pw_aff_list_le_set(
4172                 __isl_take isl_pw_aff_list *list1,
4173                 __isl_take isl_pw_aff_list *list2);
4174         __isl_give isl_set *isl_pw_aff_list_lt_set(
4175                 __isl_take isl_pw_aff_list *list1,
4176                 __isl_take isl_pw_aff_list *list2);
4177         __isl_give isl_set *isl_pw_aff_list_ge_set(
4178                 __isl_take isl_pw_aff_list *list1,
4179                 __isl_take isl_pw_aff_list *list2);
4180         __isl_give isl_set *isl_pw_aff_list_gt_set(
4181                 __isl_take isl_pw_aff_list *list1,
4182                 __isl_take isl_pw_aff_list *list2);
4184 The function C<isl_aff_neg_basic_set> returns a basic set
4185 containing those elements in the domain space
4186 of C<aff> where C<aff> is negative.
4187 The function C<isl_aff_ge_basic_set> returns a basic set
4188 containing those elements in the shared space
4189 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
4190 The function C<isl_pw_aff_ge_set> returns a set
4191 containing those elements in the shared domain
4192 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
4193 The functions operating on C<isl_pw_aff_list> apply the corresponding
4194 C<isl_pw_aff> function to each pair of elements in the two lists.
4196         #include <isl/aff.h>
4197         __isl_give isl_set *isl_pw_aff_nonneg_set(
4198                 __isl_take isl_pw_aff *pwaff);
4199         __isl_give isl_set *isl_pw_aff_zero_set(
4200                 __isl_take isl_pw_aff *pwaff);
4201         __isl_give isl_set *isl_pw_aff_non_zero_set(
4202                 __isl_take isl_pw_aff *pwaff);
4204 The function C<isl_pw_aff_nonneg_set> returns a set
4205 containing those elements in the domain
4206 of C<pwaff> where C<pwaff> is non-negative.
4208         #include <isl/aff.h>
4209         __isl_give isl_pw_aff *isl_pw_aff_cond(
4210                 __isl_take isl_pw_aff *cond,
4211                 __isl_take isl_pw_aff *pwaff_true,
4212                 __isl_take isl_pw_aff *pwaff_false);
4214 The function C<isl_pw_aff_cond> performs a conditional operator
4215 and returns an expression that is equal to C<pwaff_true>
4216 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
4217 where C<cond> is zero.
4219         #include <isl/aff.h>
4220         __isl_give isl_pw_aff *isl_pw_aff_union_min(
4221                 __isl_take isl_pw_aff *pwaff1,
4222                 __isl_take isl_pw_aff *pwaff2);
4223         __isl_give isl_pw_aff *isl_pw_aff_union_max(
4224                 __isl_take isl_pw_aff *pwaff1,
4225                 __isl_take isl_pw_aff *pwaff2);
4226         __isl_give isl_pw_aff *isl_pw_aff_union_add(
4227                 __isl_take isl_pw_aff *pwaff1,
4228                 __isl_take isl_pw_aff *pwaff2);
4230 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
4231 expression with a domain that is the union of those of C<pwaff1> and
4232 C<pwaff2> and such that on each cell, the quasi-affine expression is
4233 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
4234 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
4235 associated expression is the defined one.
4237 An expression can be read from input using
4239         #include <isl/aff.h>
4240         __isl_give isl_aff *isl_aff_read_from_str(
4241                 isl_ctx *ctx, const char *str);
4242         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
4243                 isl_ctx *ctx, const char *str);
4245 An expression can be printed using
4247         #include <isl/aff.h>
4248         __isl_give isl_printer *isl_printer_print_aff(
4249                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
4251         __isl_give isl_printer *isl_printer_print_pw_aff(
4252                 __isl_take isl_printer *p,
4253                 __isl_keep isl_pw_aff *pwaff);
4255 =head2 Piecewise Multiple Quasi Affine Expressions
4257 An C<isl_multi_aff> object represents a sequence of
4258 zero or more affine expressions, all defined on the same domain space.
4259 Similarly, an C<isl_multi_pw_aff> object represents a sequence of
4260 zero or more piecewise affine expressions.
4262 An C<isl_multi_aff> can be constructed from a single
4263 C<isl_aff> or an C<isl_aff_list> using the
4264 following functions.  Similarly for C<isl_multi_pw_aff>
4265 and C<isl_pw_multi_aff>.
4267         #include <isl/aff.h>
4268         __isl_give isl_multi_aff *isl_multi_aff_from_aff(
4269                 __isl_take isl_aff *aff);
4270         __isl_give isl_multi_pw_aff *
4271         isl_multi_pw_aff_from_multi_aff(
4272                 __isl_take isl_multi_aff *ma);
4273         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
4274                 __isl_take isl_pw_aff *pa);
4275         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_pw_aff(
4276                 __isl_take isl_pw_aff *pa);
4277         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
4278                 __isl_take isl_space *space,
4279                 __isl_take isl_aff_list *list);
4281 An C<isl_multi_pw_aff> can be converted to an C<isl_pw_multi_aff>
4282 using the function C<isl_pw_multi_aff_from_multi_pw_aff> below.
4283 Note however that the domain
4284 of the result is the intersection of the domains of the input.
4285 The reverse conversion is exact.
4287         #include <isl/aff.h>
4288         __isl_give isl_pw_multi_aff *
4289         isl_pw_multi_aff_from_multi_pw_aff(
4290                 __isl_take isl_multi_pw_aff *mpa);
4291         __isl_give isl_multi_pw_aff *
4292         isl_multi_pw_aff_from_pw_multi_aff(
4293                 __isl_take isl_pw_multi_aff *pma);
4295 An empty piecewise multiple quasi affine expression (one with no cells),
4296 the zero piecewise multiple quasi affine expression (with value zero
4297 for each output dimension),
4298 a piecewise multiple quasi affine expression with a single cell (with
4299 either a universe or a specified domain) or
4300 a zero-dimensional piecewise multiple quasi affine expression
4301 on a given domain
4302 can be created using the following functions.
4304         #include <isl/aff.h>
4305         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
4306                 __isl_take isl_space *space);
4307         __isl_give isl_multi_aff *isl_multi_aff_zero(
4308                 __isl_take isl_space *space);
4309         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_zero(
4310                 __isl_take isl_space *space);
4311         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
4312                 __isl_take isl_space *space);
4313         __isl_give isl_multi_aff *isl_multi_aff_identity(
4314                 __isl_take isl_space *space);
4315         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
4316                 __isl_take isl_space *space);
4317         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
4318                 __isl_take isl_space *space);
4319         __isl_give isl_multi_aff *isl_multi_aff_domain_map(
4320                 __isl_take isl_space *space);
4321         __isl_give isl_multi_aff *isl_multi_aff_range_map(
4322                 __isl_take isl_space *space);
4323         __isl_give isl_multi_aff *isl_multi_aff_project_out_map(
4324                 __isl_take isl_space *space,
4325                 enum isl_dim_type type,
4326                 unsigned first, unsigned n);
4327         __isl_give isl_pw_multi_aff *
4328         isl_pw_multi_aff_project_out_map(
4329                 __isl_take isl_space *space,
4330                 enum isl_dim_type type,
4331                 unsigned first, unsigned n);
4332         __isl_give isl_pw_multi_aff *
4333         isl_pw_multi_aff_from_multi_aff(
4334                 __isl_take isl_multi_aff *ma);
4335         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
4336                 __isl_take isl_set *set,
4337                 __isl_take isl_multi_aff *maff);
4338         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
4339                 __isl_take isl_set *set);
4341         __isl_give isl_union_pw_multi_aff *
4342         isl_union_pw_multi_aff_empty(
4343                 __isl_take isl_space *space);
4344         __isl_give isl_union_pw_multi_aff *
4345         isl_union_pw_multi_aff_add_pw_multi_aff(
4346                 __isl_take isl_union_pw_multi_aff *upma,
4347                 __isl_take isl_pw_multi_aff *pma);
4348         __isl_give isl_union_pw_multi_aff *
4349         isl_union_pw_multi_aff_from_domain(
4350                 __isl_take isl_union_set *uset);
4352 A piecewise multiple quasi affine expression can also be initialized
4353 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
4354 and the C<isl_map> is single-valued.
4355 In case of a conversion from an C<isl_union_set> or an C<isl_union_map>
4356 to an C<isl_union_pw_multi_aff>, these properties need to hold in each space.
4358         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
4359                 __isl_take isl_set *set);
4360         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
4361                 __isl_take isl_map *map);
4363         __isl_give isl_union_pw_multi_aff *
4364         isl_union_pw_multi_aff_from_union_set(
4365                 __isl_take isl_union_set *uset);
4366         __isl_give isl_union_pw_multi_aff *
4367         isl_union_pw_multi_aff_from_union_map(
4368                 __isl_take isl_union_map *umap);
4370 Multiple quasi affine expressions can be copied and freed using
4372         #include <isl/aff.h>
4373         __isl_give isl_multi_aff *isl_multi_aff_copy(
4374                 __isl_keep isl_multi_aff *maff);
4375         void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
4377         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
4378                 __isl_keep isl_pw_multi_aff *pma);
4379         void *isl_pw_multi_aff_free(
4380                 __isl_take isl_pw_multi_aff *pma);
4382         __isl_give isl_union_pw_multi_aff *
4383         isl_union_pw_multi_aff_copy(
4384                 __isl_keep isl_union_pw_multi_aff *upma);
4385         void *isl_union_pw_multi_aff_free(
4386                 __isl_take isl_union_pw_multi_aff *upma);
4388         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
4389                 __isl_keep isl_multi_pw_aff *mpa);
4390         void *isl_multi_pw_aff_free(
4391                 __isl_take isl_multi_pw_aff *mpa);
4393 The expression can be inspected using
4395         #include <isl/aff.h>
4396         isl_ctx *isl_multi_aff_get_ctx(
4397                 __isl_keep isl_multi_aff *maff);
4398         isl_ctx *isl_pw_multi_aff_get_ctx(
4399                 __isl_keep isl_pw_multi_aff *pma);
4400         isl_ctx *isl_union_pw_multi_aff_get_ctx(
4401                 __isl_keep isl_union_pw_multi_aff *upma);
4402         isl_ctx *isl_multi_pw_aff_get_ctx(
4403                 __isl_keep isl_multi_pw_aff *mpa);
4405         int isl_multi_aff_involves_dims(
4406                 __isl_keep isl_multi_aff *ma,
4407                 enum isl_dim_type type, unsigned first, unsigned n);
4408         int isl_multi_pw_aff_involves_dims(
4409                 __isl_keep isl_multi_pw_aff *mpa,
4410                 enum isl_dim_type type, unsigned first, unsigned n);
4412         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
4413                 enum isl_dim_type type);
4414         unsigned isl_pw_multi_aff_dim(
4415                 __isl_keep isl_pw_multi_aff *pma,
4416                 enum isl_dim_type type);
4417         unsigned isl_multi_pw_aff_dim(
4418                 __isl_keep isl_multi_pw_aff *mpa,
4419                 enum isl_dim_type type);
4420         __isl_give isl_aff *isl_multi_aff_get_aff(
4421                 __isl_keep isl_multi_aff *multi, int pos);
4422         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
4423                 __isl_keep isl_pw_multi_aff *pma, int pos);
4424         __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
4425                 __isl_keep isl_multi_pw_aff *mpa, int pos);
4426         int isl_multi_aff_find_dim_by_id(
4427                 __isl_keep isl_multi_aff *ma,
4428                 enum isl_dim_type type, __isl_keep isl_id *id);
4429         int isl_multi_pw_aff_find_dim_by_id(
4430                 __isl_keep isl_multi_pw_aff *mpa,
4431                 enum isl_dim_type type, __isl_keep isl_id *id);
4432         const char *isl_pw_multi_aff_get_dim_name(
4433                 __isl_keep isl_pw_multi_aff *pma,
4434                 enum isl_dim_type type, unsigned pos);
4435         __isl_give isl_id *isl_multi_aff_get_dim_id(
4436                 __isl_keep isl_multi_aff *ma,
4437                 enum isl_dim_type type, unsigned pos);
4438         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
4439                 __isl_keep isl_pw_multi_aff *pma,
4440                 enum isl_dim_type type, unsigned pos);
4441         __isl_give isl_id *isl_multi_pw_aff_get_dim_id(
4442                 __isl_keep isl_multi_pw_aff *mpa,
4443                 enum isl_dim_type type, unsigned pos);
4444         const char *isl_multi_aff_get_tuple_name(
4445                 __isl_keep isl_multi_aff *multi,
4446                 enum isl_dim_type type);
4447         int isl_pw_multi_aff_has_tuple_name(
4448                 __isl_keep isl_pw_multi_aff *pma,
4449                 enum isl_dim_type type);
4450         const char *isl_pw_multi_aff_get_tuple_name(
4451                 __isl_keep isl_pw_multi_aff *pma,
4452                 enum isl_dim_type type);
4453         int isl_multi_aff_has_tuple_id(__isl_keep isl_multi_aff *ma,
4454                 enum isl_dim_type type);
4455         int isl_pw_multi_aff_has_tuple_id(
4456                 __isl_keep isl_pw_multi_aff *pma,
4457                 enum isl_dim_type type);
4458         int isl_multi_pw_aff_has_tuple_id(
4459                 __isl_keep isl_multi_pw_aff *mpa,
4460                 enum isl_dim_type type);
4461         __isl_give isl_id *isl_multi_aff_get_tuple_id(
4462                 __isl_keep isl_multi_aff *ma,
4463                 enum isl_dim_type type);
4464         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
4465                 __isl_keep isl_pw_multi_aff *pma,
4466                 enum isl_dim_type type);
4467         __isl_give isl_id *isl_multi_pw_aff_get_tuple_id(
4468                 __isl_keep isl_multi_pw_aff *mpa,
4469                 enum isl_dim_type type);
4470         int isl_multi_aff_range_is_wrapping(
4471                 __isl_keep isl_multi_aff *ma);
4472         int isl_multi_pw_aff_range_is_wrapping(
4473                 __isl_keep isl_multi_pw_aff *mpa);
4475         int isl_pw_multi_aff_foreach_piece(
4476                 __isl_keep isl_pw_multi_aff *pma,
4477                 int (*fn)(__isl_take isl_set *set,
4478                             __isl_take isl_multi_aff *maff,
4479                             void *user), void *user);
4481         int isl_union_pw_multi_aff_foreach_pw_multi_aff(
4482                 __isl_keep isl_union_pw_multi_aff *upma,
4483                 int (*fn)(__isl_take isl_pw_multi_aff *pma,
4484                             void *user), void *user);
4486 It can be modified using
4488         #include <isl/aff.h>
4489         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
4490                 __isl_take isl_multi_aff *multi, int pos,
4491                 __isl_take isl_aff *aff);
4492         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
4493                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
4494                 __isl_take isl_pw_aff *pa);
4495         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
4496                 __isl_take isl_multi_aff *maff,
4497                 enum isl_dim_type type, unsigned pos, const char *s);
4498         __isl_give isl_multi_aff *isl_multi_aff_set_dim_id(
4499                 __isl_take isl_multi_aff *maff,
4500                 enum isl_dim_type type, unsigned pos,
4501                 __isl_take isl_id *id);
4502         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
4503                 __isl_take isl_multi_aff *maff,
4504                 enum isl_dim_type type, const char *s);
4505         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
4506                 __isl_take isl_multi_aff *maff,
4507                 enum isl_dim_type type, __isl_take isl_id *id);
4508         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
4509                 __isl_take isl_pw_multi_aff *pma,
4510                 enum isl_dim_type type, __isl_take isl_id *id);
4511         __isl_give isl_multi_aff *isl_multi_aff_reset_tuple_id(
4512                 __isl_take isl_multi_aff *ma,
4513                 enum isl_dim_type type);
4514         __isl_give isl_multi_pw_aff *
4515         isl_multi_pw_aff_reset_tuple_id(
4516                 __isl_take isl_multi_pw_aff *mpa,
4517                 enum isl_dim_type type);
4518         __isl_give isl_multi_aff *isl_multi_aff_reset_user(
4519                 __isl_take isl_multi_aff *ma);
4520         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_reset_user(
4521                 __isl_take isl_multi_pw_aff *mpa);
4523         __isl_give isl_multi_pw_aff *
4524         isl_multi_pw_aff_set_dim_name(
4525                 __isl_take isl_multi_pw_aff *mpa,
4526                 enum isl_dim_type type, unsigned pos, const char *s);
4527         __isl_give isl_multi_pw_aff *
4528         isl_multi_pw_aff_set_dim_id(
4529                 __isl_take isl_multi_pw_aff *mpa,
4530                 enum isl_dim_type type, unsigned pos,
4531                 __isl_take isl_id *id);
4532         __isl_give isl_multi_pw_aff *
4533         isl_multi_pw_aff_set_tuple_name(
4534                 __isl_take isl_multi_pw_aff *mpa,
4535                 enum isl_dim_type type, const char *s);
4537         __isl_give isl_multi_aff *isl_multi_aff_flatten_domain(
4538                 __isl_take isl_multi_aff *ma);
4540         __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
4541                 __isl_take isl_multi_aff *ma,
4542                 enum isl_dim_type type, unsigned first, unsigned n);
4543         __isl_give isl_multi_aff *isl_multi_aff_add_dims(
4544                 __isl_take isl_multi_aff *ma,
4545                 enum isl_dim_type type, unsigned n);
4546         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
4547                 __isl_take isl_multi_aff *maff,
4548                 enum isl_dim_type type, unsigned first, unsigned n);
4549         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
4550                 __isl_take isl_pw_multi_aff *pma,
4551                 enum isl_dim_type type, unsigned first, unsigned n);
4553         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
4554                 __isl_take isl_multi_pw_aff *mpa,
4555                 enum isl_dim_type type, unsigned first, unsigned n);
4556         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
4557                 __isl_take isl_multi_pw_aff *mpa,
4558                 enum isl_dim_type type, unsigned n);
4559         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_move_dims(
4560                 __isl_take isl_multi_pw_aff *pma,
4561                 enum isl_dim_type dst_type, unsigned dst_pos,
4562                 enum isl_dim_type src_type, unsigned src_pos,
4563                 unsigned n);
4565 To check whether two multiple affine expressions are
4566 (obviously) equal to each other, use
4568         int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
4569                 __isl_keep isl_multi_aff *maff2);
4570         int isl_pw_multi_aff_plain_is_equal(
4571                 __isl_keep isl_pw_multi_aff *pma1,
4572                 __isl_keep isl_pw_multi_aff *pma2);
4573         int isl_multi_pw_aff_plain_is_equal(
4574                 __isl_keep isl_multi_pw_aff *mpa1,
4575                 __isl_keep isl_multi_pw_aff *mpa2);
4576         int isl_multi_pw_aff_is_equal(
4577                 __isl_keep isl_multi_pw_aff *mpa1,
4578                 __isl_keep isl_multi_pw_aff *mpa2);
4580 Operations include
4582         #include <isl/aff.h>
4583         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
4584                 __isl_take isl_pw_multi_aff *pma1,
4585                 __isl_take isl_pw_multi_aff *pma2);
4586         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
4587                 __isl_take isl_pw_multi_aff *pma1,
4588                 __isl_take isl_pw_multi_aff *pma2);
4589         __isl_give isl_multi_aff *isl_multi_aff_add(
4590                 __isl_take isl_multi_aff *maff1,
4591                 __isl_take isl_multi_aff *maff2);
4592         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
4593                 __isl_take isl_pw_multi_aff *pma1,
4594                 __isl_take isl_pw_multi_aff *pma2);
4595         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
4596                 __isl_take isl_union_pw_multi_aff *upma1,
4597                 __isl_take isl_union_pw_multi_aff *upma2);
4598         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
4599                 __isl_take isl_pw_multi_aff *pma1,
4600                 __isl_take isl_pw_multi_aff *pma2);
4601         __isl_give isl_multi_aff *isl_multi_aff_sub(
4602                 __isl_take isl_multi_aff *ma1,
4603                 __isl_take isl_multi_aff *ma2);
4604         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
4605                 __isl_take isl_pw_multi_aff *pma1,
4606                 __isl_take isl_pw_multi_aff *pma2);
4607         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_sub(
4608                 __isl_take isl_union_pw_multi_aff *upma1,
4609                 __isl_take isl_union_pw_multi_aff *upma2);
4611 C<isl_multi_aff_sub> subtracts the second argument from the first.
4613         __isl_give isl_multi_aff *isl_multi_aff_scale_val(
4614                 __isl_take isl_multi_aff *ma,
4615                 __isl_take isl_val *v);
4616         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_val(
4617                 __isl_take isl_pw_multi_aff *pma,
4618                 __isl_take isl_val *v);
4619         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_scale_val(
4620                 __isl_take isl_multi_pw_aff *mpa,
4621                 __isl_take isl_val *v);
4622         __isl_give isl_multi_aff *isl_multi_aff_scale_multi_val(
4623                 __isl_take isl_multi_aff *ma,
4624                 __isl_take isl_multi_val *mv);
4625         __isl_give isl_pw_multi_aff *
4626         isl_pw_multi_aff_scale_multi_val(
4627                 __isl_take isl_pw_multi_aff *pma,
4628                 __isl_take isl_multi_val *mv);
4629         __isl_give isl_multi_pw_aff *
4630         isl_multi_pw_aff_scale_multi_val(
4631                 __isl_take isl_multi_pw_aff *mpa,
4632                 __isl_take isl_multi_val *mv);
4633         __isl_give isl_union_pw_multi_aff *
4634         isl_union_pw_multi_aff_scale_multi_val(
4635                 __isl_take isl_union_pw_multi_aff *upma,
4636                 __isl_take isl_multi_val *mv);
4637         __isl_give isl_multi_aff *
4638         isl_multi_aff_scale_down_multi_val(
4639                 __isl_take isl_multi_aff *ma,
4640                 __isl_take isl_multi_val *mv);
4641         __isl_give isl_multi_pw_aff *
4642         isl_multi_pw_aff_scale_down_multi_val(
4643                 __isl_take isl_multi_pw_aff *mpa,
4644                 __isl_take isl_multi_val *mv);
4646 C<isl_multi_aff_scale_multi_val> scales the elements of C<ma>
4647 by the corresponding elements of C<mv>.
4649         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_fix_si(
4650                 __isl_take isl_pw_multi_aff *pma,
4651                 enum isl_dim_type type, unsigned pos, int value);
4652         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
4653                 __isl_take isl_pw_multi_aff *pma,
4654                 __isl_take isl_set *set);
4655         __isl_give isl_set *isl_multi_pw_aff_domain(
4656                 __isl_take isl_multi_pw_aff *mpa);
4657         __isl_give isl_multi_pw_aff *
4658         isl_multi_pw_aff_intersect_params(
4659                 __isl_take isl_multi_pw_aff *mpa,
4660                 __isl_take isl_set *set);
4661         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
4662                 __isl_take isl_pw_multi_aff *pma,
4663                 __isl_take isl_set *set);
4664         __isl_give isl_multi_pw_aff *
4665         isl_multi_pw_aff_intersect_domain(
4666                 __isl_take isl_multi_pw_aff *mpa,
4667                 __isl_take isl_set *domain);
4668         __isl_give isl_union_pw_multi_aff *
4669         isl_union_pw_multi_aff_intersect_domain(
4670                 __isl_take isl_union_pw_multi_aff *upma,
4671                 __isl_take isl_union_set *uset);
4672         __isl_give isl_multi_aff *isl_multi_aff_lift(
4673                 __isl_take isl_multi_aff *maff,
4674                 __isl_give isl_local_space **ls);
4675         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
4676                 __isl_take isl_pw_multi_aff *pma);
4677         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_coalesce(
4678                 __isl_take isl_multi_pw_aff *mpa);
4679         __isl_give isl_multi_aff *isl_multi_aff_align_params(
4680                 __isl_take isl_multi_aff *multi,
4681                 __isl_take isl_space *model);
4682         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
4683                 __isl_take isl_pw_multi_aff *pma,
4684                 __isl_take isl_space *model);
4685         __isl_give isl_pw_multi_aff *
4686         isl_pw_multi_aff_project_domain_on_params(
4687                 __isl_take isl_pw_multi_aff *pma);
4688         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
4689                 __isl_take isl_multi_aff *maff,
4690                 __isl_take isl_set *context);
4691         __isl_give isl_multi_aff *isl_multi_aff_gist(
4692                 __isl_take isl_multi_aff *maff,
4693                 __isl_take isl_set *context);
4694         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
4695                 __isl_take isl_pw_multi_aff *pma,
4696                 __isl_take isl_set *set);
4697         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
4698                 __isl_take isl_pw_multi_aff *pma,
4699                 __isl_take isl_set *set);
4700         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_gist_params(
4701                 __isl_take isl_multi_pw_aff *mpa,
4702                 __isl_take isl_set *set);
4703         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_gist(
4704                 __isl_take isl_multi_pw_aff *mpa,
4705                 __isl_take isl_set *set);
4706         __isl_give isl_multi_aff *isl_multi_aff_from_range(
4707                 __isl_take isl_multi_aff *ma);
4708         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_range(
4709                 __isl_take isl_multi_pw_aff *mpa);
4710         __isl_give isl_set *isl_pw_multi_aff_domain(
4711                 __isl_take isl_pw_multi_aff *pma);
4712         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
4713                 __isl_take isl_union_pw_multi_aff *upma);
4714         __isl_give isl_multi_aff *isl_multi_aff_range_splice(
4715                 __isl_take isl_multi_aff *ma1, unsigned pos,
4716                 __isl_take isl_multi_aff *ma2);
4717         __isl_give isl_multi_aff *isl_multi_aff_splice(
4718                 __isl_take isl_multi_aff *ma1,
4719                 unsigned in_pos, unsigned out_pos,
4720                 __isl_take isl_multi_aff *ma2);
4721         __isl_give isl_multi_aff *isl_multi_aff_range_product(
4722                 __isl_take isl_multi_aff *ma1,
4723                 __isl_take isl_multi_aff *ma2);
4724         __isl_give isl_multi_aff *
4725         isl_multi_aff_range_factor_domain(
4726                 __isl_take isl_multi_aff *ma);
4727         __isl_give isl_multi_aff *
4728         isl_multi_aff_range_factor_range(
4729                 __isl_take isl_multi_aff *ma);
4730         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
4731                 __isl_take isl_multi_aff *ma1,
4732                 __isl_take isl_multi_aff *ma2);
4733         __isl_give isl_multi_aff *isl_multi_aff_product(
4734                 __isl_take isl_multi_aff *ma1,
4735                 __isl_take isl_multi_aff *ma2);
4736         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_product(
4737                 __isl_take isl_multi_pw_aff *mpa1,
4738                 __isl_take isl_multi_pw_aff *mpa2);
4739         __isl_give isl_pw_multi_aff *
4740         isl_pw_multi_aff_range_product(
4741                 __isl_take isl_pw_multi_aff *pma1,
4742                 __isl_take isl_pw_multi_aff *pma2);
4743         __isl_give isl_multi_pw_aff *
4744         isl_multi_pw_aff_range_factor_domain(
4745                 __isl_take isl_multi_pw_aff *mpa);
4746         __isl_give isl_multi_pw_aff *
4747         isl_multi_pw_aff_range_factor_range(
4748                 __isl_take isl_multi_pw_aff *mpa);
4749         __isl_give isl_pw_multi_aff *
4750         isl_pw_multi_aff_flat_range_product(
4751                 __isl_take isl_pw_multi_aff *pma1,
4752                 __isl_take isl_pw_multi_aff *pma2);
4753         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
4754                 __isl_take isl_pw_multi_aff *pma1,
4755                 __isl_take isl_pw_multi_aff *pma2);
4756         __isl_give isl_union_pw_multi_aff *
4757         isl_union_pw_multi_aff_flat_range_product(
4758                 __isl_take isl_union_pw_multi_aff *upma1,
4759                 __isl_take isl_union_pw_multi_aff *upma2);
4760         __isl_give isl_multi_pw_aff *
4761         isl_multi_pw_aff_range_splice(
4762                 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
4763                 __isl_take isl_multi_pw_aff *mpa2);
4764         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
4765                 __isl_take isl_multi_pw_aff *mpa1,
4766                 unsigned in_pos, unsigned out_pos,
4767                 __isl_take isl_multi_pw_aff *mpa2);
4768         __isl_give isl_multi_pw_aff *
4769         isl_multi_pw_aff_range_product(
4770                 __isl_take isl_multi_pw_aff *mpa1,
4771                 __isl_take isl_multi_pw_aff *mpa2);
4772         __isl_give isl_multi_pw_aff *
4773         isl_multi_pw_aff_flat_range_product(
4774                 __isl_take isl_multi_pw_aff *mpa1,
4775                 __isl_take isl_multi_pw_aff *mpa2);
4777 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
4778 then it is assigned the local space that lies at the basis of
4779 the lifting applied.
4781         #include <isl/aff.h>
4782         __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
4783                 __isl_take isl_multi_aff *ma1,
4784                 __isl_take isl_multi_aff *ma2);
4785         __isl_give isl_pw_multi_aff *
4786         isl_pw_multi_aff_pullback_multi_aff(
4787                 __isl_take isl_pw_multi_aff *pma,
4788                 __isl_take isl_multi_aff *ma);
4789         __isl_give isl_multi_pw_aff *
4790         isl_multi_pw_aff_pullback_multi_aff(
4791                 __isl_take isl_multi_pw_aff *mpa,
4792                 __isl_take isl_multi_aff *ma);
4793         __isl_give isl_pw_multi_aff *
4794         isl_pw_multi_aff_pullback_pw_multi_aff(
4795                 __isl_take isl_pw_multi_aff *pma1,
4796                 __isl_take isl_pw_multi_aff *pma2);
4797         __isl_give isl_multi_pw_aff *
4798         isl_multi_pw_aff_pullback_pw_multi_aff(
4799                 __isl_take isl_multi_pw_aff *mpa,
4800                 __isl_take isl_pw_multi_aff *pma);
4801         __isl_give isl_multi_pw_aff *
4802         isl_multi_pw_aff_pullback_multi_pw_aff(
4803                 __isl_take isl_multi_pw_aff *mpa1,
4804                 __isl_take isl_multi_pw_aff *mpa2);
4806 The function C<isl_multi_aff_pullback_multi_aff> precomposes C<ma1> by C<ma2>.
4807 In other words, C<ma2> is plugged
4808 into C<ma1>.
4810         __isl_give isl_set *isl_multi_aff_lex_le_set(
4811                 __isl_take isl_multi_aff *ma1,
4812                 __isl_take isl_multi_aff *ma2);
4813         __isl_give isl_set *isl_multi_aff_lex_ge_set(
4814                 __isl_take isl_multi_aff *ma1,
4815                 __isl_take isl_multi_aff *ma2);
4817 The function C<isl_multi_aff_lex_le_set> returns a set
4818 containing those elements in the shared domain space
4819 where C<ma1> is lexicographically smaller than or
4820 equal to C<ma2>.
4822 An expression can be read from input using
4824         #include <isl/aff.h>
4825         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
4826                 isl_ctx *ctx, const char *str);
4827         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
4828                 isl_ctx *ctx, const char *str);
4829         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_read_from_str(
4830                 isl_ctx *ctx, const char *str);
4831         __isl_give isl_union_pw_multi_aff *
4832         isl_union_pw_multi_aff_read_from_str(
4833                 isl_ctx *ctx, const char *str);
4835 An expression can be printed using
4837         #include <isl/aff.h>
4838         __isl_give isl_printer *isl_printer_print_multi_aff(
4839                 __isl_take isl_printer *p,
4840                 __isl_keep isl_multi_aff *maff);
4841         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
4842                 __isl_take isl_printer *p,
4843                 __isl_keep isl_pw_multi_aff *pma);
4844         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
4845                 __isl_take isl_printer *p,
4846                 __isl_keep isl_union_pw_multi_aff *upma);
4847         __isl_give isl_printer *isl_printer_print_multi_pw_aff(
4848                 __isl_take isl_printer *p,
4849                 __isl_keep isl_multi_pw_aff *mpa);
4851 =head2 Points
4853 Points are elements of a set.  They can be used to construct
4854 simple sets (boxes) or they can be used to represent the
4855 individual elements of a set.
4856 The zero point (the origin) can be created using
4858         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
4860 The coordinates of a point can be inspected, set and changed
4861 using
4863         __isl_give isl_val *isl_point_get_coordinate_val(
4864                 __isl_keep isl_point *pnt,
4865                 enum isl_dim_type type, int pos);
4866         __isl_give isl_point *isl_point_set_coordinate_val(
4867                 __isl_take isl_point *pnt,
4868                 enum isl_dim_type type, int pos,
4869                 __isl_take isl_val *v);
4871         __isl_give isl_point *isl_point_add_ui(
4872                 __isl_take isl_point *pnt,
4873                 enum isl_dim_type type, int pos, unsigned val);
4874         __isl_give isl_point *isl_point_sub_ui(
4875                 __isl_take isl_point *pnt,
4876                 enum isl_dim_type type, int pos, unsigned val);
4878 Other properties can be obtained using
4880         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
4882 Points can be copied or freed using
4884         __isl_give isl_point *isl_point_copy(
4885                 __isl_keep isl_point *pnt);
4886         void isl_point_free(__isl_take isl_point *pnt);
4888 A singleton set can be created from a point using
4890         __isl_give isl_basic_set *isl_basic_set_from_point(
4891                 __isl_take isl_point *pnt);
4892         __isl_give isl_set *isl_set_from_point(
4893                 __isl_take isl_point *pnt);
4895 and a box can be created from two opposite extremal points using
4897         __isl_give isl_basic_set *isl_basic_set_box_from_points(
4898                 __isl_take isl_point *pnt1,
4899                 __isl_take isl_point *pnt2);
4900         __isl_give isl_set *isl_set_box_from_points(
4901                 __isl_take isl_point *pnt1,
4902                 __isl_take isl_point *pnt2);
4904 All elements of a B<bounded> (union) set can be enumerated using
4905 the following functions.
4907         int isl_set_foreach_point(__isl_keep isl_set *set,
4908                 int (*fn)(__isl_take isl_point *pnt, void *user),
4909                 void *user);
4910         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
4911                 int (*fn)(__isl_take isl_point *pnt, void *user),
4912                 void *user);
4914 The function C<fn> is called for each integer point in
4915 C<set> with as second argument the last argument of
4916 the C<isl_set_foreach_point> call.  The function C<fn>
4917 should return C<0> on success and C<-1> on failure.
4918 In the latter case, C<isl_set_foreach_point> will stop
4919 enumerating and return C<-1> as well.
4920 If the enumeration is performed successfully and to completion,
4921 then C<isl_set_foreach_point> returns C<0>.
4923 To obtain a single point of a (basic) set, use
4925         __isl_give isl_point *isl_basic_set_sample_point(
4926                 __isl_take isl_basic_set *bset);
4927         __isl_give isl_point *isl_set_sample_point(
4928                 __isl_take isl_set *set);
4930 If C<set> does not contain any (integer) points, then the
4931 resulting point will be ``void'', a property that can be
4932 tested using
4934         int isl_point_is_void(__isl_keep isl_point *pnt);
4936 =head2 Piecewise Quasipolynomials
4938 A piecewise quasipolynomial is a particular kind of function that maps
4939 a parametric point to a rational value.
4940 More specifically, a quasipolynomial is a polynomial expression in greatest
4941 integer parts of affine expressions of parameters and variables.
4942 A piecewise quasipolynomial is a subdivision of a given parametric
4943 domain into disjoint cells with a quasipolynomial associated to
4944 each cell.  The value of the piecewise quasipolynomial at a given
4945 point is the value of the quasipolynomial associated to the cell
4946 that contains the point.  Outside of the union of cells,
4947 the value is assumed to be zero.
4948 For example, the piecewise quasipolynomial
4950         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
4952 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
4953 A given piecewise quasipolynomial has a fixed domain dimension.
4954 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
4955 defined over different domains.
4956 Piecewise quasipolynomials are mainly used by the C<barvinok>
4957 library for representing the number of elements in a parametric set or map.
4958 For example, the piecewise quasipolynomial above represents
4959 the number of points in the map
4961         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
4963 =head3 Input and Output
4965 Piecewise quasipolynomials can be read from input using
4967         __isl_give isl_union_pw_qpolynomial *
4968         isl_union_pw_qpolynomial_read_from_str(
4969                 isl_ctx *ctx, const char *str);
4971 Quasipolynomials and piecewise quasipolynomials can be printed
4972 using the following functions.
4974         __isl_give isl_printer *isl_printer_print_qpolynomial(
4975                 __isl_take isl_printer *p,
4976                 __isl_keep isl_qpolynomial *qp);
4978         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
4979                 __isl_take isl_printer *p,
4980                 __isl_keep isl_pw_qpolynomial *pwqp);
4982         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
4983                 __isl_take isl_printer *p,
4984                 __isl_keep isl_union_pw_qpolynomial *upwqp);
4986 The output format of the printer
4987 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4988 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
4989 is supported.
4990 In case of printing in C<ISL_FORMAT_C>, the user may want
4991 to set the names of all dimensions
4993         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
4994                 __isl_take isl_qpolynomial *qp,
4995                 enum isl_dim_type type, unsigned pos,
4996                 const char *s);
4997         __isl_give isl_pw_qpolynomial *
4998         isl_pw_qpolynomial_set_dim_name(
4999                 __isl_take isl_pw_qpolynomial *pwqp,
5000                 enum isl_dim_type type, unsigned pos,
5001                 const char *s);
5003 =head3 Creating New (Piecewise) Quasipolynomials
5005 Some simple quasipolynomials can be created using the following functions.
5006 More complicated quasipolynomials can be created by applying
5007 operations such as addition and multiplication
5008 on the resulting quasipolynomials
5010         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
5011                 __isl_take isl_space *domain);
5012         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
5013                 __isl_take isl_space *domain);
5014         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
5015                 __isl_take isl_space *domain);
5016         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
5017                 __isl_take isl_space *domain);
5018         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
5019                 __isl_take isl_space *domain);
5020         __isl_give isl_qpolynomial *isl_qpolynomial_val_on_domain(
5021                 __isl_take isl_space *domain,
5022                 __isl_take isl_val *val);
5023         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
5024                 __isl_take isl_space *domain,
5025                 enum isl_dim_type type, unsigned pos);
5026         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
5027                 __isl_take isl_aff *aff);
5029 Note that the space in which a quasipolynomial lives is a map space
5030 with a one-dimensional range.  The C<domain> argument in some of
5031 the functions above corresponds to the domain of this map space.
5033 The zero piecewise quasipolynomial or a piecewise quasipolynomial
5034 with a single cell can be created using the following functions.
5035 Multiple of these single cell piecewise quasipolynomials can
5036 be combined to create more complicated piecewise quasipolynomials.
5038         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
5039                 __isl_take isl_space *space);
5040         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
5041                 __isl_take isl_set *set,
5042                 __isl_take isl_qpolynomial *qp);
5043         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
5044                 __isl_take isl_qpolynomial *qp);
5045         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
5046                 __isl_take isl_pw_aff *pwaff);
5048         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
5049                 __isl_take isl_space *space);
5050         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
5051                 __isl_take isl_pw_qpolynomial *pwqp);
5052         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
5053                 __isl_take isl_union_pw_qpolynomial *upwqp,
5054                 __isl_take isl_pw_qpolynomial *pwqp);
5056 Quasipolynomials can be copied and freed again using the following
5057 functions.
5059         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
5060                 __isl_keep isl_qpolynomial *qp);
5061         void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
5063         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
5064                 __isl_keep isl_pw_qpolynomial *pwqp);
5065         void *isl_pw_qpolynomial_free(
5066                 __isl_take isl_pw_qpolynomial *pwqp);
5068         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
5069                 __isl_keep isl_union_pw_qpolynomial *upwqp);
5070         void *isl_union_pw_qpolynomial_free(
5071                 __isl_take isl_union_pw_qpolynomial *upwqp);
5073 =head3 Inspecting (Piecewise) Quasipolynomials
5075 To iterate over all piecewise quasipolynomials in a union
5076 piecewise quasipolynomial, use the following function
5078         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
5079                 __isl_keep isl_union_pw_qpolynomial *upwqp,
5080                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
5081                 void *user);
5083 To extract the piecewise quasipolynomial in a given space from a union, use
5085         __isl_give isl_pw_qpolynomial *
5086         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
5087                 __isl_keep isl_union_pw_qpolynomial *upwqp,
5088                 __isl_take isl_space *space);
5090 To iterate over the cells in a piecewise quasipolynomial,
5091 use either of the following two functions
5093         int isl_pw_qpolynomial_foreach_piece(
5094                 __isl_keep isl_pw_qpolynomial *pwqp,
5095                 int (*fn)(__isl_take isl_set *set,
5096                           __isl_take isl_qpolynomial *qp,
5097                           void *user), void *user);
5098         int isl_pw_qpolynomial_foreach_lifted_piece(
5099                 __isl_keep isl_pw_qpolynomial *pwqp,
5100                 int (*fn)(__isl_take isl_set *set,
5101                           __isl_take isl_qpolynomial *qp,
5102                           void *user), void *user);
5104 As usual, the function C<fn> should return C<0> on success
5105 and C<-1> on failure.  The difference between
5106 C<isl_pw_qpolynomial_foreach_piece> and
5107 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
5108 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
5109 compute unique representations for all existentially quantified
5110 variables and then turn these existentially quantified variables
5111 into extra set variables, adapting the associated quasipolynomial
5112 accordingly.  This means that the C<set> passed to C<fn>
5113 will not have any existentially quantified variables, but that
5114 the dimensions of the sets may be different for different
5115 invocations of C<fn>.
5117 The constant term of a quasipolynomial can be extracted using
5119         __isl_give isl_val *isl_qpolynomial_get_constant_val(
5120                 __isl_keep isl_qpolynomial *qp);
5122 To iterate over all terms in a quasipolynomial,
5125         int isl_qpolynomial_foreach_term(
5126                 __isl_keep isl_qpolynomial *qp,
5127                 int (*fn)(__isl_take isl_term *term,
5128                           void *user), void *user);
5130 The terms themselves can be inspected and freed using
5131 these functions
5133         unsigned isl_term_dim(__isl_keep isl_term *term,
5134                 enum isl_dim_type type);
5135         __isl_give isl_val *isl_term_get_coefficient_val(
5136                 __isl_keep isl_term *term);
5137         int isl_term_get_exp(__isl_keep isl_term *term,
5138                 enum isl_dim_type type, unsigned pos);
5139         __isl_give isl_aff *isl_term_get_div(
5140                 __isl_keep isl_term *term, unsigned pos);
5141         void isl_term_free(__isl_take isl_term *term);
5143 Each term is a product of parameters, set variables and
5144 integer divisions.  The function C<isl_term_get_exp>
5145 returns the exponent of a given dimensions in the given term.
5147 =head3 Properties of (Piecewise) Quasipolynomials
5149 To check whether two union piecewise quasipolynomials are
5150 obviously equal, use
5152         int isl_union_pw_qpolynomial_plain_is_equal(
5153                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
5154                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
5156 =head3 Operations on (Piecewise) Quasipolynomials
5158         __isl_give isl_qpolynomial *isl_qpolynomial_scale_val(
5159                 __isl_take isl_qpolynomial *qp,
5160                 __isl_take isl_val *v);
5161         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
5162                 __isl_take isl_qpolynomial *qp);
5163         __isl_give isl_qpolynomial *isl_qpolynomial_add(
5164                 __isl_take isl_qpolynomial *qp1,
5165                 __isl_take isl_qpolynomial *qp2);
5166         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
5167                 __isl_take isl_qpolynomial *qp1,
5168                 __isl_take isl_qpolynomial *qp2);
5169         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
5170                 __isl_take isl_qpolynomial *qp1,
5171                 __isl_take isl_qpolynomial *qp2);
5172         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
5173                 __isl_take isl_qpolynomial *qp, unsigned exponent);
5175         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_fix_val(
5176                 __isl_take isl_pw_qpolynomial *pwqp,
5177                 enum isl_dim_type type, unsigned n,
5178                 __isl_take isl_val *v);
5179         __isl_give isl_pw_qpolynomial *
5180         isl_pw_qpolynomial_scale_val(
5181                 __isl_take isl_pw_qpolynomial *pwqp,
5182                 __isl_take isl_val *v);
5183         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
5184                 __isl_take isl_pw_qpolynomial *pwqp1,
5185                 __isl_take isl_pw_qpolynomial *pwqp2);
5186         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
5187                 __isl_take isl_pw_qpolynomial *pwqp1,
5188                 __isl_take isl_pw_qpolynomial *pwqp2);
5189         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
5190                 __isl_take isl_pw_qpolynomial *pwqp1,
5191                 __isl_take isl_pw_qpolynomial *pwqp2);
5192         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
5193                 __isl_take isl_pw_qpolynomial *pwqp);
5194         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
5195                 __isl_take isl_pw_qpolynomial *pwqp1,
5196                 __isl_take isl_pw_qpolynomial *pwqp2);
5197         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
5198                 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
5200         __isl_give isl_union_pw_qpolynomial *
5201         isl_union_pw_qpolynomial_scale_val(
5202                 __isl_take isl_union_pw_qpolynomial *upwqp,
5203                 __isl_take isl_val *v);
5204         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
5205                 __isl_take isl_union_pw_qpolynomial *upwqp1,
5206                 __isl_take isl_union_pw_qpolynomial *upwqp2);
5207         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
5208                 __isl_take isl_union_pw_qpolynomial *upwqp1,
5209                 __isl_take isl_union_pw_qpolynomial *upwqp2);
5210         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
5211                 __isl_take isl_union_pw_qpolynomial *upwqp1,
5212                 __isl_take isl_union_pw_qpolynomial *upwqp2);
5214         __isl_give isl_val *isl_pw_qpolynomial_eval(
5215                 __isl_take isl_pw_qpolynomial *pwqp,
5216                 __isl_take isl_point *pnt);
5218         __isl_give isl_val *isl_union_pw_qpolynomial_eval(
5219                 __isl_take isl_union_pw_qpolynomial *upwqp,
5220                 __isl_take isl_point *pnt);
5222         __isl_give isl_set *isl_pw_qpolynomial_domain(
5223                 __isl_take isl_pw_qpolynomial *pwqp);
5224         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
5225                 __isl_take isl_pw_qpolynomial *pwpq,
5226                 __isl_take isl_set *set);
5227         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
5228                 __isl_take isl_pw_qpolynomial *pwpq,
5229                 __isl_take isl_set *set);
5231         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
5232                 __isl_take isl_union_pw_qpolynomial *upwqp);
5233         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
5234                 __isl_take isl_union_pw_qpolynomial *upwpq,
5235                 __isl_take isl_union_set *uset);
5236         __isl_give isl_union_pw_qpolynomial *
5237         isl_union_pw_qpolynomial_intersect_params(
5238                 __isl_take isl_union_pw_qpolynomial *upwpq,
5239                 __isl_take isl_set *set);
5241         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
5242                 __isl_take isl_qpolynomial *qp,
5243                 __isl_take isl_space *model);
5245         __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
5246                 __isl_take isl_qpolynomial *qp);
5247         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
5248                 __isl_take isl_pw_qpolynomial *pwqp);
5250         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
5251                 __isl_take isl_union_pw_qpolynomial *upwqp);
5253         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
5254                 __isl_take isl_qpolynomial *qp,
5255                 __isl_take isl_set *context);
5256         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
5257                 __isl_take isl_qpolynomial *qp,
5258                 __isl_take isl_set *context);
5260         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
5261                 __isl_take isl_pw_qpolynomial *pwqp,
5262                 __isl_take isl_set *context);
5263         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
5264                 __isl_take isl_pw_qpolynomial *pwqp,
5265                 __isl_take isl_set *context);
5267         __isl_give isl_union_pw_qpolynomial *
5268         isl_union_pw_qpolynomial_gist_params(
5269                 __isl_take isl_union_pw_qpolynomial *upwqp,
5270                 __isl_take isl_set *context);
5271         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
5272                 __isl_take isl_union_pw_qpolynomial *upwqp,
5273                 __isl_take isl_union_set *context);
5275 The gist operation applies the gist operation to each of
5276 the cells in the domain of the input piecewise quasipolynomial.
5277 The context is also exploited
5278 to simplify the quasipolynomials associated to each cell.
5280         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
5281                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
5282         __isl_give isl_union_pw_qpolynomial *
5283         isl_union_pw_qpolynomial_to_polynomial(
5284                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
5286 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
5287 the polynomial will be an overapproximation.  If C<sign> is negative,
5288 it will be an underapproximation.  If C<sign> is zero, the approximation
5289 will lie somewhere in between.
5291 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
5293 A piecewise quasipolynomial reduction is a piecewise
5294 reduction (or fold) of quasipolynomials.
5295 In particular, the reduction can be maximum or a minimum.
5296 The objects are mainly used to represent the result of
5297 an upper or lower bound on a quasipolynomial over its domain,
5298 i.e., as the result of the following function.
5300         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
5301                 __isl_take isl_pw_qpolynomial *pwqp,
5302                 enum isl_fold type, int *tight);
5304         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
5305                 __isl_take isl_union_pw_qpolynomial *upwqp,
5306                 enum isl_fold type, int *tight);
5308 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
5309 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
5310 is the returned bound is known be tight, i.e., for each value
5311 of the parameters there is at least
5312 one element in the domain that reaches the bound.
5313 If the domain of C<pwqp> is not wrapping, then the bound is computed
5314 over all elements in that domain and the result has a purely parametric
5315 domain.  If the domain of C<pwqp> is wrapping, then the bound is
5316 computed over the range of the wrapped relation.  The domain of the
5317 wrapped relation becomes the domain of the result.
5319 A (piecewise) quasipolynomial reduction can be copied or freed using the
5320 following functions.
5322         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
5323                 __isl_keep isl_qpolynomial_fold *fold);
5324         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
5325                 __isl_keep isl_pw_qpolynomial_fold *pwf);
5326         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
5327                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
5328         void isl_qpolynomial_fold_free(
5329                 __isl_take isl_qpolynomial_fold *fold);
5330         void *isl_pw_qpolynomial_fold_free(
5331                 __isl_take isl_pw_qpolynomial_fold *pwf);
5332         void *isl_union_pw_qpolynomial_fold_free(
5333                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
5335 =head3 Printing Piecewise Quasipolynomial Reductions
5337 Piecewise quasipolynomial reductions can be printed
5338 using the following function.
5340         __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
5341                 __isl_take isl_printer *p,
5342                 __isl_keep isl_pw_qpolynomial_fold *pwf);
5343         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
5344                 __isl_take isl_printer *p,
5345                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
5347 For C<isl_printer_print_pw_qpolynomial_fold>,
5348 output format of the printer
5349 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
5350 For C<isl_printer_print_union_pw_qpolynomial_fold>,
5351 output format of the printer
5352 needs to be set to C<ISL_FORMAT_ISL>.
5353 In case of printing in C<ISL_FORMAT_C>, the user may want
5354 to set the names of all dimensions
5356         __isl_give isl_pw_qpolynomial_fold *
5357         isl_pw_qpolynomial_fold_set_dim_name(
5358                 __isl_take isl_pw_qpolynomial_fold *pwf,
5359                 enum isl_dim_type type, unsigned pos,
5360                 const char *s);
5362 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
5364 To iterate over all piecewise quasipolynomial reductions in a union
5365 piecewise quasipolynomial reduction, use the following function
5367         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
5368                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
5369                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
5370                             void *user), void *user);
5372 To iterate over the cells in a piecewise quasipolynomial reduction,
5373 use either of the following two functions
5375         int isl_pw_qpolynomial_fold_foreach_piece(
5376                 __isl_keep isl_pw_qpolynomial_fold *pwf,
5377                 int (*fn)(__isl_take isl_set *set,
5378                           __isl_take isl_qpolynomial_fold *fold,
5379                           void *user), void *user);
5380         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
5381                 __isl_keep isl_pw_qpolynomial_fold *pwf,
5382                 int (*fn)(__isl_take isl_set *set,
5383                           __isl_take isl_qpolynomial_fold *fold,
5384                           void *user), void *user);
5386 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
5387 of the difference between these two functions.
5389 To iterate over all quasipolynomials in a reduction, use
5391         int isl_qpolynomial_fold_foreach_qpolynomial(
5392                 __isl_keep isl_qpolynomial_fold *fold,
5393                 int (*fn)(__isl_take isl_qpolynomial *qp,
5394                           void *user), void *user);
5396 =head3 Properties of Piecewise Quasipolynomial Reductions
5398 To check whether two union piecewise quasipolynomial reductions are
5399 obviously equal, use
5401         int isl_union_pw_qpolynomial_fold_plain_is_equal(
5402                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
5403                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
5405 =head3 Operations on Piecewise Quasipolynomial Reductions
5407         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale_val(
5408                 __isl_take isl_qpolynomial_fold *fold,
5409                 __isl_take isl_val *v);
5410         __isl_give isl_pw_qpolynomial_fold *
5411         isl_pw_qpolynomial_fold_scale_val(
5412                 __isl_take isl_pw_qpolynomial_fold *pwf,
5413                 __isl_take isl_val *v);
5414         __isl_give isl_union_pw_qpolynomial_fold *
5415         isl_union_pw_qpolynomial_fold_scale_val(
5416                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5417                 __isl_take isl_val *v);
5419         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
5420                 __isl_take isl_pw_qpolynomial_fold *pwf1,
5421                 __isl_take isl_pw_qpolynomial_fold *pwf2);
5423         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
5424                 __isl_take isl_pw_qpolynomial_fold *pwf1,
5425                 __isl_take isl_pw_qpolynomial_fold *pwf2);
5427         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
5428                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
5429                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
5431         __isl_give isl_val *isl_pw_qpolynomial_fold_eval(
5432                 __isl_take isl_pw_qpolynomial_fold *pwf,
5433                 __isl_take isl_point *pnt);
5435         __isl_give isl_val *isl_union_pw_qpolynomial_fold_eval(
5436                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5437                 __isl_take isl_point *pnt);
5439         __isl_give isl_pw_qpolynomial_fold *
5440         isl_pw_qpolynomial_fold_intersect_params(
5441                 __isl_take isl_pw_qpolynomial_fold *pwf,
5442                 __isl_take isl_set *set);
5444         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
5445                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
5446         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
5447                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5448                 __isl_take isl_union_set *uset);
5449         __isl_give isl_union_pw_qpolynomial_fold *
5450         isl_union_pw_qpolynomial_fold_intersect_params(
5451                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5452                 __isl_take isl_set *set);
5454         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
5455                 __isl_take isl_pw_qpolynomial_fold *pwf);
5457         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
5458                 __isl_take isl_pw_qpolynomial_fold *pwf);
5460         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
5461                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
5463         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
5464                 __isl_take isl_qpolynomial_fold *fold,
5465                 __isl_take isl_set *context);
5466         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
5467                 __isl_take isl_qpolynomial_fold *fold,
5468                 __isl_take isl_set *context);
5470         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
5471                 __isl_take isl_pw_qpolynomial_fold *pwf,
5472                 __isl_take isl_set *context);
5473         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
5474                 __isl_take isl_pw_qpolynomial_fold *pwf,
5475                 __isl_take isl_set *context);
5477         __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
5478                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5479                 __isl_take isl_union_set *context);
5480         __isl_give isl_union_pw_qpolynomial_fold *
5481         isl_union_pw_qpolynomial_fold_gist_params(
5482                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5483                 __isl_take isl_set *context);
5485 The gist operation applies the gist operation to each of
5486 the cells in the domain of the input piecewise quasipolynomial reduction.
5487 In future, the operation will also exploit the context
5488 to simplify the quasipolynomial reductions associated to each cell.
5490         __isl_give isl_pw_qpolynomial_fold *
5491         isl_set_apply_pw_qpolynomial_fold(
5492                 __isl_take isl_set *set,
5493                 __isl_take isl_pw_qpolynomial_fold *pwf,
5494                 int *tight);
5495         __isl_give isl_pw_qpolynomial_fold *
5496         isl_map_apply_pw_qpolynomial_fold(
5497                 __isl_take isl_map *map,
5498                 __isl_take isl_pw_qpolynomial_fold *pwf,
5499                 int *tight);
5500         __isl_give isl_union_pw_qpolynomial_fold *
5501         isl_union_set_apply_union_pw_qpolynomial_fold(
5502                 __isl_take isl_union_set *uset,
5503                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5504                 int *tight);
5505         __isl_give isl_union_pw_qpolynomial_fold *
5506         isl_union_map_apply_union_pw_qpolynomial_fold(
5507                 __isl_take isl_union_map *umap,
5508                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5509                 int *tight);
5511 The functions taking a map
5512 compose the given map with the given piecewise quasipolynomial reduction.
5513 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
5514 over all elements in the intersection of the range of the map
5515 and the domain of the piecewise quasipolynomial reduction
5516 as a function of an element in the domain of the map.
5517 The functions taking a set compute a bound over all elements in the
5518 intersection of the set and the domain of the
5519 piecewise quasipolynomial reduction.
5521 =head2 Parametric Vertex Enumeration
5523 The parametric vertex enumeration described in this section
5524 is mainly intended to be used internally and by the C<barvinok>
5525 library.
5527         #include <isl/vertices.h>
5528         __isl_give isl_vertices *isl_basic_set_compute_vertices(
5529                 __isl_keep isl_basic_set *bset);
5531 The function C<isl_basic_set_compute_vertices> performs the
5532 actual computation of the parametric vertices and the chamber
5533 decomposition and store the result in an C<isl_vertices> object.
5534 This information can be queried by either iterating over all
5535 the vertices or iterating over all the chambers or cells
5536 and then iterating over all vertices that are active on the chamber.
5538         int isl_vertices_foreach_vertex(
5539                 __isl_keep isl_vertices *vertices,
5540                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5541                 void *user);
5543         int isl_vertices_foreach_cell(
5544                 __isl_keep isl_vertices *vertices,
5545                 int (*fn)(__isl_take isl_cell *cell, void *user),
5546                 void *user);
5547         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
5548                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5549                 void *user);
5551 Other operations that can be performed on an C<isl_vertices> object are
5552 the following.
5554         isl_ctx *isl_vertices_get_ctx(
5555                 __isl_keep isl_vertices *vertices);
5556         int isl_vertices_get_n_vertices(
5557                 __isl_keep isl_vertices *vertices);
5558         void isl_vertices_free(__isl_take isl_vertices *vertices);
5560 Vertices can be inspected and destroyed using the following functions.
5562         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
5563         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
5564         __isl_give isl_basic_set *isl_vertex_get_domain(
5565                 __isl_keep isl_vertex *vertex);
5566         __isl_give isl_basic_set *isl_vertex_get_expr(
5567                 __isl_keep isl_vertex *vertex);
5568         void isl_vertex_free(__isl_take isl_vertex *vertex);
5570 C<isl_vertex_get_expr> returns a singleton parametric set describing
5571 the vertex, while C<isl_vertex_get_domain> returns the activity domain
5572 of the vertex.
5573 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
5574 B<rational> basic sets, so they should mainly be used for inspection
5575 and should not be mixed with integer sets.
5577 Chambers can be inspected and destroyed using the following functions.
5579         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
5580         __isl_give isl_basic_set *isl_cell_get_domain(
5581                 __isl_keep isl_cell *cell);
5582         void isl_cell_free(__isl_take isl_cell *cell);
5584 =head1 Polyhedral Compilation Library
5586 This section collects functionality in C<isl> that has been specifically
5587 designed for use during polyhedral compilation.
5589 =head2 Dependence Analysis
5591 C<isl> contains specialized functionality for performing
5592 array dataflow analysis.  That is, given a I<sink> access relation
5593 and a collection of possible I<source> access relations,
5594 C<isl> can compute relations that describe
5595 for each iteration of the sink access, which iteration
5596 of which of the source access relations was the last
5597 to access the same data element before the given iteration
5598 of the sink access.
5599 The resulting dependence relations map source iterations
5600 to the corresponding sink iterations.
5601 To compute standard flow dependences, the sink should be
5602 a read, while the sources should be writes.
5603 If any of the source accesses are marked as being I<may>
5604 accesses, then there will be a dependence from the last
5605 I<must> access B<and> from any I<may> access that follows
5606 this last I<must> access.
5607 In particular, if I<all> sources are I<may> accesses,
5608 then memory based dependence analysis is performed.
5609 If, on the other hand, all sources are I<must> accesses,
5610 then value based dependence analysis is performed.
5612         #include <isl/flow.h>
5614         typedef int (*isl_access_level_before)(void *first, void *second);
5616         __isl_give isl_access_info *isl_access_info_alloc(
5617                 __isl_take isl_map *sink,
5618                 void *sink_user, isl_access_level_before fn,
5619                 int max_source);
5620         __isl_give isl_access_info *isl_access_info_add_source(
5621                 __isl_take isl_access_info *acc,
5622                 __isl_take isl_map *source, int must,
5623                 void *source_user);
5624         void *isl_access_info_free(__isl_take isl_access_info *acc);
5626         __isl_give isl_flow *isl_access_info_compute_flow(
5627                 __isl_take isl_access_info *acc);
5629         int isl_flow_foreach(__isl_keep isl_flow *deps,
5630                 int (*fn)(__isl_take isl_map *dep, int must,
5631                           void *dep_user, void *user),
5632                 void *user);
5633         __isl_give isl_map *isl_flow_get_no_source(
5634                 __isl_keep isl_flow *deps, int must);
5635         void isl_flow_free(__isl_take isl_flow *deps);
5637 The function C<isl_access_info_compute_flow> performs the actual
5638 dependence analysis.  The other functions are used to construct
5639 the input for this function or to read off the output.
5641 The input is collected in an C<isl_access_info>, which can
5642 be created through a call to C<isl_access_info_alloc>.
5643 The arguments to this functions are the sink access relation
5644 C<sink>, a token C<sink_user> used to identify the sink
5645 access to the user, a callback function for specifying the
5646 relative order of source and sink accesses, and the number
5647 of source access relations that will be added.
5648 The callback function has type C<int (*)(void *first, void *second)>.
5649 The function is called with two user supplied tokens identifying
5650 either a source or the sink and it should return the shared nesting
5651 level and the relative order of the two accesses.
5652 In particular, let I<n> be the number of loops shared by
5653 the two accesses.  If C<first> precedes C<second> textually,
5654 then the function should return I<2 * n + 1>; otherwise,
5655 it should return I<2 * n>.
5656 The sources can be added to the C<isl_access_info> by performing
5657 (at most) C<max_source> calls to C<isl_access_info_add_source>.
5658 C<must> indicates whether the source is a I<must> access
5659 or a I<may> access.  Note that a multi-valued access relation
5660 should only be marked I<must> if every iteration in the domain
5661 of the relation accesses I<all> elements in its image.
5662 The C<source_user> token is again used to identify
5663 the source access.  The range of the source access relation
5664 C<source> should have the same dimension as the range
5665 of the sink access relation.
5666 The C<isl_access_info_free> function should usually not be
5667 called explicitly, because it is called implicitly by
5668 C<isl_access_info_compute_flow>.
5670 The result of the dependence analysis is collected in an
5671 C<isl_flow>.  There may be elements of
5672 the sink access for which no preceding source access could be
5673 found or for which all preceding sources are I<may> accesses.
5674 The relations containing these elements can be obtained through
5675 calls to C<isl_flow_get_no_source>, the first with C<must> set
5676 and the second with C<must> unset.
5677 In the case of standard flow dependence analysis,
5678 with the sink a read and the sources I<must> writes,
5679 the first relation corresponds to the reads from uninitialized
5680 array elements and the second relation is empty.
5681 The actual flow dependences can be extracted using
5682 C<isl_flow_foreach>.  This function will call the user-specified
5683 callback function C<fn> for each B<non-empty> dependence between
5684 a source and the sink.  The callback function is called
5685 with four arguments, the actual flow dependence relation
5686 mapping source iterations to sink iterations, a boolean that
5687 indicates whether it is a I<must> or I<may> dependence, a token
5688 identifying the source and an additional C<void *> with value
5689 equal to the third argument of the C<isl_flow_foreach> call.
5690 A dependence is marked I<must> if it originates from a I<must>
5691 source and if it is not followed by any I<may> sources.
5693 After finishing with an C<isl_flow>, the user should call
5694 C<isl_flow_free> to free all associated memory.
5696 A higher-level interface to dependence analysis is provided
5697 by the following function.
5699         #include <isl/flow.h>
5701         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
5702                 __isl_take isl_union_map *must_source,
5703                 __isl_take isl_union_map *may_source,
5704                 __isl_take isl_union_map *schedule,
5705                 __isl_give isl_union_map **must_dep,
5706                 __isl_give isl_union_map **may_dep,
5707                 __isl_give isl_union_map **must_no_source,
5708                 __isl_give isl_union_map **may_no_source);
5710 The arrays are identified by the tuple names of the ranges
5711 of the accesses.  The iteration domains by the tuple names
5712 of the domains of the accesses and of the schedule.
5713 The relative order of the iteration domains is given by the
5714 schedule.  The relations returned through C<must_no_source>
5715 and C<may_no_source> are subsets of C<sink>.
5716 Any of C<must_dep>, C<may_dep>, C<must_no_source>
5717 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
5718 any of the other arguments is treated as an error.
5720 =head3 Interaction with Dependence Analysis
5722 During the dependence analysis, we frequently need to perform
5723 the following operation.  Given a relation between sink iterations
5724 and potential source iterations from a particular source domain,
5725 what is the last potential source iteration corresponding to each
5726 sink iteration.  It can sometimes be convenient to adjust
5727 the set of potential source iterations before or after each such operation.
5728 The prototypical example is fuzzy array dataflow analysis,
5729 where we need to analyze if, based on data-dependent constraints,
5730 the sink iteration can ever be executed without one or more of
5731 the corresponding potential source iterations being executed.
5732 If so, we can introduce extra parameters and select an unknown
5733 but fixed source iteration from the potential source iterations.
5734 To be able to perform such manipulations, C<isl> provides the following
5735 function.
5737         #include <isl/flow.h>
5739         typedef __isl_give isl_restriction *(*isl_access_restrict)(
5740                 __isl_keep isl_map *source_map,
5741                 __isl_keep isl_set *sink, void *source_user,
5742                 void *user);
5743         __isl_give isl_access_info *isl_access_info_set_restrict(
5744                 __isl_take isl_access_info *acc,
5745                 isl_access_restrict fn, void *user);
5747 The function C<isl_access_info_set_restrict> should be called
5748 before calling C<isl_access_info_compute_flow> and registers a callback function
5749 that will be called any time C<isl> is about to compute the last
5750 potential source.  The first argument is the (reverse) proto-dependence,
5751 mapping sink iterations to potential source iterations.
5752 The second argument represents the sink iterations for which
5753 we want to compute the last source iteration.
5754 The third argument is the token corresponding to the source
5755 and the final argument is the token passed to C<isl_access_info_set_restrict>.
5756 The callback is expected to return a restriction on either the input or
5757 the output of the operation computing the last potential source.
5758 If the input needs to be restricted then restrictions are needed
5759 for both the source and the sink iterations.  The sink iterations
5760 and the potential source iterations will be intersected with these sets.
5761 If the output needs to be restricted then only a restriction on the source
5762 iterations is required.
5763 If any error occurs, the callback should return C<NULL>.
5764 An C<isl_restriction> object can be created, freed and inspected
5765 using the following functions.
5767         #include <isl/flow.h>
5769         __isl_give isl_restriction *isl_restriction_input(
5770                 __isl_take isl_set *source_restr,
5771                 __isl_take isl_set *sink_restr);
5772         __isl_give isl_restriction *isl_restriction_output(
5773                 __isl_take isl_set *source_restr);
5774         __isl_give isl_restriction *isl_restriction_none(
5775                 __isl_take isl_map *source_map);
5776         __isl_give isl_restriction *isl_restriction_empty(
5777                 __isl_take isl_map *source_map);
5778         void *isl_restriction_free(
5779                 __isl_take isl_restriction *restr);
5780         isl_ctx *isl_restriction_get_ctx(
5781                 __isl_keep isl_restriction *restr);
5783 C<isl_restriction_none> and C<isl_restriction_empty> are special
5784 cases of C<isl_restriction_input>.  C<isl_restriction_none>
5785 is essentially equivalent to
5787         isl_restriction_input(isl_set_universe(
5788             isl_space_range(isl_map_get_space(source_map))),
5789                             isl_set_universe(
5790             isl_space_domain(isl_map_get_space(source_map))));
5792 whereas C<isl_restriction_empty> is essentially equivalent to
5794         isl_restriction_input(isl_set_empty(
5795             isl_space_range(isl_map_get_space(source_map))),
5796                             isl_set_universe(
5797             isl_space_domain(isl_map_get_space(source_map))));
5799 =head2 Scheduling
5801 B<The functionality described in this section is fairly new
5802 and may be subject to change.>
5804         #include <isl/schedule.h>
5805         __isl_give isl_schedule *
5806         isl_schedule_constraints_compute_schedule(
5807                 __isl_take isl_schedule_constraints *sc);
5808         void *isl_schedule_free(__isl_take isl_schedule *sched);
5810 The function C<isl_schedule_constraints_compute_schedule> can be
5811 used to compute a schedule that satisfy the given schedule constraints.
5812 These schedule constraints include the iteration domain for which
5813 a schedule should be computed and dependences between pairs of
5814 iterations.  In particular, these dependences include
5815 I<validity> dependences and I<proximity> dependences.
5816 By default, the algorithm used to construct the schedule is similar
5817 to that of C<Pluto>.
5818 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
5819 be selected.
5820 The generated schedule respects all validity dependences.
5821 That is, all dependence distances over these dependences in the
5822 scheduled space are lexicographically positive.
5823 The default algorithm tries to ensure that the dependence distances
5824 over coincidence constraints are zero and to minimize the
5825 dependence distances over proximity dependences.
5826 Moreover, it tries to obtain sequences (bands) of schedule dimensions
5827 for groups of domains where the dependence distances over validity
5828 dependences have only non-negative values.
5829 When using Feautrier's algorithm, the coincidence and proximity constraints
5830 are only taken into account during the extension to a
5831 full-dimensional schedule.
5833 An C<isl_schedule_constraints> object can be constructed
5834 and manipulated using the following functions.
5836         #include <isl/schedule.h>
5837         __isl_give isl_schedule_constraints *
5838         isl_schedule_constraints_copy(
5839                 __isl_keep isl_schedule_constraints *sc);
5840         __isl_give isl_schedule_constraints *
5841         isl_schedule_constraints_on_domain(
5842                 __isl_take isl_union_set *domain);
5843         isl_ctx *isl_schedule_constraints_get_ctx(
5844                 __isl_keep isl_schedule_constraints *sc);
5845         __isl_give isl_schedule_constraints *
5846         isl_schedule_constraints_set_validity(
5847                 __isl_take isl_schedule_constraints *sc,
5848                 __isl_take isl_union_map *validity);
5849         __isl_give isl_schedule_constraints *
5850         isl_schedule_constraints_set_coincidence(
5851                 __isl_take isl_schedule_constraints *sc,
5852                 __isl_take isl_union_map *coincidence);
5853         __isl_give isl_schedule_constraints *
5854         isl_schedule_constraints_set_proximity(
5855                 __isl_take isl_schedule_constraints *sc,
5856                 __isl_take isl_union_map *proximity);
5857         __isl_give isl_schedule_constraints *
5858         isl_schedule_constraints_set_conditional_validity(
5859                 __isl_take isl_schedule_constraints *sc,
5860                 __isl_take isl_union_map *condition,
5861                 __isl_take isl_union_map *validity);
5862         void *isl_schedule_constraints_free(
5863                 __isl_take isl_schedule_constraints *sc);
5865 The initial C<isl_schedule_constraints> object created by
5866 C<isl_schedule_constraints_on_domain> does not impose any constraints.
5867 That is, it has an empty set of dependences.
5868 The function C<isl_schedule_constraints_set_validity> replaces the
5869 validity dependences, mapping domain elements I<i> to domain
5870 elements that should be scheduled after I<i>.
5871 The function C<isl_schedule_constraints_set_coincidence> replaces the
5872 coincidence dependences, mapping domain elements I<i> to domain
5873 elements that should be scheduled together with I<I>, if possible.
5874 The function C<isl_schedule_constraints_set_proximity> replaces the
5875 proximity dependences, mapping domain elements I<i> to domain
5876 elements that should be scheduled either before I<I>
5877 or as early as possible after I<i>.
5879 The function C<isl_schedule_constraints_set_conditional_validity>
5880 replaces the conditional validity constraints.
5881 A conditional validity constraint is only imposed when any of the corresponding
5882 conditions is satisfied, i.e., when any of them is non-zero.
5883 That is, the scheduler ensures that within each band if the dependence
5884 distances over the condition constraints are not all zero
5885 then all corresponding conditional validity constraints are respected.
5886 A conditional validity constraint corresponds to a condition
5887 if the two are adjacent, i.e., if the domain of one relation intersect
5888 the range of the other relation.
5889 The typical use case of conditional validity constraints is
5890 to allow order constraints between live ranges to be violated
5891 as long as the live ranges themselves are local to the band.
5892 To allow more fine-grained control over which conditions correspond
5893 to which conditional validity constraints, the domains and ranges
5894 of these relations may include I<tags>.  That is, the domains and
5895 ranges of those relation may themselves be wrapped relations
5896 where the iteration domain appears in the domain of those wrapped relations
5897 and the range of the wrapped relations can be arbitrarily chosen
5898 by the user.  Conditions and conditional validity constraints are only
5899 considere adjacent to each other if the entire wrapped relation matches.
5900 In particular, a relation with a tag will never be considered adjacent
5901 to a relation without a tag.
5903 The following function computes a schedule directly from
5904 an iteration domain and validity and proximity dependences
5905 and is implemented in terms of the functions described above.
5906 The use of C<isl_union_set_compute_schedule> is discouraged.
5908         #include <isl/schedule.h>
5909         __isl_give isl_schedule *isl_union_set_compute_schedule(
5910                 __isl_take isl_union_set *domain,
5911                 __isl_take isl_union_map *validity,
5912                 __isl_take isl_union_map *proximity);
5914 A mapping from the domains to the scheduled space can be obtained
5915 from an C<isl_schedule> using the following function.
5917         __isl_give isl_union_map *isl_schedule_get_map(
5918                 __isl_keep isl_schedule *sched);
5920 A representation of the schedule can be printed using
5921          
5922         __isl_give isl_printer *isl_printer_print_schedule(
5923                 __isl_take isl_printer *p,
5924                 __isl_keep isl_schedule *schedule);
5926 A representation of the schedule as a forest of bands can be obtained
5927 using the following function.
5929         __isl_give isl_band_list *isl_schedule_get_band_forest(
5930                 __isl_keep isl_schedule *schedule);
5932 The individual bands can be visited in depth-first post-order
5933 using the following function.
5935         #include <isl/schedule.h>
5936         int isl_schedule_foreach_band(
5937                 __isl_keep isl_schedule *sched,
5938                 int (*fn)(__isl_keep isl_band *band, void *user),
5939                 void *user);
5941 The list can be manipulated as explained in L<"Lists">.
5942 The bands inside the list can be copied and freed using the following
5943 functions.
5945         #include <isl/band.h>
5946         __isl_give isl_band *isl_band_copy(
5947                 __isl_keep isl_band *band);
5948         void *isl_band_free(__isl_take isl_band *band);
5950 Each band contains zero or more scheduling dimensions.
5951 These are referred to as the members of the band.
5952 The section of the schedule that corresponds to the band is
5953 referred to as the partial schedule of the band.
5954 For those nodes that participate in a band, the outer scheduling
5955 dimensions form the prefix schedule, while the inner scheduling
5956 dimensions form the suffix schedule.
5957 That is, if we take a cut of the band forest, then the union of
5958 the concatenations of the prefix, partial and suffix schedules of
5959 each band in the cut is equal to the entire schedule (modulo
5960 some possible padding at the end with zero scheduling dimensions).
5961 The properties of a band can be inspected using the following functions.
5963         #include <isl/band.h>
5964         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
5966         int isl_band_has_children(__isl_keep isl_band *band);
5967         __isl_give isl_band_list *isl_band_get_children(
5968                 __isl_keep isl_band *band);
5970         __isl_give isl_union_map *isl_band_get_prefix_schedule(
5971                 __isl_keep isl_band *band);
5972         __isl_give isl_union_map *isl_band_get_partial_schedule(
5973                 __isl_keep isl_band *band);
5974         __isl_give isl_union_map *isl_band_get_suffix_schedule(
5975                 __isl_keep isl_band *band);
5977         int isl_band_n_member(__isl_keep isl_band *band);
5978         int isl_band_member_is_coincident(
5979                 __isl_keep isl_band *band, int pos);
5981         int isl_band_list_foreach_band(
5982                 __isl_keep isl_band_list *list,
5983                 int (*fn)(__isl_keep isl_band *band, void *user),
5984                 void *user);
5986 Note that a scheduling dimension is considered to be ``coincident''
5987 if it satisfies the coincidence constraints within its band.
5988 That is, if the dependence distances of the coincidence
5989 constraints are all zero in that direction (for fixed
5990 iterations of outer bands).
5991 Like C<isl_schedule_foreach_band>,
5992 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
5993 in depth-first post-order.
5995 A band can be tiled using the following function.
5997         #include <isl/band.h>
5998         int isl_band_tile(__isl_keep isl_band *band,
5999                 __isl_take isl_vec *sizes);
6001         int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
6002                 int val);
6003         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
6004         int isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
6005                 int val);
6006         int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
6008 The C<isl_band_tile> function tiles the band using the given tile sizes
6009 inside its schedule.
6010 A new child band is created to represent the point loops and it is
6011 inserted between the modified band and its children.
6012 The C<tile_scale_tile_loops> option specifies whether the tile
6013 loops iterators should be scaled by the tile sizes.
6014 If the C<tile_shift_point_loops> option is set, then the point loops
6015 are shifted to start at zero.
6017 A band can be split into two nested bands using the following function.
6019         int isl_band_split(__isl_keep isl_band *band, int pos);
6021 The resulting outer band contains the first C<pos> dimensions of C<band>
6022 while the inner band contains the remaining dimensions.
6024 A representation of the band can be printed using
6026         #include <isl/band.h>
6027         __isl_give isl_printer *isl_printer_print_band(
6028                 __isl_take isl_printer *p,
6029                 __isl_keep isl_band *band);
6031 =head3 Options
6033         #include <isl/schedule.h>
6034         int isl_options_set_schedule_max_coefficient(
6035                 isl_ctx *ctx, int val);
6036         int isl_options_get_schedule_max_coefficient(
6037                 isl_ctx *ctx);
6038         int isl_options_set_schedule_max_constant_term(
6039                 isl_ctx *ctx, int val);
6040         int isl_options_get_schedule_max_constant_term(
6041                 isl_ctx *ctx);
6042         int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
6043         int isl_options_get_schedule_fuse(isl_ctx *ctx);
6044         int isl_options_set_schedule_maximize_band_depth(
6045                 isl_ctx *ctx, int val);
6046         int isl_options_get_schedule_maximize_band_depth(
6047                 isl_ctx *ctx);
6048         int isl_options_set_schedule_outer_coincidence(
6049                 isl_ctx *ctx, int val);
6050         int isl_options_get_schedule_outer_coincidence(
6051                 isl_ctx *ctx);
6052         int isl_options_set_schedule_split_scaled(
6053                 isl_ctx *ctx, int val);
6054         int isl_options_get_schedule_split_scaled(
6055                 isl_ctx *ctx);
6056         int isl_options_set_schedule_algorithm(
6057                 isl_ctx *ctx, int val);
6058         int isl_options_get_schedule_algorithm(
6059                 isl_ctx *ctx);
6060         int isl_options_set_schedule_separate_components(
6061                 isl_ctx *ctx, int val);
6062         int isl_options_get_schedule_separate_components(
6063                 isl_ctx *ctx);
6065 =over
6067 =item * schedule_max_coefficient
6069 This option enforces that the coefficients for variable and parameter
6070 dimensions in the calculated schedule are not larger than the specified value.
6071 This option can significantly increase the speed of the scheduling calculation
6072 and may also prevent fusing of unrelated dimensions. A value of -1 means that
6073 this option does not introduce bounds on the variable or parameter
6074 coefficients.
6076 =item * schedule_max_constant_term
6078 This option enforces that the constant coefficients in the calculated schedule
6079 are not larger than the maximal constant term. This option can significantly
6080 increase the speed of the scheduling calculation and may also prevent fusing of
6081 unrelated dimensions. A value of -1 means that this option does not introduce
6082 bounds on the constant coefficients.
6084 =item * schedule_fuse
6086 This option controls the level of fusion.
6087 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
6088 resulting schedule will be distributed as much as possible.
6089 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
6090 try to fuse loops in the resulting schedule.
6092 =item * schedule_maximize_band_depth
6094 If this option is set, we do not split bands at the point
6095 where we detect splitting is necessary. Instead, we
6096 backtrack and split bands as early as possible. This
6097 reduces the number of splits and maximizes the width of
6098 the bands. Wider bands give more possibilities for tiling.
6099 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
6100 then bands will be split as early as possible, even if there is no need.
6101 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
6103 =item * schedule_outer_coincidence
6105 If this option is set, then we try to construct schedules
6106 where the outermost scheduling dimension in each band
6107 satisfies the coincidence constraints.
6109 =item * schedule_split_scaled
6111 If this option is set, then we try to construct schedules in which the
6112 constant term is split off from the linear part if the linear parts of
6113 the scheduling rows for all nodes in the graphs have a common non-trivial
6114 divisor.
6115 The constant term is then placed in a separate band and the linear
6116 part is reduced.
6118 =item * schedule_algorithm
6120 Selects the scheduling algorithm to be used.
6121 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
6122 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
6124 =item * schedule_separate_components
6126 If at any point the dependence graph contains any (weakly connected) components,
6127 then these components are scheduled separately.
6128 If this option is not set, then some iterations of the domains
6129 in these components may be scheduled together.
6130 If this option is set, then the components are given consecutive
6131 schedules.
6133 =back
6135 =head2 AST Generation
6137 This section describes the C<isl> functionality for generating
6138 ASTs that visit all the elements
6139 in a domain in an order specified by a schedule.
6140 In particular, given a C<isl_union_map>, an AST is generated
6141 that visits all the elements in the domain of the C<isl_union_map>
6142 according to the lexicographic order of the corresponding image
6143 element(s).  If the range of the C<isl_union_map> consists of
6144 elements in more than one space, then each of these spaces is handled
6145 separately in an arbitrary order.
6146 It should be noted that the image elements only specify the I<order>
6147 in which the corresponding domain elements should be visited.
6148 No direct relation between the image elements and the loop iterators
6149 in the generated AST should be assumed.
6151 Each AST is generated within a build.  The initial build
6152 simply specifies the constraints on the parameters (if any)
6153 and can be created, inspected, copied and freed using the following functions.
6155         #include <isl/ast_build.h>
6156         __isl_give isl_ast_build *isl_ast_build_from_context(
6157                 __isl_take isl_set *set);
6158         isl_ctx *isl_ast_build_get_ctx(
6159                 __isl_keep isl_ast_build *build);
6160         __isl_give isl_ast_build *isl_ast_build_copy(
6161                 __isl_keep isl_ast_build *build);
6162         void *isl_ast_build_free(
6163                 __isl_take isl_ast_build *build);
6165 The C<set> argument is usually a parameter set with zero or more parameters.
6166 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
6167 and L</"Fine-grained Control over AST Generation">.
6168 Finally, the AST itself can be constructed using the following
6169 function.
6171         #include <isl/ast_build.h>
6172         __isl_give isl_ast_node *isl_ast_build_ast_from_schedule(
6173                 __isl_keep isl_ast_build *build,
6174                 __isl_take isl_union_map *schedule);
6176 =head3 Inspecting the AST
6178 The basic properties of an AST node can be obtained as follows.
6180         #include <isl/ast.h>
6181         isl_ctx *isl_ast_node_get_ctx(
6182                 __isl_keep isl_ast_node *node);
6183         enum isl_ast_node_type isl_ast_node_get_type(
6184                 __isl_keep isl_ast_node *node);
6186 The type of an AST node is one of
6187 C<isl_ast_node_for>,
6188 C<isl_ast_node_if>,
6189 C<isl_ast_node_block> or
6190 C<isl_ast_node_user>.
6191 An C<isl_ast_node_for> represents a for node.
6192 An C<isl_ast_node_if> represents an if node.
6193 An C<isl_ast_node_block> represents a compound node.
6194 An C<isl_ast_node_user> represents an expression statement.
6195 An expression statement typically corresponds to a domain element, i.e.,
6196 one of the elements that is visited by the AST.
6198 Each type of node has its own additional properties.
6200         #include <isl/ast.h>
6201         __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
6202                 __isl_keep isl_ast_node *node);
6203         __isl_give isl_ast_expr *isl_ast_node_for_get_init(
6204                 __isl_keep isl_ast_node *node);
6205         __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
6206                 __isl_keep isl_ast_node *node);
6207         __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
6208                 __isl_keep isl_ast_node *node);
6209         __isl_give isl_ast_node *isl_ast_node_for_get_body(
6210                 __isl_keep isl_ast_node *node);
6211         int isl_ast_node_for_is_degenerate(
6212                 __isl_keep isl_ast_node *node);
6214 An C<isl_ast_for> is considered degenerate if it is known to execute
6215 exactly once.
6217         #include <isl/ast.h>
6218         __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
6219                 __isl_keep isl_ast_node *node);
6220         __isl_give isl_ast_node *isl_ast_node_if_get_then(
6221                 __isl_keep isl_ast_node *node);
6222         int isl_ast_node_if_has_else(
6223                 __isl_keep isl_ast_node *node);
6224         __isl_give isl_ast_node *isl_ast_node_if_get_else(
6225                 __isl_keep isl_ast_node *node);
6227         __isl_give isl_ast_node_list *
6228         isl_ast_node_block_get_children(
6229                 __isl_keep isl_ast_node *node);
6231         __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
6232                 __isl_keep isl_ast_node *node);
6234 Each of the returned C<isl_ast_expr>s can in turn be inspected using
6235 the following functions.
6237         #include <isl/ast.h>
6238         isl_ctx *isl_ast_expr_get_ctx(
6239                 __isl_keep isl_ast_expr *expr);
6240         enum isl_ast_expr_type isl_ast_expr_get_type(
6241                 __isl_keep isl_ast_expr *expr);
6243 The type of an AST expression is one of
6244 C<isl_ast_expr_op>,
6245 C<isl_ast_expr_id> or
6246 C<isl_ast_expr_int>.
6247 An C<isl_ast_expr_op> represents the result of an operation.
6248 An C<isl_ast_expr_id> represents an identifier.
6249 An C<isl_ast_expr_int> represents an integer value.
6251 Each type of expression has its own additional properties.
6253         #include <isl/ast.h>
6254         enum isl_ast_op_type isl_ast_expr_get_op_type(
6255                 __isl_keep isl_ast_expr *expr);
6256         int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
6257         __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
6258                 __isl_keep isl_ast_expr *expr, int pos);
6259         int isl_ast_node_foreach_ast_op_type(
6260                 __isl_keep isl_ast_node *node,
6261                 int (*fn)(enum isl_ast_op_type type, void *user),
6262                 void *user);
6264 C<isl_ast_expr_get_op_type> returns the type of the operation
6265 performed.  C<isl_ast_expr_get_op_n_arg> returns the number of
6266 arguments.  C<isl_ast_expr_get_op_arg> returns the specified
6267 argument.
6268 C<isl_ast_node_foreach_ast_op_type> calls C<fn> for each distinct
6269 C<isl_ast_op_type> that appears in C<node>.
6270 The operation type is one of the following.
6272 =over
6274 =item C<isl_ast_op_and>
6276 Logical I<and> of two arguments.
6277 Both arguments can be evaluated.
6279 =item C<isl_ast_op_and_then>
6281 Logical I<and> of two arguments.
6282 The second argument can only be evaluated if the first evaluates to true.
6284 =item C<isl_ast_op_or>
6286 Logical I<or> of two arguments.
6287 Both arguments can be evaluated.
6289 =item C<isl_ast_op_or_else>
6291 Logical I<or> of two arguments.
6292 The second argument can only be evaluated if the first evaluates to false.
6294 =item C<isl_ast_op_max>
6296 Maximum of two or more arguments.
6298 =item C<isl_ast_op_min>
6300 Minimum of two or more arguments.
6302 =item C<isl_ast_op_minus>
6304 Change sign.
6306 =item C<isl_ast_op_add>
6308 Sum of two arguments.
6310 =item C<isl_ast_op_sub>
6312 Difference of two arguments.
6314 =item C<isl_ast_op_mul>
6316 Product of two arguments.
6318 =item C<isl_ast_op_div>
6320 Exact division.  That is, the result is known to be an integer.
6322 =item C<isl_ast_op_fdiv_q>
6324 Result of integer division, rounded towards negative
6325 infinity.
6327 =item C<isl_ast_op_pdiv_q>
6329 Result of integer division, where dividend is known to be non-negative.
6331 =item C<isl_ast_op_pdiv_r>
6333 Remainder of integer division, where dividend is known to be non-negative.
6335 =item C<isl_ast_op_cond>
6337 Conditional operator defined on three arguments.
6338 If the first argument evaluates to true, then the result
6339 is equal to the second argument.  Otherwise, the result
6340 is equal to the third argument.
6341 The second and third argument may only be evaluated if
6342 the first argument evaluates to true and false, respectively.
6343 Corresponds to C<a ? b : c> in C.
6345 =item C<isl_ast_op_select>
6347 Conditional operator defined on three arguments.
6348 If the first argument evaluates to true, then the result
6349 is equal to the second argument.  Otherwise, the result
6350 is equal to the third argument.
6351 The second and third argument may be evaluated independently
6352 of the value of the first argument.
6353 Corresponds to C<a * b + (1 - a) * c> in C.
6355 =item C<isl_ast_op_eq>
6357 Equality relation.
6359 =item C<isl_ast_op_le>
6361 Less than or equal relation.
6363 =item C<isl_ast_op_lt>
6365 Less than relation.
6367 =item C<isl_ast_op_ge>
6369 Greater than or equal relation.
6371 =item C<isl_ast_op_gt>
6373 Greater than relation.
6375 =item C<isl_ast_op_call>
6377 A function call.
6378 The number of arguments of the C<isl_ast_expr> is one more than
6379 the number of arguments in the function call, the first argument
6380 representing the function being called.
6382 =item C<isl_ast_op_access>
6384 An array access.
6385 The number of arguments of the C<isl_ast_expr> is one more than
6386 the number of index expressions in the array access, the first argument
6387 representing the array being accessed.
6389 =item C<isl_ast_op_member>
6391 A member access.
6392 This operation has two arguments, a structure and the name of
6393 the member of the structure being accessed.
6395 =back
6397         #include <isl/ast.h>
6398         __isl_give isl_id *isl_ast_expr_get_id(
6399                 __isl_keep isl_ast_expr *expr);
6401 Return the identifier represented by the AST expression.
6403         #include <isl/ast.h>
6404         __isl_give isl_val *isl_ast_expr_get_val(
6405                 __isl_keep isl_ast_expr *expr);
6407 Return the integer represented by the AST expression.
6409 =head3 Properties of ASTs
6411         #include <isl/ast.h>
6412         int isl_ast_expr_is_equal(__isl_keep isl_ast_expr *expr1,
6413                 __isl_keep isl_ast_expr *expr2);
6415 Check if two C<isl_ast_expr>s are equal to each other.
6417 =head3 Manipulating and printing the AST
6419 AST nodes can be copied and freed using the following functions.
6421         #include <isl/ast.h>
6422         __isl_give isl_ast_node *isl_ast_node_copy(
6423                 __isl_keep isl_ast_node *node);
6424         void *isl_ast_node_free(__isl_take isl_ast_node *node);
6426 AST expressions can be copied and freed using the following functions.
6428         #include <isl/ast.h>
6429         __isl_give isl_ast_expr *isl_ast_expr_copy(
6430                 __isl_keep isl_ast_expr *expr);
6431         void *isl_ast_expr_free(__isl_take isl_ast_expr *expr);
6433 New AST expressions can be created either directly or within
6434 the context of an C<isl_ast_build>.
6436         #include <isl/ast.h>
6437         __isl_give isl_ast_expr *isl_ast_expr_from_val(
6438                 __isl_take isl_val *v);
6439         __isl_give isl_ast_expr *isl_ast_expr_from_id(
6440                 __isl_take isl_id *id);
6441         __isl_give isl_ast_expr *isl_ast_expr_neg(
6442                 __isl_take isl_ast_expr *expr);
6443         __isl_give isl_ast_expr *isl_ast_expr_add(
6444                 __isl_take isl_ast_expr *expr1,
6445                 __isl_take isl_ast_expr *expr2);
6446         __isl_give isl_ast_expr *isl_ast_expr_sub(
6447                 __isl_take isl_ast_expr *expr1,
6448                 __isl_take isl_ast_expr *expr2);
6449         __isl_give isl_ast_expr *isl_ast_expr_mul(
6450                 __isl_take isl_ast_expr *expr1,
6451                 __isl_take isl_ast_expr *expr2);
6452         __isl_give isl_ast_expr *isl_ast_expr_div(
6453                 __isl_take isl_ast_expr *expr1,
6454                 __isl_take isl_ast_expr *expr2);
6455         __isl_give isl_ast_expr *isl_ast_expr_and(
6456                 __isl_take isl_ast_expr *expr1,
6457                 __isl_take isl_ast_expr *expr2)
6458         __isl_give isl_ast_expr *isl_ast_expr_or(
6459                 __isl_take isl_ast_expr *expr1,
6460                 __isl_take isl_ast_expr *expr2)
6461         __isl_give isl_ast_expr *isl_ast_expr_access(
6462                 __isl_take isl_ast_expr *array,
6463                 __isl_take isl_ast_expr_list *indices);
6465         #include <isl/ast_build.h>
6466         __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
6467                 __isl_keep isl_ast_build *build,
6468                 __isl_take isl_pw_aff *pa);
6469         __isl_give isl_ast_expr *
6470         isl_ast_build_access_from_pw_multi_aff(
6471                 __isl_keep isl_ast_build *build,
6472                 __isl_take isl_pw_multi_aff *pma);
6473         __isl_give isl_ast_expr *
6474         isl_ast_build_access_from_multi_pw_aff(
6475                 __isl_keep isl_ast_build *build,
6476                 __isl_take isl_multi_pw_aff *mpa);
6477         __isl_give isl_ast_expr *
6478         isl_ast_build_call_from_pw_multi_aff(
6479                 __isl_keep isl_ast_build *build,
6480                 __isl_take isl_pw_multi_aff *pma);
6481         __isl_give isl_ast_expr *
6482         isl_ast_build_call_from_multi_pw_aff(
6483                 __isl_keep isl_ast_build *build,
6484                 __isl_take isl_multi_pw_aff *mpa);
6486 The domains of C<pa>, C<mpa> and C<pma> should correspond
6487 to the schedule space of C<build>.
6488 The tuple id of C<mpa> or C<pma> is used as the array being accessed or
6489 the function being called.
6490 If the accessed space is a nested relation, then it is taken
6491 to represent an access of the member specified by the range
6492 of this nested relation of the structure specified by the domain
6493 of the nested relation.
6495 The following functions can be used to modify an C<isl_ast_expr>.
6497         #include <isl/ast.h>
6498         __isl_give isl_ast_expr *isl_ast_expr_set_op_arg(
6499                 __isl_take isl_ast_expr *expr, int pos,
6500                 __isl_take isl_ast_expr *arg);
6502 Replace the argument of C<expr> at position C<pos> by C<arg>.
6504         #include <isl/ast.h>
6505         __isl_give isl_ast_expr *isl_ast_expr_substitute_ids(
6506                 __isl_take isl_ast_expr *expr,
6507                 __isl_take isl_id_to_ast_expr *id2expr);
6509 The function C<isl_ast_expr_substitute_ids> replaces the
6510 subexpressions of C<expr> of type C<isl_ast_expr_id>
6511 by the corresponding expression in C<id2expr>, if there is any.
6514 User specified data can be attached to an C<isl_ast_node> and obtained
6515 from the same C<isl_ast_node> using the following functions.
6517         #include <isl/ast.h>
6518         __isl_give isl_ast_node *isl_ast_node_set_annotation(
6519                 __isl_take isl_ast_node *node,
6520                 __isl_take isl_id *annotation);
6521         __isl_give isl_id *isl_ast_node_get_annotation(
6522                 __isl_keep isl_ast_node *node);
6524 Basic printing can be performed using the following functions.
6526         #include <isl/ast.h>
6527         __isl_give isl_printer *isl_printer_print_ast_expr(
6528                 __isl_take isl_printer *p,
6529                 __isl_keep isl_ast_expr *expr);
6530         __isl_give isl_printer *isl_printer_print_ast_node(
6531                 __isl_take isl_printer *p,
6532                 __isl_keep isl_ast_node *node);
6534 More advanced printing can be performed using the following functions.
6536         #include <isl/ast.h>
6537         __isl_give isl_printer *isl_ast_op_type_print_macro(
6538                 enum isl_ast_op_type type,
6539                 __isl_take isl_printer *p);
6540         __isl_give isl_printer *isl_ast_node_print_macros(
6541                 __isl_keep isl_ast_node *node,
6542                 __isl_take isl_printer *p);
6543         __isl_give isl_printer *isl_ast_node_print(
6544                 __isl_keep isl_ast_node *node,
6545                 __isl_take isl_printer *p,
6546                 __isl_take isl_ast_print_options *options);
6547         __isl_give isl_printer *isl_ast_node_for_print(
6548                 __isl_keep isl_ast_node *node,
6549                 __isl_take isl_printer *p,
6550                 __isl_take isl_ast_print_options *options);
6551         __isl_give isl_printer *isl_ast_node_if_print(
6552                 __isl_keep isl_ast_node *node,
6553                 __isl_take isl_printer *p,
6554                 __isl_take isl_ast_print_options *options);
6556 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
6557 C<isl> may print out an AST that makes use of macros such
6558 as C<floord>, C<min> and C<max>.
6559 C<isl_ast_op_type_print_macro> prints out the macro
6560 corresponding to a specific C<isl_ast_op_type>.
6561 C<isl_ast_node_print_macros> scans the C<isl_ast_node>
6562 for expressions where these macros would be used and prints
6563 out the required macro definitions.
6564 Essentially, C<isl_ast_node_print_macros> calls
6565 C<isl_ast_node_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
6566 as function argument.
6567 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
6568 C<isl_ast_node_if_print> print an C<isl_ast_node>
6569 in C<ISL_FORMAT_C>, but allow for some extra control
6570 through an C<isl_ast_print_options> object.
6571 This object can be created using the following functions.
6573         #include <isl/ast.h>
6574         __isl_give isl_ast_print_options *
6575         isl_ast_print_options_alloc(isl_ctx *ctx);
6576         __isl_give isl_ast_print_options *
6577         isl_ast_print_options_copy(
6578                 __isl_keep isl_ast_print_options *options);
6579         void *isl_ast_print_options_free(
6580                 __isl_take isl_ast_print_options *options);
6582         __isl_give isl_ast_print_options *
6583         isl_ast_print_options_set_print_user(
6584                 __isl_take isl_ast_print_options *options,
6585                 __isl_give isl_printer *(*print_user)(
6586                         __isl_take isl_printer *p,
6587                         __isl_take isl_ast_print_options *options,
6588                         __isl_keep isl_ast_node *node, void *user),
6589                 void *user);
6590         __isl_give isl_ast_print_options *
6591         isl_ast_print_options_set_print_for(
6592                 __isl_take isl_ast_print_options *options,
6593                 __isl_give isl_printer *(*print_for)(
6594                         __isl_take isl_printer *p,
6595                         __isl_take isl_ast_print_options *options,
6596                         __isl_keep isl_ast_node *node, void *user),
6597                 void *user);
6599 The callback set by C<isl_ast_print_options_set_print_user>
6600 is called whenever a node of type C<isl_ast_node_user> needs to
6601 be printed.
6602 The callback set by C<isl_ast_print_options_set_print_for>
6603 is called whenever a node of type C<isl_ast_node_for> needs to
6604 be printed.
6605 Note that C<isl_ast_node_for_print> will I<not> call the
6606 callback set by C<isl_ast_print_options_set_print_for> on the node
6607 on which C<isl_ast_node_for_print> is called, but only on nested
6608 nodes of type C<isl_ast_node_for>.  It is therefore safe to
6609 call C<isl_ast_node_for_print> from within the callback set by
6610 C<isl_ast_print_options_set_print_for>.
6612 The following option determines the type to be used for iterators
6613 while printing the AST.
6615         int isl_options_set_ast_iterator_type(
6616                 isl_ctx *ctx, const char *val);
6617         const char *isl_options_get_ast_iterator_type(
6618                 isl_ctx *ctx);
6620 =head3 Options
6622         #include <isl/ast_build.h>
6623         int isl_options_set_ast_build_atomic_upper_bound(
6624                 isl_ctx *ctx, int val);
6625         int isl_options_get_ast_build_atomic_upper_bound(
6626                 isl_ctx *ctx);
6627         int isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
6628                 int val);
6629         int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
6630         int isl_options_set_ast_build_exploit_nested_bounds(
6631                 isl_ctx *ctx, int val);
6632         int isl_options_get_ast_build_exploit_nested_bounds(
6633                 isl_ctx *ctx);
6634         int isl_options_set_ast_build_group_coscheduled(
6635                 isl_ctx *ctx, int val);
6636         int isl_options_get_ast_build_group_coscheduled(
6637                 isl_ctx *ctx);
6638         int isl_options_set_ast_build_scale_strides(
6639                 isl_ctx *ctx, int val);
6640         int isl_options_get_ast_build_scale_strides(
6641                 isl_ctx *ctx);
6642         int isl_options_set_ast_build_allow_else(isl_ctx *ctx,
6643                 int val);
6644         int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
6645         int isl_options_set_ast_build_allow_or(isl_ctx *ctx,
6646                 int val);
6647         int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
6649 =over
6651 =item * ast_build_atomic_upper_bound
6653 Generate loop upper bounds that consist of the current loop iterator,
6654 an operator and an expression not involving the iterator.
6655 If this option is not set, then the current loop iterator may appear
6656 several times in the upper bound.
6657 For example, when this option is turned off, AST generation
6658 for the schedule
6660         [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
6662 produces
6664         for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
6665           A(c0);
6667 When the option is turned on, the following AST is generated
6669         for (int c0 = 0; c0 <= min(100, n); c0 += 1)
6670           A(c0);
6672 =item * ast_build_prefer_pdiv
6674 If this option is turned off, then the AST generation will
6675 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
6676 operators, but no C<isl_ast_op_pdiv_q> or
6677 C<isl_ast_op_pdiv_r> operators.
6678 If this options is turned on, then C<isl> will try to convert
6679 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
6680 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
6682 =item * ast_build_exploit_nested_bounds
6684 Simplify conditions based on bounds of nested for loops.
6685 In particular, remove conditions that are implied by the fact
6686 that one or more nested loops have at least one iteration,
6687 meaning that the upper bound is at least as large as the lower bound.
6688 For example, when this option is turned off, AST generation
6689 for the schedule
6691         [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
6692                                         0 <= j <= M }
6694 produces
6696         if (M >= 0)
6697           for (int c0 = 0; c0 <= N; c0 += 1)
6698             for (int c1 = 0; c1 <= M; c1 += 1)
6699               A(c0, c1);
6701 When the option is turned on, the following AST is generated
6703         for (int c0 = 0; c0 <= N; c0 += 1)
6704           for (int c1 = 0; c1 <= M; c1 += 1)
6705             A(c0, c1);
6707 =item * ast_build_group_coscheduled
6709 If two domain elements are assigned the same schedule point, then
6710 they may be executed in any order and they may even appear in different
6711 loops.  If this options is set, then the AST generator will make
6712 sure that coscheduled domain elements do not appear in separate parts
6713 of the AST.  This is useful in case of nested AST generation
6714 if the outer AST generation is given only part of a schedule
6715 and the inner AST generation should handle the domains that are
6716 coscheduled by this initial part of the schedule together.
6717 For example if an AST is generated for a schedule
6719         { A[i] -> [0]; B[i] -> [0] }
6721 then the C<isl_ast_build_set_create_leaf> callback described
6722 below may get called twice, once for each domain.
6723 Setting this option ensures that the callback is only called once
6724 on both domains together.
6726 =item * ast_build_separation_bounds
6728 This option specifies which bounds to use during separation.
6729 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
6730 then all (possibly implicit) bounds on the current dimension will
6731 be used during separation.
6732 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
6733 then only those bounds that are explicitly available will
6734 be used during separation.
6736 =item * ast_build_scale_strides
6738 This option specifies whether the AST generator is allowed
6739 to scale down iterators of strided loops.
6741 =item * ast_build_allow_else
6743 This option specifies whether the AST generator is allowed
6744 to construct if statements with else branches.
6746 =item * ast_build_allow_or
6748 This option specifies whether the AST generator is allowed
6749 to construct if conditions with disjunctions.
6751 =back
6753 =head3 Fine-grained Control over AST Generation
6755 Besides specifying the constraints on the parameters,
6756 an C<isl_ast_build> object can be used to control
6757 various aspects of the AST generation process.
6758 The most prominent way of control is through ``options'',
6759 which can be set using the following function.
6761         #include <isl/ast_build.h>
6762         __isl_give isl_ast_build *
6763         isl_ast_build_set_options(
6764                 __isl_take isl_ast_build *control,
6765                 __isl_take isl_union_map *options);
6767 The options are encoded in an <isl_union_map>.
6768 The domain of this union relation refers to the schedule domain,
6769 i.e., the range of the schedule passed to C<isl_ast_build_ast_from_schedule>.
6770 In the case of nested AST generation (see L</"Nested AST Generation">),
6771 the domain of C<options> should refer to the extra piece of the schedule.
6772 That is, it should be equal to the range of the wrapped relation in the
6773 range of the schedule.
6774 The range of the options can consist of elements in one or more spaces,
6775 the names of which determine the effect of the option.
6776 The values of the range typically also refer to the schedule dimension
6777 to which the option applies.  In case of nested AST generation
6778 (see L</"Nested AST Generation">), these values refer to the position
6779 of the schedule dimension within the innermost AST generation.
6780 The constraints on the domain elements of
6781 the option should only refer to this dimension and earlier dimensions.
6782 We consider the following spaces.
6784 =over
6786 =item C<separation_class>
6788 This space is a wrapped relation between two one dimensional spaces.
6789 The input space represents the schedule dimension to which the option
6790 applies and the output space represents the separation class.
6791 While constructing a loop corresponding to the specified schedule
6792 dimension(s), the AST generator will try to generate separate loops
6793 for domain elements that are assigned different classes.
6794 If only some of the elements are assigned a class, then those elements
6795 that are not assigned any class will be treated as belonging to a class
6796 that is separate from the explicitly assigned classes.
6797 The typical use case for this option is to separate full tiles from
6798 partial tiles.
6799 The other options, described below, are applied after the separation
6800 into classes.
6802 As an example, consider the separation into full and partial tiles
6803 of a tiling of a triangular domain.
6804 Take, for example, the domain
6806         { A[i,j] : 0 <= i,j and i + j <= 100 }
6808 and a tiling into tiles of 10 by 10.  The input to the AST generator
6809 is then the schedule
6811         { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
6812                                                 i + j <= 100 }
6814 Without any options, the following AST is generated
6816         for (int c0 = 0; c0 <= 10; c0 += 1)
6817           for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6818             for (int c2 = 10 * c0;
6819                  c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6820                  c2 += 1)
6821               for (int c3 = 10 * c1;
6822                    c3 <= min(10 * c1 + 9, -c2 + 100);
6823                    c3 += 1)
6824                 A(c2, c3);
6826 Separation into full and partial tiles can be obtained by assigning
6827 a class, say C<0>, to the full tiles.  The full tiles are represented by those
6828 values of the first and second schedule dimensions for which there are
6829 values of the third and fourth dimensions to cover an entire tile.
6830 That is, we need to specify the following option
6832         { [a,b,c,d] -> separation_class[[0]->[0]] :
6833                 exists b': 0 <= 10a,10b' and
6834                            10a+9+10b'+9 <= 100;
6835           [a,b,c,d] -> separation_class[[1]->[0]] :
6836                 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
6838 which simplifies to
6840         { [a, b, c, d] -> separation_class[[1] -> [0]] :
6841                 a >= 0 and b >= 0 and b <= 8 - a;
6842           [a, b, c, d] -> separation_class[[0] -> [0]] :
6843                 a >= 0 and a <= 8 }
6845 With this option, the generated AST is as follows
6847         {
6848           for (int c0 = 0; c0 <= 8; c0 += 1) {
6849             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
6850               for (int c2 = 10 * c0;
6851                    c2 <= 10 * c0 + 9; c2 += 1)
6852                 for (int c3 = 10 * c1;
6853                      c3 <= 10 * c1 + 9; c3 += 1)
6854                   A(c2, c3);
6855             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
6856               for (int c2 = 10 * c0;
6857                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6858                    c2 += 1)
6859                 for (int c3 = 10 * c1;
6860                      c3 <= min(-c2 + 100, 10 * c1 + 9);
6861                      c3 += 1)
6862                   A(c2, c3);
6863           }
6864           for (int c0 = 9; c0 <= 10; c0 += 1)
6865             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6866               for (int c2 = 10 * c0;
6867                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6868                    c2 += 1)
6869                 for (int c3 = 10 * c1;
6870                      c3 <= min(10 * c1 + 9, -c2 + 100);
6871                      c3 += 1)
6872                   A(c2, c3);
6873         }
6875 =item C<separate>
6877 This is a single-dimensional space representing the schedule dimension(s)
6878 to which ``separation'' should be applied.  Separation tries to split
6879 a loop into several pieces if this can avoid the generation of guards
6880 inside the loop.
6881 See also the C<atomic> option.
6883 =item C<atomic>
6885 This is a single-dimensional space representing the schedule dimension(s)
6886 for which the domains should be considered ``atomic''.  That is, the
6887 AST generator will make sure that any given domain space will only appear
6888 in a single loop at the specified level.
6890 Consider the following schedule
6892         { a[i] -> [i] : 0 <= i < 10;
6893           b[i] -> [i+1] : 0 <= i < 10 }
6895 If the following option is specified
6897         { [i] -> separate[x] }
6899 then the following AST will be generated
6901         {
6902           a(0);
6903           for (int c0 = 1; c0 <= 9; c0 += 1) {
6904             a(c0);
6905             b(c0 - 1);
6906           }
6907           b(9);
6908         }
6910 If, on the other hand, the following option is specified
6912         { [i] -> atomic[x] }
6914 then the following AST will be generated
6916         for (int c0 = 0; c0 <= 10; c0 += 1) {
6917           if (c0 <= 9)
6918             a(c0);
6919           if (c0 >= 1)
6920             b(c0 - 1);
6921         }
6923 If neither C<atomic> nor C<separate> is specified, then the AST generator
6924 may produce either of these two results or some intermediate form.
6926 =item C<unroll>
6928 This is a single-dimensional space representing the schedule dimension(s)
6929 that should be I<completely> unrolled.
6930 To obtain a partial unrolling, the user should apply an additional
6931 strip-mining to the schedule and fully unroll the inner loop.
6933 =back
6935 Additional control is available through the following functions.
6937         #include <isl/ast_build.h>
6938         __isl_give isl_ast_build *
6939         isl_ast_build_set_iterators(
6940                 __isl_take isl_ast_build *control,
6941                 __isl_take isl_id_list *iterators);
6943 The function C<isl_ast_build_set_iterators> allows the user to
6944 specify a list of iterator C<isl_id>s to be used as iterators.
6945 If the input schedule is injective, then
6946 the number of elements in this list should be as large as the dimension
6947 of the schedule space, but no direct correspondence should be assumed
6948 between dimensions and elements.
6949 If the input schedule is not injective, then an additional number
6950 of C<isl_id>s equal to the largest dimension of the input domains
6951 may be required.
6952 If the number of provided C<isl_id>s is insufficient, then additional
6953 names are automatically generated.
6955         #include <isl/ast_build.h>
6956         __isl_give isl_ast_build *
6957         isl_ast_build_set_create_leaf(
6958                 __isl_take isl_ast_build *control,
6959                 __isl_give isl_ast_node *(*fn)(
6960                         __isl_take isl_ast_build *build,
6961                         void *user), void *user);
6964 C<isl_ast_build_set_create_leaf> function allows for the
6965 specification of a callback that should be called whenever the AST
6966 generator arrives at an element of the schedule domain.
6967 The callback should return an AST node that should be inserted
6968 at the corresponding position of the AST.  The default action (when
6969 the callback is not set) is to continue generating parts of the AST to scan
6970 all the domain elements associated to the schedule domain element
6971 and to insert user nodes, ``calling'' the domain element, for each of them.
6972 The C<build> argument contains the current state of the C<isl_ast_build>.
6973 To ease nested AST generation (see L</"Nested AST Generation">),
6974 all control information that is
6975 specific to the current AST generation such as the options and
6976 the callbacks has been removed from this C<isl_ast_build>.
6977 The callback would typically return the result of a nested
6978 AST generation or a
6979 user defined node created using the following function.
6981         #include <isl/ast.h>
6982         __isl_give isl_ast_node *isl_ast_node_alloc_user(
6983                 __isl_take isl_ast_expr *expr);
6985         #include <isl/ast_build.h>
6986         __isl_give isl_ast_build *
6987         isl_ast_build_set_at_each_domain(
6988                 __isl_take isl_ast_build *build,
6989                 __isl_give isl_ast_node *(*fn)(
6990                         __isl_take isl_ast_node *node,
6991                         __isl_keep isl_ast_build *build,
6992                         void *user), void *user);
6993         __isl_give isl_ast_build *
6994         isl_ast_build_set_before_each_for(
6995                 __isl_take isl_ast_build *build,
6996                 __isl_give isl_id *(*fn)(
6997                         __isl_keep isl_ast_build *build,
6998                         void *user), void *user);
6999         __isl_give isl_ast_build *
7000         isl_ast_build_set_after_each_for(
7001                 __isl_take isl_ast_build *build,
7002                 __isl_give isl_ast_node *(*fn)(
7003                         __isl_take isl_ast_node *node,
7004                         __isl_keep isl_ast_build *build,
7005                         void *user), void *user);
7007 The callback set by C<isl_ast_build_set_at_each_domain> will
7008 be called for each domain AST node.
7009 The callbacks set by C<isl_ast_build_set_before_each_for>
7010 and C<isl_ast_build_set_after_each_for> will be called
7011 for each for AST node.  The first will be called in depth-first
7012 pre-order, while the second will be called in depth-first post-order.
7013 Since C<isl_ast_build_set_before_each_for> is called before the for
7014 node is actually constructed, it is only passed an C<isl_ast_build>.
7015 The returned C<isl_id> will be added as an annotation (using
7016 C<isl_ast_node_set_annotation>) to the constructed for node.
7017 In particular, if the user has also specified an C<after_each_for>
7018 callback, then the annotation can be retrieved from the node passed to
7019 that callback using C<isl_ast_node_get_annotation>.
7020 All callbacks should C<NULL> on failure.
7021 The given C<isl_ast_build> can be used to create new
7022 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
7023 or C<isl_ast_build_call_from_pw_multi_aff>.
7025 =head3 Nested AST Generation
7027 C<isl> allows the user to create an AST within the context
7028 of another AST.  These nested ASTs are created using the
7029 same C<isl_ast_build_ast_from_schedule> function that is used to create the
7030 outer AST.  The C<build> argument should be an C<isl_ast_build>
7031 passed to a callback set by
7032 C<isl_ast_build_set_create_leaf>.
7033 The space of the range of the C<schedule> argument should refer
7034 to this build.  In particular, the space should be a wrapped
7035 relation and the domain of this wrapped relation should be the
7036 same as that of the range of the schedule returned by
7037 C<isl_ast_build_get_schedule> below.
7038 In practice, the new schedule is typically
7039 created by calling C<isl_union_map_range_product> on the old schedule
7040 and some extra piece of the schedule.
7041 The space of the schedule domain is also available from
7042 the C<isl_ast_build>.
7044         #include <isl/ast_build.h>
7045         __isl_give isl_union_map *isl_ast_build_get_schedule(
7046                 __isl_keep isl_ast_build *build);
7047         __isl_give isl_space *isl_ast_build_get_schedule_space(
7048                 __isl_keep isl_ast_build *build);
7049         __isl_give isl_ast_build *isl_ast_build_restrict(
7050                 __isl_take isl_ast_build *build,
7051                 __isl_take isl_set *set);
7053 The C<isl_ast_build_get_schedule> function returns a (partial)
7054 schedule for the domains elements for which part of the AST still needs to
7055 be generated in the current build.
7056 In particular, the domain elements are mapped to those iterations of the loops
7057 enclosing the current point of the AST generation inside which
7058 the domain elements are executed.
7059 No direct correspondence between
7060 the input schedule and this schedule should be assumed.
7061 The space obtained from C<isl_ast_build_get_schedule_space> can be used
7062 to create a set for C<isl_ast_build_restrict> to intersect
7063 with the current build.  In particular, the set passed to
7064 C<isl_ast_build_restrict> can have additional parameters.
7065 The ids of the set dimensions in the space returned by
7066 C<isl_ast_build_get_schedule_space> correspond to the
7067 iterators of the already generated loops.
7068 The user should not rely on the ids of the output dimensions
7069 of the relations in the union relation returned by
7070 C<isl_ast_build_get_schedule> having any particular value.
7072 =head1 Applications
7074 Although C<isl> is mainly meant to be used as a library,
7075 it also contains some basic applications that use some
7076 of the functionality of C<isl>.
7077 The input may be specified in either the L<isl format>
7078 or the L<PolyLib format>.
7080 =head2 C<isl_polyhedron_sample>
7082 C<isl_polyhedron_sample> takes a polyhedron as input and prints
7083 an integer element of the polyhedron, if there is any.
7084 The first column in the output is the denominator and is always
7085 equal to 1.  If the polyhedron contains no integer points,
7086 then a vector of length zero is printed.
7088 =head2 C<isl_pip>
7090 C<isl_pip> takes the same input as the C<example> program
7091 from the C<piplib> distribution, i.e., a set of constraints
7092 on the parameters, a line containing only -1 and finally a set
7093 of constraints on a parametric polyhedron.
7094 The coefficients of the parameters appear in the last columns
7095 (but before the final constant column).
7096 The output is the lexicographic minimum of the parametric polyhedron.
7097 As C<isl> currently does not have its own output format, the output
7098 is just a dump of the internal state.
7100 =head2 C<isl_polyhedron_minimize>
7102 C<isl_polyhedron_minimize> computes the minimum of some linear
7103 or affine objective function over the integer points in a polyhedron.
7104 If an affine objective function
7105 is given, then the constant should appear in the last column.
7107 =head2 C<isl_polytope_scan>
7109 Given a polytope, C<isl_polytope_scan> prints
7110 all integer points in the polytope.
7112 =head2 C<isl_codegen>
7114 Given a schedule, a context set and an options relation,
7115 C<isl_codegen> prints out an AST that scans the domain elements
7116 of the schedule in the order of their image(s) taking into account
7117 the constraints in the context set.