add isl_multi_union_pw_aff_read_from_str
[isl.git] / doc / user.pod
blob77f7ef6f8f442ccfb482c09f0718fbf2015978bb
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> or C<imath>.
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 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 =item * The function C<isl_vertex_get_expr> has been changed
205 to return an C<isl_multi_aff> instead of a rational C<isl_basic_set>.
206 The function C<isl_vertex_get_domain> has been changed to return
207 a regular basic set, rather than a rational basic set.
209 =back
211 =head3 Changes since isl-0.14
213 =over
215 =item * Objects of type C<isl_union_pw_multi_aff> can no longer contain
216 two or more C<isl_pw_multi_aff> objects with the same domain space.
218 =item * The function C<isl_union_pw_multi_aff_add> now consistently
219 computes the sum on the shared definition domain.
220 The function C<isl_union_pw_multi_aff_union_add> has been added
221 to compute the sum on the union of definition domains.
222 The original behavior of C<isl_union_pw_multi_aff_add> was
223 confused and is no longer available.
225 =back
227 =head1 License
229 C<isl> is released under the MIT license.
231 =over
233 Permission is hereby granted, free of charge, to any person obtaining a copy of
234 this software and associated documentation files (the "Software"), to deal in
235 the Software without restriction, including without limitation the rights to
236 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
237 of the Software, and to permit persons to whom the Software is furnished to do
238 so, subject to the following conditions:
240 The above copyright notice and this permission notice shall be included in all
241 copies or substantial portions of the Software.
243 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
244 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
245 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
246 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
247 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
248 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
249 SOFTWARE.
251 =back
253 Note that by default C<isl> requires C<GMP>, which is released
254 under the GNU Lesser General Public License (LGPL).  This means
255 that code linked against C<isl> is also linked against LGPL code.
257 When configuring with C<--with-int=imath>, C<isl> will link against C<imath>, a
258 library for exact integer arithmetic released under the MIT license.
260 =head1 Installation
262 The source of C<isl> can be obtained either as a tarball
263 or from the git repository.  Both are available from
264 L<http://freshmeat.net/projects/isl/>.
265 The installation process depends on how you obtained
266 the source.
268 =head2 Installation from the git repository
270 =over
272 =item 1 Clone or update the repository
274 The first time the source is obtained, you need to clone
275 the repository.
277         git clone git://repo.or.cz/isl.git
279 To obtain updates, you need to pull in the latest changes
281         git pull
283 =item 2 Optionally get C<imath> submodule
285 To build C<isl> with C<imath>, you need to obtain the C<imath>
286 submodule by running in the git source tree of C<isl>
288        git submodule init
289        git submodule update
291 This will fetch the required version of C<imath> in a subdirectory of C<isl>.
293 =item 2 Generate C<configure>
295         ./autogen.sh
297 =back
299 After performing the above steps, continue
300 with the L<Common installation instructions>.
302 =head2 Common installation instructions
304 =over
306 =item 1 Obtain C<GMP>
308 By default, building C<isl> requires C<GMP>, including its headers files.
309 Your distribution may not provide these header files by default
310 and you may need to install a package called C<gmp-devel> or something
311 similar.  Alternatively, C<GMP> can be built from
312 source, available from L<http://gmplib.org/>.
313 C<GMP> is not needed if you build C<isl> with C<imath>.
315 =item 2 Configure
317 C<isl> uses the standard C<autoconf> C<configure> script.
318 To run it, just type
320         ./configure
322 optionally followed by some configure options.
323 A complete list of options can be obtained by running
325         ./configure --help
327 Below we discuss some of the more common options.
329 =over
331 =item C<--prefix>
333 Installation prefix for C<isl>
335 =item C<--with-int=[gmp|imath]>
337 Select the integer library to be used by C<isl>, the default is C<gmp>.
338 Note that C<isl> may run significantly slower if you use C<imath>.
340 =item C<--with-gmp-prefix>
342 Installation prefix for C<GMP> (architecture-independent files).
344 =item C<--with-gmp-exec-prefix>
346 Installation prefix for C<GMP> (architecture-dependent files).
348 =back
350 =item 3 Compile
352         make
354 =item 4 Install (optional)
356         make install
358 =back
360 =head1 Integer Set Library
362 =head2 Memory Management
364 Since a high-level operation on isl objects usually involves
365 several substeps and since the user is usually not interested in
366 the intermediate results, most functions that return a new object
367 will also release all the objects passed as arguments.
368 If the user still wants to use one or more of these arguments
369 after the function call, she should pass along a copy of the
370 object rather than the object itself.
371 The user is then responsible for making sure that the original
372 object gets used somewhere else or is explicitly freed.
374 The arguments and return values of all documented functions are
375 annotated to make clear which arguments are released and which
376 arguments are preserved.  In particular, the following annotations
377 are used
379 =over
381 =item C<__isl_give>
383 C<__isl_give> means that a new object is returned.
384 The user should make sure that the returned pointer is
385 used exactly once as a value for an C<__isl_take> argument.
386 In between, it can be used as a value for as many
387 C<__isl_keep> arguments as the user likes.
388 There is one exception, and that is the case where the
389 pointer returned is C<NULL>.  Is this case, the user
390 is free to use it as an C<__isl_take> argument or not.
391 When applied to a C<char *>, the returned pointer needs to be
392 freed using C<free>.
394 =item C<__isl_null>
396 C<__isl_null> means that a C<NULL> value is returned.
398 =item C<__isl_take>
400 C<__isl_take> means that the object the argument points to
401 is taken over by the function and may no longer be used
402 by the user as an argument to any other function.
403 The pointer value must be one returned by a function
404 returning an C<__isl_give> pointer.
405 If the user passes in a C<NULL> value, then this will
406 be treated as an error in the sense that the function will
407 not perform its usual operation.  However, it will still
408 make sure that all the other C<__isl_take> arguments
409 are released.
411 =item C<__isl_keep>
413 C<__isl_keep> means that the function will only use the object
414 temporarily.  After the function has finished, the user
415 can still use it as an argument to other functions.
416 A C<NULL> value will be treated in the same way as
417 a C<NULL> value for an C<__isl_take> argument.
418 This annotation may also be used on return values of
419 type C<const char *>, in which case the returned pointer should
420 not be freed by the user and is only valid until the object
421 from which it was derived is updated or freed.
423 =back
425 =head2 Initialization
427 All manipulations of integer sets and relations occur within
428 the context of an C<isl_ctx>.
429 A given C<isl_ctx> can only be used within a single thread.
430 All arguments of a function are required to have been allocated
431 within the same context.
432 There are currently no functions available for moving an object
433 from one C<isl_ctx> to another C<isl_ctx>.  This means that
434 there is currently no way of safely moving an object from one
435 thread to another, unless the whole C<isl_ctx> is moved.
437 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
438 freed using C<isl_ctx_free>.
439 All objects allocated within an C<isl_ctx> should be freed
440 before the C<isl_ctx> itself is freed.
442         isl_ctx *isl_ctx_alloc();
443         void isl_ctx_free(isl_ctx *ctx);
445 The user can impose a bound on the number of low-level I<operations>
446 that can be performed by an C<isl_ctx>.  This bound can be set and
447 retrieved using the following functions.  A bound of zero means that
448 no bound is imposed.  The number of operations performed can be
449 reset using C<isl_ctx_reset_operations>.  Note that the number
450 of low-level operations needed to perform a high-level computation
451 may differ significantly across different versions
452 of C<isl>, but it should be the same across different platforms
453 for the same version of C<isl>.
455 Warning: This feature is experimental.  C<isl> has good support to abort and
456 bail out during the computation, but this feature may exercise error code paths
457 that are normally not used that much. Consequently, it is not unlikely that
458 hidden bugs will be exposed.
460         void isl_ctx_set_max_operations(isl_ctx *ctx,
461                 unsigned long max_operations);
462         unsigned long isl_ctx_get_max_operations(isl_ctx *ctx);
463         void isl_ctx_reset_operations(isl_ctx *ctx);
465 In order to be able to create an object in the same context
466 as another object, most object types (described later in
467 this document) provide a function to obtain the context
468 in which the object was created.
470         #include <isl/val.h>
471         isl_ctx *isl_val_get_ctx(__isl_keep isl_val *val);
472         isl_ctx *isl_multi_val_get_ctx(
473                 __isl_keep isl_multi_val *mv);
475         #include <isl/id.h>
476         isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
478         #include <isl/local_space.h>
479         isl_ctx *isl_local_space_get_ctx(
480                 __isl_keep isl_local_space *ls);
482         #include <isl/set.h>
483         isl_ctx *isl_set_list_get_ctx(
484                 __isl_keep isl_set_list *list);
486         #include <isl/aff.h>
487         isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
488         isl_ctx *isl_multi_aff_get_ctx(
489                 __isl_keep isl_multi_aff *maff);
490         isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pa);
491         isl_ctx *isl_pw_multi_aff_get_ctx(
492                 __isl_keep isl_pw_multi_aff *pma);
493         isl_ctx *isl_multi_pw_aff_get_ctx(
494                 __isl_keep isl_multi_pw_aff *mpa);
495         isl_ctx *isl_union_pw_aff_get_ctx(
496                 __isl_keep isl_union_pw_aff *upa);
497         isl_ctx *isl_union_pw_multi_aff_get_ctx(
498                 __isl_keep isl_union_pw_multi_aff *upma);
499         isl_ctx *isl_multi_union_pw_aff_get_ctx(
500                 __isl_keep isl_multi_union_pw_aff *mupa);
502         #include <isl/id_to_ast_expr.h>
503         isl_ctx *isl_id_to_ast_expr_get_ctx(
504                 __isl_keep id_to_ast_expr *id2expr);
506         #include <isl/point.h>
507         isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
509         #include <isl/vec.h>
510         isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
512         #include <isl/mat.h>
513         isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
515         #include <isl/vertices.h>
516         isl_ctx *isl_vertices_get_ctx(
517                 __isl_keep isl_vertices *vertices);
518         isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
519         isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
521         #include <isl/flow.h>
522         isl_ctx *isl_restriction_get_ctx(
523                 __isl_keep isl_restriction *restr);
525         #include <isl/schedule.h>
526         isl_ctx *isl_schedule_constraints_get_ctx(
527                 __isl_keep isl_schedule_constraints *sc);
529         #include <isl/band.h>
530         isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
532         #include <isl/ast_build.h>
533         isl_ctx *isl_ast_build_get_ctx(
534                 __isl_keep isl_ast_build *build);
536         #include <isl/ast.h>
537         isl_ctx *isl_ast_expr_get_ctx(
538                 __isl_keep isl_ast_expr *expr);
539         isl_ctx *isl_ast_node_get_ctx(
540                 __isl_keep isl_ast_node *node);
542 =head2 Values
544 An C<isl_val> represents an integer value, a rational value
545 or one of three special values, infinity, negative infinity and NaN.
546 Some predefined values can be created using the following functions.
548         #include <isl/val.h>
549         __isl_give isl_val *isl_val_zero(isl_ctx *ctx);
550         __isl_give isl_val *isl_val_one(isl_ctx *ctx);
551         __isl_give isl_val *isl_val_negone(isl_ctx *ctx);
552         __isl_give isl_val *isl_val_nan(isl_ctx *ctx);
553         __isl_give isl_val *isl_val_infty(isl_ctx *ctx);
554         __isl_give isl_val *isl_val_neginfty(isl_ctx *ctx);
556 Specific integer values can be created using the following functions.
558         #include <isl/val.h>
559         __isl_give isl_val *isl_val_int_from_si(isl_ctx *ctx,
560                 long i);
561         __isl_give isl_val *isl_val_int_from_ui(isl_ctx *ctx,
562                 unsigned long u);
563         __isl_give isl_val *isl_val_int_from_chunks(isl_ctx *ctx,
564                 size_t n, size_t size, const void *chunks);
566 The function C<isl_val_int_from_chunks> constructs an C<isl_val>
567 from the C<n> I<digits>, each consisting of C<size> bytes, stored at C<chunks>.
568 The least significant digit is assumed to be stored first.
570 Value objects can be copied and freed using the following functions.
572         #include <isl/val.h>
573         __isl_give isl_val *isl_val_copy(__isl_keep isl_val *v);
574         __isl_null isl_val *isl_val_free(__isl_take isl_val *v);
576 They can be inspected using the following functions.
578         #include <isl/val.h>
579         long isl_val_get_num_si(__isl_keep isl_val *v);
580         long isl_val_get_den_si(__isl_keep isl_val *v);
581         double isl_val_get_d(__isl_keep isl_val *v);
582         size_t isl_val_n_abs_num_chunks(__isl_keep isl_val *v,
583                 size_t size);
584         int isl_val_get_abs_num_chunks(__isl_keep isl_val *v,
585                 size_t size, void *chunks);
587 C<isl_val_n_abs_num_chunks> returns the number of I<digits>
588 of C<size> bytes needed to store the absolute value of the
589 numerator of C<v>.
590 C<isl_val_get_abs_num_chunks> stores these digits at C<chunks>,
591 which is assumed to have been preallocated by the caller.
592 The least significant digit is stored first.
593 Note that C<isl_val_get_num_si>, C<isl_val_get_den_si>,
594 C<isl_val_get_d>, C<isl_val_n_abs_num_chunks>
595 and C<isl_val_get_abs_num_chunks> can only be applied to rational values.
597 An C<isl_val> can be modified using the following function.
599         #include <isl/val.h>
600         __isl_give isl_val *isl_val_set_si(__isl_take isl_val *v,
601                 long i);
603 The following unary properties are defined on C<isl_val>s.
605         #include <isl/val.h>
606         int isl_val_sgn(__isl_keep isl_val *v);
607         int isl_val_is_zero(__isl_keep isl_val *v);
608         int isl_val_is_one(__isl_keep isl_val *v);
609         int isl_val_is_negone(__isl_keep isl_val *v);
610         int isl_val_is_nonneg(__isl_keep isl_val *v);
611         int isl_val_is_nonpos(__isl_keep isl_val *v);
612         int isl_val_is_pos(__isl_keep isl_val *v);
613         int isl_val_is_neg(__isl_keep isl_val *v);
614         int isl_val_is_int(__isl_keep isl_val *v);
615         int isl_val_is_rat(__isl_keep isl_val *v);
616         int isl_val_is_nan(__isl_keep isl_val *v);
617         int isl_val_is_infty(__isl_keep isl_val *v);
618         int isl_val_is_neginfty(__isl_keep isl_val *v);
620 Note that the sign of NaN is undefined.
622 The following binary properties are defined on pairs of C<isl_val>s.
624         #include <isl/val.h>
625         int isl_val_lt(__isl_keep isl_val *v1,
626                 __isl_keep isl_val *v2);
627         int isl_val_le(__isl_keep isl_val *v1,
628                 __isl_keep isl_val *v2);
629         int isl_val_gt(__isl_keep isl_val *v1,
630                 __isl_keep isl_val *v2);
631         int isl_val_ge(__isl_keep isl_val *v1,
632                 __isl_keep isl_val *v2);
633         int isl_val_eq(__isl_keep isl_val *v1,
634                 __isl_keep isl_val *v2);
635         int isl_val_ne(__isl_keep isl_val *v1,
636                 __isl_keep isl_val *v2);
637         int isl_val_abs_eq(__isl_keep isl_val *v1,
638                 __isl_keep isl_val *v2);
640 The function C<isl_val_abs_eq> checks whether its two arguments
641 are equal in absolute value.
643 For integer C<isl_val>s we additionally have the following binary property.
645         #include <isl/val.h>
646         int isl_val_is_divisible_by(__isl_keep isl_val *v1,
647                 __isl_keep isl_val *v2);
649 An C<isl_val> can also be compared to an integer using the following
650 function.  The result is undefined for NaN.
652         #include <isl/val.h>
653         int isl_val_cmp_si(__isl_keep isl_val *v, long i);
655 The following unary operations are available on C<isl_val>s.
657         #include <isl/val.h>
658         __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
659         __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
660         __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
661         __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
662         __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
663         __isl_give isl_val *isl_val_inv(__isl_take isl_val *v);
664         __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
666 The following binary operations are available on C<isl_val>s.
668         #include <isl/val.h>
669         __isl_give isl_val *isl_val_min(__isl_take isl_val *v1,
670                 __isl_take isl_val *v2);
671         __isl_give isl_val *isl_val_max(__isl_take isl_val *v1,
672                 __isl_take isl_val *v2);
673         __isl_give isl_val *isl_val_add(__isl_take isl_val *v1,
674                 __isl_take isl_val *v2);
675         __isl_give isl_val *isl_val_add_ui(__isl_take isl_val *v1,
676                 unsigned long v2);
677         __isl_give isl_val *isl_val_sub(__isl_take isl_val *v1,
678                 __isl_take isl_val *v2);
679         __isl_give isl_val *isl_val_sub_ui(__isl_take isl_val *v1,
680                 unsigned long v2);
681         __isl_give isl_val *isl_val_mul(__isl_take isl_val *v1,
682                 __isl_take isl_val *v2);
683         __isl_give isl_val *isl_val_mul_ui(__isl_take isl_val *v1,
684                 unsigned long v2);
685         __isl_give isl_val *isl_val_div(__isl_take isl_val *v1,
686                 __isl_take isl_val *v2);
688 On integer values, we additionally have the following operations.
690         #include <isl/val.h>
691         __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
692         __isl_give isl_val *isl_val_mod(__isl_take isl_val *v1,
693                 __isl_take isl_val *v2);
694         __isl_give isl_val *isl_val_gcd(__isl_take isl_val *v1,
695                 __isl_take isl_val *v2);
696         __isl_give isl_val *isl_val_gcdext(__isl_take isl_val *v1,
697                 __isl_take isl_val *v2, __isl_give isl_val **x,
698                 __isl_give isl_val **y);
700 The function C<isl_val_gcdext> returns the greatest common divisor g
701 of C<v1> and C<v2> as well as two integers C<*x> and C<*y> such
702 that C<*x> * C<v1> + C<*y> * C<v2> = g.
704 =head3 GMP specific functions
706 These functions are only available if C<isl> has been compiled with C<GMP>
707 support.
709 Specific integer and rational values can be created from C<GMP> values using
710 the following functions.
712         #include <isl/val_gmp.h>
713         __isl_give isl_val *isl_val_int_from_gmp(isl_ctx *ctx,
714                 mpz_t z);
715         __isl_give isl_val *isl_val_from_gmp(isl_ctx *ctx,
716                 const mpz_t n, const mpz_t d);
718 The numerator and denominator of a rational value can be extracted as
719 C<GMP> values using the following functions.
721         #include <isl/val_gmp.h>
722         int isl_val_get_num_gmp(__isl_keep isl_val *v, mpz_t z);
723         int isl_val_get_den_gmp(__isl_keep isl_val *v, mpz_t z);
725 =head2 Sets and Relations
727 C<isl> uses six types of objects for representing sets and relations,
728 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
729 C<isl_union_set> and C<isl_union_map>.
730 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
731 can be described as a conjunction of affine constraints, while
732 C<isl_set> and C<isl_map> represent unions of
733 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
734 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
735 to live in the same space.  C<isl_union_set>s and C<isl_union_map>s
736 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
737 where spaces are considered different if they have a different number
738 of dimensions and/or different names (see L<"Spaces">).
739 The difference between sets and relations (maps) is that sets have
740 one set of variables, while relations have two sets of variables,
741 input variables and output variables.
743 =head2 Error Handling
745 C<isl> supports different ways to react in case a runtime error is triggered.
746 Runtime errors arise, e.g., if a function such as C<isl_map_intersect> is called
747 with two maps that have incompatible spaces. There are three possible ways
748 to react on error: to warn, to continue or to abort.
750 The default behavior is to warn. In this mode, C<isl> prints a warning, stores
751 the last error in the corresponding C<isl_ctx> and the function in which the
752 error was triggered returns C<NULL>. An error does not corrupt internal state,
753 such that isl can continue to be used. C<isl> also provides functions to
754 read the last error and to reset the memory that stores the last error. The
755 last error is only stored for information purposes. Its presence does not
756 change the behavior of C<isl>. Hence, resetting an error is not required to
757 continue to use isl, but only to observe new errors.
759         #include <isl/ctx.h>
760         enum isl_error isl_ctx_last_error(isl_ctx *ctx);
761         void isl_ctx_reset_error(isl_ctx *ctx);
763 Another option is to continue on error. This is similar to warn on error mode,
764 except that C<isl> does not print any warning. This allows a program to
765 implement its own error reporting.
767 The last option is to directly abort the execution of the program from within
768 the isl library. This makes it obviously impossible to recover from an error,
769 but it allows to directly spot the error location. By aborting on error,
770 debuggers break at the location the error occurred and can provide a stack
771 trace. Other tools that automatically provide stack traces on abort or that do
772 not want to continue execution after an error was triggered may also prefer to
773 abort on error.
775 The on error behavior of isl can be specified by calling
776 C<isl_options_set_on_error> or by setting the command line option
777 C<--isl-on-error>. Valid arguments for the function call are
778 C<ISL_ON_ERROR_WARN>, C<ISL_ON_ERROR_CONTINUE> and C<ISL_ON_ERROR_ABORT>. The
779 choices for the command line option are C<warn>, C<continue> and C<abort>.
780 It is also possible to query the current error mode.
782         #include <isl/options.h>
783         int isl_options_set_on_error(isl_ctx *ctx, int val);
784         int isl_options_get_on_error(isl_ctx *ctx);
786 =head2 Identifiers
788 Identifiers are used to identify both individual dimensions
789 and tuples of dimensions.  They consist of an optional name and an optional
790 user pointer.  The name and the user pointer cannot both be C<NULL>, however.
791 Identifiers with the same name but different pointer values
792 are considered to be distinct.
793 Similarly, identifiers with different names but the same pointer value
794 are also considered to be distinct.
795 Equal identifiers are represented using the same object.
796 Pairs of identifiers can therefore be tested for equality using the
797 C<==> operator.
798 Identifiers can be constructed, copied, freed, inspected and printed
799 using the following functions.
801         #include <isl/id.h>
802         __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
803                 __isl_keep const char *name, void *user);
804         __isl_give isl_id *isl_id_set_free_user(
805                 __isl_take isl_id *id,
806                 __isl_give void (*free_user)(void *user));
807         __isl_give isl_id *isl_id_copy(isl_id *id);
808         __isl_null isl_id *isl_id_free(__isl_take isl_id *id);
810         void *isl_id_get_user(__isl_keep isl_id *id);
811         __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
813         __isl_give isl_printer *isl_printer_print_id(
814                 __isl_take isl_printer *p, __isl_keep isl_id *id);
816 The callback set by C<isl_id_set_free_user> is called on the user
817 pointer when the last reference to the C<isl_id> is freed.
818 Note that C<isl_id_get_name> returns a pointer to some internal
819 data structure, so the result can only be used while the
820 corresponding C<isl_id> is alive.
822 =head2 Spaces
824 Whenever a new set, relation or similar object is created from scratch,
825 the space in which it lives needs to be specified using an C<isl_space>.
826 Each space involves zero or more parameters and zero, one or two
827 tuples of set or input/output dimensions.  The parameters and dimensions
828 are identified by an C<isl_dim_type> and a position.
829 The type C<isl_dim_param> refers to parameters,
830 the type C<isl_dim_set> refers to set dimensions (for spaces
831 with a single tuple of dimensions) and the types C<isl_dim_in>
832 and C<isl_dim_out> refer to input and output dimensions
833 (for spaces with two tuples of dimensions).
834 Local spaces (see L</"Local Spaces">) also contain dimensions
835 of type C<isl_dim_div>.
836 Note that parameters are only identified by their position within
837 a given object.  Across different objects, parameters are (usually)
838 identified by their names or identifiers.  Only unnamed parameters
839 are identified by their positions across objects.  The use of unnamed
840 parameters is discouraged.
842         #include <isl/space.h>
843         __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
844                 unsigned nparam, unsigned n_in, unsigned n_out);
845         __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
846                 unsigned nparam);
847         __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
848                 unsigned nparam, unsigned dim);
849         __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
850         __isl_null isl_space *isl_space_free(__isl_take isl_space *space);
852 The space used for creating a parameter domain
853 needs to be created using C<isl_space_params_alloc>.
854 For other sets, the space
855 needs to be created using C<isl_space_set_alloc>, while
856 for a relation, the space
857 needs to be created using C<isl_space_alloc>.
859 To check whether a given space is that of a set or a map
860 or whether it is a parameter space, use these functions:
862         #include <isl/space.h>
863         int isl_space_is_params(__isl_keep isl_space *space);
864         int isl_space_is_set(__isl_keep isl_space *space);
865         int isl_space_is_map(__isl_keep isl_space *space);
867 Spaces can be compared using the following functions:
869         #include <isl/space.h>
870         int isl_space_is_equal(__isl_keep isl_space *space1,
871                 __isl_keep isl_space *space2);
872         int isl_space_is_domain(__isl_keep isl_space *space1,
873                 __isl_keep isl_space *space2);
874         int isl_space_is_range(__isl_keep isl_space *space1,
875                 __isl_keep isl_space *space2);
876         int isl_space_tuple_is_equal(
877                 __isl_keep isl_space *space1,
878                 enum isl_dim_type type1,
879                 __isl_keep isl_space *space2,
880                 enum isl_dim_type type2);
882 C<isl_space_is_domain> checks whether the first argument is equal
883 to the domain of the second argument.  This requires in particular that
884 the first argument is a set space and that the second argument
885 is a map space.  C<isl_space_tuple_is_equal> checks whether the given
886 tuples (C<isl_dim_in>, C<isl_dim_out> or C<isl_dim_set>) of the given
887 spaces are the same.  That is, it checks if they have the same
888 identifier (if any), the same dimension and the same internal structure
889 (if any).
891 It is often useful to create objects that live in the
892 same space as some other object.  This can be accomplished
893 by creating the new objects
894 (see L</"Creating New Sets and Relations"> or
895 L</"Functions">) based on the space
896 of the original object.
898         #include <isl/set.h>
899         __isl_give isl_space *isl_basic_set_get_space(
900                 __isl_keep isl_basic_set *bset);
901         __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
903         #include <isl/union_set.h>
904         __isl_give isl_space *isl_union_set_get_space(
905                 __isl_keep isl_union_set *uset);
907         #include <isl/map.h>
908         __isl_give isl_space *isl_basic_map_get_space(
909                 __isl_keep isl_basic_map *bmap);
910         __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
912         #include <isl/union_map.h>
913         __isl_give isl_space *isl_union_map_get_space(
914                 __isl_keep isl_union_map *umap);
916         #include <isl/constraint.h>
917         __isl_give isl_space *isl_constraint_get_space(
918                 __isl_keep isl_constraint *constraint);
920         #include <isl/polynomial.h>
921         __isl_give isl_space *isl_qpolynomial_get_domain_space(
922                 __isl_keep isl_qpolynomial *qp);
923         __isl_give isl_space *isl_qpolynomial_get_space(
924                 __isl_keep isl_qpolynomial *qp);
925         __isl_give isl_space *isl_qpolynomial_fold_get_space(
926                 __isl_keep isl_qpolynomial_fold *fold);
927         __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
928                 __isl_keep isl_pw_qpolynomial *pwqp);
929         __isl_give isl_space *isl_pw_qpolynomial_get_space(
930                 __isl_keep isl_pw_qpolynomial *pwqp);
931         __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
932                 __isl_keep isl_pw_qpolynomial_fold *pwf);
933         __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
934                 __isl_keep isl_pw_qpolynomial_fold *pwf);
935         __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
936                 __isl_keep isl_union_pw_qpolynomial *upwqp);
937         __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
938                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
940         #include <isl/val.h>
941         __isl_give isl_space *isl_multi_val_get_space(
942                 __isl_keep isl_multi_val *mv);
944         #include <isl/aff.h>
945         __isl_give isl_space *isl_aff_get_domain_space(
946                 __isl_keep isl_aff *aff);
947         __isl_give isl_space *isl_aff_get_space(
948                 __isl_keep isl_aff *aff);
949         __isl_give isl_space *isl_pw_aff_get_domain_space(
950                 __isl_keep isl_pw_aff *pwaff);
951         __isl_give isl_space *isl_pw_aff_get_space(
952                 __isl_keep isl_pw_aff *pwaff);
953         __isl_give isl_space *isl_multi_aff_get_domain_space(
954                 __isl_keep isl_multi_aff *maff);
955         __isl_give isl_space *isl_multi_aff_get_space(
956                 __isl_keep isl_multi_aff *maff);
957         __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
958                 __isl_keep isl_pw_multi_aff *pma);
959         __isl_give isl_space *isl_pw_multi_aff_get_space(
960                 __isl_keep isl_pw_multi_aff *pma);
961         __isl_give isl_space *isl_union_pw_aff_get_space(
962                 __isl_keep isl_union_pw_aff *upa);
963         __isl_give isl_space *isl_union_pw_multi_aff_get_space(
964                 __isl_keep isl_union_pw_multi_aff *upma);
965         __isl_give isl_space *isl_multi_pw_aff_get_domain_space(
966                 __isl_keep isl_multi_pw_aff *mpa);
967         __isl_give isl_space *isl_multi_pw_aff_get_space(
968                 __isl_keep isl_multi_pw_aff *mpa);
969         __isl_give isl_space *
970         isl_multi_union_pw_aff_get_domain_space(
971                 __isl_keep isl_multi_union_pw_aff *mupa);
972         __isl_give isl_space *
973         isl_multi_union_pw_aff_get_space(
974                 __isl_keep isl_multi_union_pw_aff *mupa);
976         #include <isl/point.h>
977         __isl_give isl_space *isl_point_get_space(
978                 __isl_keep isl_point *pnt);
980 The number of dimensions of a given type of space
981 may be read off from a space or an object that lives
982 in a space using the following functions.
983 In case of C<isl_space_dim>, type may be
984 C<isl_dim_param>, C<isl_dim_in> (only for relations),
985 C<isl_dim_out> (only for relations), C<isl_dim_set>
986 (only for sets) or C<isl_dim_all>.
988         #include <isl/space.h>
989         unsigned isl_space_dim(__isl_keep isl_space *space,
990                 enum isl_dim_type type);
992         #include <isl/local_space.h>
993         int isl_local_space_dim(__isl_keep isl_local_space *ls,
994                 enum isl_dim_type type);
996         #include <isl/set.h>
997         unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
998                 enum isl_dim_type type);
999         unsigned isl_set_dim(__isl_keep isl_set *set,
1000                 enum isl_dim_type type);
1002         #include <isl/union_set.h>
1003         unsigned isl_union_set_dim(__isl_keep isl_union_set *uset,
1004                 enum isl_dim_type type);
1006         #include <isl/map.h>
1007         unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1008                 enum isl_dim_type type);
1009         unsigned isl_map_dim(__isl_keep isl_map *map,
1010                 enum isl_dim_type type);
1012         #include <isl/union_map.h>
1013         unsigned isl_union_map_dim(__isl_keep isl_union_map *umap,
1014                 enum isl_dim_type type);
1016         #include <isl/val.h>
1017         unsigned isl_multi_val_dim(__isl_keep isl_multi_val *mv,
1018                 enum isl_dim_type type);
1020         #include <isl/aff.h>
1021         int isl_aff_dim(__isl_keep isl_aff *aff,
1022                 enum isl_dim_type type);
1023         unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
1024                 enum isl_dim_type type);
1025         unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
1026                 enum isl_dim_type type);
1027         unsigned isl_pw_multi_aff_dim(
1028                 __isl_keep isl_pw_multi_aff *pma,
1029                 enum isl_dim_type type);
1030         unsigned isl_multi_pw_aff_dim(
1031                 __isl_keep isl_multi_pw_aff *mpa,
1032                 enum isl_dim_type type);
1033         unsigned isl_union_pw_aff_dim(
1034                 __isl_keep isl_union_pw_aff *upa,
1035                 enum isl_dim_type type);
1036         unsigned isl_union_pw_multi_aff_dim(
1037                 __isl_keep isl_union_pw_multi_aff *upma,
1038                 enum isl_dim_type type);
1039         unsigned isl_multi_union_pw_aff_dim(
1040                 __isl_keep isl_multi_union_pw_aff *mupa,
1041                 enum isl_dim_type type);
1043         #include <isl/polynomial.h>
1044         unsigned isl_union_pw_qpolynomial_dim(
1045                 __isl_keep isl_union_pw_qpolynomial *upwqp,
1046                 enum isl_dim_type type);
1047         unsigned isl_union_pw_qpolynomial_fold_dim(
1048                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
1049                 enum isl_dim_type type);
1051 Note that an C<isl_union_set>, an C<isl_union_map>,
1052 an C<isl_union_pw_multi_aff>,
1053 an C<isl_union_pw_qpolynomial> and
1054 an C<isl_union_pw_qpolynomial_fold>
1055 only have parameters.
1057 The identifiers or names of the individual dimensions of spaces
1058 may be set or read off using the following functions on spaces
1059 or objects that live in spaces.
1060 These functions are mostly useful to obtain the identifiers, positions
1061 or names of the parameters.  Identifiers of individual dimensions are
1062 essentially only useful for printing.  They are ignored by all other
1063 operations and may not be preserved across those operations.
1065         #include <isl/space.h>
1066         __isl_give isl_space *isl_space_set_dim_id(
1067                 __isl_take isl_space *space,
1068                 enum isl_dim_type type, unsigned pos,
1069                 __isl_take isl_id *id);
1070         int isl_space_has_dim_id(__isl_keep isl_space *space,
1071                 enum isl_dim_type type, unsigned pos);
1072         __isl_give isl_id *isl_space_get_dim_id(
1073                 __isl_keep isl_space *space,
1074                 enum isl_dim_type type, unsigned pos);
1075         __isl_give isl_space *isl_space_set_dim_name(
1076                 __isl_take isl_space *space,
1077                  enum isl_dim_type type, unsigned pos,
1078                  __isl_keep const char *name);
1079         int isl_space_has_dim_name(__isl_keep isl_space *space,
1080                 enum isl_dim_type type, unsigned pos);
1081         __isl_keep const char *isl_space_get_dim_name(
1082                 __isl_keep isl_space *space,
1083                 enum isl_dim_type type, unsigned pos);
1085         #include <isl/local_space.h>
1086         __isl_give isl_local_space *isl_local_space_set_dim_id(
1087                 __isl_take isl_local_space *ls,
1088                 enum isl_dim_type type, unsigned pos,
1089                 __isl_take isl_id *id);
1090         int isl_local_space_has_dim_id(
1091                 __isl_keep isl_local_space *ls,
1092                 enum isl_dim_type type, unsigned pos);
1093         __isl_give isl_id *isl_local_space_get_dim_id(
1094                 __isl_keep isl_local_space *ls,
1095                 enum isl_dim_type type, unsigned pos);
1096         __isl_give isl_local_space *isl_local_space_set_dim_name(
1097                 __isl_take isl_local_space *ls,
1098                 enum isl_dim_type type, unsigned pos, const char *s);
1099         int isl_local_space_has_dim_name(
1100                 __isl_keep isl_local_space *ls,
1101                 enum isl_dim_type type, unsigned pos)
1102         const char *isl_local_space_get_dim_name(
1103                 __isl_keep isl_local_space *ls,
1104                 enum isl_dim_type type, unsigned pos);
1106         #include <isl/constraint.h>
1107         const char *isl_constraint_get_dim_name(
1108                 __isl_keep isl_constraint *constraint,
1109                 enum isl_dim_type type, unsigned pos);
1111         #include <isl/set.h>
1112         __isl_give isl_id *isl_basic_set_get_dim_id(
1113                 __isl_keep isl_basic_set *bset,
1114                 enum isl_dim_type type, unsigned pos);
1115         __isl_give isl_set *isl_set_set_dim_id(
1116                 __isl_take isl_set *set, enum isl_dim_type type,
1117                 unsigned pos, __isl_take isl_id *id);
1118         int isl_set_has_dim_id(__isl_keep isl_set *set,
1119                 enum isl_dim_type type, unsigned pos);
1120         __isl_give isl_id *isl_set_get_dim_id(
1121                 __isl_keep isl_set *set, enum isl_dim_type type,
1122                 unsigned pos);
1123         const char *isl_basic_set_get_dim_name(
1124                 __isl_keep isl_basic_set *bset,
1125                 enum isl_dim_type type, unsigned pos);
1126         int isl_set_has_dim_name(__isl_keep isl_set *set,
1127                 enum isl_dim_type type, unsigned pos);
1128         const char *isl_set_get_dim_name(
1129                 __isl_keep isl_set *set,
1130                 enum isl_dim_type type, unsigned pos);
1132         #include <isl/map.h>
1133         __isl_give isl_map *isl_map_set_dim_id(
1134                 __isl_take isl_map *map, enum isl_dim_type type,
1135                 unsigned pos, __isl_take isl_id *id);
1136         int isl_basic_map_has_dim_id(
1137                 __isl_keep isl_basic_map *bmap,
1138                 enum isl_dim_type type, unsigned pos);
1139         int isl_map_has_dim_id(__isl_keep isl_map *map,
1140                 enum isl_dim_type type, unsigned pos);
1141         __isl_give isl_id *isl_map_get_dim_id(
1142                 __isl_keep isl_map *map, enum isl_dim_type type,
1143                 unsigned pos);
1144         __isl_give isl_id *isl_union_map_get_dim_id(
1145                 __isl_keep isl_union_map *umap,
1146                 enum isl_dim_type type, unsigned pos);
1147         const char *isl_basic_map_get_dim_name(
1148                 __isl_keep isl_basic_map *bmap,
1149                 enum isl_dim_type type, unsigned pos);
1150         int isl_map_has_dim_name(__isl_keep isl_map *map,
1151                 enum isl_dim_type type, unsigned pos);
1152         const char *isl_map_get_dim_name(
1153                 __isl_keep isl_map *map,
1154                 enum isl_dim_type type, unsigned pos);
1156         #include <isl/val.h>
1157         __isl_give isl_multi_val *isl_multi_val_set_dim_id(
1158                 __isl_take isl_multi_val *mv,
1159                 enum isl_dim_type type, unsigned pos,
1160                 __isl_take isl_id *id);
1161         __isl_give isl_id *isl_multi_val_get_dim_id(
1162                 __isl_keep isl_multi_val *mv,
1163                 enum isl_dim_type type, unsigned pos);
1164         __isl_give isl_multi_val *isl_multi_val_set_dim_name(
1165                 __isl_take isl_multi_val *mv,
1166                 enum isl_dim_type type, unsigned pos, const char *s);
1168         #include <isl/aff.h>
1169         __isl_give isl_aff *isl_aff_set_dim_id(
1170                 __isl_take isl_aff *aff, enum isl_dim_type type,
1171                 unsigned pos, __isl_take isl_id *id);
1172         __isl_give isl_multi_aff *isl_multi_aff_set_dim_id(
1173                 __isl_take isl_multi_aff *maff,
1174                 enum isl_dim_type type, unsigned pos,
1175                 __isl_take isl_id *id);
1176         __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
1177                 __isl_take isl_pw_aff *pma,
1178                 enum isl_dim_type type, unsigned pos,
1179                 __isl_take isl_id *id);
1180         __isl_give isl_multi_pw_aff *
1181         isl_multi_pw_aff_set_dim_id(
1182                 __isl_take isl_multi_pw_aff *mpa,
1183                 enum isl_dim_type type, unsigned pos,
1184                 __isl_take isl_id *id);
1185         __isl_give isl_multi_union_pw_aff *
1186         isl_multi_union_pw_aff_set_dim_id(
1187                 __isl_take isl_multi_union_pw_aff *mupa,
1188                 enum isl_dim_type type, unsigned pos,
1189                 __isl_take isl_id *id);
1190         __isl_give isl_id *isl_multi_aff_get_dim_id(
1191                 __isl_keep isl_multi_aff *ma,
1192                 enum isl_dim_type type, unsigned pos);
1193         int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
1194                 enum isl_dim_type type, unsigned pos);
1195         __isl_give isl_id *isl_pw_aff_get_dim_id(
1196                 __isl_keep isl_pw_aff *pa,
1197                 enum isl_dim_type type, unsigned pos);
1198         __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
1199                 __isl_keep isl_pw_multi_aff *pma,
1200                 enum isl_dim_type type, unsigned pos);
1201         __isl_give isl_id *isl_multi_pw_aff_get_dim_id(
1202                 __isl_keep isl_multi_pw_aff *mpa,
1203                 enum isl_dim_type type, unsigned pos);
1204         __isl_give isl_id *isl_multi_union_pw_aff_get_dim_id(
1205                 __isl_keep isl_multi_union_pw_aff *mupa,
1206                 enum isl_dim_type type, unsigned pos);
1207         __isl_give isl_aff *isl_aff_set_dim_name(
1208                 __isl_take isl_aff *aff, enum isl_dim_type type,
1209                 unsigned pos, const char *s);
1210         __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
1211                 __isl_take isl_multi_aff *maff,
1212                 enum isl_dim_type type, unsigned pos, const char *s);
1213         __isl_give isl_multi_pw_aff *
1214         isl_multi_pw_aff_set_dim_name(
1215                 __isl_take isl_multi_pw_aff *mpa,
1216                 enum isl_dim_type type, unsigned pos, const char *s);
1217         __isl_give isl_union_pw_aff *
1218         isl_union_pw_aff_set_dim_name(
1219                 __isl_take isl_union_pw_aff *upa,
1220                 enum isl_dim_type type, unsigned pos,
1221                 const char *s);
1222         __isl_give isl_union_pw_multi_aff *
1223         isl_union_pw_multi_aff_set_dim_name(
1224                 __isl_take isl_union_pw_multi_aff *upma,
1225                 enum isl_dim_type type, unsigned pos,
1226                 const char *s);
1227         __isl_give isl_multi_union_pw_aff *
1228         isl_multi_union_pw_aff_set_dim_name(
1229                 __isl_take isl_multi_union_pw_aff *mupa,
1230                 enum isl_dim_type type, unsigned pos,
1231         const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
1232                 enum isl_dim_type type, unsigned pos);
1233         const char *isl_pw_aff_get_dim_name(
1234                 __isl_keep isl_pw_aff *pa,
1235                 enum isl_dim_type type, unsigned pos);
1236         const char *isl_pw_multi_aff_get_dim_name(
1237                 __isl_keep isl_pw_multi_aff *pma,
1238                 enum isl_dim_type type, unsigned pos);
1240         #include <isl/polynomial.h>
1241         __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
1242                 __isl_take isl_qpolynomial *qp,
1243                 enum isl_dim_type type, unsigned pos,
1244                 const char *s);
1245         __isl_give isl_pw_qpolynomial *
1246         isl_pw_qpolynomial_set_dim_name(
1247                 __isl_take isl_pw_qpolynomial *pwqp,
1248                 enum isl_dim_type type, unsigned pos,
1249                 const char *s);
1250         __isl_give isl_pw_qpolynomial_fold *
1251         isl_pw_qpolynomial_fold_set_dim_name(
1252                 __isl_take isl_pw_qpolynomial_fold *pwf,
1253                 enum isl_dim_type type, unsigned pos,
1254                 const char *s);
1255         __isl_give isl_union_pw_qpolynomial *
1256         isl_union_pw_qpolynomial_set_dim_name(
1257                 __isl_take isl_union_pw_qpolynomial *upwqp,
1258                 enum isl_dim_type type, unsigned pos,
1259                 const char *s);
1260         __isl_give isl_union_pw_qpolynomial_fold *
1261         isl_union_pw_qpolynomial_fold_set_dim_name(
1262                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
1263                 enum isl_dim_type type, unsigned pos,
1264                 const char *s);
1266 Note that C<isl_space_get_name> returns a pointer to some internal
1267 data structure, so the result can only be used while the
1268 corresponding C<isl_space> is alive.
1269 Also note that every function that operates on two sets or relations
1270 requires that both arguments have the same parameters.  This also
1271 means that if one of the arguments has named parameters, then the
1272 other needs to have named parameters too and the names need to match.
1273 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
1274 arguments may have different parameters (as long as they are named),
1275 in which case the result will have as parameters the union of the parameters of
1276 the arguments.
1278 Given the identifier or name of a dimension (typically a parameter),
1279 its position can be obtained from the following functions.
1281         #include <isl/space.h>
1282         int isl_space_find_dim_by_id(__isl_keep isl_space *space,
1283                 enum isl_dim_type type, __isl_keep isl_id *id);
1284         int isl_space_find_dim_by_name(__isl_keep isl_space *space,
1285                 enum isl_dim_type type, const char *name);
1287         #include <isl/local_space.h>
1288         int isl_local_space_find_dim_by_name(
1289                 __isl_keep isl_local_space *ls,
1290                 enum isl_dim_type type, const char *name);
1292         #include <isl/val.h>
1293         int isl_multi_val_find_dim_by_id(
1294                 __isl_keep isl_multi_val *mv,
1295                 enum isl_dim_type type, __isl_keep isl_id *id);
1296         int isl_multi_val_find_dim_by_name(
1297                 __isl_keep isl_multi_val *mv,
1298                 enum isl_dim_type type, const char *name);
1300         #include <isl/set.h>
1301         int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1302                 enum isl_dim_type type, __isl_keep isl_id *id);
1303         int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1304                 enum isl_dim_type type, const char *name);
1306         #include <isl/map.h>
1307         int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1308                 enum isl_dim_type type, __isl_keep isl_id *id);
1309         int isl_basic_map_find_dim_by_name(
1310                 __isl_keep isl_basic_map *bmap,
1311                 enum isl_dim_type type, const char *name);
1312         int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1313                 enum isl_dim_type type, const char *name);
1314         int isl_union_map_find_dim_by_name(
1315                 __isl_keep isl_union_map *umap,
1316                 enum isl_dim_type type, const char *name);
1318         #include <isl/aff.h>
1319         int isl_multi_aff_find_dim_by_id(
1320                 __isl_keep isl_multi_aff *ma,
1321                 enum isl_dim_type type, __isl_keep isl_id *id);
1322         int isl_multi_pw_aff_find_dim_by_id(
1323                 __isl_keep isl_multi_pw_aff *mpa,
1324                 enum isl_dim_type type, __isl_keep isl_id *id);
1325         int isl_multi_union_pw_aff_find_dim_by_id(
1326                 __isl_keep isl_union_multi_pw_aff *mupa,
1327                 enum isl_dim_type type, __isl_keep isl_id *id);
1328         int isl_aff_find_dim_by_name(__isl_keep isl_aff *aff,
1329                 enum isl_dim_type type, const char *name);
1330         int isl_multi_aff_find_dim_by_name(
1331                 __isl_keep isl_multi_aff *ma,
1332                 enum isl_dim_type type, const char *name);
1333         int isl_pw_aff_find_dim_by_name(__isl_keep isl_pw_aff *pa,
1334                 enum isl_dim_type type, const char *name);
1335         int isl_multi_pw_aff_find_dim_by_name(
1336                 __isl_keep isl_multi_pw_aff *mpa,
1337                 enum isl_dim_type type, const char *name);
1338         int isl_pw_multi_aff_find_dim_by_name(
1339                 __isl_keep isl_pw_multi_aff *pma,
1340                 enum isl_dim_type type, const char *name);
1341         int isl_union_pw_aff_find_dim_by_name(
1342                 __isl_keep isl_union_pw_aff *upa,
1343                 enum isl_dim_type type, const char *name);
1344         int isl_union_pw_multi_aff_find_dim_by_name(
1345                 __isl_keep isl_union_pw_multi_aff *upma,
1346                 enum isl_dim_type type, const char *name);
1347         int isl_multi_union_pw_aff_find_dim_by_name(
1348                 __isl_keep isl_multi_union_pw_aff *mupa,
1349                 enum isl_dim_type type, const char *name);
1351         #include <isl/polynomial.h>
1352         int isl_pw_qpolynomial_find_dim_by_name(
1353                 __isl_keep isl_pw_qpolynomial *pwqp,
1354                 enum isl_dim_type type, const char *name);
1355         int isl_pw_qpolynomial_fold_find_dim_by_name(
1356                 __isl_keep isl_pw_qpolynomial_fold *pwf,
1357                 enum isl_dim_type type, const char *name);
1358         int isl_union_pw_qpolynomial_find_dim_by_name(
1359                 __isl_keep isl_union_pw_qpolynomial *upwqp,
1360                 enum isl_dim_type type, const char *name);
1361         int isl_union_pw_qpolynomial_fold_find_dim_by_name(
1362                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
1363                 enum isl_dim_type type, const char *name);
1365 The identifiers or names of entire spaces may be set or read off
1366 using the following functions.
1368         #include <isl/space.h>
1369         __isl_give isl_space *isl_space_set_tuple_id(
1370                 __isl_take isl_space *space,
1371                 enum isl_dim_type type, __isl_take isl_id *id);
1372         __isl_give isl_space *isl_space_reset_tuple_id(
1373                 __isl_take isl_space *space, enum isl_dim_type type);
1374         int isl_space_has_tuple_id(__isl_keep isl_space *space,
1375                 enum isl_dim_type type);
1376         __isl_give isl_id *isl_space_get_tuple_id(
1377                 __isl_keep isl_space *space, enum isl_dim_type type);
1378         __isl_give isl_space *isl_space_set_tuple_name(
1379                 __isl_take isl_space *space,
1380                 enum isl_dim_type type, const char *s);
1381         int isl_space_has_tuple_name(__isl_keep isl_space *space,
1382                 enum isl_dim_type type);
1383         const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
1384                 enum isl_dim_type type);
1386         #include <isl/local_space.h>
1387         __isl_give isl_local_space *isl_local_space_set_tuple_id(
1388                 __isl_take isl_local_space *ls,
1389                 enum isl_dim_type type, __isl_take isl_id *id);
1391         #include <isl/set.h>
1392         __isl_give isl_basic_set *isl_basic_set_set_tuple_id(
1393                 __isl_take isl_basic_set *bset,
1394                 __isl_take isl_id *id);
1395         __isl_give isl_set *isl_set_set_tuple_id(
1396                 __isl_take isl_set *set, __isl_take isl_id *id);
1397         __isl_give isl_set *isl_set_reset_tuple_id(
1398                 __isl_take isl_set *set);
1399         int isl_set_has_tuple_id(__isl_keep isl_set *set);
1400         __isl_give isl_id *isl_set_get_tuple_id(
1401                 __isl_keep isl_set *set);
1402         __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1403                 __isl_take isl_basic_set *set, const char *s);
1404         __isl_give isl_set *isl_set_set_tuple_name(
1405                 __isl_take isl_set *set, const char *s);
1406         const char *isl_basic_set_get_tuple_name(
1407                 __isl_keep isl_basic_set *bset);
1408         int isl_set_has_tuple_name(__isl_keep isl_set *set);
1409         const char *isl_set_get_tuple_name(
1410                 __isl_keep isl_set *set);
1412         #include <isl/map.h>
1413         __isl_give isl_basic_map *isl_basic_map_set_tuple_id(
1414                 __isl_take isl_basic_map *bmap,
1415                 enum isl_dim_type type, __isl_take isl_id *id);
1416         __isl_give isl_map *isl_map_set_tuple_id(
1417                 __isl_take isl_map *map, enum isl_dim_type type,
1418                 __isl_take isl_id *id);
1419         __isl_give isl_map *isl_map_reset_tuple_id(
1420                 __isl_take isl_map *map, enum isl_dim_type type);
1421         int isl_map_has_tuple_id(__isl_keep isl_map *map,
1422                 enum isl_dim_type type);
1423         __isl_give isl_id *isl_map_get_tuple_id(
1424                 __isl_keep isl_map *map, enum isl_dim_type type);
1425         __isl_give isl_map *isl_map_set_tuple_name(
1426                 __isl_take isl_map *map,
1427                 enum isl_dim_type type, const char *s);
1428         const char *isl_basic_map_get_tuple_name(
1429                 __isl_keep isl_basic_map *bmap,
1430                 enum isl_dim_type type);
1431         __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1432                 __isl_take isl_basic_map *bmap,
1433                 enum isl_dim_type type, const char *s);
1434         int isl_map_has_tuple_name(__isl_keep isl_map *map,
1435                 enum isl_dim_type type);
1436         const char *isl_map_get_tuple_name(
1437                 __isl_keep isl_map *map,
1438                 enum isl_dim_type type);
1440         #include <isl/val.h>
1441         __isl_give isl_multi_val *isl_multi_val_set_tuple_id(
1442                 __isl_take isl_multi_val *mv,
1443                 enum isl_dim_type type, __isl_take isl_id *id);
1444         __isl_give isl_multi_val *isl_multi_val_reset_tuple_id(
1445                 __isl_take isl_multi_val *mv,
1446                 enum isl_dim_type type);
1447         int isl_multi_val_has_tuple_id(__isl_keep isl_multi_val *mv,
1448                 enum isl_dim_type type);
1449         __isl_give isl_id *isl_multi_val_get_tuple_id(
1450                 __isl_keep isl_multi_val *mv,
1451                 enum isl_dim_type type);
1452         __isl_give isl_multi_val *isl_multi_val_set_tuple_name(
1453                 __isl_take isl_multi_val *mv,
1454                 enum isl_dim_type type, const char *s);
1455         const char *isl_multi_val_get_tuple_name(
1456                 __isl_keep isl_multi_val *mv,
1457                 enum isl_dim_type type);
1459         #include <isl/aff.h>
1460         __isl_give isl_aff *isl_aff_set_tuple_id(
1461                 __isl_take isl_aff *aff,
1462                 enum isl_dim_type type, __isl_take isl_id *id);
1463         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
1464                 __isl_take isl_multi_aff *maff,
1465                 enum isl_dim_type type, __isl_take isl_id *id);
1466         __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
1467                 __isl_take isl_pw_aff *pwaff,
1468                 enum isl_dim_type type, __isl_take isl_id *id);
1469         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
1470                 __isl_take isl_pw_multi_aff *pma,
1471                 enum isl_dim_type type, __isl_take isl_id *id);
1472         __isl_give isl_multi_union_pw_aff *
1473         isl_multi_union_pw_aff_set_tuple_id(
1474                 __isl_take isl_multi_union_pw_aff *mupa,
1475                 enum isl_dim_type type, __isl_take isl_id *id);
1476         __isl_give isl_multi_aff *isl_multi_aff_reset_tuple_id(
1477                 __isl_take isl_multi_aff *ma,
1478                 enum isl_dim_type type);
1479         __isl_give isl_pw_aff *isl_pw_aff_reset_tuple_id(
1480                 __isl_take isl_pw_aff *pa,
1481                 enum isl_dim_type type);
1482         __isl_give isl_multi_pw_aff *
1483         isl_multi_pw_aff_reset_tuple_id(
1484                 __isl_take isl_multi_pw_aff *mpa,
1485                 enum isl_dim_type type);
1486         __isl_give isl_pw_multi_aff *
1487         isl_pw_multi_aff_reset_tuple_id(
1488                 __isl_take isl_pw_multi_aff *pma,
1489                 enum isl_dim_type type);
1490         __isl_give isl_multi_union_pw_aff *
1491         isl_multi_union_pw_aff_reset_tuple_id(
1492                 __isl_take isl_multi_union_pw_aff *mupa,
1493                 enum isl_dim_type type);
1494         int isl_multi_aff_has_tuple_id(__isl_keep isl_multi_aff *ma,
1495                 enum isl_dim_type type);
1496         __isl_give isl_id *isl_multi_aff_get_tuple_id(
1497                 __isl_keep isl_multi_aff *ma,
1498                 enum isl_dim_type type);
1499         int isl_pw_aff_has_tuple_id(__isl_keep isl_pw_aff *pa,
1500                 enum isl_dim_type type);
1501         __isl_give isl_id *isl_pw_aff_get_tuple_id(
1502                 __isl_keep isl_pw_aff *pa,
1503                 enum isl_dim_type type);
1504         int isl_pw_multi_aff_has_tuple_id(
1505                 __isl_keep isl_pw_multi_aff *pma,
1506                 enum isl_dim_type type);
1507         __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
1508                 __isl_keep isl_pw_multi_aff *pma,
1509                 enum isl_dim_type type);
1510         int isl_multi_pw_aff_has_tuple_id(
1511                 __isl_keep isl_multi_pw_aff *mpa,
1512                 enum isl_dim_type type);
1513         __isl_give isl_id *isl_multi_pw_aff_get_tuple_id(
1514                 __isl_keep isl_multi_pw_aff *mpa,
1515                 enum isl_dim_type type);
1516         int isl_multi_union_pw_aff_has_tuple_id(
1517                 __isl_keep isl_multi_union_pw_aff *mupa,
1518                 enum isl_dim_type type);
1519         __isl_give isl_id *isl_multi_union_pw_aff_get_tuple_id(
1520                 __isl_keep isl_multi_union_pw_aff *mupa,
1521                 enum isl_dim_type type);
1522         __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
1523                 __isl_take isl_multi_aff *maff,
1524                 enum isl_dim_type type, const char *s);
1525         __isl_give isl_multi_pw_aff *
1526         isl_multi_pw_aff_set_tuple_name(
1527                 __isl_take isl_multi_pw_aff *mpa,
1528                 enum isl_dim_type type, const char *s);
1529         __isl_give isl_multi_union_pw_aff *
1530         isl_multi_union_pw_aff_set_tuple_name(
1531                 __isl_take isl_multi_union_pw_aff *mupa,
1532                 enum isl_dim_type type, const char *s);
1533         const char *isl_multi_aff_get_tuple_name(
1534                 __isl_keep isl_multi_aff *multi,
1535                 enum isl_dim_type type);
1536         int isl_pw_multi_aff_has_tuple_name(
1537                 __isl_keep isl_pw_multi_aff *pma,
1538                 enum isl_dim_type type);
1539         const char *isl_pw_multi_aff_get_tuple_name(
1540                 __isl_keep isl_pw_multi_aff *pma,
1541                 enum isl_dim_type type);
1542         const char *isl_multi_union_pw_aff_get_tuple_name(
1543                 __isl_keep isl_multi_union_pw_aff *mupa,
1544                 enum isl_dim_type type);
1546 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
1547 or C<isl_dim_set>.  As with C<isl_space_get_name>,
1548 the C<isl_space_get_tuple_name> function returns a pointer to some internal
1549 data structure.
1550 Binary operations require the corresponding spaces of their arguments
1551 to have the same name.
1553 To keep the names of all parameters and tuples, but reset the user pointers
1554 of all the corresponding identifiers, use the following function.
1556         #include <isl/space.h>
1557         __isl_give isl_space *isl_space_reset_user(
1558                 __isl_take isl_space *space);
1560         #include <isl/set.h>
1561         __isl_give isl_set *isl_set_reset_user(
1562                 __isl_take isl_set *set);
1564         #include <isl/map.h>
1565         __isl_give isl_map *isl_map_reset_user(
1566                 __isl_take isl_map *map);
1568         #include <isl/union_set.h>
1569         __isl_give isl_union_set *isl_union_set_reset_user(
1570                 __isl_take isl_union_set *uset);
1572         #include <isl/union_map.h>
1573         __isl_give isl_union_map *isl_union_map_reset_user(
1574                 __isl_take isl_union_map *umap);
1576         #include <isl/val.h>
1577         __isl_give isl_multi_val *isl_multi_val_reset_user(
1578                 __isl_take isl_multi_val *mv);
1580         #include <isl/aff.h>
1581         __isl_give isl_multi_aff *isl_multi_aff_reset_user(
1582                 __isl_take isl_multi_aff *ma);
1583         __isl_give isl_pw_aff *isl_pw_aff_reset_user(
1584                 __isl_take isl_pw_aff *pa);
1585         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_reset_user(
1586                 __isl_take isl_multi_pw_aff *mpa);
1587         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_reset_user(
1588                 __isl_take isl_pw_multi_aff *pma);
1589         __isl_give isl_union_pw_aff *isl_union_pw_aff_reset_user(
1590                 __isl_take isl_union_pw_aff *upa);
1591         __isl_give isl_multi_union_pw_aff *
1592         isl_multi_union_pw_aff_reset_user(
1593                 __isl_take isl_multi_union_pw_aff *mupa);
1594         __isl_give isl_union_pw_multi_aff *
1595         isl_union_pw_multi_aff_reset_user(
1596                 __isl_take isl_union_pw_multi_aff *upma);
1598         #include <isl/polynomial.h>
1599         __isl_give isl_pw_qpolynomial *
1600         isl_pw_qpolynomial_reset_user(
1601                 __isl_take isl_pw_qpolynomial *pwqp);
1602         __isl_give isl_union_pw_qpolynomial *
1603         isl_union_pw_qpolynomial_reset_user(
1604                 __isl_take isl_union_pw_qpolynomial *upwqp);
1605         __isl_give isl_pw_qpolynomial_fold *
1606         isl_pw_qpolynomial_fold_reset_user(
1607                 __isl_take isl_pw_qpolynomial_fold *pwf);
1608         __isl_give isl_union_pw_qpolynomial_fold *
1609         isl_union_pw_qpolynomial_fold_reset_user(
1610                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
1612 Spaces can be nested.  In particular, the domain of a set or
1613 the domain or range of a relation can be a nested relation.
1614 This process is also called I<wrapping>.
1615 The functions for detecting, constructing and deconstructing
1616 such nested spaces can be found in the wrapping properties
1617 of L</"Unary Properties">, the wrapping operations
1618 of L</"Unary Operations"> and the Cartesian product operations
1619 of L</"Basic Operations">.
1621 Spaces can be created from other spaces
1622 using the functions described in L</"Unary Operations">
1623 and L</"Binary Operations">.
1625 =head2 Local Spaces
1627 A local space is essentially a space with
1628 zero or more existentially quantified variables.
1629 The local space of various objects can be obtained
1630 using the following functions.
1632         #include <isl/constraint.h>
1633         __isl_give isl_local_space *isl_constraint_get_local_space(
1634                 __isl_keep isl_constraint *constraint);
1636         #include <isl/set.h>
1637         __isl_give isl_local_space *isl_basic_set_get_local_space(
1638                 __isl_keep isl_basic_set *bset);
1640         #include <isl/map.h>
1641         __isl_give isl_local_space *isl_basic_map_get_local_space(
1642                 __isl_keep isl_basic_map *bmap);
1644         #include <isl/aff.h>
1645         __isl_give isl_local_space *isl_aff_get_domain_local_space(
1646                 __isl_keep isl_aff *aff);
1647         __isl_give isl_local_space *isl_aff_get_local_space(
1648                 __isl_keep isl_aff *aff);
1650 A new local space can be created from a space using
1652         #include <isl/local_space.h>
1653         __isl_give isl_local_space *isl_local_space_from_space(
1654                 __isl_take isl_space *space);
1656 They can be inspected, modified, copied and freed using the following functions.
1658         #include <isl/local_space.h>
1659         int isl_local_space_is_params(
1660                 __isl_keep isl_local_space *ls);
1661         int isl_local_space_is_set(__isl_keep isl_local_space *ls);
1662         __isl_give isl_space *isl_local_space_get_space(
1663                 __isl_keep isl_local_space *ls);
1664         __isl_give isl_aff *isl_local_space_get_div(
1665                 __isl_keep isl_local_space *ls, int pos);
1666         __isl_give isl_local_space *isl_local_space_copy(
1667                 __isl_keep isl_local_space *ls);
1668         __isl_null isl_local_space *isl_local_space_free(
1669                 __isl_take isl_local_space *ls);
1671 Note that C<isl_local_space_get_div> can only be used on local spaces
1672 of sets.
1674 Two local spaces can be compared using
1676         int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
1677                 __isl_keep isl_local_space *ls2);
1679 Local spaces can be created from other local spaces
1680 using the functions described in L</"Unary Operations">
1681 and L</"Binary Operations">.
1683 =head2 Creating New Sets and Relations
1685 C<isl> has functions for creating some standard sets and relations.
1687 =over
1689 =item * Empty sets and relations
1691         __isl_give isl_basic_set *isl_basic_set_empty(
1692                 __isl_take isl_space *space);
1693         __isl_give isl_basic_map *isl_basic_map_empty(
1694                 __isl_take isl_space *space);
1695         __isl_give isl_set *isl_set_empty(
1696                 __isl_take isl_space *space);
1697         __isl_give isl_map *isl_map_empty(
1698                 __isl_take isl_space *space);
1699         __isl_give isl_union_set *isl_union_set_empty(
1700                 __isl_take isl_space *space);
1701         __isl_give isl_union_map *isl_union_map_empty(
1702                 __isl_take isl_space *space);
1704 For C<isl_union_set>s and C<isl_union_map>s, the space
1705 is only used to specify the parameters.
1707 =item * Universe sets and relations
1709         __isl_give isl_basic_set *isl_basic_set_universe(
1710                 __isl_take isl_space *space);
1711         __isl_give isl_basic_map *isl_basic_map_universe(
1712                 __isl_take isl_space *space);
1713         __isl_give isl_set *isl_set_universe(
1714                 __isl_take isl_space *space);
1715         __isl_give isl_map *isl_map_universe(
1716                 __isl_take isl_space *space);
1717         __isl_give isl_union_set *isl_union_set_universe(
1718                 __isl_take isl_union_set *uset);
1719         __isl_give isl_union_map *isl_union_map_universe(
1720                 __isl_take isl_union_map *umap);
1722 The sets and relations constructed by the functions above
1723 contain all integer values, while those constructed by the
1724 functions below only contain non-negative values.
1726         __isl_give isl_basic_set *isl_basic_set_nat_universe(
1727                 __isl_take isl_space *space);
1728         __isl_give isl_basic_map *isl_basic_map_nat_universe(
1729                 __isl_take isl_space *space);
1730         __isl_give isl_set *isl_set_nat_universe(
1731                 __isl_take isl_space *space);
1732         __isl_give isl_map *isl_map_nat_universe(
1733                 __isl_take isl_space *space);
1735 =item * Identity relations
1737         __isl_give isl_basic_map *isl_basic_map_identity(
1738                 __isl_take isl_space *space);
1739         __isl_give isl_map *isl_map_identity(
1740                 __isl_take isl_space *space);
1742 The number of input and output dimensions in C<space> needs
1743 to be the same.
1745 =item * Lexicographic order
1747         __isl_give isl_map *isl_map_lex_lt(
1748                 __isl_take isl_space *set_space);
1749         __isl_give isl_map *isl_map_lex_le(
1750                 __isl_take isl_space *set_space);
1751         __isl_give isl_map *isl_map_lex_gt(
1752                 __isl_take isl_space *set_space);
1753         __isl_give isl_map *isl_map_lex_ge(
1754                 __isl_take isl_space *set_space);
1755         __isl_give isl_map *isl_map_lex_lt_first(
1756                 __isl_take isl_space *space, unsigned n);
1757         __isl_give isl_map *isl_map_lex_le_first(
1758                 __isl_take isl_space *space, unsigned n);
1759         __isl_give isl_map *isl_map_lex_gt_first(
1760                 __isl_take isl_space *space, unsigned n);
1761         __isl_give isl_map *isl_map_lex_ge_first(
1762                 __isl_take isl_space *space, unsigned n);
1764 The first four functions take a space for a B<set>
1765 and return relations that express that the elements in the domain
1766 are lexicographically less
1767 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1768 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1769 than the elements in the range.
1770 The last four functions take a space for a map
1771 and return relations that express that the first C<n> dimensions
1772 in the domain are lexicographically less
1773 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1774 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1775 than the first C<n> dimensions in the range.
1777 =back
1779 A basic set or relation can be converted to a set or relation
1780 using the following functions.
1782         __isl_give isl_set *isl_set_from_basic_set(
1783                 __isl_take isl_basic_set *bset);
1784         __isl_give isl_map *isl_map_from_basic_map(
1785                 __isl_take isl_basic_map *bmap);
1787 Sets and relations can be converted to union sets and relations
1788 using the following functions.
1790         __isl_give isl_union_set *isl_union_set_from_basic_set(
1791                 __isl_take isl_basic_set *bset);
1792         __isl_give isl_union_map *isl_union_map_from_basic_map(
1793                 __isl_take isl_basic_map *bmap);
1794         __isl_give isl_union_set *isl_union_set_from_set(
1795                 __isl_take isl_set *set);
1796         __isl_give isl_union_map *isl_union_map_from_map(
1797                 __isl_take isl_map *map);
1799 The inverse conversions below can only be used if the input
1800 union set or relation is known to contain elements in exactly one
1801 space.
1803         __isl_give isl_set *isl_set_from_union_set(
1804                 __isl_take isl_union_set *uset);
1805         __isl_give isl_map *isl_map_from_union_map(
1806                 __isl_take isl_union_map *umap);
1808 Sets and relations can be copied and freed again using the following
1809 functions.
1811         __isl_give isl_basic_set *isl_basic_set_copy(
1812                 __isl_keep isl_basic_set *bset);
1813         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1814         __isl_give isl_union_set *isl_union_set_copy(
1815                 __isl_keep isl_union_set *uset);
1816         __isl_give isl_basic_map *isl_basic_map_copy(
1817                 __isl_keep isl_basic_map *bmap);
1818         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1819         __isl_give isl_union_map *isl_union_map_copy(
1820                 __isl_keep isl_union_map *umap);
1821         __isl_null isl_basic_set *isl_basic_set_free(
1822                 __isl_take isl_basic_set *bset);
1823         __isl_null isl_set *isl_set_free(__isl_take isl_set *set);
1824         __isl_null isl_union_set *isl_union_set_free(
1825                 __isl_take isl_union_set *uset);
1826         __isl_null isl_basic_map *isl_basic_map_free(
1827                 __isl_take isl_basic_map *bmap);
1828         __isl_null isl_map *isl_map_free(__isl_take isl_map *map);
1829         __isl_null isl_union_map *isl_union_map_free(
1830                 __isl_take isl_union_map *umap);
1832 Other sets and relations can be constructed by starting
1833 from a universe set or relation, adding equality and/or
1834 inequality constraints and then projecting out the
1835 existentially quantified variables, if any.
1836 Constraints can be constructed, manipulated and
1837 added to (or removed from) (basic) sets and relations
1838 using the following functions.
1840         #include <isl/constraint.h>
1841         __isl_give isl_constraint *isl_equality_alloc(
1842                 __isl_take isl_local_space *ls);
1843         __isl_give isl_constraint *isl_inequality_alloc(
1844                 __isl_take isl_local_space *ls);
1845         __isl_give isl_constraint *isl_constraint_set_constant_si(
1846                 __isl_take isl_constraint *constraint, int v);
1847         __isl_give isl_constraint *isl_constraint_set_constant_val(
1848                 __isl_take isl_constraint *constraint,
1849                 __isl_take isl_val *v);
1850         __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1851                 __isl_take isl_constraint *constraint,
1852                 enum isl_dim_type type, int pos, int v);
1853         __isl_give isl_constraint *
1854         isl_constraint_set_coefficient_val(
1855                 __isl_take isl_constraint *constraint,
1856                 enum isl_dim_type type, int pos,
1857                 __isl_take isl_val *v);
1858         __isl_give isl_basic_map *isl_basic_map_add_constraint(
1859                 __isl_take isl_basic_map *bmap,
1860                 __isl_take isl_constraint *constraint);
1861         __isl_give isl_basic_set *isl_basic_set_add_constraint(
1862                 __isl_take isl_basic_set *bset,
1863                 __isl_take isl_constraint *constraint);
1864         __isl_give isl_map *isl_map_add_constraint(
1865                 __isl_take isl_map *map,
1866                 __isl_take isl_constraint *constraint);
1867         __isl_give isl_set *isl_set_add_constraint(
1868                 __isl_take isl_set *set,
1869                 __isl_take isl_constraint *constraint);
1870         __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1871                 __isl_take isl_basic_set *bset,
1872                 __isl_take isl_constraint *constraint);
1874 For example, to create a set containing the even integers
1875 between 10 and 42, you would use the following code.
1877         isl_space *space;
1878         isl_local_space *ls;
1879         isl_constraint *c;
1880         isl_basic_set *bset;
1882         space = isl_space_set_alloc(ctx, 0, 2);
1883         bset = isl_basic_set_universe(isl_space_copy(space));
1884         ls = isl_local_space_from_space(space);
1886         c = isl_equality_alloc(isl_local_space_copy(ls));
1887         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1888         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1889         bset = isl_basic_set_add_constraint(bset, c);
1891         c = isl_inequality_alloc(isl_local_space_copy(ls));
1892         c = isl_constraint_set_constant_si(c, -10);
1893         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1894         bset = isl_basic_set_add_constraint(bset, c);
1896         c = isl_inequality_alloc(ls);
1897         c = isl_constraint_set_constant_si(c, 42);
1898         c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1899         bset = isl_basic_set_add_constraint(bset, c);
1901         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1903 Or, alternatively,
1905         isl_basic_set *bset;
1906         bset = isl_basic_set_read_from_str(ctx,
1907                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1909 A basic set or relation can also be constructed from two matrices
1910 describing the equalities and the inequalities.
1912         __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1913                 __isl_take isl_space *space,
1914                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1915                 enum isl_dim_type c1,
1916                 enum isl_dim_type c2, enum isl_dim_type c3,
1917                 enum isl_dim_type c4);
1918         __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1919                 __isl_take isl_space *space,
1920                 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1921                 enum isl_dim_type c1,
1922                 enum isl_dim_type c2, enum isl_dim_type c3,
1923                 enum isl_dim_type c4, enum isl_dim_type c5);
1925 The C<isl_dim_type> arguments indicate the order in which
1926 different kinds of variables appear in the input matrices
1927 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1928 C<isl_dim_set> and C<isl_dim_div> for sets and
1929 of C<isl_dim_cst>, C<isl_dim_param>,
1930 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1932 A (basic or union) set or relation can also be constructed from a
1933 (union) (piecewise) (multiple) affine expression
1934 or a list of affine expressions
1935 (See L</"Functions">).
1937         __isl_give isl_basic_map *isl_basic_map_from_aff(
1938                 __isl_take isl_aff *aff);
1939         __isl_give isl_map *isl_map_from_aff(
1940                 __isl_take isl_aff *aff);
1941         __isl_give isl_set *isl_set_from_pw_aff(
1942                 __isl_take isl_pw_aff *pwaff);
1943         __isl_give isl_map *isl_map_from_pw_aff(
1944                 __isl_take isl_pw_aff *pwaff);
1945         __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1946                 __isl_take isl_space *domain_space,
1947                 __isl_take isl_aff_list *list);
1948         __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1949                 __isl_take isl_multi_aff *maff)
1950         __isl_give isl_map *isl_map_from_multi_aff(
1951                 __isl_take isl_multi_aff *maff)
1952         __isl_give isl_set *isl_set_from_pw_multi_aff(
1953                 __isl_take isl_pw_multi_aff *pma);
1954         __isl_give isl_map *isl_map_from_pw_multi_aff(
1955                 __isl_take isl_pw_multi_aff *pma);
1956         __isl_give isl_set *isl_set_from_multi_pw_aff(
1957                 __isl_take isl_multi_pw_aff *mpa);
1958         __isl_give isl_map *isl_map_from_multi_pw_aff(
1959                 __isl_take isl_multi_pw_aff *mpa);
1960         __isl_give isl_union_map *isl_union_map_from_union_pw_aff(
1961                 __isl_take isl_union_pw_aff *upa);
1962         __isl_give isl_union_map *
1963         isl_union_map_from_union_pw_multi_aff(
1964                 __isl_take isl_union_pw_multi_aff *upma);
1966 The C<domain_space> argument describes the domain of the resulting
1967 basic relation.  It is required because the C<list> may consist
1968 of zero affine expressions.
1970 =head2 Inspecting Sets and Relations
1972 Usually, the user should not have to care about the actual constraints
1973 of the sets and maps, but should instead apply the abstract operations
1974 explained in the following sections.
1975 Occasionally, however, it may be required to inspect the individual
1976 coefficients of the constraints.  This section explains how to do so.
1977 In these cases, it may also be useful to have C<isl> compute
1978 an explicit representation of the existentially quantified variables.
1980         __isl_give isl_set *isl_set_compute_divs(
1981                 __isl_take isl_set *set);
1982         __isl_give isl_map *isl_map_compute_divs(
1983                 __isl_take isl_map *map);
1984         __isl_give isl_union_set *isl_union_set_compute_divs(
1985                 __isl_take isl_union_set *uset);
1986         __isl_give isl_union_map *isl_union_map_compute_divs(
1987                 __isl_take isl_union_map *umap);
1989 This explicit representation defines the existentially quantified
1990 variables as integer divisions of the other variables, possibly
1991 including earlier existentially quantified variables.
1992 An explicitly represented existentially quantified variable therefore
1993 has a unique value when the values of the other variables are known.
1994 If, furthermore, the same existentials, i.e., existentials
1995 with the same explicit representations, should appear in the
1996 same order in each of the disjuncts of a set or map, then the user should call
1997 either of the following functions.
1999         __isl_give isl_set *isl_set_align_divs(
2000                 __isl_take isl_set *set);
2001         __isl_give isl_map *isl_map_align_divs(
2002                 __isl_take isl_map *map);
2004 Alternatively, the existentially quantified variables can be removed
2005 using the following functions, which compute an overapproximation.
2007         __isl_give isl_basic_set *isl_basic_set_remove_divs(
2008                 __isl_take isl_basic_set *bset);
2009         __isl_give isl_basic_map *isl_basic_map_remove_divs(
2010                 __isl_take isl_basic_map *bmap);
2011         __isl_give isl_set *isl_set_remove_divs(
2012                 __isl_take isl_set *set);
2013         __isl_give isl_map *isl_map_remove_divs(
2014                 __isl_take isl_map *map);
2016 It is also possible to only remove those divs that are defined
2017 in terms of a given range of dimensions or only those for which
2018 no explicit representation is known.
2020         __isl_give isl_basic_set *
2021         isl_basic_set_remove_divs_involving_dims(
2022                 __isl_take isl_basic_set *bset,
2023                 enum isl_dim_type type,
2024                 unsigned first, unsigned n);
2025         __isl_give isl_basic_map *
2026         isl_basic_map_remove_divs_involving_dims(
2027                 __isl_take isl_basic_map *bmap,
2028                 enum isl_dim_type type,
2029                 unsigned first, unsigned n);
2030         __isl_give isl_set *isl_set_remove_divs_involving_dims(
2031                 __isl_take isl_set *set, enum isl_dim_type type,
2032                 unsigned first, unsigned n);
2033         __isl_give isl_map *isl_map_remove_divs_involving_dims(
2034                 __isl_take isl_map *map, enum isl_dim_type type,
2035                 unsigned first, unsigned n);
2037         __isl_give isl_basic_set *
2038         isl_basic_set_remove_unknown_divs(
2039                 __isl_take isl_basic_set *bset);
2040         __isl_give isl_set *isl_set_remove_unknown_divs(
2041                 __isl_take isl_set *set);
2042         __isl_give isl_map *isl_map_remove_unknown_divs(
2043                 __isl_take isl_map *map);
2045 To iterate over all the sets or maps in a union set or map, use
2047         int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
2048                 int (*fn)(__isl_take isl_set *set, void *user),
2049                 void *user);
2050         int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
2051                 int (*fn)(__isl_take isl_map *map, void *user),
2052                 void *user);
2054 The number of sets or maps in a union set or map can be obtained
2055 from
2057         int isl_union_set_n_set(__isl_keep isl_union_set *uset);
2058         int isl_union_map_n_map(__isl_keep isl_union_map *umap);
2060 To extract the set or map in a given space from a union, use
2062         __isl_give isl_set *isl_union_set_extract_set(
2063                 __isl_keep isl_union_set *uset,
2064                 __isl_take isl_space *space);
2065         __isl_give isl_map *isl_union_map_extract_map(
2066                 __isl_keep isl_union_map *umap,
2067                 __isl_take isl_space *space);
2069 To iterate over all the basic sets or maps in a set or map, use
2071         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
2072                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
2073                 void *user);
2074         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
2075                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
2076                 void *user);
2078 The callback function C<fn> should return 0 if successful and
2079 -1 if an error occurs.  In the latter case, or if any other error
2080 occurs, the above functions will return -1.
2082 It should be noted that C<isl> does not guarantee that
2083 the basic sets or maps passed to C<fn> are disjoint.
2084 If this is required, then the user should call one of
2085 the following functions first.
2087         __isl_give isl_set *isl_set_make_disjoint(
2088                 __isl_take isl_set *set);
2089         __isl_give isl_map *isl_map_make_disjoint(
2090                 __isl_take isl_map *map);
2092 The number of basic sets in a set can be obtained
2093 or the number of basic maps in a map can be obtained
2094 from
2096         #include <isl/set.h>
2097         int isl_set_n_basic_set(__isl_keep isl_set *set);
2099         #include <isl/map.h>
2100         int isl_map_n_basic_map(__isl_keep isl_map *map);
2102 To iterate over the constraints of a basic set or map, use
2104         #include <isl/constraint.h>
2106         int isl_basic_set_n_constraint(
2107                 __isl_keep isl_basic_set *bset);
2108         int isl_basic_set_foreach_constraint(
2109                 __isl_keep isl_basic_set *bset,
2110                 int (*fn)(__isl_take isl_constraint *c, void *user),
2111                 void *user);
2112         int isl_basic_map_n_constraint(
2113                 __isl_keep isl_basic_map *bmap);
2114         int isl_basic_map_foreach_constraint(
2115                 __isl_keep isl_basic_map *bmap,
2116                 int (*fn)(__isl_take isl_constraint *c, void *user),
2117                 void *user);
2118         __isl_null isl_constraint *isl_constraint_free(
2119                 __isl_take isl_constraint *c);
2121 Again, the callback function C<fn> should return 0 if successful and
2122 -1 if an error occurs.  In the latter case, or if any other error
2123 occurs, the above functions will return -1.
2124 The constraint C<c> represents either an equality or an inequality.
2125 Use the following function to find out whether a constraint
2126 represents an equality.  If not, it represents an inequality.
2128         int isl_constraint_is_equality(
2129                 __isl_keep isl_constraint *constraint);
2131 It is also possible to obtain a list of constraints from a basic
2132 map or set
2134         #include <isl/constraint.h>
2135         __isl_give isl_constraint_list *
2136         isl_basic_map_get_constraint_list(
2137                 __isl_keep isl_basic_map *bmap);
2138         __isl_give isl_constraint_list *
2139         isl_basic_set_get_constraint_list(
2140                 __isl_keep isl_basic_set *bset);
2142 These functions require that all existentially quantified variables
2143 have an explicit representation.
2144 The returned list can be manipulated using the functions in L<"Lists">.
2146 The coefficients of the constraints can be inspected using
2147 the following functions.
2149         int isl_constraint_is_lower_bound(
2150                 __isl_keep isl_constraint *constraint,
2151                 enum isl_dim_type type, unsigned pos);
2152         int isl_constraint_is_upper_bound(
2153                 __isl_keep isl_constraint *constraint,
2154                 enum isl_dim_type type, unsigned pos);
2155         __isl_give isl_val *isl_constraint_get_constant_val(
2156                 __isl_keep isl_constraint *constraint);
2157         __isl_give isl_val *isl_constraint_get_coefficient_val(
2158                 __isl_keep isl_constraint *constraint,
2159                 enum isl_dim_type type, int pos);
2161 The explicit representations of the existentially quantified
2162 variables can be inspected using the following function.
2163 Note that the user is only allowed to use this function
2164 if the inspected set or map is the result of a call
2165 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
2166 The existentially quantified variable is equal to the floor
2167 of the returned affine expression.  The affine expression
2168 itself can be inspected using the functions in
2169 L</"Functions">.
2171         __isl_give isl_aff *isl_constraint_get_div(
2172                 __isl_keep isl_constraint *constraint, int pos);
2174 To obtain the constraints of a basic set or map in matrix
2175 form, use the following functions.
2177         __isl_give isl_mat *isl_basic_set_equalities_matrix(
2178                 __isl_keep isl_basic_set *bset,
2179                 enum isl_dim_type c1, enum isl_dim_type c2,
2180                 enum isl_dim_type c3, enum isl_dim_type c4);
2181         __isl_give isl_mat *isl_basic_set_inequalities_matrix(
2182                 __isl_keep isl_basic_set *bset,
2183                 enum isl_dim_type c1, enum isl_dim_type c2,
2184                 enum isl_dim_type c3, enum isl_dim_type c4);
2185         __isl_give isl_mat *isl_basic_map_equalities_matrix(
2186                 __isl_keep isl_basic_map *bmap,
2187                 enum isl_dim_type c1,
2188                 enum isl_dim_type c2, enum isl_dim_type c3,
2189                 enum isl_dim_type c4, enum isl_dim_type c5);
2190         __isl_give isl_mat *isl_basic_map_inequalities_matrix(
2191                 __isl_keep isl_basic_map *bmap,
2192                 enum isl_dim_type c1,
2193                 enum isl_dim_type c2, enum isl_dim_type c3,
2194                 enum isl_dim_type c4, enum isl_dim_type c5);
2196 The C<isl_dim_type> arguments dictate the order in which
2197 different kinds of variables appear in the resulting matrix.
2198 For set inputs, they should be a permutation of
2199 C<isl_dim_cst>, C<isl_dim_param>, C<isl_dim_set> and C<isl_dim_div>.
2200 For map inputs, they should be a permutation of
2201 C<isl_dim_cst>, C<isl_dim_param>,
2202 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
2204 =head2 Points
2206 Points are elements of a set.  They can be used to construct
2207 simple sets (boxes) or they can be used to represent the
2208 individual elements of a set.
2209 The zero point (the origin) can be created using
2211         __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
2213 The coordinates of a point can be inspected, set and changed
2214 using
2216         __isl_give isl_val *isl_point_get_coordinate_val(
2217                 __isl_keep isl_point *pnt,
2218                 enum isl_dim_type type, int pos);
2219         __isl_give isl_point *isl_point_set_coordinate_val(
2220                 __isl_take isl_point *pnt,
2221                 enum isl_dim_type type, int pos,
2222                 __isl_take isl_val *v);
2224         __isl_give isl_point *isl_point_add_ui(
2225                 __isl_take isl_point *pnt,
2226                 enum isl_dim_type type, int pos, unsigned val);
2227         __isl_give isl_point *isl_point_sub_ui(
2228                 __isl_take isl_point *pnt,
2229                 enum isl_dim_type type, int pos, unsigned val);
2231 Points can be copied or freed using
2233         __isl_give isl_point *isl_point_copy(
2234                 __isl_keep isl_point *pnt);
2235         void isl_point_free(__isl_take isl_point *pnt);
2237 A singleton set can be created from a point using
2239         __isl_give isl_basic_set *isl_basic_set_from_point(
2240                 __isl_take isl_point *pnt);
2241         __isl_give isl_set *isl_set_from_point(
2242                 __isl_take isl_point *pnt);
2244 and a box can be created from two opposite extremal points using
2246         __isl_give isl_basic_set *isl_basic_set_box_from_points(
2247                 __isl_take isl_point *pnt1,
2248                 __isl_take isl_point *pnt2);
2249         __isl_give isl_set *isl_set_box_from_points(
2250                 __isl_take isl_point *pnt1,
2251                 __isl_take isl_point *pnt2);
2253 All elements of a B<bounded> (union) set can be enumerated using
2254 the following functions.
2256         int isl_set_foreach_point(__isl_keep isl_set *set,
2257                 int (*fn)(__isl_take isl_point *pnt, void *user),
2258                 void *user);
2259         int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
2260                 int (*fn)(__isl_take isl_point *pnt, void *user),
2261                 void *user);
2263 The function C<fn> is called for each integer point in
2264 C<set> with as second argument the last argument of
2265 the C<isl_set_foreach_point> call.  The function C<fn>
2266 should return C<0> on success and C<-1> on failure.
2267 In the latter case, C<isl_set_foreach_point> will stop
2268 enumerating and return C<-1> as well.
2269 If the enumeration is performed successfully and to completion,
2270 then C<isl_set_foreach_point> returns C<0>.
2272 To obtain a single point of a (basic) set, use
2274         __isl_give isl_point *isl_basic_set_sample_point(
2275                 __isl_take isl_basic_set *bset);
2276         __isl_give isl_point *isl_set_sample_point(
2277                 __isl_take isl_set *set);
2279 If C<set> does not contain any (integer) points, then the
2280 resulting point will be ``void'', a property that can be
2281 tested using
2283         int isl_point_is_void(__isl_keep isl_point *pnt);
2285 =head2 Functions
2287 Besides sets and relation, C<isl> also supports various types of functions.
2288 Each of these types is derived from the value type (see L</"Values">)
2289 or from one of two primitive function types
2290 through the application of zero or more type constructors.
2291 We first describe the primitive type and then we describe
2292 the types derived from these primitive types.
2294 =head3 Primitive Functions
2296 C<isl> support two primitive function types, quasi-affine
2297 expressions and quasipolynomials.
2298 A quasi-affine expression is defined either over a parameter
2299 space or over a set and is composed of integer constants,
2300 parameters and set variables, addition, subtraction and
2301 integer division by an integer constant.
2302 For example, the quasi-affine expression
2304         [n] -> { [x] -> [2*floor((4 n + x)/9] }
2306 maps C<x> to C<2*floor((4 n + x)/9>.
2307 A quasipolynomial is a polynomial expression in quasi-affine
2308 expression.  That is, it additionally allows for multiplication.
2309 Note, though, that it is not allowed to construct an integer
2310 division of an expression involving multiplications.
2311 Here is an example of a quasipolynomial that is not
2312 quasi-affine expression
2314         [n] -> { [x] -> (n*floor((4 n + x)/9) }
2316 Note that the external representations of quasi-affine expressions
2317 and quasipolynomials are different.  Quasi-affine expressions
2318 use a notation with square brackets just like binary relations,
2319 while quasipolynomials do not.  This might change at some point.
2321 If a primitive function is defined over a parameter space,
2322 then the space of the function itself is that of a set.
2323 If it is defined over a set, then the space of the function
2324 is that of a relation.  In both cases, the set space (or
2325 the output space) is single-dimensional, anonymous and unstructured.
2326 To create functions with multiple dimensions or with other kinds
2327 of set or output spaces, use multiple expressions
2328 (see L</"Multiple Expressions">).
2330 =over
2332 =item * Quasi-affine Expressions
2334 Besides the expressions described above, a quasi-affine
2335 expression can also be set to NaN.  Such expressions
2336 typically represent a failure to represent a result
2337 as a quasi-affine expression.
2339 The zero quasi affine expression or the quasi affine expression
2340 that is equal to a given value or
2341 a specified dimension on a given domain can be created using
2343         #include <isl/aff.h>
2344         __isl_give isl_aff *isl_aff_zero_on_domain(
2345                 __isl_take isl_local_space *ls);
2346         __isl_give isl_aff *isl_aff_val_on_domain(
2347                 __isl_take isl_local_space *ls,
2348                 __isl_take isl_val *val);
2349         __isl_give isl_aff *isl_aff_var_on_domain(
2350                 __isl_take isl_local_space *ls,
2351                 enum isl_dim_type type, unsigned pos);
2352         __isl_give isl_aff *isl_aff_nan_on_domain(
2353                 __isl_take isl_local_space *ls);
2355 Quasi affine expressions can be copied and freed using
2357         #include <isl/aff.h>
2358         __isl_give isl_aff *isl_aff_copy(
2359                 __isl_keep isl_aff *aff);
2360         __isl_null isl_aff *isl_aff_free(
2361                 __isl_take isl_aff *aff);
2363 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
2364 using the following function.  The constraint is required to have
2365 a non-zero coefficient for the specified dimension.
2367         #include <isl/constraint.h>
2368         __isl_give isl_aff *isl_constraint_get_bound(
2369                 __isl_keep isl_constraint *constraint,
2370                 enum isl_dim_type type, int pos);
2372 The entire affine expression of the constraint can also be extracted
2373 using the following function.
2375         #include <isl/constraint.h>
2376         __isl_give isl_aff *isl_constraint_get_aff(
2377                 __isl_keep isl_constraint *constraint);
2379 Conversely, an equality constraint equating
2380 the affine expression to zero or an inequality constraint enforcing
2381 the affine expression to be non-negative, can be constructed using
2383         __isl_give isl_constraint *isl_equality_from_aff(
2384                 __isl_take isl_aff *aff);
2385         __isl_give isl_constraint *isl_inequality_from_aff(
2386                 __isl_take isl_aff *aff);
2388 The coefficients and the integer divisions of an affine expression
2389 can be inspected using the following functions.
2391         #include <isl/aff.h>
2392         __isl_give isl_val *isl_aff_get_constant_val(
2393                 __isl_keep isl_aff *aff);
2394         __isl_give isl_val *isl_aff_get_coefficient_val(
2395                 __isl_keep isl_aff *aff,
2396                 enum isl_dim_type type, int pos);
2397         int isl_aff_coefficient_sgn(__isl_keep isl_aff *aff,
2398                 enum isl_dim_type type, int pos);
2399         __isl_give isl_val *isl_aff_get_denominator_val(
2400                 __isl_keep isl_aff *aff);
2401         __isl_give isl_aff *isl_aff_get_div(
2402                 __isl_keep isl_aff *aff, int pos);
2404 They can be modified using the following functions.
2406         #include <isl/aff.h>
2407         __isl_give isl_aff *isl_aff_set_constant_si(
2408                 __isl_take isl_aff *aff, int v);
2409         __isl_give isl_aff *isl_aff_set_constant_val(
2410                 __isl_take isl_aff *aff, __isl_take isl_val *v);
2411         __isl_give isl_aff *isl_aff_set_coefficient_si(
2412                 __isl_take isl_aff *aff,
2413                 enum isl_dim_type type, int pos, int v);
2414         __isl_give isl_aff *isl_aff_set_coefficient_val(
2415                 __isl_take isl_aff *aff,
2416                 enum isl_dim_type type, int pos,
2417                 __isl_take isl_val *v);
2419         __isl_give isl_aff *isl_aff_add_constant_si(
2420                 __isl_take isl_aff *aff, int v);
2421         __isl_give isl_aff *isl_aff_add_constant_val(
2422                 __isl_take isl_aff *aff, __isl_take isl_val *v);
2423         __isl_give isl_aff *isl_aff_add_constant_num_si(
2424                 __isl_take isl_aff *aff, int v);
2425         __isl_give isl_aff *isl_aff_add_coefficient_si(
2426                 __isl_take isl_aff *aff,
2427                 enum isl_dim_type type, int pos, int v);
2428         __isl_give isl_aff *isl_aff_add_coefficient_val(
2429                 __isl_take isl_aff *aff,
2430                 enum isl_dim_type type, int pos,
2431                 __isl_take isl_val *v);
2433 Note that C<isl_aff_set_constant_si> and C<isl_aff_set_coefficient_si>
2434 set the I<numerator> of the constant or coefficient, while
2435 C<isl_aff_set_constant_val> and C<isl_aff_set_coefficient_val> set
2436 the constant or coefficient as a whole.
2437 The C<add_constant> and C<add_coefficient> functions add an integer
2438 or rational value to
2439 the possibly rational constant or coefficient.
2440 The C<add_constant_num> functions add an integer value to
2441 the numerator.
2443 =item * Quasipolynomials
2445 Some simple quasipolynomials can be created using the following functions.
2447         #include <isl/polynomial.h>
2448         __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
2449                 __isl_take isl_space *domain);
2450         __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
2451                 __isl_take isl_space *domain);
2452         __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
2453                 __isl_take isl_space *domain);
2454         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
2455                 __isl_take isl_space *domain);
2456         __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
2457                 __isl_take isl_space *domain);
2458         __isl_give isl_qpolynomial *isl_qpolynomial_val_on_domain(
2459                 __isl_take isl_space *domain,
2460                 __isl_take isl_val *val);
2461         __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
2462                 __isl_take isl_space *domain,
2463                 enum isl_dim_type type, unsigned pos);
2464         __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
2465                 __isl_take isl_aff *aff);
2467 Recall that the space in which a quasipolynomial lives is a map space
2468 with a one-dimensional range.  The C<domain> argument in some of
2469 the functions above corresponds to the domain of this map space.
2471 Quasipolynomials can be copied and freed again using the following
2472 functions.
2474         #include <isl/polynomial.h>
2475         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
2476                 __isl_keep isl_qpolynomial *qp);
2477         __isl_null isl_qpolynomial *isl_qpolynomial_free(
2478                 __isl_take isl_qpolynomial *qp);
2480 The constant term of a quasipolynomial can be extracted using
2482         __isl_give isl_val *isl_qpolynomial_get_constant_val(
2483                 __isl_keep isl_qpolynomial *qp);
2485 To iterate over all terms in a quasipolynomial,
2488         int isl_qpolynomial_foreach_term(
2489                 __isl_keep isl_qpolynomial *qp,
2490                 int (*fn)(__isl_take isl_term *term,
2491                           void *user), void *user);
2493 The terms themselves can be inspected and freed using
2494 these functions
2496         unsigned isl_term_dim(__isl_keep isl_term *term,
2497                 enum isl_dim_type type);
2498         __isl_give isl_val *isl_term_get_coefficient_val(
2499                 __isl_keep isl_term *term);
2500         int isl_term_get_exp(__isl_keep isl_term *term,
2501                 enum isl_dim_type type, unsigned pos);
2502         __isl_give isl_aff *isl_term_get_div(
2503                 __isl_keep isl_term *term, unsigned pos);
2504         void isl_term_free(__isl_take isl_term *term);
2506 Each term is a product of parameters, set variables and
2507 integer divisions.  The function C<isl_term_get_exp>
2508 returns the exponent of a given dimensions in the given term.
2510 =back
2512 =head3 Reductions
2514 A reduction represents a maximum or a minimum of its
2515 base expressions.
2516 The only reduction type defined by C<isl> is
2517 C<isl_qpolynomial_fold>.
2519 There are currently no functions to directly create such
2520 objects, but they do appear in the piecewise quasipolynomial
2521 reductions returned by the C<isl_pw_qpolynomial_bound> function.
2523 L</"Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions">.
2525 Reductions can be copied and freed using
2526 the following functions.
2528         #include <isl/polynomial.h>
2529         __isl_give isl_qpolynomial_fold *
2530         isl_qpolynomial_fold_copy(
2531                 __isl_keep isl_qpolynomial_fold *fold);
2532         void isl_qpolynomial_fold_free(
2533                 __isl_take isl_qpolynomial_fold *fold);
2535 To iterate over all quasipolynomials in a reduction, use
2537         int isl_qpolynomial_fold_foreach_qpolynomial(
2538                 __isl_keep isl_qpolynomial_fold *fold,
2539                 int (*fn)(__isl_take isl_qpolynomial *qp,
2540                           void *user), void *user);
2542 =head3 Multiple Expressions
2544 A multiple expression represents a sequence of zero or
2545 more base expressions, all defined on the same domain space.
2546 The domain space of the multiple expression is the same
2547 as that of the base expressions, but the range space
2548 can be any space.  In case the base expressions have
2549 a set space, the corresponding multiple expression
2550 also has a set space.
2551 Objects of the value type do not have an associated space.
2552 The space of a multiple value is therefore always a set space.
2553 Similarly, the space of a multiple union piecewise
2554 affine expression is always a set space.
2556 The multiple expression types defined by C<isl>
2557 are C<isl_multi_val>, C<isl_multi_aff>, C<isl_multi_pw_aff>,
2558 C<isl_multi_union_pw_aff>.
2560 A multiple expression with the value zero for
2561 each output (or set) dimension can be created
2562 using the following functions.
2564         #include <isl/val.h>
2565         __isl_give isl_multi_val *isl_multi_val_zero(
2566                 __isl_take isl_space *space);
2568         #include <isl/aff.h>
2569         __isl_give isl_multi_aff *isl_multi_aff_zero(
2570                 __isl_take isl_space *space);
2571         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
2572                 __isl_take isl_space *space);
2573         __isl_give isl_multi_union_pw_aff *
2574         isl_multi_union_pw_aff_zero(
2575                 __isl_take isl_space *space);
2577 Since there is no canonical way of representing a zero
2578 value of type C<isl_union_pw_aff>, the space passed
2579 to C<isl_multi_union_pw_aff_zero> needs to be zero-dimensional.
2581 An identity function can be created using the following
2582 functions.  The space needs to be that of a relation
2583 with the same number of input and output dimensions.
2585         #include <isl/aff.h>
2586         __isl_give isl_multi_aff *isl_multi_aff_identity(
2587                 __isl_take isl_space *space);
2588         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
2589                 __isl_take isl_space *space);
2591 A function that performs a projection on a universe
2592 relation or set can be created using the following functions.
2593 See also the corresponding
2594 projection operations in L</"Unary Operations">.
2596         #include <isl/aff.h>
2597         __isl_give isl_multi_aff *isl_multi_aff_domain_map(
2598                 __isl_take isl_space *space);
2599         __isl_give isl_multi_aff *isl_multi_aff_range_map(
2600                 __isl_take isl_space *space);
2601         __isl_give isl_multi_aff *isl_multi_aff_project_out_map(
2602                 __isl_take isl_space *space,
2603                 enum isl_dim_type type,
2604                 unsigned first, unsigned n);
2606 A multiple expression can be created from a single
2607 base expression using the following functions.
2608 The space of the created multiple expression is the same
2609 as that of the base expression, except for
2610 C<isl_multi_union_pw_aff_from_union_pw_aff> where the input
2611 lives in a parameter space and the output lives
2612 in a single-dimensional set space.
2614         #include <isl/aff.h>
2615         __isl_give isl_multi_aff *isl_multi_aff_from_aff(
2616                 __isl_take isl_aff *aff);
2617         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
2618                 __isl_take isl_pw_aff *pa);
2619         __isl_give isl_multi_union_pw_aff *
2620         isl_multi_union_pw_aff_from_union_pw_aff(
2621                 __isl_take isl_union_pw_aff *upa);
2623 A multiple expression can be created from a list
2624 of base expression in a specified space.
2625 The domain of this space needs to be the same
2626 as the domains of the base expressions in the list.
2627 If the base expressions have a set space (or no associated space),
2628 then this space also needs to be a set space.
2630         #include <isl/val.h>
2631         __isl_give isl_multi_val *isl_multi_val_from_val_list(
2632                 __isl_take isl_space *space,
2633                 __isl_take isl_val_list *list);
2635         #include <isl/aff.h>
2636         __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
2637                 __isl_take isl_space *space,
2638                 __isl_take isl_aff_list *list);
2639         __isl_give isl_multi_union_pw_aff *
2640         isl_multi_union_pw_aff_from_union_pw_aff_list(
2641                 __isl_take isl_space *space,
2642                 __isl_take isl_union_pw_aff_list *list);
2644 As a convenience, a multiple piecewise expression can
2645 also be created from a multiple expression.
2646 Each piecewise expression in the result has a single
2647 universe cell.
2649         #include <isl/aff.h>
2650         __isl_give isl_multi_pw_aff *
2651         isl_multi_pw_aff_from_multi_aff(
2652                 __isl_take isl_multi_aff *ma);
2654 Similarly, a multiple union expression can be
2655 created from a multiple expression.
2657         #include <isl/aff.h>
2658         __isl_give isl_multi_union_pw_aff *
2659         isl_multi_union_pw_aff_from_multi_aff(
2660                 __isl_take isl_multi_aff *ma);
2661         __isl_give isl_multi_union_pw_aff *
2662         isl_multi_union_pw_aff_from_multi_pw_aff(
2663                 __isl_take isl_multi_pw_aff *mpa);
2665 A multiple quasi-affine expression can be created from
2666 a multiple value with a given domain space using the following
2667 function.
2669         #include <isl/aff.h>
2670         __isl_give isl_multi_aff *
2671         isl_multi_aff_multi_val_on_space(
2672                 __isl_take isl_space *space,
2673                 __isl_take isl_multi_val *mv);
2675 Similarly,
2676 a multiple union piecewise affine expression can be created from
2677 a multiple value with a given domain or
2678 a multiple affine expression with a given domain
2679 using the following functions.
2681         #include <isl/aff.h>
2682         __isl_give isl_multi_union_pw_aff *
2683         isl_multi_union_pw_aff_multi_val_on_domain(
2684                 __isl_take isl_union_set *domain,
2685                 __isl_take isl_multi_val *mv);
2686         __isl_give isl_multi_union_pw_aff *
2687         isl_multi_union_pw_aff_multi_aff_on_domain(
2688                 __isl_take isl_union_set *domain,
2689                 __isl_take isl_multi_aff *ma);
2691 Multiple expressions can be copied and freed using
2692 the following functions.
2694         #include <isl/val.h>
2695         __isl_give isl_multi_val *isl_multi_val_copy(
2696                 __isl_keep isl_multi_val *mv);
2697         __isl_null isl_multi_val *isl_multi_val_free(
2698                 __isl_take isl_multi_val *mv);
2700         #include <isl/aff.h>
2701         __isl_give isl_multi_aff *isl_multi_aff_copy(
2702                 __isl_keep isl_multi_aff *maff);
2703         __isl_null isl_multi_aff *isl_multi_aff_free(
2704                 __isl_take isl_multi_aff *maff);
2705         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
2706                 __isl_keep isl_multi_pw_aff *mpa);
2707         __isl_null isl_multi_pw_aff *isl_multi_pw_aff_free(
2708                 __isl_take isl_multi_pw_aff *mpa);
2709         __isl_give isl_multi_union_pw_aff *
2710         isl_multi_union_pw_aff_copy(
2711                 __isl_keep isl_multi_union_pw_aff *mupa);
2712         __isl_null isl_multi_union_pw_aff *
2713         isl_multi_union_pw_aff_free(
2714                 __isl_take isl_multi_union_pw_aff *mupa);
2716 The base expression at a given position of a multiple
2717 expression can be extracted using the following functions.
2719         #include <isl/val.h>
2720         __isl_give isl_val *isl_multi_val_get_val(
2721                 __isl_keep isl_multi_val *mv, int pos);
2723         #include <isl/aff.h>
2724         __isl_give isl_aff *isl_multi_aff_get_aff(
2725                 __isl_keep isl_multi_aff *multi, int pos);
2726         __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
2727                 __isl_keep isl_multi_pw_aff *mpa, int pos);
2728         __isl_give isl_union_pw_aff *
2729         isl_multi_union_pw_aff_get_union_pw_aff(
2730                 __isl_keep isl_multi_union_pw_aff *mupa, int pos);
2732 It can be replaced using the following functions.
2734         #include <isl/val.h>
2735         __isl_give isl_multi_val *isl_multi_val_set_val(
2736                 __isl_take isl_multi_val *mv, int pos,
2737                 __isl_take isl_val *val);
2739         #include <isl/aff.h>
2740         __isl_give isl_multi_aff *isl_multi_aff_set_aff(
2741                 __isl_take isl_multi_aff *multi, int pos,
2742                 __isl_take isl_aff *aff);
2743         __isl_give isl_multi_union_pw_aff *
2744         isl_multi_union_pw_aff_set_union_pw_aff(
2745                 __isl_take isl_multi_union_pw_aff *mupa, int pos,
2746                 __isl_take isl_union_pw_aff *upa);
2748 Note that there is a difference between C<isl_multi_union_pw_aff>
2749 and C<isl_union_pw_multi_aff> objects.  The first is a sequence
2750 of unions of piecewise expressions, while the second is a union
2751 of piecewise sequences.  In particular, multiple affine expressions
2752 in an C<isl_union_pw_multi_aff> may live in different spaces,
2753 while there is only a single multiple expression in
2754 an C<isl_multi_union_pw_aff>, which can therefore only live
2755 in a single space.  This means that not every
2756 C<isl_union_pw_multi_aff> can be converted to
2757 an C<isl_multi_union_pw_aff>.  The following function can
2758 be used to perform this conversion when it is possible.
2760         #include <isl/aff.h>
2761         __isl_give isl_multi_union_pw_aff *
2762         isl_multi_union_pw_aff_from_union_pw_multi_aff(
2763                 __isl_take isl_union_pw_multi_aff *upma);
2765 =head3 Piecewise Expressions
2767 A piecewise expression is an expression that is described
2768 using zero or more base expression defined over the same
2769 number of cells in the domain space of the base expressions.
2770 All base expressions are defined over the same
2771 domain space and the cells are disjoint.
2772 The space of a piecewise expression is the same as
2773 that of the base expressions.
2774 If the union of the cells is a strict subset of the domain
2775 space, then the value of the piecewise expression outside
2776 this union is different for types derived from quasi-affine
2777 expressions and those derived from quasipolynomials.
2778 Piecewise expressions derived from quasi-affine expressions
2779 are considered to be undefined outside the union of their cells.
2780 Piecewise expressions derived from quasipolynomials
2781 are considered to be zero outside the union of their cells.
2783 Piecewise quasipolynomials are mainly used by the C<barvinok>
2784 library for representing the number of elements in a parametric set or map.
2785 For example, the piecewise quasipolynomial
2787         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
2789 represents the number of points in the map
2791         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
2793 The piecewise expression types defined by C<isl>
2794 are C<isl_pw_aff>, C<isl_pw_multi_aff>,
2795 C<isl_pw_qpolynomial> and C<isl_pw_qpolynomial_fold>.
2797 A piecewise expression with no cells can be created using
2798 the following functions.
2800         #include <isl/aff.h>
2801         __isl_give isl_pw_aff *isl_pw_aff_empty(
2802                 __isl_take isl_space *space);
2803         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
2804                 __isl_take isl_space *space);
2806 A piecewise expression with a single universe cell can be
2807 created using the following functions.
2809         #include <isl/aff.h>
2810         __isl_give isl_pw_aff *isl_pw_aff_from_aff(
2811                 __isl_take isl_aff *aff);
2812         __isl_give isl_pw_multi_aff *
2813         isl_pw_multi_aff_from_multi_aff(
2814                 __isl_take isl_multi_aff *ma);
2816         #include <isl/polynomial.h>
2817         __isl_give isl_pw_qpolynomial *
2818         isl_pw_qpolynomial_from_qpolynomial(
2819                 __isl_take isl_qpolynomial *qp);
2821 A piecewise expression with a single specified cell can be
2822 created using the following functions.
2824         #include <isl/aff.h>
2825         __isl_give isl_pw_aff *isl_pw_aff_alloc(
2826                 __isl_take isl_set *set, __isl_take isl_aff *aff);
2827         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
2828                 __isl_take isl_set *set,
2829                 __isl_take isl_multi_aff *maff);
2831         #include <isl/polynomial.h>
2832         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
2833                 __isl_take isl_set *set,
2834                 __isl_take isl_qpolynomial *qp);
2836 The following convenience functions first create a base expression and
2837 then create a piecewise expression over a universe domain.
2839         #include <isl/aff.h>
2840         __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
2841                 __isl_take isl_local_space *ls);
2842         __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
2843                 __isl_take isl_local_space *ls,
2844                 enum isl_dim_type type, unsigned pos);
2845         __isl_give isl_pw_aff *isl_pw_aff_nan_on_domain(
2846                 __isl_take isl_local_space *ls);
2847         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_zero(
2848                 __isl_take isl_space *space);
2849         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
2850                 __isl_take isl_space *space);
2851         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_range_map(
2852                 __isl_take isl_space *space);
2853         __isl_give isl_pw_multi_aff *
2854         isl_pw_multi_aff_project_out_map(
2855                 __isl_take isl_space *space,
2856                 enum isl_dim_type type,
2857                 unsigned first, unsigned n);
2859         #include <isl/polynomial.h>
2860         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
2861                 __isl_take isl_space *space);
2863 The following convenience functions first create a base expression and
2864 then create a piecewise expression over a given domain.
2866         #include <isl/aff.h>
2867         __isl_give isl_pw_aff *isl_pw_aff_val_on_domain(
2868                 __isl_take isl_set *domain,
2869                 __isl_take isl_val *v);
2870         __isl_give isl_pw_multi_aff *
2871         isl_pw_multi_aff_multi_val_on_domain(
2872                 __isl_take isl_set *domain,
2873                 __isl_take isl_multi_val *mv);
2875 As a convenience, a piecewise multiple expression can
2876 also be created from a piecewise expression.
2877 Each multiple expression in the result is derived
2878 from the corresponding base expression.
2880         #include <isl/aff.h>
2881         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_pw_aff(
2882                 __isl_take isl_pw_aff *pa);
2884 Similarly, a piecewise quasipolynomial can be
2885 created from a piecewise quasi-affine expression using
2886 the following function.
2888         #include <isl/polynomial.h>
2889         __isl_give isl_pw_qpolynomial *
2890         isl_pw_qpolynomial_from_pw_aff(
2891                 __isl_take isl_pw_aff *pwaff);
2893 Piecewise expressions can be copied and freed using the following functions.
2895         #include <isl/aff.h>
2896         __isl_give isl_pw_aff *isl_pw_aff_copy(
2897                 __isl_keep isl_pw_aff *pwaff);
2898         __isl_null isl_pw_aff *isl_pw_aff_free(
2899                 __isl_take isl_pw_aff *pwaff);
2900         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
2901                 __isl_keep isl_pw_multi_aff *pma);
2902         __isl_null isl_pw_multi_aff *isl_pw_multi_aff_free(
2903                 __isl_take isl_pw_multi_aff *pma);
2905         #include <isl/polynomial.h>
2906         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
2907                 __isl_keep isl_pw_qpolynomial *pwqp);
2908         __isl_null isl_pw_qpolynomial *isl_pw_qpolynomial_free(
2909                 __isl_take isl_pw_qpolynomial *pwqp);
2910         __isl_give isl_pw_qpolynomial_fold *
2911         isl_pw_qpolynomial_fold_copy(
2912                 __isl_keep isl_pw_qpolynomial_fold *pwf);
2913         __isl_null isl_pw_qpolynomial_fold *
2914         isl_pw_qpolynomial_fold_free(
2915                 __isl_take isl_pw_qpolynomial_fold *pwf);
2917 To iterate over the different cells of a piecewise expression,
2918 use the following functions.
2920         #include <isl/aff.h>
2921         int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
2922         int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
2923         int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
2924                 int (*fn)(__isl_take isl_set *set,
2925                           __isl_take isl_aff *aff,
2926                           void *user), void *user);
2927         int isl_pw_multi_aff_foreach_piece(
2928                 __isl_keep isl_pw_multi_aff *pma,
2929                 int (*fn)(__isl_take isl_set *set,
2930                             __isl_take isl_multi_aff *maff,
2931                             void *user), void *user);
2933         #include <isl/polynomial.h>
2934         int isl_pw_qpolynomial_foreach_piece(
2935                 __isl_keep isl_pw_qpolynomial *pwqp,
2936                 int (*fn)(__isl_take isl_set *set,
2937                           __isl_take isl_qpolynomial *qp,
2938                           void *user), void *user);
2939         int isl_pw_qpolynomial_foreach_lifted_piece(
2940                 __isl_keep isl_pw_qpolynomial *pwqp,
2941                 int (*fn)(__isl_take isl_set *set,
2942                           __isl_take isl_qpolynomial *qp,
2943                           void *user), void *user);
2944         int isl_pw_qpolynomial_fold_foreach_piece(
2945                 __isl_keep isl_pw_qpolynomial_fold *pwf,
2946                 int (*fn)(__isl_take isl_set *set,
2947                           __isl_take isl_qpolynomial_fold *fold,
2948                           void *user), void *user);
2949         int isl_pw_qpolynomial_fold_foreach_lifted_piece(
2950                 __isl_keep isl_pw_qpolynomial_fold *pwf,
2951                 int (*fn)(__isl_take isl_set *set,
2952                           __isl_take isl_qpolynomial_fold *fold,
2953                           void *user), void *user);
2955 As usual, the function C<fn> should return C<0> on success
2956 and C<-1> on failure.  The difference between
2957 C<isl_pw_qpolynomial_foreach_piece> and
2958 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
2959 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
2960 compute unique representations for all existentially quantified
2961 variables and then turn these existentially quantified variables
2962 into extra set variables, adapting the associated quasipolynomial
2963 accordingly.  This means that the C<set> passed to C<fn>
2964 will not have any existentially quantified variables, but that
2965 the dimensions of the sets may be different for different
2966 invocations of C<fn>.
2967 Similarly for C<isl_pw_qpolynomial_fold_foreach_piece>
2968 and C<isl_pw_qpolynomial_fold_foreach_lifted_piece>.
2970 A piecewise expression consisting of the expressions at a given
2971 position of a piecewise multiple expression can be extracted
2972 using the following function.
2974         #include <isl/aff.h>
2975         __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
2976                 __isl_keep isl_pw_multi_aff *pma, int pos);
2978 These expressions can be replaced using the following function.
2980         #include <isl/aff.h>
2981         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
2982                 __isl_take isl_pw_multi_aff *pma, unsigned pos,
2983                 __isl_take isl_pw_aff *pa);
2985 Note that there is a difference between C<isl_multi_pw_aff> and
2986 C<isl_pw_multi_aff> objects.  The first is a sequence of piecewise
2987 affine expressions, while the second is a piecewise sequence
2988 of affine expressions.  In particular, each of the piecewise
2989 affine expressions in an C<isl_multi_pw_aff> may have a different
2990 domain, while all multiple expressions associated to a cell
2991 in an C<isl_pw_multi_aff> have the same domain.
2992 It is possible to convert between the two, but when converting
2993 an C<isl_multi_pw_aff> to an C<isl_pw_multi_aff>, the domain
2994 of the result is the intersection of the domains of the input.
2995 The reverse conversion is exact.
2997         #include <isl/aff.h>
2998         __isl_give isl_pw_multi_aff *
2999         isl_pw_multi_aff_from_multi_pw_aff(
3000                 __isl_take isl_multi_pw_aff *mpa);
3001         __isl_give isl_multi_pw_aff *
3002         isl_multi_pw_aff_from_pw_multi_aff(
3003                 __isl_take isl_pw_multi_aff *pma);
3005 =head3 Union Expressions
3007 A union expression collects base expressions defined
3008 over different domains.  The space of a union expression
3009 is that of the shared parameter space.
3011 The union expression types defined by C<isl>
3012 are C<isl_union_pw_aff>, C<isl_union_pw_multi_aff>,
3013 C<isl_union_pw_qpolynomial> and C<isl_union_pw_qpolynomial_fold>.
3015 An empty union expression can be created using the following functions.
3017         #include <isl/aff.h>
3018         __isl_give isl_union_pw_aff *isl_union_pw_aff_empty(
3019                 __isl_take isl_space *space);
3020         __isl_give isl_union_pw_multi_aff *
3021         isl_union_pw_multi_aff_empty(
3022                 __isl_take isl_space *space);
3024         #include <isl/polynomial.h>
3025         __isl_give isl_union_pw_qpolynomial *
3026         isl_union_pw_qpolynomial_zero(
3027                 __isl_take isl_space *space);
3029 A union expression containing a single base expression
3030 can be created using the following functions.
3032         #include <isl/aff.h>
3033         __isl_give isl_union_pw_aff *
3034         isl_union_pw_aff_from_pw_aff(
3035                 __isl_take isl_pw_aff *pa);
3036         __isl_give isl_union_pw_multi_aff *
3037         isl_union_pw_multi_aff_from_aff(
3038                 __isl_take isl_aff *aff);
3039         __isl_give isl_union_pw_multi_aff *
3040         isl_union_pw_multi_aff_from_pw_multi_aff(
3041                 __isl_take isl_pw_multi_aff *pma);
3043         #include <isl/polynomial.h>
3044         __isl_give isl_union_pw_qpolynomial *
3045         isl_union_pw_qpolynomial_from_pw_qpolynomial(
3046                 __isl_take isl_pw_qpolynomial *pwqp);
3048 The following functions create a base expression on each
3049 of the sets in the union set and collect the results.
3051         #include <isl/aff.h>
3052         __isl_give isl_union_pw_multi_aff *
3053         isl_union_pw_multi_aff_from_union_pw_aff(
3054                 __isl_take isl_union_pw_aff *upa);
3055         __isl_give isl_union_pw_aff *
3056         isl_union_pw_multi_aff_get_union_pw_aff(
3057                 __isl_keep isl_union_pw_multi_aff *upma, int pos);
3058         __isl_give isl_union_pw_aff *
3059         isl_union_pw_aff_val_on_domain(
3060                 __isl_take isl_union_set *domain,
3061                 __isl_take isl_val *v);
3062         __isl_give isl_union_pw_multi_aff *
3063         isl_union_pw_multi_aff_multi_val_on_domain(
3064                 __isl_take isl_union_set *domain,
3065                 __isl_take isl_multi_val *mv);
3067 An C<isl_union_pw_aff> that is equal to a (parametric) affine
3068 expression on a given domain can be created using the following
3069 function.
3071         #include <isl/aff.h>
3072         __isl_give isl_union_pw_aff *
3073         isl_union_pw_aff_aff_on_domain(
3074                 __isl_take isl_union_set *domain,
3075                 __isl_take isl_aff *aff);
3077 A base expression can be added to a union expression using
3078 the following functions.
3080         #include <isl/aff.h>
3081         __isl_give isl_union_pw_aff *
3082         isl_union_pw_aff_add_pw_aff(
3083                 __isl_take isl_union_pw_aff *upa,
3084                 __isl_take isl_pw_aff *pa);
3085         __isl_give isl_union_pw_multi_aff *
3086         isl_union_pw_multi_aff_add_pw_multi_aff(
3087                 __isl_take isl_union_pw_multi_aff *upma,
3088                 __isl_take isl_pw_multi_aff *pma);
3090         #include <isl/polynomial.h>
3091         __isl_give isl_union_pw_qpolynomial *
3092         isl_union_pw_qpolynomial_add_pw_qpolynomial(
3093                 __isl_take isl_union_pw_qpolynomial *upwqp,
3094                 __isl_take isl_pw_qpolynomial *pwqp);
3096 Union expressions can be copied and freed using
3097 the following functions.
3099         #include <isl/aff.h>
3100         __isl_give isl_union_pw_aff *isl_union_pw_aff_copy(
3101                 __isl_keep isl_union_pw_aff *upa);
3102         __isl_null isl_union_pw_aff *isl_union_pw_aff_free(
3103                 __isl_take isl_union_pw_aff *upa);
3104         __isl_give isl_union_pw_multi_aff *
3105         isl_union_pw_multi_aff_copy(
3106                 __isl_keep isl_union_pw_multi_aff *upma);
3107         __isl_null isl_union_pw_multi_aff *
3108         isl_union_pw_multi_aff_free(
3109                 __isl_take isl_union_pw_multi_aff *upma);
3111         #include <isl/polynomial.h>
3112         __isl_give isl_union_pw_qpolynomial *
3113         isl_union_pw_qpolynomial_copy(
3114                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3115         __isl_null isl_union_pw_qpolynomial *
3116         isl_union_pw_qpolynomial_free(
3117                 __isl_take isl_union_pw_qpolynomial *upwqp);
3118         __isl_give isl_union_pw_qpolynomial_fold *
3119         isl_union_pw_qpolynomial_fold_copy(
3120                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3121         __isl_null isl_union_pw_qpolynomial_fold *
3122         isl_union_pw_qpolynomial_fold_free(
3123                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
3125 To iterate over the base expressions in a union expression,
3126 use the following functions.
3128         #include <isl/aff.h>
3129         int isl_union_pw_aff_n_pw_multi_aff(
3130                 __isl_keep isl_union_pw_aff *upa);
3131         int isl_union_pw_aff_foreach_pw_aff(
3132                 __isl_keep isl_union_pw_aff *upa,
3133                 int (*fn)(__isl_take isl_pw_aff *ma, void *user),
3134                         void *user);
3135         int isl_union_pw_multi_aff_n_pw_multi_aff(
3136                 __isl_keep isl_union_pw_multi_aff *upma);
3137         int isl_union_pw_multi_aff_foreach_pw_multi_aff(
3138                 __isl_keep isl_union_pw_multi_aff *upma,
3139                 int (*fn)(__isl_take isl_pw_multi_aff *pma,
3140                             void *user), void *user);
3142         #include <isl/polynomial.h>
3143         int isl_union_pw_qplynomial_n_pw_qpolynomial(
3144                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3145         int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
3146                 __isl_keep isl_union_pw_qpolynomial *upwqp,
3147                 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp,
3148                             void *user), void *user);
3149         int isl_union_pw_qplynomial_fold_n_pw_qpolynomial_fold(
3150                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3151         int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
3152                 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
3153                 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
3154                             void *user), void *user);
3156 To extract the base expression in a given space from a union, use
3157 the following functions.
3159         #include <isl/aff.h>
3160         __isl_give isl_pw_aff *isl_union_pw_aff_extract_pw_aff(
3161                 __isl_keep isl_union_pw_aff *upa,
3162                 __isl_take isl_space *space);
3163         __isl_give isl_pw_multi_aff *
3164         isl_union_pw_multi_aff_extract_pw_multi_aff(
3165                 __isl_keep isl_union_pw_multi_aff *upma,
3166                 __isl_take isl_space *space);
3168         #include <isl/polynomial.h>
3169         __isl_give isl_pw_qpolynomial *
3170         isl_union_pw_qpolynomial_extract_pw_qpolynomial(
3171                 __isl_keep isl_union_pw_qpolynomial *upwqp,
3172                 __isl_take isl_space *space);
3174 =head2 Input and Output
3176 For set and relation,
3177 C<isl> supports its own input/output format, which is similar
3178 to the C<Omega> format, but also supports the C<PolyLib> format
3179 in some cases.
3180 For other object types, typically only an C<isl> format is supported.
3182 =head3 C<isl> format
3184 The C<isl> format is similar to that of C<Omega>, but has a different
3185 syntax for describing the parameters and allows for the definition
3186 of an existentially quantified variable as the integer division
3187 of an affine expression.
3188 For example, the set of integers C<i> between C<0> and C<n>
3189 such that C<i % 10 <= 6> can be described as
3191         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
3192                                 i - 10 a <= 6) }
3194 A set or relation can have several disjuncts, separated
3195 by the keyword C<or>.  Each disjunct is either a conjunction
3196 of constraints or a projection (C<exists>) of a conjunction
3197 of constraints.  The constraints are separated by the keyword
3198 C<and>.
3200 =head3 C<PolyLib> format
3202 If the represented set is a union, then the first line
3203 contains a single number representing the number of disjuncts.
3204 Otherwise, a line containing the number C<1> is optional.
3206 Each disjunct is represented by a matrix of constraints.
3207 The first line contains two numbers representing
3208 the number of rows and columns,
3209 where the number of rows is equal to the number of constraints
3210 and the number of columns is equal to two plus the number of variables.
3211 The following lines contain the actual rows of the constraint matrix.
3212 In each row, the first column indicates whether the constraint
3213 is an equality (C<0>) or inequality (C<1>).  The final column
3214 corresponds to the constant term.
3216 If the set is parametric, then the coefficients of the parameters
3217 appear in the last columns before the constant column.
3218 The coefficients of any existentially quantified variables appear
3219 between those of the set variables and those of the parameters.
3221 =head3 Extended C<PolyLib> format
3223 The extended C<PolyLib> format is nearly identical to the
3224 C<PolyLib> format.  The only difference is that the line
3225 containing the number of rows and columns of a constraint matrix
3226 also contains four additional numbers:
3227 the number of output dimensions, the number of input dimensions,
3228 the number of local dimensions (i.e., the number of existentially
3229 quantified variables) and the number of parameters.
3230 For sets, the number of ``output'' dimensions is equal
3231 to the number of set dimensions, while the number of ``input''
3232 dimensions is zero.
3234 =head3 Input
3236 Objects can be read from input using the following functions.
3238         #include <isl/val.h>
3239         __isl_give isl_val *isl_val_read_from_str(isl_ctx *ctx,
3240                 const char *str);
3241         __isl_give isl_multi_val *isl_multi_val_read_from_str(
3242                 isl_ctx *ctx, const char *str);
3244         #include <isl/set.h>
3245         __isl_give isl_basic_set *isl_basic_set_read_from_file(
3246                 isl_ctx *ctx, FILE *input);
3247         __isl_give isl_basic_set *isl_basic_set_read_from_str(
3248                 isl_ctx *ctx, const char *str);
3249         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
3250                 FILE *input);
3251         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
3252                 const char *str);
3254         #include <isl/map.h>
3255         __isl_give isl_basic_map *isl_basic_map_read_from_file(
3256                 isl_ctx *ctx, FILE *input);
3257         __isl_give isl_basic_map *isl_basic_map_read_from_str(
3258                 isl_ctx *ctx, const char *str);
3259         __isl_give isl_map *isl_map_read_from_file(
3260                 isl_ctx *ctx, FILE *input);
3261         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
3262                 const char *str);
3264         #include <isl/union_set.h>
3265         __isl_give isl_union_set *isl_union_set_read_from_file(
3266                 isl_ctx *ctx, FILE *input);
3267         __isl_give isl_union_set *isl_union_set_read_from_str(
3268                 isl_ctx *ctx, const char *str);
3270         #include <isl/union_map.h>
3271         __isl_give isl_union_map *isl_union_map_read_from_file(
3272                 isl_ctx *ctx, FILE *input);
3273         __isl_give isl_union_map *isl_union_map_read_from_str(
3274                 isl_ctx *ctx, const char *str);
3276         #include <isl/aff.h>
3277         __isl_give isl_aff *isl_aff_read_from_str(
3278                 isl_ctx *ctx, const char *str);
3279         __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
3280                 isl_ctx *ctx, const char *str);
3281         __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3282                 isl_ctx *ctx, const char *str);
3283         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
3284                 isl_ctx *ctx, const char *str);
3285         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_read_from_str(
3286                 isl_ctx *ctx, const char *str);
3287         __isl_give isl_union_pw_multi_aff *
3288         isl_union_pw_multi_aff_read_from_str(
3289                 isl_ctx *ctx, const char *str);
3290         __isl_give isl_multi_union_pw_aff *
3291         isl_multi_union_pw_aff_read_from_str(
3292                 isl_ctx *ctx, const char *str);
3294         #include <isl/polynomial.h>
3295         __isl_give isl_union_pw_qpolynomial *
3296         isl_union_pw_qpolynomial_read_from_str(
3297                 isl_ctx *ctx, const char *str);
3299 For sets and relations,
3300 the input format is autodetected and may be either the C<PolyLib> format
3301 or the C<isl> format.
3303 =head3 Output
3305 Before anything can be printed, an C<isl_printer> needs to
3306 be created.
3308         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
3309                 FILE *file);
3310         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
3311         __isl_null isl_printer *isl_printer_free(
3312                 __isl_take isl_printer *printer);
3313         __isl_give char *isl_printer_get_str(
3314                 __isl_keep isl_printer *printer);
3316 The printer can be inspected using the following functions.
3318         FILE *isl_printer_get_file(
3319                 __isl_keep isl_printer *printer);
3320         int isl_printer_get_output_format(
3321                 __isl_keep isl_printer *p);
3323 The behavior of the printer can be modified in various ways
3325         __isl_give isl_printer *isl_printer_set_output_format(
3326                 __isl_take isl_printer *p, int output_format);
3327         __isl_give isl_printer *isl_printer_set_indent(
3328                 __isl_take isl_printer *p, int indent);
3329         __isl_give isl_printer *isl_printer_set_indent_prefix(
3330                 __isl_take isl_printer *p, const char *prefix);
3331         __isl_give isl_printer *isl_printer_indent(
3332                 __isl_take isl_printer *p, int indent);
3333         __isl_give isl_printer *isl_printer_set_prefix(
3334                 __isl_take isl_printer *p, const char *prefix);
3335         __isl_give isl_printer *isl_printer_set_suffix(
3336                 __isl_take isl_printer *p, const char *suffix);
3338 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
3339 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
3340 and defaults to C<ISL_FORMAT_ISL>.
3341 Each line in the output is prefixed by C<indent_prefix>,
3342 indented by C<indent> (set by C<isl_printer_set_indent>) spaces
3343 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
3344 In the C<PolyLib> format output,
3345 the coefficients of the existentially quantified variables
3346 appear between those of the set variables and those
3347 of the parameters.
3348 The function C<isl_printer_indent> increases the indentation
3349 by the specified amount (which may be negative).
3351 To actually print something, use
3353         #include <isl/printer.h>
3354         __isl_give isl_printer *isl_printer_print_double(
3355                 __isl_take isl_printer *p, double d);
3357         #include <isl/val.h>
3358         __isl_give isl_printer *isl_printer_print_val(
3359                 __isl_take isl_printer *p, __isl_keep isl_val *v);
3361         #include <isl/set.h>
3362         __isl_give isl_printer *isl_printer_print_basic_set(
3363                 __isl_take isl_printer *printer,
3364                 __isl_keep isl_basic_set *bset);
3365         __isl_give isl_printer *isl_printer_print_set(
3366                 __isl_take isl_printer *printer,
3367                 __isl_keep isl_set *set);
3369         #include <isl/map.h>
3370         __isl_give isl_printer *isl_printer_print_basic_map(
3371                 __isl_take isl_printer *printer,
3372                 __isl_keep isl_basic_map *bmap);
3373         __isl_give isl_printer *isl_printer_print_map(
3374                 __isl_take isl_printer *printer,
3375                 __isl_keep isl_map *map);
3377         #include <isl/union_set.h>
3378         __isl_give isl_printer *isl_printer_print_union_set(
3379                 __isl_take isl_printer *p,
3380                 __isl_keep isl_union_set *uset);
3382         #include <isl/union_map.h>
3383         __isl_give isl_printer *isl_printer_print_union_map(
3384                 __isl_take isl_printer *p,
3385                 __isl_keep isl_union_map *umap);
3387         #include <isl/val.h>
3388         __isl_give isl_printer *isl_printer_print_multi_val(
3389                 __isl_take isl_printer *p,
3390                 __isl_keep isl_multi_val *mv);
3392         #include <isl/aff.h>
3393         __isl_give isl_printer *isl_printer_print_aff(
3394                 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3395         __isl_give isl_printer *isl_printer_print_multi_aff(
3396                 __isl_take isl_printer *p,
3397                 __isl_keep isl_multi_aff *maff);
3398         __isl_give isl_printer *isl_printer_print_pw_aff(
3399                 __isl_take isl_printer *p,
3400                 __isl_keep isl_pw_aff *pwaff);
3401         __isl_give isl_printer *isl_printer_print_pw_multi_aff(
3402                 __isl_take isl_printer *p,
3403                 __isl_keep isl_pw_multi_aff *pma);
3404         __isl_give isl_printer *isl_printer_print_multi_pw_aff(
3405                 __isl_take isl_printer *p,
3406                 __isl_keep isl_multi_pw_aff *mpa);
3407         __isl_give isl_printer *isl_printer_print_union_pw_aff(
3408                 __isl_take isl_printer *p,
3409                 __isl_keep isl_union_pw_aff *upa);
3410         __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
3411                 __isl_take isl_printer *p,
3412                 __isl_keep isl_union_pw_multi_aff *upma);
3413         __isl_give isl_printer *
3414         isl_printer_print_multi_union_pw_aff(
3415                 __isl_take isl_printer *p,
3416                 __isl_keep isl_multi_union_pw_aff *mupa);
3418         #include <isl/polynomial.h>
3419         __isl_give isl_printer *isl_printer_print_qpolynomial(
3420                 __isl_take isl_printer *p,
3421                 __isl_keep isl_qpolynomial *qp);
3422         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
3423                 __isl_take isl_printer *p,
3424                 __isl_keep isl_pw_qpolynomial *pwqp);
3425         __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
3426                 __isl_take isl_printer *p,
3427                 __isl_keep isl_union_pw_qpolynomial *upwqp);
3429         __isl_give isl_printer *
3430         isl_printer_print_pw_qpolynomial_fold(
3431                 __isl_take isl_printer *p,
3432                 __isl_keep isl_pw_qpolynomial_fold *pwf);
3433         __isl_give isl_printer *
3434         isl_printer_print_union_pw_qpolynomial_fold(
3435                 __isl_take isl_printer *p,
3436                 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
3438 For C<isl_printer_print_qpolynomial>,
3439 C<isl_printer_print_pw_qpolynomial> and
3440 C<isl_printer_print_pw_qpolynomial_fold>,
3441 the output format of the printer
3442 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
3443 For C<isl_printer_print_union_pw_qpolynomial> and
3444 C<isl_printer_print_union_pw_qpolynomial_fold>, only C<ISL_FORMAT_ISL>
3445 is supported.
3446 In case of printing in C<ISL_FORMAT_C>, the user may want
3447 to set the names of all dimensions first.
3449 When called on a file printer, the following function flushes
3450 the file.  When called on a string printer, the buffer is cleared.
3452         __isl_give isl_printer *isl_printer_flush(
3453                 __isl_take isl_printer *p);
3455 Alternatively, a string representation can be obtained
3456 directly using the following functions, which always print
3457 in isl format.
3459         #include <isl/space.h>
3460         __isl_give char *isl_space_to_str(
3461                 __isl_keep isl_space *space);
3463         #include <isl/val.h>
3464         __isl_give char *isl_val_to_str(__isl_keep isl_val *v);
3465         __isl_give char *isl_multi_val_to_str(
3466                 __isl_keep isl_multi_val *mv);
3468         #include <isl/set.h>
3469         __isl_give char *isl_set_to_str(
3470                 __isl_keep isl_set *set);
3472         #include <isl/union_set.h>
3473         __isl_give char *isl_union_set_to_str(
3474                 __isl_keep isl_union_set *uset);
3476         #include <isl/map.h>
3477         __isl_give char *isl_map_to_str(
3478                 __isl_keep isl_map *map);
3480         #include <isl/union_map.h>
3481         __isl_give char *isl_union_map_to_str(
3482                 __isl_keep isl_union_map *umap);
3484         #include <isl/aff.h>
3485         __isl_give char *isl_multi_aff_to_str(
3486                 __isl_keep isl_multi_aff *aff);
3487         __isl_give char *isl_union_pw_aff_to_str(
3488                 __isl_keep isl_union_pw_aff *upa);
3489         __isl_give char *isl_union_pw_multi_aff_to_str(
3490                 __isl_keep isl_union_pw_multi_aff *upma);
3491         __isl_give char *isl_multi_union_pw_aff_to_str(
3492                 __isl_keep isl_multi_union_pw_aff *mupa);
3494 =head2 Properties
3496 =head3 Unary Properties
3498 =over
3500 =item * Emptiness
3502 The following functions test whether the given set or relation
3503 contains any integer points.  The ``plain'' variants do not perform
3504 any computations, but simply check if the given set or relation
3505 is already known to be empty.
3507         int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
3508         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
3509         int isl_set_plain_is_empty(__isl_keep isl_set *set);
3510         int isl_set_is_empty(__isl_keep isl_set *set);
3511         int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
3512         int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
3513         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
3514         int isl_map_plain_is_empty(__isl_keep isl_map *map);
3515         int isl_map_is_empty(__isl_keep isl_map *map);
3516         int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
3518 =item * Universality
3520         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
3521         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
3522         int isl_set_plain_is_universe(__isl_keep isl_set *set);
3524 =item * Single-valuedness
3526         #include <isl/set.h>
3527         int isl_set_is_singleton(__isl_keep isl_set *set);
3529         #include <isl/map.h>
3530         int isl_basic_map_is_single_valued(
3531                 __isl_keep isl_basic_map *bmap);
3532         int isl_map_plain_is_single_valued(
3533                 __isl_keep isl_map *map);
3534         int isl_map_is_single_valued(__isl_keep isl_map *map);
3536         #include <isl/union_map.h>
3537         int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
3539 =item * Injectivity
3541         int isl_map_plain_is_injective(__isl_keep isl_map *map);
3542         int isl_map_is_injective(__isl_keep isl_map *map);
3543         int isl_union_map_plain_is_injective(
3544                 __isl_keep isl_union_map *umap);
3545         int isl_union_map_is_injective(
3546                 __isl_keep isl_union_map *umap);
3548 =item * Bijectivity
3550         int isl_map_is_bijective(__isl_keep isl_map *map);
3551         int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
3553 =item * Position
3555         __isl_give isl_val *
3556         isl_basic_map_plain_get_val_if_fixed(
3557                 __isl_keep isl_basic_map *bmap,
3558                 enum isl_dim_type type, unsigned pos);
3559         __isl_give isl_val *isl_set_plain_get_val_if_fixed(
3560                 __isl_keep isl_set *set,
3561                 enum isl_dim_type type, unsigned pos);
3562         __isl_give isl_val *isl_map_plain_get_val_if_fixed(
3563                 __isl_keep isl_map *map,
3564                 enum isl_dim_type type, unsigned pos);
3566 If the set or relation obviously lies on a hyperplane where the given dimension
3567 has a fixed value, then return that value.
3568 Otherwise return NaN.
3570 =item * Stride
3572         int isl_set_dim_residue_class_val(
3573                 __isl_keep isl_set *set,
3574                 int pos, __isl_give isl_val **modulo,
3575                 __isl_give isl_val **residue);
3577 Check if the values of the given set dimension are equal to a fixed
3578 value modulo some integer value.  If so, assign the modulo to C<*modulo>
3579 and the fixed value to C<*residue>.  If the given dimension attains only
3580 a single value, then assign C<0> to C<*modulo> and the fixed value to
3581 C<*residue>.
3582 If the dimension does not attain only a single value and if no modulo
3583 can be found then assign C<1> to C<*modulo> and C<1> to C<*residue>.
3585 =item * Dependence
3587 To check whether the description of a set, relation or function depends
3588 on one or more given dimensions,
3589 the following functions can be used.
3591         #include <isl/constraint.h>
3592         int isl_constraint_involves_dims(
3593                 __isl_keep isl_constraint *constraint,
3594                 enum isl_dim_type type, unsigned first, unsigned n);
3596         #include <isl/set.h>
3597         int isl_basic_set_involves_dims(
3598                 __isl_keep isl_basic_set *bset,
3599                 enum isl_dim_type type, unsigned first, unsigned n);
3600         int isl_set_involves_dims(__isl_keep isl_set *set,
3601                 enum isl_dim_type type, unsigned first, unsigned n);
3603         #include <isl/map.h>
3604         int isl_basic_map_involves_dims(
3605                 __isl_keep isl_basic_map *bmap,
3606                 enum isl_dim_type type, unsigned first, unsigned n);
3607         int isl_map_involves_dims(__isl_keep isl_map *map,
3608                 enum isl_dim_type type, unsigned first, unsigned n);
3610         #include <isl/union_map.h>
3611         int isl_union_map_involves_dims(
3612                 __isl_keep isl_union_map *umap,
3613                 enum isl_dim_type type, unsigned first, unsigned n);
3615         #include <isl/aff.h>
3616         int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3617                 enum isl_dim_type type, unsigned first, unsigned n);
3618         int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3619                 enum isl_dim_type type, unsigned first, unsigned n);
3620         int isl_multi_aff_involves_dims(
3621                 __isl_keep isl_multi_aff *ma,
3622                 enum isl_dim_type type, unsigned first, unsigned n);
3623         int isl_multi_pw_aff_involves_dims(
3624                 __isl_keep isl_multi_pw_aff *mpa,
3625                 enum isl_dim_type type, unsigned first, unsigned n);
3627 Similarly, the following functions can be used to check whether
3628 a given dimension is involved in any lower or upper bound.
3630         #include <isl/set.h>
3631         int isl_set_dim_has_any_lower_bound(__isl_keep isl_set *set,
3632                 enum isl_dim_type type, unsigned pos);
3633         int isl_set_dim_has_any_upper_bound(__isl_keep isl_set *set,
3634                 enum isl_dim_type type, unsigned pos);
3636 Note that these functions return true even if there is a bound on
3637 the dimension on only some of the basic sets of C<set>.
3638 To check if they have a bound for all of the basic sets in C<set>,
3639 use the following functions instead.
3641         #include <isl/set.h>
3642         int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
3643                 enum isl_dim_type type, unsigned pos);
3644         int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
3645                 enum isl_dim_type type, unsigned pos);
3647 =item * Space
3649 To check whether a set is a parameter domain, use this function:
3651         int isl_set_is_params(__isl_keep isl_set *set);
3652         int isl_union_set_is_params(
3653                 __isl_keep isl_union_set *uset);
3655 =item * Wrapping
3657 The following functions check whether the space of the given
3658 (basic) set or relation range is a wrapped relation.
3660         #include <isl/space.h>
3661         int isl_space_is_wrapping(
3662                 __isl_keep isl_space *space);
3663         int isl_space_domain_is_wrapping(
3664                 __isl_keep isl_space *space);
3665         int isl_space_range_is_wrapping(
3666                 __isl_keep isl_space *space);
3668         #include <isl/set.h>
3669         int isl_basic_set_is_wrapping(
3670                 __isl_keep isl_basic_set *bset);
3671         int isl_set_is_wrapping(__isl_keep isl_set *set);
3673         #include <isl/map.h>
3674         int isl_map_domain_is_wrapping(
3675                 __isl_keep isl_map *map);
3676         int isl_map_range_is_wrapping(
3677                 __isl_keep isl_map *map);
3679         #include <isl/val.h>
3680         int isl_multi_val_range_is_wrapping(
3681                 __isl_keep isl_multi_val *mv);
3683         #include <isl/aff.h>
3684         int isl_multi_aff_range_is_wrapping(
3685                 __isl_keep isl_multi_aff *ma);
3686         int isl_multi_pw_aff_range_is_wrapping(
3687                 __isl_keep isl_multi_pw_aff *mpa);
3688         int isl_multi_union_pw_aff_range_is_wrapping(
3689                 __isl_keep isl_multi_union_pw_aff *mupa);
3691 The input to C<isl_space_is_wrapping> should
3692 be the space of a set, while that of
3693 C<isl_space_domain_is_wrapping> and
3694 C<isl_space_range_is_wrapping> should be the space of a relation.
3696 =item * Internal Product
3698         int isl_basic_map_can_zip(
3699                 __isl_keep isl_basic_map *bmap);
3700         int isl_map_can_zip(__isl_keep isl_map *map);
3702 Check whether the product of domain and range of the given relation
3703 can be computed,
3704 i.e., whether both domain and range are nested relations.
3706 =item * Currying
3708         int isl_basic_map_can_curry(
3709                 __isl_keep isl_basic_map *bmap);
3710         int isl_map_can_curry(__isl_keep isl_map *map);
3712 Check whether the domain of the (basic) relation is a wrapped relation.
3714         int isl_basic_map_can_uncurry(
3715                 __isl_keep isl_basic_map *bmap);
3716         int isl_map_can_uncurry(__isl_keep isl_map *map);
3718 Check whether the range of the (basic) relation is a wrapped relation.
3720 =item * Special Values
3722         #include <isl/aff.h>
3723         int isl_aff_is_cst(__isl_keep isl_aff *aff);
3724         int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3726 Check whether the given expression is a constant.
3728         #include <isl/aff.h>
3729         int isl_aff_is_nan(__isl_keep isl_aff *aff);
3730         int isl_pw_aff_involves_nan(__isl_keep isl_pw_aff *pa);
3732 Check whether the given expression is equal to or involves NaN.
3734         #include <isl/aff.h>
3735         int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3737 Check whether the affine expression is obviously zero.
3739 =back
3741 =head3 Binary Properties
3743 =over
3745 =item * Equality
3747 The following functions check whether two objects
3748 represent the same set, relation or function.
3749 The C<plain> variants only return true if the objects
3750 are obviously the same.  That is, they may return false
3751 even if the objects are the same, but they will never
3752 return true if the objects are not the same.
3754         #include <isl/set.h>
3755         int isl_basic_set_plain_is_equal(
3756                 __isl_keep isl_basic_set *bset1,
3757                 __isl_keep isl_basic_set *bset2);
3758         int isl_set_plain_is_equal(__isl_keep isl_set *set1,
3759                 __isl_keep isl_set *set2);
3760         int isl_set_is_equal(__isl_keep isl_set *set1,
3761                 __isl_keep isl_set *set2);
3763         #include <isl/map.h>
3764         int isl_basic_map_is_equal(
3765                 __isl_keep isl_basic_map *bmap1,
3766                 __isl_keep isl_basic_map *bmap2);
3767         int isl_map_is_equal(__isl_keep isl_map *map1,
3768                 __isl_keep isl_map *map2);
3769         int isl_map_plain_is_equal(__isl_keep isl_map *map1,
3770                 __isl_keep isl_map *map2);
3772         #include <isl/union_set.h>
3773         int isl_union_set_is_equal(
3774                 __isl_keep isl_union_set *uset1,
3775                 __isl_keep isl_union_set *uset2);
3777         #include <isl/union_map.h>
3778         int isl_union_map_is_equal(
3779                 __isl_keep isl_union_map *umap1,
3780                 __isl_keep isl_union_map *umap2);
3782         #include <isl/aff.h>
3783         int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3784                 __isl_keep isl_aff *aff2);
3785         int isl_multi_aff_plain_is_equal(
3786                 __isl_keep isl_multi_aff *maff1,
3787                 __isl_keep isl_multi_aff *maff2);
3788         int isl_pw_aff_plain_is_equal(
3789                 __isl_keep isl_pw_aff *pwaff1,
3790                 __isl_keep isl_pw_aff *pwaff2);
3791         int isl_pw_multi_aff_plain_is_equal(
3792                 __isl_keep isl_pw_multi_aff *pma1,
3793                 __isl_keep isl_pw_multi_aff *pma2);
3794         int isl_multi_pw_aff_plain_is_equal(
3795                 __isl_keep isl_multi_pw_aff *mpa1,
3796                 __isl_keep isl_multi_pw_aff *mpa2);
3797         int isl_multi_pw_aff_is_equal(
3798                 __isl_keep isl_multi_pw_aff *mpa1,
3799                 __isl_keep isl_multi_pw_aff *mpa2);
3800         int isl_union_pw_aff_plain_is_equal(
3801                 __isl_keep isl_union_pw_aff *upa1,
3802                 __isl_keep isl_union_pw_aff *upa2);
3803         int isl_union_pw_multi_aff_plain_is_equal(
3804                 __isl_keep isl_union_pw_multi_aff *upma1,
3805                 __isl_keep isl_union_pw_multi_aff *upma2);
3806         int isl_multi_union_pw_aff_plain_is_equal(
3807                 __isl_keep isl_multi_union_pw_aff *mupa1,
3808                 __isl_keep isl_multi_union_pw_aff *mupa2);
3810         #include <isl/polynomial.h>
3811         int isl_union_pw_qpolynomial_plain_is_equal(
3812                 __isl_keep isl_union_pw_qpolynomial *upwqp1,
3813                 __isl_keep isl_union_pw_qpolynomial *upwqp2);
3814         int isl_union_pw_qpolynomial_fold_plain_is_equal(
3815                 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
3816                 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
3818 =item * Disjointness
3820         #include <isl/set.h>
3821         int isl_basic_set_is_disjoint(
3822                 __isl_keep isl_basic_set *bset1,
3823                 __isl_keep isl_basic_set *bset2);
3824         int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
3825                 __isl_keep isl_set *set2);
3826         int isl_set_is_disjoint(__isl_keep isl_set *set1,
3827                 __isl_keep isl_set *set2);
3829         #include <isl/map.h>
3830         int isl_basic_map_is_disjoint(
3831                 __isl_keep isl_basic_map *bmap1,
3832                 __isl_keep isl_basic_map *bmap2);
3833         int isl_map_is_disjoint(__isl_keep isl_map *map1,
3834                 __isl_keep isl_map *map2);
3836         #include <isl/union_set.h>
3837         int isl_union_set_is_disjoint(
3838                 __isl_keep isl_union_set *uset1,
3839                 __isl_keep isl_union_set *uset2);
3841         #include <isl/union_map.h>
3842         int isl_union_map_is_disjoint(
3843                 __isl_keep isl_union_map *umap1,
3844                 __isl_keep isl_union_map *umap2);
3846 =item * Subset
3848         int isl_basic_set_is_subset(
3849                 __isl_keep isl_basic_set *bset1,
3850                 __isl_keep isl_basic_set *bset2);
3851         int isl_set_is_subset(__isl_keep isl_set *set1,
3852                 __isl_keep isl_set *set2);
3853         int isl_set_is_strict_subset(
3854                 __isl_keep isl_set *set1,
3855                 __isl_keep isl_set *set2);
3856         int isl_union_set_is_subset(
3857                 __isl_keep isl_union_set *uset1,
3858                 __isl_keep isl_union_set *uset2);
3859         int isl_union_set_is_strict_subset(
3860                 __isl_keep isl_union_set *uset1,
3861                 __isl_keep isl_union_set *uset2);
3862         int isl_basic_map_is_subset(
3863                 __isl_keep isl_basic_map *bmap1,
3864                 __isl_keep isl_basic_map *bmap2);
3865         int isl_basic_map_is_strict_subset(
3866                 __isl_keep isl_basic_map *bmap1,
3867                 __isl_keep isl_basic_map *bmap2);
3868         int isl_map_is_subset(
3869                 __isl_keep isl_map *map1,
3870                 __isl_keep isl_map *map2);
3871         int isl_map_is_strict_subset(
3872                 __isl_keep isl_map *map1,
3873                 __isl_keep isl_map *map2);
3874         int isl_union_map_is_subset(
3875                 __isl_keep isl_union_map *umap1,
3876                 __isl_keep isl_union_map *umap2);
3877         int isl_union_map_is_strict_subset(
3878                 __isl_keep isl_union_map *umap1,
3879                 __isl_keep isl_union_map *umap2);
3881 Check whether the first argument is a (strict) subset of the
3882 second argument.
3884 =item * Order
3886 Every comparison function returns a negative value if the first
3887 argument is considered smaller than the second, a positive value
3888 if the first argument is considered greater and zero if the two
3889 constraints are considered the same by the comparison criterion.
3891         #include <isl/constraint.h>
3892         int isl_constraint_plain_cmp(
3893                 __isl_keep isl_constraint *c1,
3894                 __isl_keep isl_constraint *c2);
3896 This function is useful for sorting C<isl_constraint>s.
3897 The order depends on the internal representation of the inputs.
3898 The order is fixed over different calls to the function (assuming
3899 the internal representation of the inputs has not changed), but may
3900 change over different versions of C<isl>.
3902         #include <isl/constraint.h>
3903         int isl_constraint_cmp_last_non_zero(
3904                 __isl_keep isl_constraint *c1,
3905                 __isl_keep isl_constraint *c2);
3907 This function can be used to sort constraints that live in the same
3908 local space.  Constraints that involve ``earlier'' dimensions or
3909 that have a smaller coefficient for the shared latest dimension
3910 are considered smaller than other constraints.
3911 This function only defines a B<partial> order.
3913         #include <isl/set.h>
3914         int isl_set_plain_cmp(__isl_keep isl_set *set1,
3915                 __isl_keep isl_set *set2);
3917 This function is useful for sorting C<isl_set>s.
3918 The order depends on the internal representation of the inputs.
3919 The order is fixed over different calls to the function (assuming
3920 the internal representation of the inputs has not changed), but may
3921 change over different versions of C<isl>.
3923         #include <isl/aff.h>
3924         int isl_pw_aff_plain_cmp(__isl_keep isl_pw_aff *pa1,
3925                 __isl_keep isl_pw_aff *pa2);
3927 The function C<isl_pw_aff_plain_cmp> can be used to sort
3928 C<isl_pw_aff>s.  The order is not strictly defined.
3929 The current order sorts expressions that only involve
3930 earlier dimensions before those that involve later dimensions.
3932 =back
3934 =head2 Unary Operations
3936 =over
3938 =item * Complement
3940         __isl_give isl_set *isl_set_complement(
3941                 __isl_take isl_set *set);
3942         __isl_give isl_map *isl_map_complement(
3943                 __isl_take isl_map *map);
3945 =item * Inverse map
3947         #include <isl/space.h>
3948         __isl_give isl_space *isl_space_reverse(
3949                 __isl_take isl_space *space);
3951         #include <isl/map.h>
3952         __isl_give isl_basic_map *isl_basic_map_reverse(
3953                 __isl_take isl_basic_map *bmap);
3954         __isl_give isl_map *isl_map_reverse(
3955                 __isl_take isl_map *map);
3957         #include <isl/union_map.h>
3958         __isl_give isl_union_map *isl_union_map_reverse(
3959                 __isl_take isl_union_map *umap);
3961 =item * Projection
3963         #include <isl/space.h>
3964         __isl_give isl_space *isl_space_domain(
3965                 __isl_take isl_space *space);
3966         __isl_give isl_space *isl_space_range(
3967                 __isl_take isl_space *space);
3968         __isl_give isl_space *isl_space_params(
3969                 __isl_take isl_space *space);
3971         #include <isl/local_space.h>
3972         __isl_give isl_local_space *isl_local_space_domain(
3973                 __isl_take isl_local_space *ls);
3974         __isl_give isl_local_space *isl_local_space_range(
3975                 __isl_take isl_local_space *ls);
3977         #include <isl/set.h>
3978         __isl_give isl_basic_set *isl_basic_set_project_out(
3979                 __isl_take isl_basic_set *bset,
3980                 enum isl_dim_type type, unsigned first, unsigned n);
3981         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
3982                 enum isl_dim_type type, unsigned first, unsigned n);
3983         __isl_give isl_basic_set *isl_basic_set_params(
3984                 __isl_take isl_basic_set *bset);
3985         __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
3987         #include <isl/map.h>
3988         __isl_give isl_basic_map *isl_basic_map_project_out(
3989                 __isl_take isl_basic_map *bmap,
3990                 enum isl_dim_type type, unsigned first, unsigned n);
3991         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
3992                 enum isl_dim_type type, unsigned first, unsigned n);
3993         __isl_give isl_basic_set *isl_basic_map_domain(
3994                 __isl_take isl_basic_map *bmap);
3995         __isl_give isl_basic_set *isl_basic_map_range(
3996                 __isl_take isl_basic_map *bmap);
3997         __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
3998         __isl_give isl_set *isl_map_domain(
3999                 __isl_take isl_map *bmap);
4000         __isl_give isl_set *isl_map_range(
4001                 __isl_take isl_map *map);
4003         #include <isl/union_set.h>
4004         __isl_give isl_union_set *isl_union_set_project_out(
4005                 __isl_take isl_union_set *uset,
4006                 enum isl_dim_type type,
4007                 unsigned first, unsigned n);
4008         __isl_give isl_set *isl_union_set_params(
4009                 __isl_take isl_union_set *uset);
4011 The function C<isl_union_set_project_out> can only project out
4012 parameters.
4014         #include <isl/union_map.h>
4015         __isl_give isl_union_map *isl_union_map_project_out(
4016                 __isl_take isl_union_map *umap,
4017                 enum isl_dim_type type, unsigned first, unsigned n);
4018         __isl_give isl_set *isl_union_map_params(
4019                 __isl_take isl_union_map *umap);
4020         __isl_give isl_union_set *isl_union_map_domain(
4021                 __isl_take isl_union_map *umap);
4022         __isl_give isl_union_set *isl_union_map_range(
4023                 __isl_take isl_union_map *umap);
4025 The function C<isl_union_map_project_out> can only project out
4026 parameters.
4028         #include <isl/aff.h>
4029         __isl_give isl_aff *isl_aff_project_domain_on_params(
4030                 __isl_take isl_aff *aff);
4031         __isl_give isl_pw_multi_aff *
4032         isl_pw_multi_aff_project_domain_on_params(
4033                 __isl_take isl_pw_multi_aff *pma);
4034         __isl_give isl_set *isl_pw_aff_domain(
4035                 __isl_take isl_pw_aff *pwaff);
4036         __isl_give isl_set *isl_pw_multi_aff_domain(
4037                 __isl_take isl_pw_multi_aff *pma);
4038         __isl_give isl_set *isl_multi_pw_aff_domain(
4039                 __isl_take isl_multi_pw_aff *mpa);
4040         __isl_give isl_union_set *isl_union_pw_aff_domain(
4041                 __isl_take isl_union_pw_aff *upa);
4042         __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
4043                 __isl_take isl_union_pw_multi_aff *upma);
4044         __isl_give isl_set *isl_pw_aff_params(
4045                 __isl_take isl_pw_aff *pwa);
4047         #include <isl/polynomial.h>
4048         __isl_give isl_qpolynomial *
4049         isl_qpolynomial_project_domain_on_params(
4050                 __isl_take isl_qpolynomial *qp);
4051         __isl_give isl_pw_qpolynomial *
4052         isl_pw_qpolynomial_project_domain_on_params(
4053                 __isl_take isl_pw_qpolynomial *pwqp);
4054         __isl_give isl_pw_qpolynomial_fold *
4055         isl_pw_qpolynomial_fold_project_domain_on_params(
4056                 __isl_take isl_pw_qpolynomial_fold *pwf);
4057         __isl_give isl_set *isl_pw_qpolynomial_domain(
4058                 __isl_take isl_pw_qpolynomial *pwqp);
4059         __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
4060                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4061         __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4062                 __isl_take isl_union_pw_qpolynomial *upwqp);
4064         #include <isl/space.h>
4065         __isl_give isl_space *isl_space_domain_map(
4066                 __isl_take isl_space *space);
4067         __isl_give isl_space *isl_space_range_map(
4068                 __isl_take isl_space *space);
4070         #include <isl/map.h>
4071         __isl_give isl_map *isl_set_wrapped_domain_map(
4072                 __isl_take isl_set *set);
4073         __isl_give isl_basic_map *isl_basic_map_domain_map(
4074                 __isl_take isl_basic_map *bmap);
4075         __isl_give isl_basic_map *isl_basic_map_range_map(
4076                 __isl_take isl_basic_map *bmap);
4077         __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
4078         __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
4080         #include <isl/union_map.h>
4081         __isl_give isl_union_map *isl_union_map_domain_map(
4082                 __isl_take isl_union_map *umap);
4083         __isl_give isl_union_pw_multi_aff *
4084         isl_union_map_domain_map_union_pw_multi_aff(
4085                 __isl_take isl_union_map *umap);
4086         __isl_give isl_union_map *isl_union_map_range_map(
4087                 __isl_take isl_union_map *umap);
4088         __isl_give isl_union_map *
4089         isl_union_set_wrapped_domain_map(
4090                 __isl_take isl_union_set *uset);
4092 The functions above construct a (basic, regular or union) relation
4093 that maps (a wrapped version of) the input relation to its domain or range.
4094 C<isl_set_wrapped_domain_map> maps the input set to the domain
4095 of its wrapped relation.
4097 =item * Elimination
4099         __isl_give isl_basic_set *isl_basic_set_eliminate(
4100                 __isl_take isl_basic_set *bset,
4101                 enum isl_dim_type type,
4102                 unsigned first, unsigned n);
4103         __isl_give isl_set *isl_set_eliminate(
4104                 __isl_take isl_set *set, enum isl_dim_type type,
4105                 unsigned first, unsigned n);
4106         __isl_give isl_basic_map *isl_basic_map_eliminate(
4107                 __isl_take isl_basic_map *bmap,
4108                 enum isl_dim_type type,
4109                 unsigned first, unsigned n);
4110         __isl_give isl_map *isl_map_eliminate(
4111                 __isl_take isl_map *map, enum isl_dim_type type,
4112                 unsigned first, unsigned n);
4114 Eliminate the coefficients for the given dimensions from the constraints,
4115 without removing the dimensions.
4117 =item * Constructing a set from a parameter domain
4119 A zero-dimensional space or (basic) set can be constructed
4120 on a given parameter domain using the following functions.
4122         #include <isl/space.h>
4123         __isl_give isl_space *isl_space_set_from_params(
4124                 __isl_take isl_space *space);
4126         #include <isl/set.h>
4127         __isl_give isl_basic_set *isl_basic_set_from_params(
4128                 __isl_take isl_basic_set *bset);
4129         __isl_give isl_set *isl_set_from_params(
4130                 __isl_take isl_set *set);
4132 =item * Constructing a relation from a set
4134 Create a relation with the given set as domain or range.
4135 The range or domain of the created relation is a zero-dimensional
4136 flat anonymous space.
4138         #include <isl/space.h>
4139         __isl_give isl_space *isl_space_from_domain(
4140                 __isl_take isl_space *space);
4141         __isl_give isl_space *isl_space_from_range(
4142                 __isl_take isl_space *space);
4143         __isl_give isl_space *isl_space_map_from_set(
4144                 __isl_take isl_space *space);
4145         __isl_give isl_space *isl_space_map_from_domain_and_range(
4146                 __isl_take isl_space *domain,
4147                 __isl_take isl_space *range);
4149         #include <isl/local_space.h>
4150         __isl_give isl_local_space *isl_local_space_from_domain(
4151                 __isl_take isl_local_space *ls);
4153         #include <isl/map.h>
4154         __isl_give isl_map *isl_map_from_domain(
4155                 __isl_take isl_set *set);
4156         __isl_give isl_map *isl_map_from_range(
4157                 __isl_take isl_set *set);
4159         #include <isl/val.h>
4160         __isl_give isl_multi_val *isl_multi_val_from_range(
4161                 __isl_take isl_multi_val *mv);
4163         #include <isl/aff.h>
4164         __isl_give isl_multi_aff *isl_multi_aff_from_range(
4165                 __isl_take isl_multi_aff *ma);
4166         __isl_give isl_pw_aff *isl_pw_aff_from_range(
4167                 __isl_take isl_pw_aff *pwa);
4168         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_range(
4169                 __isl_take isl_multi_pw_aff *mpa);
4170         __isl_give isl_multi_union_pw_aff *
4171         isl_multi_union_pw_aff_from_range(
4172                 __isl_take isl_multi_union_pw_aff *mupa);
4173         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
4174                 __isl_take isl_set *set);
4175         __isl_give isl_union_pw_multi_aff *
4176         isl_union_pw_multi_aff_from_domain(
4177                 __isl_take isl_union_set *uset);
4179 =item * Slicing
4181         #include <isl/set.h>
4182         __isl_give isl_basic_set *isl_basic_set_fix_si(
4183                 __isl_take isl_basic_set *bset,
4184                 enum isl_dim_type type, unsigned pos, int value);
4185         __isl_give isl_basic_set *isl_basic_set_fix_val(
4186                 __isl_take isl_basic_set *bset,
4187                 enum isl_dim_type type, unsigned pos,
4188                 __isl_take isl_val *v);
4189         __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
4190                 enum isl_dim_type type, unsigned pos, int value);
4191         __isl_give isl_set *isl_set_fix_val(
4192                 __isl_take isl_set *set,
4193                 enum isl_dim_type type, unsigned pos,
4194                 __isl_take isl_val *v);
4196         #include <isl/map.h>
4197         __isl_give isl_basic_map *isl_basic_map_fix_si(
4198                 __isl_take isl_basic_map *bmap,
4199                 enum isl_dim_type type, unsigned pos, int value);
4200         __isl_give isl_basic_map *isl_basic_map_fix_val(
4201                 __isl_take isl_basic_map *bmap,
4202                 enum isl_dim_type type, unsigned pos,
4203                 __isl_take isl_val *v);
4204         __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
4205                 enum isl_dim_type type, unsigned pos, int value);
4206         __isl_give isl_map *isl_map_fix_val(
4207                 __isl_take isl_map *map,
4208                 enum isl_dim_type type, unsigned pos,
4209                 __isl_take isl_val *v);
4211         #include <isl/aff.h>
4212         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_fix_si(
4213                 __isl_take isl_pw_multi_aff *pma,
4214                 enum isl_dim_type type, unsigned pos, int value);
4216         #include <isl/polynomial.h>
4217         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_fix_val(
4218                 __isl_take isl_pw_qpolynomial *pwqp,
4219                 enum isl_dim_type type, unsigned n,
4220                 __isl_take isl_val *v);
4222 Intersect the set, relation or function domain
4223 with the hyperplane where the given
4224 dimension has the fixed given value.
4226         __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
4227                 __isl_take isl_basic_map *bmap,
4228                 enum isl_dim_type type, unsigned pos, int value);
4229         __isl_give isl_basic_map *isl_basic_map_upper_bound_si(
4230                 __isl_take isl_basic_map *bmap,
4231                 enum isl_dim_type type, unsigned pos, int value);
4232         __isl_give isl_set *isl_set_lower_bound_si(
4233                 __isl_take isl_set *set,
4234                 enum isl_dim_type type, unsigned pos, int value);
4235         __isl_give isl_set *isl_set_lower_bound_val(
4236                 __isl_take isl_set *set,
4237                 enum isl_dim_type type, unsigned pos,
4238                 __isl_take isl_val *value);
4239         __isl_give isl_map *isl_map_lower_bound_si(
4240                 __isl_take isl_map *map,
4241                 enum isl_dim_type type, unsigned pos, int value);
4242         __isl_give isl_set *isl_set_upper_bound_si(
4243                 __isl_take isl_set *set,
4244                 enum isl_dim_type type, unsigned pos, int value);
4245         __isl_give isl_set *isl_set_upper_bound_val(
4246                 __isl_take isl_set *set,
4247                 enum isl_dim_type type, unsigned pos,
4248                 __isl_take isl_val *value);
4249         __isl_give isl_map *isl_map_upper_bound_si(
4250                 __isl_take isl_map *map,
4251                 enum isl_dim_type type, unsigned pos, int value);
4253 Intersect the set or relation with the half-space where the given
4254 dimension has a value bounded by the fixed given integer value.
4256         __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
4257                 enum isl_dim_type type1, int pos1,
4258                 enum isl_dim_type type2, int pos2);
4259         __isl_give isl_basic_map *isl_basic_map_equate(
4260                 __isl_take isl_basic_map *bmap,
4261                 enum isl_dim_type type1, int pos1,
4262                 enum isl_dim_type type2, int pos2);
4263         __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
4264                 enum isl_dim_type type1, int pos1,
4265                 enum isl_dim_type type2, int pos2);
4267 Intersect the set or relation with the hyperplane where the given
4268 dimensions are equal to each other.
4270         __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
4271                 enum isl_dim_type type1, int pos1,
4272                 enum isl_dim_type type2, int pos2);
4274 Intersect the relation with the hyperplane where the given
4275 dimensions have opposite values.
4277         __isl_give isl_map *isl_map_order_le(
4278                 __isl_take isl_map *map,
4279                 enum isl_dim_type type1, int pos1,
4280                 enum isl_dim_type type2, int pos2);
4281         __isl_give isl_basic_map *isl_basic_map_order_ge(
4282                 __isl_take isl_basic_map *bmap,
4283                 enum isl_dim_type type1, int pos1,
4284                 enum isl_dim_type type2, int pos2);
4285         __isl_give isl_map *isl_map_order_ge(
4286                 __isl_take isl_map *map,
4287                 enum isl_dim_type type1, int pos1,
4288                 enum isl_dim_type type2, int pos2);
4289         __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
4290                 enum isl_dim_type type1, int pos1,
4291                 enum isl_dim_type type2, int pos2);
4292         __isl_give isl_basic_map *isl_basic_map_order_gt(
4293                 __isl_take isl_basic_map *bmap,
4294                 enum isl_dim_type type1, int pos1,
4295                 enum isl_dim_type type2, int pos2);
4296         __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
4297                 enum isl_dim_type type1, int pos1,
4298                 enum isl_dim_type type2, int pos2);
4300 Intersect the relation with the half-space where the given
4301 dimensions satisfy the given ordering.
4303 =item * Locus
4305         #include <isl/aff.h>
4306         __isl_give isl_basic_set *isl_aff_zero_basic_set(
4307                 __isl_take isl_aff *aff);
4308         __isl_give isl_basic_set *isl_aff_neg_basic_set(
4309                 __isl_take isl_aff *aff);
4310         __isl_give isl_set *isl_pw_aff_pos_set(
4311                 __isl_take isl_pw_aff *pa);
4312         __isl_give isl_set *isl_pw_aff_nonneg_set(
4313                 __isl_take isl_pw_aff *pwaff);
4314         __isl_give isl_set *isl_pw_aff_zero_set(
4315                 __isl_take isl_pw_aff *pwaff);
4316         __isl_give isl_set *isl_pw_aff_non_zero_set(
4317                 __isl_take isl_pw_aff *pwaff);
4318         __isl_give isl_union_set *
4319         isl_union_pw_aff_zero_union_set(
4320                 __isl_take isl_union_pw_aff *upa);
4321         __isl_give isl_union_set *
4322         isl_multi_union_pw_aff_zero_union_set(
4323                 __isl_take isl_multi_union_pw_aff *mupa);
4325 The function C<isl_aff_neg_basic_set> returns a basic set
4326 containing those elements in the domain space
4327 of C<aff> where C<aff> is negative.
4328 The function C<isl_pw_aff_nonneg_set> returns a set
4329 containing those elements in the domain
4330 of C<pwaff> where C<pwaff> is non-negative.
4331 The function C<isl_multi_union_pw_aff_zero_union_set>
4332 returns a union set containing those elements
4333 in the domains of its elements where they are all zero.
4335 =item * Identity
4337         __isl_give isl_map *isl_set_identity(
4338                 __isl_take isl_set *set);
4339         __isl_give isl_union_map *isl_union_set_identity(
4340                 __isl_take isl_union_set *uset);
4341         __isl_give isl_union_pw_multi_aff *
4342         isl_union_set_identity_union_pw_multi_aff(
4343                 __isl_take isl_union_set *uset);
4345 Construct an identity relation on the given (union) set.
4347 =item * Function Extraction
4349 A piecewise quasi affine expression that is equal to 1 on a set
4350 and 0 outside the set can be created using the following function.
4352         #include <isl/aff.h>
4353         __isl_give isl_pw_aff *isl_set_indicator_function(
4354                 __isl_take isl_set *set);
4356 A piecewise multiple quasi affine expression can be extracted
4357 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
4358 and the C<isl_map> is single-valued.
4359 In case of a conversion from an C<isl_union_map>
4360 to an C<isl_union_pw_multi_aff>, these properties need to hold
4361 in each domain space.
4362 A conversion to a C<isl_multi_union_pw_aff> additionally
4363 requires that the input is non-empty and involves only a single
4364 range space.
4366         #include <isl/aff.h>
4367         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
4368                 __isl_take isl_set *set);
4369         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
4370                 __isl_take isl_map *map);
4372         __isl_give isl_union_pw_multi_aff *
4373         isl_union_pw_multi_aff_from_union_set(
4374                 __isl_take isl_union_set *uset);
4375         __isl_give isl_union_pw_multi_aff *
4376         isl_union_pw_multi_aff_from_union_map(
4377                 __isl_take isl_union_map *umap);
4379         __isl_give isl_multi_union_pw_aff *
4380         isl_multi_union_pw_aff_from_union_map(
4381                 __isl_take isl_union_map *umap);
4383 =item * Deltas
4385         __isl_give isl_basic_set *isl_basic_map_deltas(
4386                 __isl_take isl_basic_map *bmap);
4387         __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
4388         __isl_give isl_union_set *isl_union_map_deltas(
4389                 __isl_take isl_union_map *umap);
4391 These functions return a (basic) set containing the differences
4392 between image elements and corresponding domain elements in the input.
4394         __isl_give isl_basic_map *isl_basic_map_deltas_map(
4395                 __isl_take isl_basic_map *bmap);
4396         __isl_give isl_map *isl_map_deltas_map(
4397                 __isl_take isl_map *map);
4398         __isl_give isl_union_map *isl_union_map_deltas_map(
4399                 __isl_take isl_union_map *umap);
4401 The functions above construct a (basic, regular or union) relation
4402 that maps (a wrapped version of) the input relation to its delta set.
4404 =item * Coalescing
4406 Simplify the representation of a set, relation or functions by trying
4407 to combine pairs of basic sets or relations into a single
4408 basic set or relation.
4410         #include <isl/set.h>
4411         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
4413         #include <isl/map.h>
4414         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
4416         #include <isl/union_set.h>
4417         __isl_give isl_union_set *isl_union_set_coalesce(
4418                 __isl_take isl_union_set *uset);
4420         #include <isl/union_map.h>
4421         __isl_give isl_union_map *isl_union_map_coalesce(
4422                 __isl_take isl_union_map *umap);
4424         #include <isl/aff.h>
4425         __isl_give isl_pw_aff *isl_pw_aff_coalesce(
4426                 __isl_take isl_pw_aff *pwqp);
4427         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
4428                 __isl_take isl_pw_multi_aff *pma);
4429         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_coalesce(
4430                 __isl_take isl_multi_pw_aff *mpa);
4431         __isl_give isl_union_pw_aff *isl_union_pw_aff_coalesce(
4432                 __isl_take isl_union_pw_aff *upa);
4433         __isl_give isl_union_pw_multi_aff *
4434         isl_union_pw_multi_aff_coalesce(
4435                 __isl_take isl_union_pw_multi_aff *upma);
4437         #include <isl/polynomial.h>
4438         __isl_give isl_pw_qpolynomial_fold *
4439         isl_pw_qpolynomial_fold_coalesce(
4440                 __isl_take isl_pw_qpolynomial_fold *pwf);
4441         __isl_give isl_union_pw_qpolynomial *
4442         isl_union_pw_qpolynomial_coalesce(
4443                 __isl_take isl_union_pw_qpolynomial *upwqp);
4444         __isl_give isl_union_pw_qpolynomial_fold *
4445         isl_union_pw_qpolynomial_fold_coalesce(
4446                 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4448 One of the methods for combining pairs of basic sets or relations
4449 can result in coefficients that are much larger than those that appear
4450 in the constraints of the input.  By default, the coefficients are
4451 not allowed to grow larger, but this can be changed by unsetting
4452 the following option.
4454         int isl_options_set_coalesce_bounded_wrapping(
4455                 isl_ctx *ctx, int val);
4456         int isl_options_get_coalesce_bounded_wrapping(
4457                 isl_ctx *ctx);
4459 =item * Detecting equalities
4461         __isl_give isl_basic_set *isl_basic_set_detect_equalities(
4462                 __isl_take isl_basic_set *bset);
4463         __isl_give isl_basic_map *isl_basic_map_detect_equalities(
4464                 __isl_take isl_basic_map *bmap);
4465         __isl_give isl_set *isl_set_detect_equalities(
4466                 __isl_take isl_set *set);
4467         __isl_give isl_map *isl_map_detect_equalities(
4468                 __isl_take isl_map *map);
4469         __isl_give isl_union_set *isl_union_set_detect_equalities(
4470                 __isl_take isl_union_set *uset);
4471         __isl_give isl_union_map *isl_union_map_detect_equalities(
4472                 __isl_take isl_union_map *umap);
4474 Simplify the representation of a set or relation by detecting implicit
4475 equalities.
4477 =item * Removing redundant constraints
4479         #include <isl/set.h>
4480         __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
4481                 __isl_take isl_basic_set *bset);
4482         __isl_give isl_set *isl_set_remove_redundancies(
4483                 __isl_take isl_set *set);
4485         #include <isl/union_set.h>
4486         __isl_give isl_union_set *
4487         isl_union_set_remove_redundancies(
4488                 __isl_take isl_union_set *uset);
4490         #include <isl/map.h>
4491         __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
4492                 __isl_take isl_basic_map *bmap);
4493         __isl_give isl_map *isl_map_remove_redundancies(
4494                 __isl_take isl_map *map);
4496         #include <isl/union_map.h>
4497         __isl_give isl_union_map *
4498         isl_union_map_remove_redundancies(
4499                 __isl_take isl_union_map *umap);
4501 =item * Convex hull
4503         __isl_give isl_basic_set *isl_set_convex_hull(
4504                 __isl_take isl_set *set);
4505         __isl_give isl_basic_map *isl_map_convex_hull(
4506                 __isl_take isl_map *map);
4508 If the input set or relation has any existentially quantified
4509 variables, then the result of these operations is currently undefined.
4511 =item * Simple hull
4513         #include <isl/set.h>
4514         __isl_give isl_basic_set *
4515         isl_set_unshifted_simple_hull(
4516                 __isl_take isl_set *set);
4517         __isl_give isl_basic_set *isl_set_simple_hull(
4518                 __isl_take isl_set *set);
4519         __isl_give isl_basic_set *
4520         isl_set_unshifted_simple_hull_from_set_list(
4521                 __isl_take isl_set *set,
4522                 __isl_take isl_set_list *list);
4524         #include <isl/map.h>
4525         __isl_give isl_basic_map *
4526         isl_map_unshifted_simple_hull(
4527                 __isl_take isl_map *map);
4528         __isl_give isl_basic_map *isl_map_simple_hull(
4529                 __isl_take isl_map *map);
4530         __isl_give isl_basic_map *
4531         isl_map_unshifted_simple_hull_from_map_list(
4532                 __isl_take isl_map *map,
4533                 __isl_take isl_map_list *list);
4535         #include <isl/union_map.h>
4536         __isl_give isl_union_map *isl_union_map_simple_hull(
4537                 __isl_take isl_union_map *umap);
4539 These functions compute a single basic set or relation
4540 that contains the whole input set or relation.
4541 In particular, the output is described by translates
4542 of the constraints describing the basic sets or relations in the input.
4543 In case of C<isl_set_unshifted_simple_hull>, only the original
4544 constraints are used, without any translation.
4545 In case of C<isl_set_unshifted_simple_hull_from_set_list> and
4546 C<isl_map_unshifted_simple_hull_from_map_list>, the
4547 constraints are taken from the elements of the second argument.
4549 =begin latex
4551 (See \autoref{s:simple hull}.)
4553 =end latex
4555 =item * Affine hull
4557         __isl_give isl_basic_set *isl_basic_set_affine_hull(
4558                 __isl_take isl_basic_set *bset);
4559         __isl_give isl_basic_set *isl_set_affine_hull(
4560                 __isl_take isl_set *set);
4561         __isl_give isl_union_set *isl_union_set_affine_hull(
4562                 __isl_take isl_union_set *uset);
4563         __isl_give isl_basic_map *isl_basic_map_affine_hull(
4564                 __isl_take isl_basic_map *bmap);
4565         __isl_give isl_basic_map *isl_map_affine_hull(
4566                 __isl_take isl_map *map);
4567         __isl_give isl_union_map *isl_union_map_affine_hull(
4568                 __isl_take isl_union_map *umap);
4570 In case of union sets and relations, the affine hull is computed
4571 per space.
4573 =item * Polyhedral hull
4575         __isl_give isl_basic_set *isl_set_polyhedral_hull(
4576                 __isl_take isl_set *set);
4577         __isl_give isl_basic_map *isl_map_polyhedral_hull(
4578                 __isl_take isl_map *map);
4579         __isl_give isl_union_set *isl_union_set_polyhedral_hull(
4580                 __isl_take isl_union_set *uset);
4581         __isl_give isl_union_map *isl_union_map_polyhedral_hull(
4582                 __isl_take isl_union_map *umap);
4584 These functions compute a single basic set or relation
4585 not involving any existentially quantified variables
4586 that contains the whole input set or relation.
4587 In case of union sets and relations, the polyhedral hull is computed
4588 per space.
4590 =item * Other approximations
4592         #include <isl/set.h>
4593         __isl_give isl_basic_set *
4594         isl_basic_set_drop_constraints_involving_dims(
4595                 __isl_take isl_basic_set *bset,
4596                 enum isl_dim_type type,
4597                 unsigned first, unsigned n);
4598         __isl_give isl_basic_set *
4599         isl_basic_set_drop_constraints_not_involving_dims(
4600                 __isl_take isl_basic_set *bset,
4601                 enum isl_dim_type type,
4602                 unsigned first, unsigned n);
4603         __isl_give isl_set *
4604         isl_set_drop_constraints_involving_dims(
4605                 __isl_take isl_set *set,
4606                 enum isl_dim_type type,
4607                 unsigned first, unsigned n);
4609         #include <isl/map.h>
4610         __isl_give isl_basic_map *
4611         isl_basic_map_drop_constraints_involving_dims(
4612                 __isl_take isl_basic_map *bmap,
4613                 enum isl_dim_type type,
4614                 unsigned first, unsigned n);
4615         __isl_give isl_map *
4616         isl_map_drop_constraints_involving_dims(
4617                 __isl_take isl_map *map,
4618                 enum isl_dim_type type,
4619                 unsigned first, unsigned n);
4621 These functions drop any constraints (not) involving the specified dimensions.
4622 Note that the result depends on the representation of the input.
4624         #include <isl/polynomial.h>
4625         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4626                 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4627         __isl_give isl_union_pw_qpolynomial *
4628         isl_union_pw_qpolynomial_to_polynomial(
4629                 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4631 Approximate each quasipolynomial by a polynomial.  If C<sign> is positive,
4632 the polynomial will be an overapproximation.  If C<sign> is negative,
4633 it will be an underapproximation.  If C<sign> is zero, the approximation
4634 will lie somewhere in between.
4636 =item * Feasibility
4638         __isl_give isl_basic_set *isl_basic_set_sample(
4639                 __isl_take isl_basic_set *bset);
4640         __isl_give isl_basic_set *isl_set_sample(
4641                 __isl_take isl_set *set);
4642         __isl_give isl_basic_map *isl_basic_map_sample(
4643                 __isl_take isl_basic_map *bmap);
4644         __isl_give isl_basic_map *isl_map_sample(
4645                 __isl_take isl_map *map);
4647 If the input (basic) set or relation is non-empty, then return
4648 a singleton subset of the input.  Otherwise, return an empty set.
4650 =item * Optimization
4652         #include <isl/ilp.h>
4653         __isl_give isl_val *isl_basic_set_max_val(
4654                 __isl_keep isl_basic_set *bset,
4655                 __isl_keep isl_aff *obj);
4656         __isl_give isl_val *isl_set_min_val(
4657                 __isl_keep isl_set *set,
4658                 __isl_keep isl_aff *obj);
4659         __isl_give isl_val *isl_set_max_val(
4660                 __isl_keep isl_set *set,
4661                 __isl_keep isl_aff *obj);
4663 Compute the minimum or maximum of the integer affine expression C<obj>
4664 over the points in C<set>, returning the result in C<opt>.
4665 The result is C<NULL> in case of an error, the optimal value in case
4666 there is one, negative infinity or infinity if the problem is unbounded and
4667 NaN if the problem is empty.
4669 =item * Parametric optimization
4671         __isl_give isl_pw_aff *isl_set_dim_min(
4672                 __isl_take isl_set *set, int pos);
4673         __isl_give isl_pw_aff *isl_set_dim_max(
4674                 __isl_take isl_set *set, int pos);
4675         __isl_give isl_pw_aff *isl_map_dim_max(
4676                 __isl_take isl_map *map, int pos);
4678 Compute the minimum or maximum of the given set or output dimension
4679 as a function of the parameters (and input dimensions), but independently
4680 of the other set or output dimensions.
4681 For lexicographic optimization, see L<"Lexicographic Optimization">.
4683 =item * Dual
4685 The following functions compute either the set of (rational) coefficient
4686 values of valid constraints for the given set or the set of (rational)
4687 values satisfying the constraints with coefficients from the given set.
4688 Internally, these two sets of functions perform essentially the
4689 same operations, except that the set of coefficients is assumed to
4690 be a cone, while the set of values may be any polyhedron.
4691 The current implementation is based on the Farkas lemma and
4692 Fourier-Motzkin elimination, but this may change or be made optional
4693 in future.  In particular, future implementations may use different
4694 dualization algorithms or skip the elimination step.
4696         __isl_give isl_basic_set *isl_basic_set_coefficients(
4697                 __isl_take isl_basic_set *bset);
4698         __isl_give isl_basic_set *isl_set_coefficients(
4699                 __isl_take isl_set *set);
4700         __isl_give isl_union_set *isl_union_set_coefficients(
4701                 __isl_take isl_union_set *bset);
4702         __isl_give isl_basic_set *isl_basic_set_solutions(
4703                 __isl_take isl_basic_set *bset);
4704         __isl_give isl_basic_set *isl_set_solutions(
4705                 __isl_take isl_set *set);
4706         __isl_give isl_union_set *isl_union_set_solutions(
4707                 __isl_take isl_union_set *bset);
4709 =item * Power
4711         __isl_give isl_map *isl_map_fixed_power_val(
4712                 __isl_take isl_map *map,
4713                 __isl_take isl_val *exp);
4714         __isl_give isl_union_map *
4715         isl_union_map_fixed_power_val(
4716                 __isl_take isl_union_map *umap,
4717                 __isl_take isl_val *exp);
4719 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
4720 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
4721 of C<map> is computed.
4723         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
4724                 int *exact);
4725         __isl_give isl_union_map *isl_union_map_power(
4726                 __isl_take isl_union_map *umap, int *exact);
4728 Compute a parametric representation for all positive powers I<k> of C<map>.
4729 The result maps I<k> to a nested relation corresponding to the
4730 I<k>th power of C<map>.
4731 The result may be an overapproximation.  If the result is known to be exact,
4732 then C<*exact> is set to C<1>.
4734 =item * Transitive closure
4736         __isl_give isl_map *isl_map_transitive_closure(
4737                 __isl_take isl_map *map, int *exact);
4738         __isl_give isl_union_map *isl_union_map_transitive_closure(
4739                 __isl_take isl_union_map *umap, int *exact);
4741 Compute the transitive closure of C<map>.
4742 The result may be an overapproximation.  If the result is known to be exact,
4743 then C<*exact> is set to C<1>.
4745 =item * Reaching path lengths
4747         __isl_give isl_map *isl_map_reaching_path_lengths(
4748                 __isl_take isl_map *map, int *exact);
4750 Compute a relation that maps each element in the range of C<map>
4751 to the lengths of all paths composed of edges in C<map> that
4752 end up in the given element.
4753 The result may be an overapproximation.  If the result is known to be exact,
4754 then C<*exact> is set to C<1>.
4755 To compute the I<maximal> path length, the resulting relation
4756 should be postprocessed by C<isl_map_lexmax>.
4757 In particular, if the input relation is a dependence relation
4758 (mapping sources to sinks), then the maximal path length corresponds
4759 to the free schedule.
4760 Note, however, that C<isl_map_lexmax> expects the maximum to be
4761 finite, so if the path lengths are unbounded (possibly due to
4762 the overapproximation), then you will get an error message.
4764 =item * Wrapping
4766         #include <isl/space.h>
4767         __isl_give isl_space *isl_space_wrap(
4768                 __isl_take isl_space *space);
4769         __isl_give isl_space *isl_space_unwrap(
4770                 __isl_take isl_space *space);
4772         #include <isl/local_space.h>
4773         __isl_give isl_local_space *isl_local_space_wrap(
4774                 __isl_take isl_local_space *ls);
4776         #include <isl/set.h>
4777         __isl_give isl_basic_map *isl_basic_set_unwrap(
4778                 __isl_take isl_basic_set *bset);
4779         __isl_give isl_map *isl_set_unwrap(
4780                 __isl_take isl_set *set);
4782         #include <isl/map.h>
4783         __isl_give isl_basic_set *isl_basic_map_wrap(
4784                 __isl_take isl_basic_map *bmap);
4785         __isl_give isl_set *isl_map_wrap(
4786                 __isl_take isl_map *map);
4788         #include <isl/union_set.h>
4789         __isl_give isl_union_map *isl_union_set_unwrap(
4790                 __isl_take isl_union_set *uset);
4792         #include <isl/union_map.h>
4793         __isl_give isl_union_set *isl_union_map_wrap(
4794                 __isl_take isl_union_map *umap);
4796 The input to C<isl_space_unwrap> should
4797 be the space of a set, while that of
4798 C<isl_space_wrap> should be the space of a relation.
4799 Conversely, the output of C<isl_space_unwrap> is the space
4800 of a relation, while that of C<isl_space_wrap> is the space of a set.
4802 =item * Flattening
4804 Remove any internal structure of domain (and range) of the given
4805 set or relation.  If there is any such internal structure in the input,
4806 then the name of the space is also removed.
4808         #include <isl/local_space.h>
4809         __isl_give isl_local_space *
4810         isl_local_space_flatten_domain(
4811                 __isl_take isl_local_space *ls);
4812         __isl_give isl_local_space *
4813         isl_local_space_flatten_range(
4814                 __isl_take isl_local_space *ls);
4816         #include <isl/set.h>
4817         __isl_give isl_basic_set *isl_basic_set_flatten(
4818                 __isl_take isl_basic_set *bset);
4819         __isl_give isl_set *isl_set_flatten(
4820                 __isl_take isl_set *set);
4822         #include <isl/map.h>
4823         __isl_give isl_basic_map *isl_basic_map_flatten_domain(
4824                 __isl_take isl_basic_map *bmap);
4825         __isl_give isl_basic_map *isl_basic_map_flatten_range(
4826                 __isl_take isl_basic_map *bmap);
4827         __isl_give isl_map *isl_map_flatten_range(
4828                 __isl_take isl_map *map);
4829         __isl_give isl_map *isl_map_flatten_domain(
4830                 __isl_take isl_map *map);
4831         __isl_give isl_basic_map *isl_basic_map_flatten(
4832                 __isl_take isl_basic_map *bmap);
4833         __isl_give isl_map *isl_map_flatten(
4834                 __isl_take isl_map *map);
4836         #include <isl/val.h>
4837         __isl_give isl_multi_val *isl_multi_val_flatten_range(
4838                 __isl_take isl_multi_val *mv);
4840         #include <isl/aff.h>
4841         __isl_give isl_multi_aff *isl_multi_aff_flatten_domain(
4842                 __isl_take isl_multi_aff *ma);
4843         __isl_give isl_multi_aff *isl_multi_aff_flatten_range(
4844                 __isl_take isl_multi_aff *ma);
4845         __isl_give isl_multi_pw_aff *
4846         isl_multi_pw_aff_flatten_range(
4847                 __isl_take isl_multi_pw_aff *mpa);
4848         __isl_give isl_multi_union_pw_aff *
4849         isl_multi_union_pw_aff_flatten_range(
4850                 __isl_take isl_multi_union_pw_aff *mupa);
4852         #include <isl/map.h>
4853         __isl_give isl_map *isl_set_flatten_map(
4854                 __isl_take isl_set *set);
4856 The function above constructs a relation
4857 that maps the input set to a flattened version of the set.
4859 =item * Lifting
4861 Lift the input set to a space with extra dimensions corresponding
4862 to the existentially quantified variables in the input.
4863 In particular, the result lives in a wrapped map where the domain
4864 is the original space and the range corresponds to the original
4865 existentially quantified variables.
4867         #include <isl/set.h>
4868         __isl_give isl_basic_set *isl_basic_set_lift(
4869                 __isl_take isl_basic_set *bset);
4870         __isl_give isl_set *isl_set_lift(
4871                 __isl_take isl_set *set);
4872         __isl_give isl_union_set *isl_union_set_lift(
4873                 __isl_take isl_union_set *uset);
4875 Given a local space that contains the existentially quantified
4876 variables of a set, a basic relation that, when applied to
4877 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
4878 can be constructed using the following function.
4880         #include <isl/local_space.h>
4881         __isl_give isl_basic_map *isl_local_space_lifting(
4882                 __isl_take isl_local_space *ls);
4884         #include <isl/aff.h>
4885         __isl_give isl_multi_aff *isl_multi_aff_lift(
4886                 __isl_take isl_multi_aff *maff,
4887                 __isl_give isl_local_space **ls);
4889 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
4890 then it is assigned the local space that lies at the basis of
4891 the lifting applied.
4893 =item * Internal Product
4895         #include <isl/space.h>
4896         __isl_give isl_space *isl_space_zip(
4897                 __isl_take isl_space *space);
4899         #include <isl/map.h>
4900         __isl_give isl_basic_map *isl_basic_map_zip(
4901                 __isl_take isl_basic_map *bmap);
4902         __isl_give isl_map *isl_map_zip(
4903                 __isl_take isl_map *map);
4905         #include <isl/union_map.h>
4906         __isl_give isl_union_map *isl_union_map_zip(
4907                 __isl_take isl_union_map *umap);
4909 Given a relation with nested relations for domain and range,
4910 interchange the range of the domain with the domain of the range.
4912 =item * Currying
4914         #include <isl/space.h>
4915         __isl_give isl_space *isl_space_curry(
4916                 __isl_take isl_space *space);
4917         __isl_give isl_space *isl_space_uncurry(
4918                 __isl_take isl_space *space);
4920         #include <isl/map.h>
4921         __isl_give isl_basic_map *isl_basic_map_curry(
4922                 __isl_take isl_basic_map *bmap);
4923         __isl_give isl_basic_map *isl_basic_map_uncurry(
4924                 __isl_take isl_basic_map *bmap);
4925         __isl_give isl_map *isl_map_curry(
4926                 __isl_take isl_map *map);
4927         __isl_give isl_map *isl_map_uncurry(
4928                 __isl_take isl_map *map);
4930         #include <isl/union_map.h>
4931         __isl_give isl_union_map *isl_union_map_curry(
4932                 __isl_take isl_union_map *umap);
4933         __isl_give isl_union_map *isl_union_map_uncurry(
4934                 __isl_take isl_union_map *umap);
4936 Given a relation with a nested relation for domain,
4937 the C<curry> functions
4938 move the range of the nested relation out of the domain
4939 and use it as the domain of a nested relation in the range,
4940 with the original range as range of this nested relation.
4941 The C<uncurry> functions perform the inverse operation.
4943 =item * Aligning parameters
4945 Change the order of the parameters of the given set, relation
4946 or function
4947 such that the first parameters match those of C<model>.
4948 This may involve the introduction of extra parameters.
4949 All parameters need to be named.
4951         #include <isl/space.h>
4952         __isl_give isl_space *isl_space_align_params(
4953                 __isl_take isl_space *space1,
4954                 __isl_take isl_space *space2)
4956         #include <isl/set.h>
4957         __isl_give isl_basic_set *isl_basic_set_align_params(
4958                 __isl_take isl_basic_set *bset,
4959                 __isl_take isl_space *model);
4960         __isl_give isl_set *isl_set_align_params(
4961                 __isl_take isl_set *set,
4962                 __isl_take isl_space *model);
4964         #include <isl/map.h>
4965         __isl_give isl_basic_map *isl_basic_map_align_params(
4966                 __isl_take isl_basic_map *bmap,
4967                 __isl_take isl_space *model);
4968         __isl_give isl_map *isl_map_align_params(
4969                 __isl_take isl_map *map,
4970                 __isl_take isl_space *model);
4972         #include <isl/val.h>
4973         __isl_give isl_multi_val *isl_multi_val_align_params(
4974                 __isl_take isl_multi_val *mv,
4975                 __isl_take isl_space *model);
4977         #include <isl/aff.h>
4978         __isl_give isl_aff *isl_aff_align_params(
4979                 __isl_take isl_aff *aff,
4980                 __isl_take isl_space *model);
4981         __isl_give isl_multi_aff *isl_multi_aff_align_params(
4982                 __isl_take isl_multi_aff *multi,
4983                 __isl_take isl_space *model);
4984         __isl_give isl_pw_aff *isl_pw_aff_align_params(
4985                 __isl_take isl_pw_aff *pwaff,
4986                 __isl_take isl_space *model);
4987         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
4988                 __isl_take isl_pw_multi_aff *pma,
4989                 __isl_take isl_space *model);
4990         __isl_give isl_union_pw_aff *
4991         isl_union_pw_aff_align_params(
4992                 __isl_take isl_union_pw_aff *upa,
4993                 __isl_take isl_space *model);
4994         __isl_give isl_union_pw_multi_aff *
4995         isl_union_pw_multi_aff_align_params(
4996                 __isl_take isl_union_pw_multi_aff *upma,
4997                 __isl_take isl_space *model);
4998         __isl_give isl_multi_union_pw_aff *
4999         isl_multi_union_pw_aff_align_params(
5000                 __isl_take isl_multi_union_pw_aff *mupa,
5001                 __isl_take isl_space *model);
5003         #include <isl/polynomial.h>
5004         __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
5005                 __isl_take isl_qpolynomial *qp,
5006                 __isl_take isl_space *model);
5008 =item * Unary Arithmethic Operations
5010         #include <isl/val.h>
5011         __isl_give isl_multi_val *isl_multi_val_neg(
5012                 __isl_take isl_multi_val *mv);
5014         #include <isl/aff.h>
5015         __isl_give isl_aff *isl_aff_neg(
5016                 __isl_take isl_aff *aff);
5017         __isl_give isl_multi_aff *isl_multi_aff_neg(
5018                 __isl_take isl_multi_aff *ma);
5019         __isl_give isl_pw_aff *isl_pw_aff_neg(
5020                 __isl_take isl_pw_aff *pwaff);
5021         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_neg(
5022                 __isl_take isl_pw_multi_aff *pma);
5023         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_neg(
5024                 __isl_take isl_multi_pw_aff *mpa);
5025         __isl_give isl_union_pw_aff *isl_union_pw_aff_neg(
5026                 __isl_take isl_union_pw_aff *upa);
5027         __isl_give isl_union_pw_multi_aff *
5028         isl_union_pw_multi_aff_neg(
5029                 __isl_take isl_union_pw_multi_aff *upma);
5030         __isl_give isl_multi_union_pw_aff *
5031         isl_multi_union_pw_aff_neg(
5032                 __isl_take isl_multi_union_pw_aff *mupa);
5033         __isl_give isl_aff *isl_aff_ceil(
5034                 __isl_take isl_aff *aff);
5035         __isl_give isl_pw_aff *isl_pw_aff_ceil(
5036                 __isl_take isl_pw_aff *pwaff);
5037         __isl_give isl_aff *isl_aff_floor(
5038                 __isl_take isl_aff *aff);
5039         __isl_give isl_multi_aff *isl_multi_aff_floor(
5040                 __isl_take isl_multi_aff *ma);
5041         __isl_give isl_pw_aff *isl_pw_aff_floor(
5042                 __isl_take isl_pw_aff *pwaff);
5043         __isl_give isl_union_pw_aff *isl_union_pw_aff_floor(
5044                 __isl_take isl_union_pw_aff *upa);
5046         #include <isl/aff.h>
5047         __isl_give isl_pw_aff *isl_pw_aff_list_min(
5048                 __isl_take isl_pw_aff_list *list);
5049         __isl_give isl_pw_aff *isl_pw_aff_list_max(
5050                 __isl_take isl_pw_aff_list *list);
5052         #include <isl/polynomial.h>
5053         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
5054                 __isl_take isl_qpolynomial *qp);
5055         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
5056                 __isl_take isl_pw_qpolynomial *pwqp);
5057         __isl_give isl_union_pw_qpolynomial *
5058         isl_union_pw_qpolynomial_neg(
5059                 __isl_take isl_union_pw_qpolynomial *upwqp);
5060         __isl_give isl_qpolynomial *isl_qpolynomial_pow(
5061                 __isl_take isl_qpolynomial *qp,
5062                 unsigned exponent);
5063         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
5064                 __isl_take isl_pw_qpolynomial *pwqp,
5065                 unsigned exponent);
5067 =item * Evaluation
5069 The following functions evaluate a function in a point.
5071         #include <isl/polynomial.h>
5072         __isl_give isl_val *isl_pw_qpolynomial_eval(
5073                 __isl_take isl_pw_qpolynomial *pwqp,
5074                 __isl_take isl_point *pnt);
5075         __isl_give isl_val *isl_pw_qpolynomial_fold_eval(
5076                 __isl_take isl_pw_qpolynomial_fold *pwf,
5077                 __isl_take isl_point *pnt);
5078         __isl_give isl_val *isl_union_pw_qpolynomial_eval(
5079                 __isl_take isl_union_pw_qpolynomial *upwqp,
5080                 __isl_take isl_point *pnt);
5081         __isl_give isl_val *isl_union_pw_qpolynomial_fold_eval(
5082                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5083                 __isl_take isl_point *pnt);
5085 =item * Dimension manipulation
5087 It is usually not advisable to directly change the (input or output)
5088 space of a set or a relation as this removes the name and the internal
5089 structure of the space.  However, the functions below can be useful
5090 to add new parameters, assuming
5091 C<isl_set_align_params> and C<isl_map_align_params>
5092 are not sufficient.
5094         #include <isl/space.h>
5095         __isl_give isl_space *isl_space_add_dims(
5096                 __isl_take isl_space *space,
5097                 enum isl_dim_type type, unsigned n);
5098         __isl_give isl_space *isl_space_insert_dims(
5099                 __isl_take isl_space *space,
5100                 enum isl_dim_type type, unsigned pos, unsigned n);
5101         __isl_give isl_space *isl_space_drop_dims(
5102                 __isl_take isl_space *space,
5103                 enum isl_dim_type type, unsigned first, unsigned n);
5104         __isl_give isl_space *isl_space_move_dims(
5105                 __isl_take isl_space *space,
5106                 enum isl_dim_type dst_type, unsigned dst_pos,
5107                 enum isl_dim_type src_type, unsigned src_pos,
5108                 unsigned n);
5110         #include <isl/local_space.h>
5111         __isl_give isl_local_space *isl_local_space_add_dims(
5112                 __isl_take isl_local_space *ls,
5113                 enum isl_dim_type type, unsigned n);
5114         __isl_give isl_local_space *isl_local_space_insert_dims(
5115                 __isl_take isl_local_space *ls,
5116                 enum isl_dim_type type, unsigned first, unsigned n);
5117         __isl_give isl_local_space *isl_local_space_drop_dims(
5118                 __isl_take isl_local_space *ls,
5119                 enum isl_dim_type type, unsigned first, unsigned n);
5121         #include <isl/set.h>
5122         __isl_give isl_basic_set *isl_basic_set_add_dims(
5123                 __isl_take isl_basic_set *bset,
5124                 enum isl_dim_type type, unsigned n);
5125         __isl_give isl_set *isl_set_add_dims(
5126                 __isl_take isl_set *set,
5127                 enum isl_dim_type type, unsigned n);
5128         __isl_give isl_basic_set *isl_basic_set_insert_dims(
5129                 __isl_take isl_basic_set *bset,
5130                 enum isl_dim_type type, unsigned pos,
5131                 unsigned n);
5132         __isl_give isl_set *isl_set_insert_dims(
5133                 __isl_take isl_set *set,
5134                 enum isl_dim_type type, unsigned pos, unsigned n);
5135         __isl_give isl_basic_set *isl_basic_set_move_dims(
5136                 __isl_take isl_basic_set *bset,
5137                 enum isl_dim_type dst_type, unsigned dst_pos,
5138                 enum isl_dim_type src_type, unsigned src_pos,
5139                 unsigned n);
5140         __isl_give isl_set *isl_set_move_dims(
5141                 __isl_take isl_set *set,
5142                 enum isl_dim_type dst_type, unsigned dst_pos,
5143                 enum isl_dim_type src_type, unsigned src_pos,
5144                 unsigned n);
5146         #include <isl/map.h>
5147         __isl_give isl_map *isl_map_add_dims(
5148                 __isl_take isl_map *map,
5149                 enum isl_dim_type type, unsigned n);
5150         __isl_give isl_basic_map *isl_basic_map_insert_dims(
5151                 __isl_take isl_basic_map *bmap,
5152                 enum isl_dim_type type, unsigned pos,
5153                 unsigned n);
5154         __isl_give isl_map *isl_map_insert_dims(
5155                 __isl_take isl_map *map,
5156                 enum isl_dim_type type, unsigned pos, unsigned n);
5157         __isl_give isl_basic_map *isl_basic_map_move_dims(
5158                 __isl_take isl_basic_map *bmap,
5159                 enum isl_dim_type dst_type, unsigned dst_pos,
5160                 enum isl_dim_type src_type, unsigned src_pos,
5161                 unsigned n);
5162         __isl_give isl_map *isl_map_move_dims(
5163                 __isl_take isl_map *map,
5164                 enum isl_dim_type dst_type, unsigned dst_pos,
5165                 enum isl_dim_type src_type, unsigned src_pos,
5166                 unsigned n);
5168         #include <isl/val.h>
5169         __isl_give isl_multi_val *isl_multi_val_insert_dims(
5170                 __isl_take isl_multi_val *mv,
5171                 enum isl_dim_type type, unsigned first, unsigned n);
5172         __isl_give isl_multi_val *isl_multi_val_add_dims(
5173                 __isl_take isl_multi_val *mv,
5174                 enum isl_dim_type type, unsigned n);
5175         __isl_give isl_multi_val *isl_multi_val_drop_dims(
5176                 __isl_take isl_multi_val *mv,
5177                 enum isl_dim_type type, unsigned first, unsigned n);
5179         #include <isl/aff.h>
5180         __isl_give isl_aff *isl_aff_insert_dims(
5181                 __isl_take isl_aff *aff,
5182                 enum isl_dim_type type, unsigned first, unsigned n);
5183         __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
5184                 __isl_take isl_multi_aff *ma,
5185                 enum isl_dim_type type, unsigned first, unsigned n);
5186         __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
5187                 __isl_take isl_pw_aff *pwaff,
5188                 enum isl_dim_type type, unsigned first, unsigned n);
5189         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
5190                 __isl_take isl_multi_pw_aff *mpa,
5191                 enum isl_dim_type type, unsigned first, unsigned n);
5192         __isl_give isl_aff *isl_aff_add_dims(
5193                 __isl_take isl_aff *aff,
5194                 enum isl_dim_type type, unsigned n);
5195         __isl_give isl_multi_aff *isl_multi_aff_add_dims(
5196                 __isl_take isl_multi_aff *ma,
5197                 enum isl_dim_type type, unsigned n);
5198         __isl_give isl_pw_aff *isl_pw_aff_add_dims(
5199                 __isl_take isl_pw_aff *pwaff,
5200                 enum isl_dim_type type, unsigned n);
5201         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
5202                 __isl_take isl_multi_pw_aff *mpa,
5203                 enum isl_dim_type type, unsigned n);
5204         __isl_give isl_aff *isl_aff_drop_dims(
5205                 __isl_take isl_aff *aff,
5206                 enum isl_dim_type type, unsigned first, unsigned n);
5207         __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
5208                 __isl_take isl_multi_aff *maff,
5209                 enum isl_dim_type type, unsigned first, unsigned n);
5210         __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
5211                 __isl_take isl_pw_aff *pwaff,
5212                 enum isl_dim_type type, unsigned first, unsigned n);
5213         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
5214                 __isl_take isl_pw_multi_aff *pma,
5215                 enum isl_dim_type type, unsigned first, unsigned n);
5216         __isl_give isl_union_pw_aff *isl_union_pw_aff_drop_dims(
5217                 __isl_take isl_union_pw_aff *upa,
5218                 enum isl_dim_type type, unsigned first, unsigned n);
5219         __isl_give isl_union_pw_multi_aff *
5220                 isl_union_pw_multi_aff_drop_dims(
5221                 __isl_take isl_union_pw_multi_aff *upma,
5222                 enum isl_dim_type type,
5223                 unsigned first, unsigned n);
5224         __isl_give isl_multi_union_pw_aff *
5225         isl_multi_union_pw_aff_drop_dims(
5226                 __isl_take isl_multi_union_pw_aff *mupa,
5227                 enum isl_dim_type type, unsigned first,
5228                 unsigned n);
5229         __isl_give isl_aff *isl_aff_move_dims(
5230                 __isl_take isl_aff *aff,
5231                 enum isl_dim_type dst_type, unsigned dst_pos,
5232                 enum isl_dim_type src_type, unsigned src_pos,
5233                 unsigned n);
5234         __isl_give isl_multi_aff *isl_multi_aff_move_dims(
5235                 __isl_take isl_multi_aff *ma,
5236                 enum isl_dim_type dst_type, unsigned dst_pos,
5237                 enum isl_dim_type src_type, unsigned src_pos,
5238                 unsigned n);
5239         __isl_give isl_pw_aff *isl_pw_aff_move_dims(
5240                 __isl_take isl_pw_aff *pa,
5241                 enum isl_dim_type dst_type, unsigned dst_pos,
5242                 enum isl_dim_type src_type, unsigned src_pos,
5243                 unsigned n);
5244         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_move_dims(
5245                 __isl_take isl_multi_pw_aff *pma,
5246                 enum isl_dim_type dst_type, unsigned dst_pos,
5247                 enum isl_dim_type src_type, unsigned src_pos,
5248                 unsigned n);
5250         #include <isl/polynomial.h>
5251         __isl_give isl_union_pw_qpolynomial *
5252         isl_union_pw_qpolynomial_drop_dims(
5253                 __isl_take isl_union_pw_qpolynomial *upwqp,
5254                 enum isl_dim_type type,
5255                 unsigned first, unsigned n);
5256         __isl_give isl_union_pw_qpolynomial_fold *
5257                 isl_union_pw_qpolynomial_fold_drop_dims(
5258                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5259                 enum isl_dim_type type,
5260                 unsigned first, unsigned n);
5262 The operations on union expressions can only manipulate parameters.
5264 =back
5266 =head2 Binary Operations
5268 The two arguments of a binary operation not only need to live
5269 in the same C<isl_ctx>, they currently also need to have
5270 the same (number of) parameters.
5272 =head3 Basic Operations
5274 =over
5276 =item * Intersection
5278         #include <isl/local_space.h>
5279         __isl_give isl_local_space *isl_local_space_intersect(
5280                 __isl_take isl_local_space *ls1,
5281                 __isl_take isl_local_space *ls2);
5283         #include <isl/set.h>
5284         __isl_give isl_basic_set *isl_basic_set_intersect_params(
5285                 __isl_take isl_basic_set *bset1,
5286                 __isl_take isl_basic_set *bset2);
5287         __isl_give isl_basic_set *isl_basic_set_intersect(
5288                 __isl_take isl_basic_set *bset1,
5289                 __isl_take isl_basic_set *bset2);
5290         __isl_give isl_basic_set *isl_basic_set_list_intersect(
5291                 __isl_take struct isl_basic_set_list *list);
5292         __isl_give isl_set *isl_set_intersect_params(
5293                 __isl_take isl_set *set,
5294                 __isl_take isl_set *params);
5295         __isl_give isl_set *isl_set_intersect(
5296                 __isl_take isl_set *set1,
5297                 __isl_take isl_set *set2);
5299         #include <isl/map.h>
5300         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
5301                 __isl_take isl_basic_map *bmap,
5302                 __isl_take isl_basic_set *bset);
5303         __isl_give isl_basic_map *isl_basic_map_intersect_range(
5304                 __isl_take isl_basic_map *bmap,
5305                 __isl_take isl_basic_set *bset);
5306         __isl_give isl_basic_map *isl_basic_map_intersect(
5307                 __isl_take isl_basic_map *bmap1,
5308                 __isl_take isl_basic_map *bmap2);
5309         __isl_give isl_basic_map *isl_basic_map_list_intersect(
5310                 __isl_take isl_basic_map_list *list);
5311         __isl_give isl_map *isl_map_intersect_params(
5312                 __isl_take isl_map *map,
5313                 __isl_take isl_set *params);
5314         __isl_give isl_map *isl_map_intersect_domain(
5315                 __isl_take isl_map *map,
5316                 __isl_take isl_set *set);
5317         __isl_give isl_map *isl_map_intersect_range(
5318                 __isl_take isl_map *map,
5319                 __isl_take isl_set *set);
5320         __isl_give isl_map *isl_map_intersect(
5321                 __isl_take isl_map *map1,
5322                 __isl_take isl_map *map2);
5324         #include <isl/union_set.h>
5325         __isl_give isl_union_set *isl_union_set_intersect_params(
5326                 __isl_take isl_union_set *uset,
5327                 __isl_take isl_set *set);
5328         __isl_give isl_union_set *isl_union_set_intersect(
5329                 __isl_take isl_union_set *uset1,
5330                 __isl_take isl_union_set *uset2);
5332         #include <isl/union_map.h>
5333         __isl_give isl_union_map *isl_union_map_intersect_params(
5334                 __isl_take isl_union_map *umap,
5335                 __isl_take isl_set *set);
5336         __isl_give isl_union_map *isl_union_map_intersect_domain(
5337                 __isl_take isl_union_map *umap,
5338                 __isl_take isl_union_set *uset);
5339         __isl_give isl_union_map *isl_union_map_intersect_range(
5340                 __isl_take isl_union_map *umap,
5341                 __isl_take isl_union_set *uset);
5342         __isl_give isl_union_map *isl_union_map_intersect(
5343                 __isl_take isl_union_map *umap1,
5344                 __isl_take isl_union_map *umap2);
5346         #include <isl/aff.h>
5347         __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
5348                 __isl_take isl_pw_aff *pa,
5349                 __isl_take isl_set *set);
5350         __isl_give isl_multi_pw_aff *
5351         isl_multi_pw_aff_intersect_domain(
5352                 __isl_take isl_multi_pw_aff *mpa,
5353                 __isl_take isl_set *domain);
5354         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
5355                 __isl_take isl_pw_multi_aff *pma,
5356                 __isl_take isl_set *set);
5357         __isl_give isl_union_pw_aff *isl_union_pw_aff_intersect_domain(
5358                 __isl_take isl_union_pw_aff *upa,
5359                 __isl_take isl_union_set *uset);
5360         __isl_give isl_union_pw_multi_aff *
5361         isl_union_pw_multi_aff_intersect_domain(
5362                 __isl_take isl_union_pw_multi_aff *upma,
5363                 __isl_take isl_union_set *uset);
5364         __isl_give isl_multi_union_pw_aff *
5365         isl_multi_union_pw_aff_intersect_domain(
5366                 __isl_take isl_multi_union_pw_aff *mupa,
5367                 __isl_take isl_union_set *uset);
5368         __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
5369                 __isl_take isl_pw_aff *pa,
5370                 __isl_take isl_set *set);
5371         __isl_give isl_multi_pw_aff *
5372         isl_multi_pw_aff_intersect_params(
5373                 __isl_take isl_multi_pw_aff *mpa,
5374                 __isl_take isl_set *set);
5375         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
5376                 __isl_take isl_pw_multi_aff *pma,
5377                 __isl_take isl_set *set);
5378         __isl_give isl_union_pw_aff *
5379         isl_union_pw_aff_intersect_params(
5380                 __isl_take isl_union_pw_aff *upa,
5381         __isl_give isl_union_pw_multi_aff *
5382         isl_union_pw_multi_aff_intersect_params(
5383                 __isl_take isl_union_pw_multi_aff *upma,
5384                 __isl_take isl_set *set);
5385         __isl_give isl_multi_union_pw_aff *
5386         isl_multi_union_pw_aff_intersect_params(
5387                 __isl_take isl_multi_union_pw_aff *mupa,
5388                 __isl_take isl_set *params);
5390         #include <isl/polynomial.h>
5391         __isl_give isl_pw_qpolynomial *
5392         isl_pw_qpolynomial_intersect_domain(
5393                 __isl_take isl_pw_qpolynomial *pwpq,
5394                 __isl_take isl_set *set);
5395         __isl_give isl_union_pw_qpolynomial *
5396         isl_union_pw_qpolynomial_intersect_domain(
5397                 __isl_take isl_union_pw_qpolynomial *upwpq,
5398                 __isl_take isl_union_set *uset);
5399         __isl_give isl_union_pw_qpolynomial_fold *
5400         isl_union_pw_qpolynomial_fold_intersect_domain(
5401                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5402                 __isl_take isl_union_set *uset);
5403         __isl_give isl_pw_qpolynomial *
5404         isl_pw_qpolynomial_intersect_params(
5405                 __isl_take isl_pw_qpolynomial *pwpq,
5406                 __isl_take isl_set *set);
5407         __isl_give isl_pw_qpolynomial_fold *
5408         isl_pw_qpolynomial_fold_intersect_params(
5409                 __isl_take isl_pw_qpolynomial_fold *pwf,
5410                 __isl_take isl_set *set);
5411         __isl_give isl_union_pw_qpolynomial *
5412         isl_union_pw_qpolynomial_intersect_params(
5413                 __isl_take isl_union_pw_qpolynomial *upwpq,
5414                 __isl_take isl_set *set);
5415         __isl_give isl_union_pw_qpolynomial_fold *
5416         isl_union_pw_qpolynomial_fold_intersect_params(
5417                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5418                 __isl_take isl_set *set);
5420 The second argument to the C<_params> functions needs to be
5421 a parametric (basic) set.  For the other functions, a parametric set
5422 for either argument is only allowed if the other argument is
5423 a parametric set as well.
5424 The list passed to C<isl_basic_set_list_intersect> needs to have
5425 at least one element and all elements need to live in the same space.
5427 =item * Union
5429         #include <isl/set.h>
5430         __isl_give isl_set *isl_basic_set_union(
5431                 __isl_take isl_basic_set *bset1,
5432                 __isl_take isl_basic_set *bset2);
5433         __isl_give isl_set *isl_set_union(
5434                 __isl_take isl_set *set1,
5435                 __isl_take isl_set *set2);
5437         #include <isl/map.h>
5438         __isl_give isl_map *isl_basic_map_union(
5439                 __isl_take isl_basic_map *bmap1,
5440                 __isl_take isl_basic_map *bmap2);
5441         __isl_give isl_map *isl_map_union(
5442                 __isl_take isl_map *map1,
5443                 __isl_take isl_map *map2);
5445         #include <isl/union_set.h>
5446         __isl_give isl_union_set *isl_union_set_union(
5447                 __isl_take isl_union_set *uset1,
5448                 __isl_take isl_union_set *uset2);
5449         __isl_give isl_union_set *isl_union_set_list_union(
5450                 __isl_take isl_union_set_list *list);
5452         #include <isl/union_map.h>
5453         __isl_give isl_union_map *isl_union_map_union(
5454                 __isl_take isl_union_map *umap1,
5455                 __isl_take isl_union_map *umap2);
5457 =item * Set difference
5459         #include <isl/set.h>
5460         __isl_give isl_set *isl_set_subtract(
5461                 __isl_take isl_set *set1,
5462                 __isl_take isl_set *set2);
5464         #include <isl/map.h>
5465         __isl_give isl_map *isl_map_subtract(
5466                 __isl_take isl_map *map1,
5467                 __isl_take isl_map *map2);
5468         __isl_give isl_map *isl_map_subtract_domain(
5469                 __isl_take isl_map *map,
5470                 __isl_take isl_set *dom);
5471         __isl_give isl_map *isl_map_subtract_range(
5472                 __isl_take isl_map *map,
5473                 __isl_take isl_set *dom);
5475         #include <isl/union_set.h>
5476         __isl_give isl_union_set *isl_union_set_subtract(
5477                 __isl_take isl_union_set *uset1,
5478                 __isl_take isl_union_set *uset2);
5480         #include <isl/union_map.h>
5481         __isl_give isl_union_map *isl_union_map_subtract(
5482                 __isl_take isl_union_map *umap1,
5483                 __isl_take isl_union_map *umap2);
5484         __isl_give isl_union_map *isl_union_map_subtract_domain(
5485                 __isl_take isl_union_map *umap,
5486                 __isl_take isl_union_set *dom);
5487         __isl_give isl_union_map *isl_union_map_subtract_range(
5488                 __isl_take isl_union_map *umap,
5489                 __isl_take isl_union_set *dom);
5491         #include <isl/aff.h>
5492         __isl_give isl_pw_aff *isl_pw_aff_subtract_domain(
5493                 __isl_take isl_pw_aff *pa,
5494                 __isl_take isl_set *set);
5495         __isl_give isl_pw_multi_aff *
5496         isl_pw_multi_aff_subtract_domain(
5497                 __isl_take isl_pw_multi_aff *pma,
5498                 __isl_take isl_set *set);
5499         __isl_give isl_union_pw_aff *
5500         isl_union_pw_aff_subtract_domain(
5501                 __isl_take isl_union_pw_aff *upa,
5502                 __isl_take isl_union_set *uset);
5503         __isl_give isl_union_pw_multi_aff *
5504         isl_union_pw_multi_aff_subtract_domain(
5505                 __isl_take isl_union_pw_multi_aff *upma,
5506                 __isl_take isl_set *set);
5508         #include <isl/polynomial.h>
5509         __isl_give isl_pw_qpolynomial *
5510         isl_pw_qpolynomial_subtract_domain(
5511                 __isl_take isl_pw_qpolynomial *pwpq,
5512                 __isl_take isl_set *set);
5513         __isl_give isl_pw_qpolynomial_fold *
5514         isl_pw_qpolynomial_fold_subtract_domain(
5515                 __isl_take isl_pw_qpolynomial_fold *pwf,
5516                 __isl_take isl_set *set);
5517         __isl_give isl_union_pw_qpolynomial *
5518         isl_union_pw_qpolynomial_subtract_domain(
5519                 __isl_take isl_union_pw_qpolynomial *upwpq,
5520                 __isl_take isl_union_set *uset);
5521         __isl_give isl_union_pw_qpolynomial_fold *
5522         isl_union_pw_qpolynomial_fold_subtract_domain(
5523                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5524                 __isl_take isl_union_set *uset);
5526 =item * Application
5528         #include <isl/space.h>
5529         __isl_give isl_space *isl_space_join(
5530                 __isl_take isl_space *left,
5531                 __isl_take isl_space *right);
5533         #include <isl/map.h>
5534         __isl_give isl_basic_set *isl_basic_set_apply(
5535                 __isl_take isl_basic_set *bset,
5536                 __isl_take isl_basic_map *bmap);
5537         __isl_give isl_set *isl_set_apply(
5538                 __isl_take isl_set *set,
5539                 __isl_take isl_map *map);
5540         __isl_give isl_union_set *isl_union_set_apply(
5541                 __isl_take isl_union_set *uset,
5542                 __isl_take isl_union_map *umap);
5543         __isl_give isl_basic_map *isl_basic_map_apply_domain(
5544                 __isl_take isl_basic_map *bmap1,
5545                 __isl_take isl_basic_map *bmap2);
5546         __isl_give isl_basic_map *isl_basic_map_apply_range(
5547                 __isl_take isl_basic_map *bmap1,
5548                 __isl_take isl_basic_map *bmap2);
5549         __isl_give isl_map *isl_map_apply_domain(
5550                 __isl_take isl_map *map1,
5551                 __isl_take isl_map *map2);
5552         __isl_give isl_map *isl_map_apply_range(
5553                 __isl_take isl_map *map1,
5554                 __isl_take isl_map *map2);
5556         #include <isl/union_map.h>
5557         __isl_give isl_union_map *isl_union_map_apply_domain(
5558                 __isl_take isl_union_map *umap1,
5559                 __isl_take isl_union_map *umap2);
5560         __isl_give isl_union_map *isl_union_map_apply_range(
5561                 __isl_take isl_union_map *umap1,
5562                 __isl_take isl_union_map *umap2);
5564         #include <isl/polynomial.h>
5565         __isl_give isl_pw_qpolynomial_fold *
5566         isl_set_apply_pw_qpolynomial_fold(
5567                 __isl_take isl_set *set,
5568                 __isl_take isl_pw_qpolynomial_fold *pwf,
5569                 int *tight);
5570         __isl_give isl_pw_qpolynomial_fold *
5571         isl_map_apply_pw_qpolynomial_fold(
5572                 __isl_take isl_map *map,
5573                 __isl_take isl_pw_qpolynomial_fold *pwf,
5574                 int *tight);
5575         __isl_give isl_union_pw_qpolynomial_fold *
5576         isl_union_set_apply_union_pw_qpolynomial_fold(
5577                 __isl_take isl_union_set *uset,
5578                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5579                 int *tight);
5580         __isl_give isl_union_pw_qpolynomial_fold *
5581         isl_union_map_apply_union_pw_qpolynomial_fold(
5582                 __isl_take isl_union_map *umap,
5583                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
5584                 int *tight);
5586 The functions taking a map
5587 compose the given map with the given piecewise quasipolynomial reduction.
5588 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
5589 over all elements in the intersection of the range of the map
5590 and the domain of the piecewise quasipolynomial reduction
5591 as a function of an element in the domain of the map.
5592 The functions taking a set compute a bound over all elements in the
5593 intersection of the set and the domain of the
5594 piecewise quasipolynomial reduction.
5596 =item * Preimage
5598         #include <isl/set.h>
5599         __isl_give isl_basic_set *
5600         isl_basic_set_preimage_multi_aff(
5601                 __isl_take isl_basic_set *bset,
5602                 __isl_take isl_multi_aff *ma);
5603         __isl_give isl_set *isl_set_preimage_multi_aff(
5604                 __isl_take isl_set *set,
5605                 __isl_take isl_multi_aff *ma);
5606         __isl_give isl_set *isl_set_preimage_pw_multi_aff(
5607                 __isl_take isl_set *set,
5608                 __isl_take isl_pw_multi_aff *pma);
5609         __isl_give isl_set *isl_set_preimage_multi_pw_aff(
5610                 __isl_take isl_set *set,
5611                 __isl_take isl_multi_pw_aff *mpa);
5613         #include <isl/union_set.h>
5614         __isl_give isl_union_set *
5615         isl_union_set_preimage_multi_aff(
5616                 __isl_take isl_union_set *uset,
5617                 __isl_take isl_multi_aff *ma);
5618         __isl_give isl_union_set *
5619         isl_union_set_preimage_pw_multi_aff(
5620                 __isl_take isl_union_set *uset,
5621                 __isl_take isl_pw_multi_aff *pma);
5622         __isl_give isl_union_set *
5623         isl_union_set_preimage_union_pw_multi_aff(
5624                 __isl_take isl_union_set *uset,
5625                 __isl_take isl_union_pw_multi_aff *upma);
5627         #include <isl/map.h>
5628         __isl_give isl_basic_map *
5629         isl_basic_map_preimage_domain_multi_aff(
5630                 __isl_take isl_basic_map *bmap,
5631                 __isl_take isl_multi_aff *ma);
5632         __isl_give isl_map *isl_map_preimage_domain_multi_aff(
5633                 __isl_take isl_map *map,
5634                 __isl_take isl_multi_aff *ma);
5635         __isl_give isl_map *isl_map_preimage_range_multi_aff(
5636                 __isl_take isl_map *map,
5637                 __isl_take isl_multi_aff *ma);
5638         __isl_give isl_map *
5639         isl_map_preimage_domain_pw_multi_aff(
5640                 __isl_take isl_map *map,
5641                 __isl_take isl_pw_multi_aff *pma);
5642         __isl_give isl_map *
5643         isl_map_preimage_range_pw_multi_aff(
5644                 __isl_take isl_map *map,
5645                 __isl_take isl_pw_multi_aff *pma);
5646         __isl_give isl_map *
5647         isl_map_preimage_domain_multi_pw_aff(
5648                 __isl_take isl_map *map,
5649                 __isl_take isl_multi_pw_aff *mpa);
5650         __isl_give isl_basic_map *
5651         isl_basic_map_preimage_range_multi_aff(
5652                 __isl_take isl_basic_map *bmap,
5653                 __isl_take isl_multi_aff *ma);
5655         #include <isl/union_map.h>
5656         __isl_give isl_union_map *
5657         isl_union_map_preimage_domain_multi_aff(
5658                 __isl_take isl_union_map *umap,
5659                 __isl_take isl_multi_aff *ma);
5660         __isl_give isl_union_map *
5661         isl_union_map_preimage_range_multi_aff(
5662                 __isl_take isl_union_map *umap,
5663                 __isl_take isl_multi_aff *ma);
5664         __isl_give isl_union_map *
5665         isl_union_map_preimage_domain_pw_multi_aff(
5666                 __isl_take isl_union_map *umap,
5667                 __isl_take isl_pw_multi_aff *pma);
5668         __isl_give isl_union_map *
5669         isl_union_map_preimage_range_pw_multi_aff(
5670                 __isl_take isl_union_map *umap,
5671                 __isl_take isl_pw_multi_aff *pma);
5672         __isl_give isl_union_map *
5673         isl_union_map_preimage_domain_union_pw_multi_aff(
5674                 __isl_take isl_union_map *umap,
5675                 __isl_take isl_union_pw_multi_aff *upma);
5676         __isl_give isl_union_map *
5677         isl_union_map_preimage_range_union_pw_multi_aff(
5678                 __isl_take isl_union_map *umap,
5679                 __isl_take isl_union_pw_multi_aff *upma);
5681 These functions compute the preimage of the given set or map domain/range under
5682 the given function.  In other words, the expression is plugged
5683 into the set description or into the domain/range of the map.
5685 =item * Pullback
5687         #include <isl/aff.h>
5688         __isl_give isl_aff *isl_aff_pullback_aff(
5689                 __isl_take isl_aff *aff1,
5690                 __isl_take isl_aff *aff2);
5691         __isl_give isl_aff *isl_aff_pullback_multi_aff(
5692                 __isl_take isl_aff *aff,
5693                 __isl_take isl_multi_aff *ma);
5694         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
5695                 __isl_take isl_pw_aff *pa,
5696                 __isl_take isl_multi_aff *ma);
5697         __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
5698                 __isl_take isl_pw_aff *pa,
5699                 __isl_take isl_pw_multi_aff *pma);
5700         __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_pw_aff(
5701                 __isl_take isl_pw_aff *pa,
5702                 __isl_take isl_multi_pw_aff *mpa);
5703         __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
5704                 __isl_take isl_multi_aff *ma1,
5705                 __isl_take isl_multi_aff *ma2);
5706         __isl_give isl_pw_multi_aff *
5707         isl_pw_multi_aff_pullback_multi_aff(
5708                 __isl_take isl_pw_multi_aff *pma,
5709                 __isl_take isl_multi_aff *ma);
5710         __isl_give isl_multi_pw_aff *
5711         isl_multi_pw_aff_pullback_multi_aff(
5712                 __isl_take isl_multi_pw_aff *mpa,
5713                 __isl_take isl_multi_aff *ma);
5714         __isl_give isl_pw_multi_aff *
5715         isl_pw_multi_aff_pullback_pw_multi_aff(
5716                 __isl_take isl_pw_multi_aff *pma1,
5717                 __isl_take isl_pw_multi_aff *pma2);
5718         __isl_give isl_multi_pw_aff *
5719         isl_multi_pw_aff_pullback_pw_multi_aff(
5720                 __isl_take isl_multi_pw_aff *mpa,
5721                 __isl_take isl_pw_multi_aff *pma);
5722         __isl_give isl_multi_pw_aff *
5723         isl_multi_pw_aff_pullback_multi_pw_aff(
5724                 __isl_take isl_multi_pw_aff *mpa1,
5725                 __isl_take isl_multi_pw_aff *mpa2);
5726         __isl_give isl_union_pw_aff *
5727         isl_union_pw_aff_pullback_union_pw_multi_aff(
5728                 __isl_take isl_union_pw_aff *upa,
5729                 __isl_take isl_union_pw_multi_aff *upma);
5730         __isl_give isl_union_pw_multi_aff *
5731         isl_union_pw_multi_aff_pullback_union_pw_multi_aff(
5732                 __isl_take isl_union_pw_multi_aff *upma1,
5733                 __isl_take isl_union_pw_multi_aff *upma2);
5735 These functions precompose the first expression by the second function.
5736 In other words, the second function is plugged
5737 into the first expression.
5739 =item * Locus
5741         #include <isl/aff.h>
5742         __isl_give isl_basic_set *isl_aff_le_basic_set(
5743                 __isl_take isl_aff *aff1,
5744                 __isl_take isl_aff *aff2);
5745         __isl_give isl_basic_set *isl_aff_ge_basic_set(
5746                 __isl_take isl_aff *aff1,
5747                 __isl_take isl_aff *aff2);
5748         __isl_give isl_set *isl_pw_aff_eq_set(
5749                 __isl_take isl_pw_aff *pwaff1,
5750                 __isl_take isl_pw_aff *pwaff2);
5751         __isl_give isl_set *isl_pw_aff_ne_set(
5752                 __isl_take isl_pw_aff *pwaff1,
5753                 __isl_take isl_pw_aff *pwaff2);
5754         __isl_give isl_set *isl_pw_aff_le_set(
5755                 __isl_take isl_pw_aff *pwaff1,
5756                 __isl_take isl_pw_aff *pwaff2);
5757         __isl_give isl_set *isl_pw_aff_lt_set(
5758                 __isl_take isl_pw_aff *pwaff1,
5759                 __isl_take isl_pw_aff *pwaff2);
5760         __isl_give isl_set *isl_pw_aff_ge_set(
5761                 __isl_take isl_pw_aff *pwaff1,
5762                 __isl_take isl_pw_aff *pwaff2);
5763         __isl_give isl_set *isl_pw_aff_gt_set(
5764                 __isl_take isl_pw_aff *pwaff1,
5765                 __isl_take isl_pw_aff *pwaff2);
5767         __isl_give isl_set *isl_multi_aff_lex_le_set(
5768                 __isl_take isl_multi_aff *ma1,
5769                 __isl_take isl_multi_aff *ma2);
5770         __isl_give isl_set *isl_multi_aff_lex_ge_set(
5771                 __isl_take isl_multi_aff *ma1,
5772                 __isl_take isl_multi_aff *ma2);
5774         __isl_give isl_set *isl_pw_aff_list_eq_set(
5775                 __isl_take isl_pw_aff_list *list1,
5776                 __isl_take isl_pw_aff_list *list2);
5777         __isl_give isl_set *isl_pw_aff_list_ne_set(
5778                 __isl_take isl_pw_aff_list *list1,
5779                 __isl_take isl_pw_aff_list *list2);
5780         __isl_give isl_set *isl_pw_aff_list_le_set(
5781                 __isl_take isl_pw_aff_list *list1,
5782                 __isl_take isl_pw_aff_list *list2);
5783         __isl_give isl_set *isl_pw_aff_list_lt_set(
5784                 __isl_take isl_pw_aff_list *list1,
5785                 __isl_take isl_pw_aff_list *list2);
5786         __isl_give isl_set *isl_pw_aff_list_ge_set(
5787                 __isl_take isl_pw_aff_list *list1,
5788                 __isl_take isl_pw_aff_list *list2);
5789         __isl_give isl_set *isl_pw_aff_list_gt_set(
5790                 __isl_take isl_pw_aff_list *list1,
5791                 __isl_take isl_pw_aff_list *list2);
5793 The function C<isl_aff_ge_basic_set> returns a basic set
5794 containing those elements in the shared space
5795 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
5796 The function C<isl_pw_aff_ge_set> returns a set
5797 containing those elements in the shared domain
5798 of C<pwaff1> and C<pwaff2> where C<pwaff1> is
5799 greater than or equal to C<pwaff2>.
5800 The function C<isl_multi_aff_lex_le_set> returns a set
5801 containing those elements in the shared domain space
5802 where C<ma1> is lexicographically smaller than or
5803 equal to C<ma2>.
5804 The functions operating on C<isl_pw_aff_list> apply the corresponding
5805 C<isl_pw_aff> function to each pair of elements in the two lists.
5807 =item * Cartesian Product
5809         #include <isl/space.h>
5810         __isl_give isl_space *isl_space_product(
5811                 __isl_take isl_space *space1,
5812                 __isl_take isl_space *space2);
5813         __isl_give isl_space *isl_space_domain_product(
5814                 __isl_take isl_space *space1,
5815                 __isl_take isl_space *space2);
5816         __isl_give isl_space *isl_space_range_product(
5817                 __isl_take isl_space *space1,
5818                 __isl_take isl_space *space2);
5820 The functions
5821 C<isl_space_product>, C<isl_space_domain_product>
5822 and C<isl_space_range_product> take pairs or relation spaces and
5823 produce a single relations space, where either the domain, the range
5824 or both domain and range are wrapped spaces of relations between
5825 the domains and/or ranges of the input spaces.
5826 If the product is only constructed over the domain or the range
5827 then the ranges or the domains of the inputs should be the same.
5828 The function C<isl_space_product> also accepts a pair of set spaces,
5829 in which case it returns a wrapped space of a relation between the
5830 two input spaces.
5832         #include <isl/set.h>
5833         __isl_give isl_set *isl_set_product(
5834                 __isl_take isl_set *set1,
5835                 __isl_take isl_set *set2);
5837         #include <isl/map.h>
5838         __isl_give isl_basic_map *isl_basic_map_domain_product(
5839                 __isl_take isl_basic_map *bmap1,
5840                 __isl_take isl_basic_map *bmap2);
5841         __isl_give isl_basic_map *isl_basic_map_range_product(
5842                 __isl_take isl_basic_map *bmap1,
5843                 __isl_take isl_basic_map *bmap2);
5844         __isl_give isl_basic_map *isl_basic_map_product(
5845                 __isl_take isl_basic_map *bmap1,
5846                 __isl_take isl_basic_map *bmap2);
5847         __isl_give isl_map *isl_map_domain_product(
5848                 __isl_take isl_map *map1,
5849                 __isl_take isl_map *map2);
5850         __isl_give isl_map *isl_map_range_product(
5851                 __isl_take isl_map *map1,
5852                 __isl_take isl_map *map2);
5853         __isl_give isl_map *isl_map_product(
5854                 __isl_take isl_map *map1,
5855                 __isl_take isl_map *map2);
5857         #include <isl/union_set.h>
5858         __isl_give isl_union_set *isl_union_set_product(
5859                 __isl_take isl_union_set *uset1,
5860                 __isl_take isl_union_set *uset2);
5862         #include <isl/union_map.h>
5863         __isl_give isl_union_map *isl_union_map_domain_product(
5864                 __isl_take isl_union_map *umap1,
5865                 __isl_take isl_union_map *umap2);
5866         __isl_give isl_union_map *isl_union_map_range_product(
5867                 __isl_take isl_union_map *umap1,
5868                 __isl_take isl_union_map *umap2);
5869         __isl_give isl_union_map *isl_union_map_product(
5870                 __isl_take isl_union_map *umap1,
5871                 __isl_take isl_union_map *umap2);
5873         #include <isl/val.h>
5874         __isl_give isl_multi_val *isl_multi_val_range_product(
5875                 __isl_take isl_multi_val *mv1,
5876                 __isl_take isl_multi_val *mv2);
5877         __isl_give isl_multi_val *isl_multi_val_product(
5878                 __isl_take isl_multi_val *mv1,
5879                 __isl_take isl_multi_val *mv2);
5881         #include <isl/aff.h>
5882         __isl_give isl_multi_aff *isl_multi_aff_range_product(
5883                 __isl_take isl_multi_aff *ma1,
5884                 __isl_take isl_multi_aff *ma2);
5885         __isl_give isl_multi_aff *isl_multi_aff_product(
5886                 __isl_take isl_multi_aff *ma1,
5887                 __isl_take isl_multi_aff *ma2);
5888         __isl_give isl_multi_pw_aff *
5889         isl_multi_pw_aff_range_product(
5890                 __isl_take isl_multi_pw_aff *mpa1,
5891                 __isl_take isl_multi_pw_aff *mpa2);
5892         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_product(
5893                 __isl_take isl_multi_pw_aff *mpa1,
5894                 __isl_take isl_multi_pw_aff *mpa2);
5895         __isl_give isl_pw_multi_aff *
5896         isl_pw_multi_aff_range_product(
5897                 __isl_take isl_pw_multi_aff *pma1,
5898                 __isl_take isl_pw_multi_aff *pma2);
5899         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
5900                 __isl_take isl_pw_multi_aff *pma1,
5901                 __isl_take isl_pw_multi_aff *pma2);
5902         __isl_give isl_multi_union_pw_aff *
5903         isl_multi_union_pw_aff_range_product(
5904                 __isl_take isl_multi_union_pw_aff *mupa1,
5905                 __isl_take isl_multi_union_pw_aff *mupa2);
5907 The above functions compute the cross product of the given
5908 sets, relations or functions.  The domains and ranges of the results
5909 are wrapped maps between domains and ranges of the inputs.
5910 To obtain a ``flat'' product, use the following functions
5911 instead.
5913         #include <isl/set.h>
5914         __isl_give isl_basic_set *isl_basic_set_flat_product(
5915                 __isl_take isl_basic_set *bset1,
5916                 __isl_take isl_basic_set *bset2);
5917         __isl_give isl_set *isl_set_flat_product(
5918                 __isl_take isl_set *set1,
5919                 __isl_take isl_set *set2);
5921         #include <isl/map.h>
5922         __isl_give isl_basic_map *isl_basic_map_flat_range_product(
5923                 __isl_take isl_basic_map *bmap1,
5924                 __isl_take isl_basic_map *bmap2);
5925         __isl_give isl_map *isl_map_flat_domain_product(
5926                 __isl_take isl_map *map1,
5927                 __isl_take isl_map *map2);
5928         __isl_give isl_map *isl_map_flat_range_product(
5929                 __isl_take isl_map *map1,
5930                 __isl_take isl_map *map2);
5931         __isl_give isl_basic_map *isl_basic_map_flat_product(
5932                 __isl_take isl_basic_map *bmap1,
5933                 __isl_take isl_basic_map *bmap2);
5934         __isl_give isl_map *isl_map_flat_product(
5935                 __isl_take isl_map *map1,
5936                 __isl_take isl_map *map2);
5938         #include <isl/union_map.h>
5939         __isl_give isl_union_map *
5940         isl_union_map_flat_domain_product(
5941                 __isl_take isl_union_map *umap1,
5942                 __isl_take isl_union_map *umap2);
5943         __isl_give isl_union_map *
5944         isl_union_map_flat_range_product(
5945                 __isl_take isl_union_map *umap1,
5946                 __isl_take isl_union_map *umap2);
5948         #include <isl/val.h>
5949         __isl_give isl_multi_val *isl_multi_val_flat_range_product(
5950                 __isl_take isl_multi_val *mv1,
5951                 __isl_take isl_multi_aff *mv2);
5953         #include <isl/aff.h>
5954         __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
5955                 __isl_take isl_multi_aff *ma1,
5956                 __isl_take isl_multi_aff *ma2);
5957         __isl_give isl_pw_multi_aff *
5958         isl_pw_multi_aff_flat_range_product(
5959                 __isl_take isl_pw_multi_aff *pma1,
5960                 __isl_take isl_pw_multi_aff *pma2);
5961         __isl_give isl_multi_pw_aff *
5962         isl_multi_pw_aff_flat_range_product(
5963                 __isl_take isl_multi_pw_aff *mpa1,
5964                 __isl_take isl_multi_pw_aff *mpa2);
5965         __isl_give isl_union_pw_multi_aff *
5966         isl_union_pw_multi_aff_flat_range_product(
5967                 __isl_take isl_union_pw_multi_aff *upma1,
5968                 __isl_take isl_union_pw_multi_aff *upma2);
5969         __isl_give isl_multi_union_pw_aff *
5970         isl_multi_union_pw_aff_flat_range_product(
5971                 __isl_take isl_multi_union_pw_aff *mupa1,
5972                 __isl_take isl_multi_union_pw_aff *mupa2);
5974         #include <isl/space.h>
5975         __isl_give isl_space *isl_space_factor_domain(
5976                 __isl_take isl_space *space);
5977         __isl_give isl_space *isl_space_factor_range(
5978                 __isl_take isl_space *space);
5979         __isl_give isl_space *isl_space_domain_factor_domain(
5980                 __isl_take isl_space *space);
5981         __isl_give isl_space *isl_space_domain_factor_range(
5982                 __isl_take isl_space *space);
5983         __isl_give isl_space *isl_space_range_factor_domain(
5984                 __isl_take isl_space *space);
5985         __isl_give isl_space *isl_space_range_factor_range(
5986                 __isl_take isl_space *space);
5988 The functions C<isl_space_range_factor_domain> and
5989 C<isl_space_range_factor_range> extract the two arguments from
5990 the result of a call to C<isl_space_range_product>.
5992 The arguments of a call to C<isl_map_range_product> can be extracted
5993 from the result using the following functions.
5995         #include <isl/map.h>
5996         __isl_give isl_map *isl_map_factor_domain(
5997                 __isl_take isl_map *map);
5998         __isl_give isl_map *isl_map_factor_range(
5999                 __isl_take isl_map *map);
6000         __isl_give isl_map *isl_map_domain_factor_domain(
6001                 __isl_take isl_map *map);
6002         __isl_give isl_map *isl_map_domain_factor_range(
6003                 __isl_take isl_map *map);
6004         __isl_give isl_map *isl_map_range_factor_domain(
6005                 __isl_take isl_map *map);
6006         __isl_give isl_map *isl_map_range_factor_range(
6007                 __isl_take isl_map *map);
6009         #include <isl/union_map.h>
6010         __isl_give isl_union_map *isl_union_map_factor_domain(
6011                 __isl_take isl_union_map *umap);
6012         __isl_give isl_union_map *isl_union_map_factor_range(
6013                 __isl_take isl_union_map *umap);
6014         __isl_give isl_union_map *
6015         isl_union_map_domain_factor_domain(
6016                 __isl_take isl_union_map *umap);
6017         __isl_give isl_union_map *
6018         isl_union_map_domain_factor_range(
6019                 __isl_take isl_union_map *umap);
6020         __isl_give isl_union_map *
6021         isl_union_map_range_factor_range(
6022                 __isl_take isl_union_map *umap);
6024         #include <isl/val.h>
6025         __isl_give isl_multi_val *
6026         isl_multi_val_range_factor_domain(
6027                 __isl_take isl_multi_val *mv);
6028         __isl_give isl_multi_val *
6029         isl_multi_val_range_factor_range(
6030                 __isl_take isl_multi_val *mv);
6032         #include <isl/aff.h>
6033         __isl_give isl_multi_aff *
6034         isl_multi_aff_range_factor_domain(
6035                 __isl_take isl_multi_aff *ma);
6036         __isl_give isl_multi_aff *
6037         isl_multi_aff_range_factor_range(
6038                 __isl_take isl_multi_aff *ma);
6039         __isl_give isl_multi_pw_aff *
6040         isl_multi_pw_aff_range_factor_domain(
6041                 __isl_take isl_multi_pw_aff *mpa);
6042         __isl_give isl_multi_pw_aff *
6043         isl_multi_pw_aff_range_factor_range(
6044                 __isl_take isl_multi_pw_aff *mpa);
6045         __isl_give isl_multi_union_pw_aff *
6046         isl_multi_union_pw_aff_range_factor_domain(
6047                 __isl_take isl_multi_union_pw_aff *mupa);
6048         __isl_give isl_multi_union_pw_aff *
6049         isl_multi_union_pw_aff_range_factor_range(
6050                 __isl_take isl_multi_union_pw_aff *mupa);
6052 The splice functions are a generalization of the flat product functions,
6053 where the second argument may be inserted at any position inside
6054 the first argument rather than being placed at the end.
6056         #include <isl/val.h>
6057         __isl_give isl_multi_val *isl_multi_val_range_splice(
6058                 __isl_take isl_multi_val *mv1, unsigned pos,
6059                 __isl_take isl_multi_val *mv2);
6061         #include <isl/aff.h>
6062         __isl_give isl_multi_aff *isl_multi_aff_range_splice(
6063                 __isl_take isl_multi_aff *ma1, unsigned pos,
6064                 __isl_take isl_multi_aff *ma2);
6065         __isl_give isl_multi_aff *isl_multi_aff_splice(
6066                 __isl_take isl_multi_aff *ma1,
6067                 unsigned in_pos, unsigned out_pos,
6068                 __isl_take isl_multi_aff *ma2);
6069         __isl_give isl_multi_pw_aff *
6070         isl_multi_pw_aff_range_splice(
6071                 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
6072                 __isl_take isl_multi_pw_aff *mpa2);
6073         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
6074                 __isl_take isl_multi_pw_aff *mpa1,
6075                 unsigned in_pos, unsigned out_pos,
6076                 __isl_take isl_multi_pw_aff *mpa2);
6077         __isl_give isl_multi_union_pw_aff *
6078         isl_multi_union_pw_aff_range_splice(
6079                 __isl_take isl_multi_union_pw_aff *mupa1,
6080                 unsigned pos,
6081                 __isl_take isl_multi_union_pw_aff *mupa2);
6083 =item * Simplification
6085 When applied to a set or relation,
6086 the gist operation returns a set or relation that has the
6087 same intersection with the context as the input set or relation.
6088 Any implicit equality in the intersection is made explicit in the result,
6089 while all inequalities that are redundant with respect to the intersection
6090 are removed.
6091 In case of union sets and relations, the gist operation is performed
6092 per space.
6094 When applied to a function,
6095 the gist operation applies the set gist operation to each of
6096 the cells in the domain of the input piecewise expression.
6097 The context is also exploited
6098 to simplify the expression associated to each cell.
6100         #include <isl/set.h>
6101         __isl_give isl_basic_set *isl_basic_set_gist(
6102                 __isl_take isl_basic_set *bset,
6103                 __isl_take isl_basic_set *context);
6104         __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
6105                 __isl_take isl_set *context);
6106         __isl_give isl_set *isl_set_gist_params(
6107                 __isl_take isl_set *set,
6108                 __isl_take isl_set *context);
6110         #include <isl/map.h>
6111         __isl_give isl_basic_map *isl_basic_map_gist(
6112                 __isl_take isl_basic_map *bmap,
6113                 __isl_take isl_basic_map *context);
6114         __isl_give isl_basic_map *isl_basic_map_gist_domain(
6115                 __isl_take isl_basic_map *bmap,
6116                 __isl_take isl_basic_set *context);
6117         __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
6118                 __isl_take isl_map *context);
6119         __isl_give isl_map *isl_map_gist_params(
6120                 __isl_take isl_map *map,
6121                 __isl_take isl_set *context);
6122         __isl_give isl_map *isl_map_gist_domain(
6123                 __isl_take isl_map *map,
6124                 __isl_take isl_set *context);
6125         __isl_give isl_map *isl_map_gist_range(
6126                 __isl_take isl_map *map,
6127                 __isl_take isl_set *context);
6129         #include <isl/union_set.h>
6130         __isl_give isl_union_set *isl_union_set_gist(
6131                 __isl_take isl_union_set *uset,
6132                 __isl_take isl_union_set *context);
6133         __isl_give isl_union_set *isl_union_set_gist_params(
6134                 __isl_take isl_union_set *uset,
6135                 __isl_take isl_set *set);
6137         #include <isl/union_map.h>
6138         __isl_give isl_union_map *isl_union_map_gist(
6139                 __isl_take isl_union_map *umap,
6140                 __isl_take isl_union_map *context);
6141         __isl_give isl_union_map *isl_union_map_gist_params(
6142                 __isl_take isl_union_map *umap,
6143                 __isl_take isl_set *set);
6144         __isl_give isl_union_map *isl_union_map_gist_domain(
6145                 __isl_take isl_union_map *umap,
6146                 __isl_take isl_union_set *uset);
6147         __isl_give isl_union_map *isl_union_map_gist_range(
6148                 __isl_take isl_union_map *umap,
6149                 __isl_take isl_union_set *uset);
6151         #include <isl/aff.h>
6152         __isl_give isl_aff *isl_aff_gist_params(
6153                 __isl_take isl_aff *aff,
6154                 __isl_take isl_set *context);
6155         __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
6156                 __isl_take isl_set *context);
6157         __isl_give isl_multi_aff *isl_multi_aff_gist_params(
6158                 __isl_take isl_multi_aff *maff,
6159                 __isl_take isl_set *context);
6160         __isl_give isl_multi_aff *isl_multi_aff_gist(
6161                 __isl_take isl_multi_aff *maff,
6162                 __isl_take isl_set *context);
6163         __isl_give isl_pw_aff *isl_pw_aff_gist_params(
6164                 __isl_take isl_pw_aff *pwaff,
6165                 __isl_take isl_set *context);
6166         __isl_give isl_pw_aff *isl_pw_aff_gist(
6167                 __isl_take isl_pw_aff *pwaff,
6168                 __isl_take isl_set *context);
6169         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
6170                 __isl_take isl_pw_multi_aff *pma,
6171                 __isl_take isl_set *set);
6172         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
6173                 __isl_take isl_pw_multi_aff *pma,
6174                 __isl_take isl_set *set);
6175         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_gist_params(
6176                 __isl_take isl_multi_pw_aff *mpa,
6177                 __isl_take isl_set *set);
6178         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_gist(
6179                 __isl_take isl_multi_pw_aff *mpa,
6180                 __isl_take isl_set *set);
6181         __isl_give isl_union_pw_aff *isl_union_pw_aff_gist(
6182                 __isl_take isl_union_pw_aff *upa,
6183                 __isl_take isl_union_set *context);
6184         __isl_give isl_union_pw_aff *isl_union_pw_aff_gist_params(
6185                 __isl_take isl_union_pw_aff *upa,
6186                 __isl_take isl_set *context);
6187         __isl_give isl_union_pw_multi_aff *
6188         isl_union_pw_multi_aff_gist_params(
6189                 __isl_take isl_union_pw_multi_aff *upma,
6190                 __isl_take isl_set *context);
6191         __isl_give isl_union_pw_multi_aff *
6192         isl_union_pw_multi_aff_gist(
6193                 __isl_take isl_union_pw_multi_aff *upma,
6194                 __isl_take isl_union_set *context);
6195         __isl_give isl_multi_union_pw_aff *
6196         isl_multi_union_pw_aff_gist_params(
6197                 __isl_take isl_multi_union_pw_aff *aff,
6198                 __isl_take isl_set *context);
6199         __isl_give isl_multi_union_pw_aff *
6200         isl_multi_union_pw_aff_gist(
6201                 __isl_take isl_multi_union_pw_aff *aff,
6202                 __isl_take isl_union_set *context);
6204         #include <isl/polynomial.h>
6205         __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
6206                 __isl_take isl_qpolynomial *qp,
6207                 __isl_take isl_set *context);
6208         __isl_give isl_qpolynomial *isl_qpolynomial_gist(
6209                 __isl_take isl_qpolynomial *qp,
6210                 __isl_take isl_set *context);
6211         __isl_give isl_qpolynomial_fold *
6212         isl_qpolynomial_fold_gist_params(
6213                 __isl_take isl_qpolynomial_fold *fold,
6214                 __isl_take isl_set *context);
6215         __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
6216                 __isl_take isl_qpolynomial_fold *fold,
6217                 __isl_take isl_set *context);
6218         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
6219                 __isl_take isl_pw_qpolynomial *pwqp,
6220                 __isl_take isl_set *context);
6221         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
6222                 __isl_take isl_pw_qpolynomial *pwqp,
6223                 __isl_take isl_set *context);
6224         __isl_give isl_pw_qpolynomial_fold *
6225         isl_pw_qpolynomial_fold_gist(
6226                 __isl_take isl_pw_qpolynomial_fold *pwf,
6227                 __isl_take isl_set *context);
6228         __isl_give isl_pw_qpolynomial_fold *
6229         isl_pw_qpolynomial_fold_gist_params(
6230                 __isl_take isl_pw_qpolynomial_fold *pwf,
6231                 __isl_take isl_set *context);
6232         __isl_give isl_union_pw_qpolynomial *
6233         isl_union_pw_qpolynomial_gist_params(
6234                 __isl_take isl_union_pw_qpolynomial *upwqp,
6235                 __isl_take isl_set *context);
6236         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
6237                 __isl_take isl_union_pw_qpolynomial *upwqp,
6238                 __isl_take isl_union_set *context);
6239         __isl_give isl_union_pw_qpolynomial_fold *
6240         isl_union_pw_qpolynomial_fold_gist(
6241                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6242                 __isl_take isl_union_set *context);
6243         __isl_give isl_union_pw_qpolynomial_fold *
6244         isl_union_pw_qpolynomial_fold_gist_params(
6245                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6246                 __isl_take isl_set *context);
6248 =item * Binary Arithmethic Operations
6250         #include <isl/val.h>
6251         __isl_give isl_multi_val *isl_multi_val_sub(
6252                 __isl_take isl_multi_val *mv1,
6253                 __isl_take isl_multi_val *mv2);
6255         #include <isl/aff.h>
6256         __isl_give isl_aff *isl_aff_add(
6257                 __isl_take isl_aff *aff1,
6258                 __isl_take isl_aff *aff2);
6259         __isl_give isl_multi_aff *isl_multi_aff_add(
6260                 __isl_take isl_multi_aff *maff1,
6261                 __isl_take isl_multi_aff *maff2);
6262         __isl_give isl_pw_aff *isl_pw_aff_add(
6263                 __isl_take isl_pw_aff *pwaff1,
6264                 __isl_take isl_pw_aff *pwaff2);
6265         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
6266                 __isl_take isl_pw_multi_aff *pma1,
6267                 __isl_take isl_pw_multi_aff *pma2);
6268         __isl_give isl_union_pw_aff *isl_union_pw_aff_add(
6269                 __isl_take isl_union_pw_aff *upa1,
6270                 __isl_take isl_union_pw_aff *upa2);
6271         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
6272                 __isl_take isl_union_pw_multi_aff *upma1,
6273                 __isl_take isl_union_pw_multi_aff *upma2);
6274         __isl_give isl_pw_aff *isl_pw_aff_min(
6275                 __isl_take isl_pw_aff *pwaff1,
6276                 __isl_take isl_pw_aff *pwaff2);
6277         __isl_give isl_pw_aff *isl_pw_aff_max(
6278                 __isl_take isl_pw_aff *pwaff1,
6279                 __isl_take isl_pw_aff *pwaff2);
6280         __isl_give isl_aff *isl_aff_sub(
6281                 __isl_take isl_aff *aff1,
6282                 __isl_take isl_aff *aff2);
6283         __isl_give isl_multi_aff *isl_multi_aff_sub(
6284                 __isl_take isl_multi_aff *ma1,
6285                 __isl_take isl_multi_aff *ma2);
6286         __isl_give isl_pw_aff *isl_pw_aff_sub(
6287                 __isl_take isl_pw_aff *pwaff1,
6288                 __isl_take isl_pw_aff *pwaff2);
6289         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_sub(
6290                 __isl_take isl_multi_pw_aff *mpa1,
6291                 __isl_take isl_multi_pw_aff *mpa2);
6292         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
6293                 __isl_take isl_pw_multi_aff *pma1,
6294                 __isl_take isl_pw_multi_aff *pma2);
6295         __isl_give isl_union_pw_aff *isl_union_pw_aff_sub(
6296                 __isl_take isl_union_pw_aff *upa1,
6297                 __isl_take isl_union_pw_aff *upa2);
6298         __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_sub(
6299                 __isl_take isl_union_pw_multi_aff *upma1,
6300                 __isl_take isl_union_pw_multi_aff *upma2);
6301         __isl_give isl_multi_union_pw_aff *
6302         isl_multi_union_pw_aff_sub(
6303                 __isl_take isl_multi_union_pw_aff *mupa1,
6304                 __isl_take isl_multi_union_pw_aff *mupa2);
6306 C<isl_aff_sub> subtracts the second argument from the first.
6308         #include <isl/polynomial.h>
6309         __isl_give isl_qpolynomial *isl_qpolynomial_add(
6310                 __isl_take isl_qpolynomial *qp1,
6311                 __isl_take isl_qpolynomial *qp2);
6312         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
6313                 __isl_take isl_pw_qpolynomial *pwqp1,
6314                 __isl_take isl_pw_qpolynomial *pwqp2);
6315         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
6316                 __isl_take isl_pw_qpolynomial *pwqp1,
6317                 __isl_take isl_pw_qpolynomial *pwqp2);
6318         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
6319                 __isl_take isl_pw_qpolynomial_fold *pwf1,
6320                 __isl_take isl_pw_qpolynomial_fold *pwf2);
6321         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
6322                 __isl_take isl_union_pw_qpolynomial *upwqp1,
6323                 __isl_take isl_union_pw_qpolynomial *upwqp2);
6324         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
6325                 __isl_take isl_qpolynomial *qp1,
6326                 __isl_take isl_qpolynomial *qp2);
6327         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
6328                 __isl_take isl_pw_qpolynomial *pwqp1,
6329                 __isl_take isl_pw_qpolynomial *pwqp2);
6330         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
6331                 __isl_take isl_union_pw_qpolynomial *upwqp1,
6332                 __isl_take isl_union_pw_qpolynomial *upwqp2);
6333         __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
6334                 __isl_take isl_pw_qpolynomial_fold *pwf1,
6335                 __isl_take isl_pw_qpolynomial_fold *pwf2);
6336         __isl_give isl_union_pw_qpolynomial_fold *
6337         isl_union_pw_qpolynomial_fold_fold(
6338                 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
6339                 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
6341         #include <isl/aff.h>
6342         __isl_give isl_pw_aff *isl_pw_aff_union_add(
6343                 __isl_take isl_pw_aff *pwaff1,
6344                 __isl_take isl_pw_aff *pwaff2);
6345         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
6346                 __isl_take isl_pw_multi_aff *pma1,
6347                 __isl_take isl_pw_multi_aff *pma2);
6348         __isl_give isl_union_pw_aff *isl_union_pw_aff_union_add(
6349                 __isl_take isl_union_pw_aff *upa1,
6350                 __isl_take isl_union_pw_aff *upa2);
6351         __isl_give isl_union_pw_multi_aff *
6352         isl_union_pw_multi_aff_union_add(
6353                 __isl_take isl_union_pw_multi_aff *upma1,
6354                 __isl_take isl_union_pw_multi_aff *upma2);
6355         __isl_give isl_multi_union_pw_aff *
6356         isl_multi_union_pw_aff_union_add(
6357                 __isl_take isl_multi_union_pw_aff *mupa1,
6358                 __isl_take isl_multi_union_pw_aff *mupa2);
6359         __isl_give isl_pw_aff *isl_pw_aff_union_min(
6360                 __isl_take isl_pw_aff *pwaff1,
6361                 __isl_take isl_pw_aff *pwaff2);
6362         __isl_give isl_pw_aff *isl_pw_aff_union_max(
6363                 __isl_take isl_pw_aff *pwaff1,
6364                 __isl_take isl_pw_aff *pwaff2);
6366 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
6367 expression with a domain that is the union of those of C<pwaff1> and
6368 C<pwaff2> and such that on each cell, the quasi-affine expression is
6369 the maximum of those of C<pwaff1> and C<pwaff2>.  If only one of
6370 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
6371 associated expression is the defined one.
6372 This in contrast to the C<isl_pw_aff_max> function, which is
6373 only defined on the shared definition domain of the arguments.
6375         #include <isl/val.h>
6376         __isl_give isl_multi_val *isl_multi_val_add_val(
6377                 __isl_take isl_multi_val *mv,
6378                 __isl_take isl_val *v);
6379         __isl_give isl_multi_val *isl_multi_val_mod_val(
6380                 __isl_take isl_multi_val *mv,
6381                 __isl_take isl_val *v);
6382         __isl_give isl_multi_val *isl_multi_val_scale_val(
6383                 __isl_take isl_multi_val *mv,
6384                 __isl_take isl_val *v);
6385         __isl_give isl_multi_val *isl_multi_val_scale_down_val(
6386                 __isl_take isl_multi_val *mv,
6387                 __isl_take isl_val *v);
6389         #include <isl/aff.h>
6390         __isl_give isl_aff *isl_aff_mod_val(__isl_take isl_aff *aff,
6391                 __isl_take isl_val *mod);
6392         __isl_give isl_pw_aff *isl_pw_aff_mod_val(
6393                 __isl_take isl_pw_aff *pa,
6394                 __isl_take isl_val *mod);
6395         __isl_give isl_union_pw_aff *isl_union_pw_aff_mod_val(
6396                 __isl_take isl_union_pw_aff *upa,
6397                 __isl_take isl_val *f);
6398         __isl_give isl_aff *isl_aff_scale_val(__isl_take isl_aff *aff,
6399                 __isl_take isl_val *v);
6400         __isl_give isl_multi_aff *isl_multi_aff_scale_val(
6401                 __isl_take isl_multi_aff *ma,
6402                 __isl_take isl_val *v);
6403         __isl_give isl_pw_aff *isl_pw_aff_scale_val(
6404                 __isl_take isl_pw_aff *pa, __isl_take isl_val *v);
6405         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_scale_val(
6406                 __isl_take isl_multi_pw_aff *mpa,
6407                 __isl_take isl_val *v);
6408         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_val(
6409                 __isl_take isl_pw_multi_aff *pma,
6410                 __isl_take isl_val *v);
6411         __isl_give isl_union_pw_multi_aff *
6412         __isl_give isl_union_pw_aff *isl_union_pw_aff_scale_val(
6413                 __isl_take isl_union_pw_aff *upa,
6414                 __isl_take isl_val *f);
6415         isl_union_pw_multi_aff_scale_val(
6416                 __isl_take isl_union_pw_multi_aff *upma,
6417                 __isl_take isl_val *val);
6418         __isl_give isl_multi_union_pw_aff *
6419         isl_multi_union_pw_aff_scale_val(
6420                 __isl_take isl_multi_union_pw_aff *mupa,
6421                 __isl_take isl_val *v);
6422         __isl_give isl_aff *isl_aff_scale_down_ui(
6423                 __isl_take isl_aff *aff, unsigned f);
6424         __isl_give isl_aff *isl_aff_scale_down_val(
6425                 __isl_take isl_aff *aff, __isl_take isl_val *v);
6426         __isl_give isl_multi_aff *isl_multi_aff_scale_down_val(
6427                 __isl_take isl_multi_aff *ma,
6428                 __isl_take isl_val *v);
6429         __isl_give isl_pw_aff *isl_pw_aff_scale_down_val(
6430                 __isl_take isl_pw_aff *pa,
6431                 __isl_take isl_val *f);
6432         __isl_give isl_multi_pw_aff *isl_multi_pw_aff_scale_down_val(
6433                 __isl_take isl_multi_pw_aff *mpa,
6434                 __isl_take isl_val *v);
6435         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_down_val(
6436                 __isl_take isl_pw_multi_aff *pma,
6437                 __isl_take isl_val *v);
6438         __isl_give isl_union_pw_aff *isl_union_pw_aff_scale_down_val(
6439                 __isl_take isl_union_pw_aff *upa,
6440                 __isl_take isl_val *v);
6441         __isl_give isl_union_pw_multi_aff *
6442         isl_union_pw_multi_aff_scale_down_val(
6443                 __isl_take isl_union_pw_multi_aff *upma,
6444                 __isl_take isl_val *val);
6445         __isl_give isl_multi_union_pw_aff *
6446         isl_multi_union_pw_aff_scale_down_val(
6447                 __isl_take isl_multi_union_pw_aff *mupa,
6448                 __isl_take isl_val *v);
6450         #include <isl/polynomial.h>
6451         __isl_give isl_qpolynomial *isl_qpolynomial_scale_val(
6452                 __isl_take isl_qpolynomial *qp,
6453                 __isl_take isl_val *v);
6454         __isl_give isl_qpolynomial_fold *
6455         isl_qpolynomial_fold_scale_val(
6456                 __isl_take isl_qpolynomial_fold *fold,
6457                 __isl_take isl_val *v);
6458         __isl_give isl_pw_qpolynomial *
6459         isl_pw_qpolynomial_scale_val(
6460                 __isl_take isl_pw_qpolynomial *pwqp,
6461                 __isl_take isl_val *v);
6462         __isl_give isl_pw_qpolynomial_fold *
6463         isl_pw_qpolynomial_fold_scale_val(
6464                 __isl_take isl_pw_qpolynomial_fold *pwf,
6465                 __isl_take isl_val *v);
6466         __isl_give isl_union_pw_qpolynomial *
6467         isl_union_pw_qpolynomial_scale_val(
6468                 __isl_take isl_union_pw_qpolynomial *upwqp,
6469                 __isl_take isl_val *v);
6470         __isl_give isl_union_pw_qpolynomial_fold *
6471         isl_union_pw_qpolynomial_fold_scale_val(
6472                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6473                 __isl_take isl_val *v);
6474         __isl_give isl_qpolynomial *
6475         isl_qpolynomial_scale_down_val(
6476                 __isl_take isl_qpolynomial *qp,
6477                 __isl_take isl_val *v);
6478         __isl_give isl_qpolynomial_fold *
6479         isl_qpolynomial_fold_scale_down_val(
6480                 __isl_take isl_qpolynomial_fold *fold,
6481                 __isl_take isl_val *v);
6482         __isl_give isl_pw_qpolynomial *
6483         isl_pw_qpolynomial_scale_down_val(
6484                 __isl_take isl_pw_qpolynomial *pwqp,
6485                 __isl_take isl_val *v);
6486         __isl_give isl_pw_qpolynomial_fold *
6487         isl_pw_qpolynomial_fold_scale_down_val(
6488                 __isl_take isl_pw_qpolynomial_fold *pwf,
6489                 __isl_take isl_val *v);
6490         __isl_give isl_union_pw_qpolynomial *
6491         isl_union_pw_qpolynomial_scale_down_val(
6492                 __isl_take isl_union_pw_qpolynomial *upwqp,
6493                 __isl_take isl_val *v);
6494         __isl_give isl_union_pw_qpolynomial_fold *
6495         isl_union_pw_qpolynomial_fold_scale_down_val(
6496                 __isl_take isl_union_pw_qpolynomial_fold *upwf,
6497                 __isl_take isl_val *v);
6499         #include <isl/val.h>
6500         __isl_give isl_multi_val *isl_multi_val_mod_multi_val(
6501                 __isl_take isl_multi_val *mv1,
6502                 __isl_take isl_multi_val *mv2);
6503         __isl_give isl_multi_val *isl_multi_val_scale_multi_val(
6504                 __isl_take isl_multi_val *mv1,
6505                 __isl_take isl_multi_val *mv2);
6506         __isl_give isl_multi_val *
6507         isl_multi_val_scale_down_multi_val(
6508                 __isl_take isl_multi_val *mv1,
6509                 __isl_take isl_multi_val *mv2);
6511         #include <isl/aff.h>
6512         __isl_give isl_multi_aff *isl_multi_aff_mod_multi_val(
6513                 __isl_take isl_multi_aff *ma,
6514                 __isl_take isl_multi_val *mv);
6515         __isl_give isl_multi_union_pw_aff *
6516         isl_multi_union_pw_aff_mod_multi_val(
6517                 __isl_take isl_multi_union_pw_aff *upma,
6518                 __isl_take isl_multi_val *mv);
6519         __isl_give isl_multi_pw_aff *
6520         isl_multi_pw_aff_mod_multi_val(
6521                 __isl_take isl_multi_pw_aff *mpa,
6522                 __isl_take isl_multi_val *mv);
6523         __isl_give isl_multi_aff *isl_multi_aff_scale_multi_val(
6524                 __isl_take isl_multi_aff *ma,
6525                 __isl_take isl_multi_val *mv);
6526         __isl_give isl_pw_multi_aff *
6527         isl_pw_multi_aff_scale_multi_val(
6528                 __isl_take isl_pw_multi_aff *pma,
6529                 __isl_take isl_multi_val *mv);
6530         __isl_give isl_multi_pw_aff *
6531         isl_multi_pw_aff_scale_multi_val(
6532                 __isl_take isl_multi_pw_aff *mpa,
6533                 __isl_take isl_multi_val *mv);
6534         __isl_give isl_multi_union_pw_aff *
6535         isl_multi_union_pw_aff_scale_multi_val(
6536                 __isl_take isl_multi_union_pw_aff *mupa,
6537                 __isl_take isl_multi_val *mv);
6538         __isl_give isl_union_pw_multi_aff *
6539         isl_union_pw_multi_aff_scale_multi_val(
6540                 __isl_take isl_union_pw_multi_aff *upma,
6541                 __isl_take isl_multi_val *mv);
6542         __isl_give isl_multi_aff *
6543         isl_multi_aff_scale_down_multi_val(
6544                 __isl_take isl_multi_aff *ma,
6545                 __isl_take isl_multi_val *mv);
6546         __isl_give isl_multi_pw_aff *
6547         isl_multi_pw_aff_scale_down_multi_val(
6548                 __isl_take isl_multi_pw_aff *mpa,
6549                 __isl_take isl_multi_val *mv);
6550         __isl_give isl_multi_union_pw_aff *
6551         isl_multi_union_pw_aff_scale_down_multi_val(
6552                 __isl_take isl_multi_union_pw_aff *mupa,
6553                 __isl_take isl_multi_val *mv);
6555 C<isl_multi_aff_scale_multi_val> scales the elements of C<ma>
6556 by the corresponding elements of C<mv>.
6558         #include <isl/aff.h>
6559         __isl_give isl_aff *isl_aff_mul(
6560                 __isl_take isl_aff *aff1,
6561                 __isl_take isl_aff *aff2);
6562         __isl_give isl_aff *isl_aff_div(
6563                 __isl_take isl_aff *aff1,
6564                 __isl_take isl_aff *aff2);
6565         __isl_give isl_pw_aff *isl_pw_aff_mul(
6566                 __isl_take isl_pw_aff *pwaff1,
6567                 __isl_take isl_pw_aff *pwaff2);
6568         __isl_give isl_pw_aff *isl_pw_aff_div(
6569                 __isl_take isl_pw_aff *pa1,
6570                 __isl_take isl_pw_aff *pa2);
6571         __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
6572                 __isl_take isl_pw_aff *pa1,
6573                 __isl_take isl_pw_aff *pa2);
6574         __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
6575                 __isl_take isl_pw_aff *pa1,
6576                 __isl_take isl_pw_aff *pa2);
6578 When multiplying two affine expressions, at least one of the two needs
6579 to be a constant.  Similarly, when dividing an affine expression by another,
6580 the second expression needs to be a constant.
6581 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
6582 rounding towards zero.  C<isl_pw_aff_tdiv_r> computes the corresponding
6583 remainder.
6585         #include <isl/polynomial.h>
6586         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
6587                 __isl_take isl_qpolynomial *qp1,
6588                 __isl_take isl_qpolynomial *qp2);
6589         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
6590                 __isl_take isl_pw_qpolynomial *pwqp1,
6591                 __isl_take isl_pw_qpolynomial *pwqp2);
6592         __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
6593                 __isl_take isl_union_pw_qpolynomial *upwqp1,
6594                 __isl_take isl_union_pw_qpolynomial *upwqp2);
6596 =back
6598 =head3 Lexicographic Optimization
6600 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
6601 the following functions
6602 compute a set that contains the lexicographic minimum or maximum
6603 of the elements in C<set> (or C<bset>) for those values of the parameters
6604 that satisfy C<dom>.
6605 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
6606 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
6607 has no elements.
6608 In other words, the union of the parameter values
6609 for which the result is non-empty and of C<*empty>
6610 is equal to C<dom>.
6612         #include <isl/set.h>
6613         __isl_give isl_set *isl_basic_set_partial_lexmin(
6614                 __isl_take isl_basic_set *bset,
6615                 __isl_take isl_basic_set *dom,
6616                 __isl_give isl_set **empty);
6617         __isl_give isl_set *isl_basic_set_partial_lexmax(
6618                 __isl_take isl_basic_set *bset,
6619                 __isl_take isl_basic_set *dom,
6620                 __isl_give isl_set **empty);
6621         __isl_give isl_set *isl_set_partial_lexmin(
6622                 __isl_take isl_set *set, __isl_take isl_set *dom,
6623                 __isl_give isl_set **empty);
6624         __isl_give isl_set *isl_set_partial_lexmax(
6625                 __isl_take isl_set *set, __isl_take isl_set *dom,
6626                 __isl_give isl_set **empty);
6628 Given a (basic) set C<set> (or C<bset>), the following functions simply
6629 return a set containing the lexicographic minimum or maximum
6630 of the elements in C<set> (or C<bset>).
6631 In case of union sets, the optimum is computed per space.
6633         #include <isl/set.h>
6634         __isl_give isl_set *isl_basic_set_lexmin(
6635                 __isl_take isl_basic_set *bset);
6636         __isl_give isl_set *isl_basic_set_lexmax(
6637                 __isl_take isl_basic_set *bset);
6638         __isl_give isl_set *isl_set_lexmin(
6639                 __isl_take isl_set *set);
6640         __isl_give isl_set *isl_set_lexmax(
6641                 __isl_take isl_set *set);
6642         __isl_give isl_union_set *isl_union_set_lexmin(
6643                 __isl_take isl_union_set *uset);
6644         __isl_give isl_union_set *isl_union_set_lexmax(
6645                 __isl_take isl_union_set *uset);
6647 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
6648 the following functions
6649 compute a relation that maps each element of C<dom>
6650 to the single lexicographic minimum or maximum
6651 of the elements that are associated to that same
6652 element in C<map> (or C<bmap>).
6653 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
6654 that contains the elements in C<dom> that do not map
6655 to any elements in C<map> (or C<bmap>).
6656 In other words, the union of the domain of the result and of C<*empty>
6657 is equal to C<dom>.
6659         #include <isl/map.h>
6660         __isl_give isl_map *isl_basic_map_partial_lexmax(
6661                 __isl_take isl_basic_map *bmap,
6662                 __isl_take isl_basic_set *dom,
6663                 __isl_give isl_set **empty);
6664         __isl_give isl_map *isl_basic_map_partial_lexmin(
6665                 __isl_take isl_basic_map *bmap,
6666                 __isl_take isl_basic_set *dom,
6667                 __isl_give isl_set **empty);
6668         __isl_give isl_map *isl_map_partial_lexmax(
6669                 __isl_take isl_map *map, __isl_take isl_set *dom,
6670                 __isl_give isl_set **empty);
6671         __isl_give isl_map *isl_map_partial_lexmin(
6672                 __isl_take isl_map *map, __isl_take isl_set *dom,
6673                 __isl_give isl_set **empty);
6675 Given a (basic) map C<map> (or C<bmap>), the following functions simply
6676 return a map mapping each element in the domain of
6677 C<map> (or C<bmap>) to the lexicographic minimum or maximum
6678 of all elements associated to that element.
6679 In case of union relations, the optimum is computed per space.
6681         #include <isl/map.h>
6682         __isl_give isl_map *isl_basic_map_lexmin(
6683                 __isl_take isl_basic_map *bmap);
6684         __isl_give isl_map *isl_basic_map_lexmax(
6685                 __isl_take isl_basic_map *bmap);
6686         __isl_give isl_map *isl_map_lexmin(
6687                 __isl_take isl_map *map);
6688         __isl_give isl_map *isl_map_lexmax(
6689                 __isl_take isl_map *map);
6690         __isl_give isl_union_map *isl_union_map_lexmin(
6691                 __isl_take isl_union_map *umap);
6692         __isl_give isl_union_map *isl_union_map_lexmax(
6693                 __isl_take isl_union_map *umap);
6695 The following functions return their result in the form of
6696 a piecewise multi-affine expression,
6697 but are otherwise equivalent to the corresponding functions
6698 returning a basic set or relation.
6700         #include <isl/set.h>
6701         __isl_give isl_pw_multi_aff *
6702         isl_basic_set_partial_lexmin_pw_multi_aff(
6703                 __isl_take isl_basic_set *bset,
6704                 __isl_take isl_basic_set *dom,
6705                 __isl_give isl_set **empty);
6706         __isl_give isl_pw_multi_aff *
6707         isl_basic_set_partial_lexmax_pw_multi_aff(
6708                 __isl_take isl_basic_set *bset,
6709                 __isl_take isl_basic_set *dom,
6710                 __isl_give isl_set **empty);
6711         __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
6712                 __isl_take isl_set *set);
6713         __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
6714                 __isl_take isl_set *set);
6716         #include <isl/map.h>
6717         __isl_give isl_pw_multi_aff *
6718         isl_basic_map_lexmin_pw_multi_aff(
6719                 __isl_take isl_basic_map *bmap);
6720         __isl_give isl_pw_multi_aff *
6721         isl_basic_map_partial_lexmin_pw_multi_aff(
6722                 __isl_take isl_basic_map *bmap,
6723                 __isl_take isl_basic_set *dom,
6724                 __isl_give isl_set **empty);
6725         __isl_give isl_pw_multi_aff *
6726         isl_basic_map_partial_lexmax_pw_multi_aff(
6727                 __isl_take isl_basic_map *bmap,
6728                 __isl_take isl_basic_set *dom,
6729                 __isl_give isl_set **empty);
6730         __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
6731                 __isl_take isl_map *map);
6732         __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
6733                 __isl_take isl_map *map);
6735 The following functions return the lexicographic minimum or maximum
6736 on the shared domain of the inputs and the single defined function
6737 on those parts of the domain where only a single function is defined.
6739         #include <isl/aff.h>
6740         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
6741                 __isl_take isl_pw_multi_aff *pma1,
6742                 __isl_take isl_pw_multi_aff *pma2);
6743         __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
6744                 __isl_take isl_pw_multi_aff *pma1,
6745                 __isl_take isl_pw_multi_aff *pma2);
6747 =head2 Ternary Operations
6749         #include <isl/aff.h>
6750         __isl_give isl_pw_aff *isl_pw_aff_cond(
6751                 __isl_take isl_pw_aff *cond,
6752                 __isl_take isl_pw_aff *pwaff_true,
6753                 __isl_take isl_pw_aff *pwaff_false);
6755 The function C<isl_pw_aff_cond> performs a conditional operator
6756 and returns an expression that is equal to C<pwaff_true>
6757 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
6758 where C<cond> is zero.
6760 =head2 Lists
6762 Lists are defined over several element types, including
6763 C<isl_val>, C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_union_pw_aff>,
6764 C<isl_union_pw_multi_aff>, C<isl_constraint>,
6765 C<isl_basic_set>, C<isl_set>, C<isl_basic_map>, C<isl_map>, C<isl_union_set>,
6766 C<isl_union_map>, C<isl_ast_expr> and C<isl_ast_node>.
6767 Here we take lists of C<isl_set>s as an example.
6768 Lists can be created, copied, modified and freed using the following functions.
6770         #include <isl/set.h>
6771         __isl_give isl_set_list *isl_set_list_from_set(
6772                 __isl_take isl_set *el);
6773         __isl_give isl_set_list *isl_set_list_alloc(
6774                 isl_ctx *ctx, int n);
6775         __isl_give isl_set_list *isl_set_list_copy(
6776                 __isl_keep isl_set_list *list);
6777         __isl_give isl_set_list *isl_set_list_insert(
6778                 __isl_take isl_set_list *list, unsigned pos,
6779                 __isl_take isl_set *el);
6780         __isl_give isl_set_list *isl_set_list_add(
6781                 __isl_take isl_set_list *list,
6782                 __isl_take isl_set *el);
6783         __isl_give isl_set_list *isl_set_list_drop(
6784                 __isl_take isl_set_list *list,
6785                 unsigned first, unsigned n);
6786         __isl_give isl_set_list *isl_set_list_set_set(
6787                 __isl_take isl_set_list *list, int index,
6788                 __isl_take isl_set *set);
6789         __isl_give isl_set_list *isl_set_list_concat(
6790                 __isl_take isl_set_list *list1,
6791                 __isl_take isl_set_list *list2);
6792         __isl_give isl_set_list *isl_set_list_sort(
6793                 __isl_take isl_set_list *list,
6794                 int (*cmp)(__isl_keep isl_set *a,
6795                         __isl_keep isl_set *b, void *user),
6796                 void *user);
6797         __isl_null isl_set_list *isl_set_list_free(
6798                 __isl_take isl_set_list *list);
6800 C<isl_set_list_alloc> creates an empty list with an initial capacity
6801 for C<n> elements.  C<isl_set_list_insert> and C<isl_set_list_add>
6802 add elements to a list, increasing its capacity as needed.
6803 C<isl_set_list_from_set> creates a list with a single element.
6805 Lists can be inspected using the following functions.
6807         #include <isl/set.h>
6808         int isl_set_list_n_set(__isl_keep isl_set_list *list);
6809         __isl_give isl_set *isl_set_list_get_set(
6810                 __isl_keep isl_set_list *list, int index);
6811         int isl_set_list_foreach(__isl_keep isl_set_list *list,
6812                 int (*fn)(__isl_take isl_set *el, void *user),
6813                 void *user);
6814         int isl_set_list_foreach_scc(__isl_keep isl_set_list *list,
6815                 int (*follows)(__isl_keep isl_set *a,
6816                         __isl_keep isl_set *b, void *user),
6817                 void *follows_user
6818                 int (*fn)(__isl_take isl_set *el, void *user),
6819                 void *fn_user);
6821 The function C<isl_set_list_foreach_scc> calls C<fn> on each of the
6822 strongly connected components of the graph with as vertices the elements
6823 of C<list> and a directed edge from vertex C<b> to vertex C<a>
6824 iff C<follows(a, b)> returns C<1>.  The callbacks C<follows> and C<fn>
6825 should return C<-1> on error.
6827 Lists can be printed using
6829         #include <isl/set.h>
6830         __isl_give isl_printer *isl_printer_print_set_list(
6831                 __isl_take isl_printer *p,
6832                 __isl_keep isl_set_list *list);
6834 =head2 Associative arrays
6836 Associative arrays map isl objects of a specific type to isl objects
6837 of some (other) specific type.  They are defined for several pairs
6838 of types, including (C<isl_map>, C<isl_basic_set>),
6839 (C<isl_id>, C<isl_ast_expr>) and.
6840 (C<isl_id>, C<isl_pw_aff>).
6841 Here, we take associative arrays that map C<isl_id>s to C<isl_ast_expr>s
6842 as an example.
6844 Associative arrays can be created, copied and freed using
6845 the following functions.
6847         #include <isl/id_to_ast_expr.h>
6848         __isl_give id_to_ast_expr *isl_id_to_ast_expr_alloc(
6849                 isl_ctx *ctx, int min_size);
6850         __isl_give id_to_ast_expr *isl_id_to_ast_expr_copy(
6851                 __isl_keep id_to_ast_expr *id2expr);
6852         __isl_null id_to_ast_expr *isl_id_to_ast_expr_free(
6853                 __isl_take id_to_ast_expr *id2expr);
6855 The C<min_size> argument to C<isl_id_to_ast_expr_alloc> can be used
6856 to specify the expected size of the associative array.
6857 The associative array will be grown automatically as needed.
6859 Associative arrays can be inspected using the following functions.
6861         #include <isl/id_to_ast_expr.h>
6862         int isl_id_to_ast_expr_has(
6863                 __isl_keep id_to_ast_expr *id2expr,
6864                 __isl_keep isl_id *key);
6865         __isl_give isl_ast_expr *isl_id_to_ast_expr_get(
6866                 __isl_keep id_to_ast_expr *id2expr,
6867                 __isl_take isl_id *key);
6868         int isl_id_to_ast_expr_foreach(
6869                 __isl_keep id_to_ast_expr *id2expr,
6870                 int (*fn)(__isl_take isl_id *key,
6871                         __isl_take isl_ast_expr *val, void *user),
6872                 void *user);
6874 They can be modified using the following function.
6876         #include <isl/id_to_ast_expr.h>
6877         __isl_give id_to_ast_expr *isl_id_to_ast_expr_set(
6878                 __isl_take id_to_ast_expr *id2expr,
6879                 __isl_take isl_id *key,
6880                 __isl_take isl_ast_expr *val);
6881         __isl_give id_to_ast_expr *isl_id_to_ast_expr_drop(
6882                 __isl_take id_to_ast_expr *id2expr,
6883                 __isl_take isl_id *key);
6885 Associative arrays can be printed using the following function.
6887         #include <isl/id_to_ast_expr.h>
6888         __isl_give isl_printer *isl_printer_print_id_to_ast_expr(
6889                 __isl_take isl_printer *p,
6890                 __isl_keep id_to_ast_expr *id2expr);
6892 =head2 Vectors
6894 Vectors can be created, copied and freed using the following functions.
6896         #include <isl/vec.h>
6897         __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
6898                 unsigned size);
6899         __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
6900         __isl_null isl_vec *isl_vec_free(__isl_take isl_vec *vec);
6902 Note that the elements of a newly created vector may have arbitrary values.
6903 The elements can be changed and inspected using the following functions.
6905         int isl_vec_size(__isl_keep isl_vec *vec);
6906         __isl_give isl_val *isl_vec_get_element_val(
6907                 __isl_keep isl_vec *vec, int pos);
6908         __isl_give isl_vec *isl_vec_set_element_si(
6909                 __isl_take isl_vec *vec, int pos, int v);
6910         __isl_give isl_vec *isl_vec_set_element_val(
6911                 __isl_take isl_vec *vec, int pos,
6912                 __isl_take isl_val *v);
6913         __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
6914                 int v);
6915         __isl_give isl_vec *isl_vec_set_val(
6916                 __isl_take isl_vec *vec, __isl_take isl_val *v);
6917         int isl_vec_cmp_element(__isl_keep isl_vec *vec1,
6918                 __isl_keep isl_vec *vec2, int pos);
6920 C<isl_vec_get_element> will return a negative value if anything went wrong.
6921 In that case, the value of C<*v> is undefined.
6923 The following function can be used to concatenate two vectors.
6925         __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
6926                 __isl_take isl_vec *vec2);
6928 =head2 Matrices
6930 Matrices can be created, copied and freed using the following functions.
6932         #include <isl/mat.h>
6933         __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
6934                 unsigned n_row, unsigned n_col);
6935         __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
6936         __isl_null isl_mat *isl_mat_free(__isl_take isl_mat *mat);
6938 Note that the elements of a newly created matrix may have arbitrary values.
6939 The elements can be changed and inspected using the following functions.
6941         int isl_mat_rows(__isl_keep isl_mat *mat);
6942         int isl_mat_cols(__isl_keep isl_mat *mat);
6943         __isl_give isl_val *isl_mat_get_element_val(
6944                 __isl_keep isl_mat *mat, int row, int col);
6945         __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
6946                 int row, int col, int v);
6947         __isl_give isl_mat *isl_mat_set_element_val(
6948                 __isl_take isl_mat *mat, int row, int col,
6949                 __isl_take isl_val *v);
6951 C<isl_mat_get_element> will return a negative value if anything went wrong.
6952 In that case, the value of C<*v> is undefined.
6954 The following function can be used to compute the (right) inverse
6955 of a matrix, i.e., a matrix such that the product of the original
6956 and the inverse (in that order) is a multiple of the identity matrix.
6957 The input matrix is assumed to be of full row-rank.
6959         __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
6961 The following function can be used to compute the (right) kernel
6962 (or null space) of a matrix, i.e., a matrix such that the product of
6963 the original and the kernel (in that order) is the zero matrix.
6965         __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
6967 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
6969 The following functions determine
6970 an upper or lower bound on a quasipolynomial over its domain.
6972         __isl_give isl_pw_qpolynomial_fold *
6973         isl_pw_qpolynomial_bound(
6974                 __isl_take isl_pw_qpolynomial *pwqp,
6975                 enum isl_fold type, int *tight);
6977         __isl_give isl_union_pw_qpolynomial_fold *
6978         isl_union_pw_qpolynomial_bound(
6979                 __isl_take isl_union_pw_qpolynomial *upwqp,
6980                 enum isl_fold type, int *tight);
6982 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
6983 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
6984 is the returned bound is known be tight, i.e., for each value
6985 of the parameters there is at least
6986 one element in the domain that reaches the bound.
6987 If the domain of C<pwqp> is not wrapping, then the bound is computed
6988 over all elements in that domain and the result has a purely parametric
6989 domain.  If the domain of C<pwqp> is wrapping, then the bound is
6990 computed over the range of the wrapped relation.  The domain of the
6991 wrapped relation becomes the domain of the result.
6993 =head2 Parametric Vertex Enumeration
6995 The parametric vertex enumeration described in this section
6996 is mainly intended to be used internally and by the C<barvinok>
6997 library.
6999         #include <isl/vertices.h>
7000         __isl_give isl_vertices *isl_basic_set_compute_vertices(
7001                 __isl_keep isl_basic_set *bset);
7003 The function C<isl_basic_set_compute_vertices> performs the
7004 actual computation of the parametric vertices and the chamber
7005 decomposition and store the result in an C<isl_vertices> object.
7006 This information can be queried by either iterating over all
7007 the vertices or iterating over all the chambers or cells
7008 and then iterating over all vertices that are active on the chamber.
7010         int isl_vertices_foreach_vertex(
7011                 __isl_keep isl_vertices *vertices,
7012                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
7013                 void *user);
7015         int isl_vertices_foreach_cell(
7016                 __isl_keep isl_vertices *vertices,
7017                 int (*fn)(__isl_take isl_cell *cell, void *user),
7018                 void *user);
7019         int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
7020                 int (*fn)(__isl_take isl_vertex *vertex, void *user),
7021                 void *user);
7023 Other operations that can be performed on an C<isl_vertices> object are
7024 the following.
7026         int isl_vertices_get_n_vertices(
7027                 __isl_keep isl_vertices *vertices);
7028         void isl_vertices_free(__isl_take isl_vertices *vertices);
7030 Vertices can be inspected and destroyed using the following functions.
7032         int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
7033         __isl_give isl_basic_set *isl_vertex_get_domain(
7034                 __isl_keep isl_vertex *vertex);
7035         __isl_give isl_multi_aff *isl_vertex_get_expr(
7036                 __isl_keep isl_vertex *vertex);
7037         void isl_vertex_free(__isl_take isl_vertex *vertex);
7039 C<isl_vertex_get_expr> returns a multiple quasi-affine expression
7040 describing the vertex in terms of the parameters,
7041 while C<isl_vertex_get_domain> returns the activity domain
7042 of the vertex.
7044 Chambers can be inspected and destroyed using the following functions.
7046         __isl_give isl_basic_set *isl_cell_get_domain(
7047                 __isl_keep isl_cell *cell);
7048         void isl_cell_free(__isl_take isl_cell *cell);
7050 =head1 Polyhedral Compilation Library
7052 This section collects functionality in C<isl> that has been specifically
7053 designed for use during polyhedral compilation.
7055 =head2 Dependence Analysis
7057 C<isl> contains specialized functionality for performing
7058 array dataflow analysis.  That is, given a I<sink> access relation
7059 and a collection of possible I<source> access relations,
7060 C<isl> can compute relations that describe
7061 for each iteration of the sink access, which iteration
7062 of which of the source access relations was the last
7063 to access the same data element before the given iteration
7064 of the sink access.
7065 The resulting dependence relations map source iterations
7066 to the corresponding sink iterations.
7067 To compute standard flow dependences, the sink should be
7068 a read, while the sources should be writes.
7069 If any of the source accesses are marked as being I<may>
7070 accesses, then there will be a dependence from the last
7071 I<must> access B<and> from any I<may> access that follows
7072 this last I<must> access.
7073 In particular, if I<all> sources are I<may> accesses,
7074 then memory based dependence analysis is performed.
7075 If, on the other hand, all sources are I<must> accesses,
7076 then value based dependence analysis is performed.
7078         #include <isl/flow.h>
7080         typedef int (*isl_access_level_before)(void *first, void *second);
7082         __isl_give isl_access_info *isl_access_info_alloc(
7083                 __isl_take isl_map *sink,
7084                 void *sink_user, isl_access_level_before fn,
7085                 int max_source);
7086         __isl_give isl_access_info *isl_access_info_add_source(
7087                 __isl_take isl_access_info *acc,
7088                 __isl_take isl_map *source, int must,
7089                 void *source_user);
7090         __isl_null isl_access_info *isl_access_info_free(
7091                 __isl_take isl_access_info *acc);
7093         __isl_give isl_flow *isl_access_info_compute_flow(
7094                 __isl_take isl_access_info *acc);
7096         int isl_flow_foreach(__isl_keep isl_flow *deps,
7097                 int (*fn)(__isl_take isl_map *dep, int must,
7098                           void *dep_user, void *user),
7099                 void *user);
7100         __isl_give isl_map *isl_flow_get_no_source(
7101                 __isl_keep isl_flow *deps, int must);
7102         void isl_flow_free(__isl_take isl_flow *deps);
7104 The function C<isl_access_info_compute_flow> performs the actual
7105 dependence analysis.  The other functions are used to construct
7106 the input for this function or to read off the output.
7108 The input is collected in an C<isl_access_info>, which can
7109 be created through a call to C<isl_access_info_alloc>.
7110 The arguments to this functions are the sink access relation
7111 C<sink>, a token C<sink_user> used to identify the sink
7112 access to the user, a callback function for specifying the
7113 relative order of source and sink accesses, and the number
7114 of source access relations that will be added.
7115 The callback function has type C<int (*)(void *first, void *second)>.
7116 The function is called with two user supplied tokens identifying
7117 either a source or the sink and it should return the shared nesting
7118 level and the relative order of the two accesses.
7119 In particular, let I<n> be the number of loops shared by
7120 the two accesses.  If C<first> precedes C<second> textually,
7121 then the function should return I<2 * n + 1>; otherwise,
7122 it should return I<2 * n>.
7123 The sources can be added to the C<isl_access_info> by performing
7124 (at most) C<max_source> calls to C<isl_access_info_add_source>.
7125 C<must> indicates whether the source is a I<must> access
7126 or a I<may> access.  Note that a multi-valued access relation
7127 should only be marked I<must> if every iteration in the domain
7128 of the relation accesses I<all> elements in its image.
7129 The C<source_user> token is again used to identify
7130 the source access.  The range of the source access relation
7131 C<source> should have the same dimension as the range
7132 of the sink access relation.
7133 The C<isl_access_info_free> function should usually not be
7134 called explicitly, because it is called implicitly by
7135 C<isl_access_info_compute_flow>.
7137 The result of the dependence analysis is collected in an
7138 C<isl_flow>.  There may be elements of
7139 the sink access for which no preceding source access could be
7140 found or for which all preceding sources are I<may> accesses.
7141 The relations containing these elements can be obtained through
7142 calls to C<isl_flow_get_no_source>, the first with C<must> set
7143 and the second with C<must> unset.
7144 In the case of standard flow dependence analysis,
7145 with the sink a read and the sources I<must> writes,
7146 the first relation corresponds to the reads from uninitialized
7147 array elements and the second relation is empty.
7148 The actual flow dependences can be extracted using
7149 C<isl_flow_foreach>.  This function will call the user-specified
7150 callback function C<fn> for each B<non-empty> dependence between
7151 a source and the sink.  The callback function is called
7152 with four arguments, the actual flow dependence relation
7153 mapping source iterations to sink iterations, a boolean that
7154 indicates whether it is a I<must> or I<may> dependence, a token
7155 identifying the source and an additional C<void *> with value
7156 equal to the third argument of the C<isl_flow_foreach> call.
7157 A dependence is marked I<must> if it originates from a I<must>
7158 source and if it is not followed by any I<may> sources.
7160 After finishing with an C<isl_flow>, the user should call
7161 C<isl_flow_free> to free all associated memory.
7163 A higher-level interface to dependence analysis is provided
7164 by the following function.
7166         #include <isl/flow.h>
7168         int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
7169                 __isl_take isl_union_map *must_source,
7170                 __isl_take isl_union_map *may_source,
7171                 __isl_take isl_union_map *schedule,
7172                 __isl_give isl_union_map **must_dep,
7173                 __isl_give isl_union_map **may_dep,
7174                 __isl_give isl_union_map **must_no_source,
7175                 __isl_give isl_union_map **may_no_source);
7177 The arrays are identified by the tuple names of the ranges
7178 of the accesses.  The iteration domains by the tuple names
7179 of the domains of the accesses and of the schedule.
7180 The relative order of the iteration domains is given by the
7181 schedule.  The relations returned through C<must_no_source>
7182 and C<may_no_source> are subsets of C<sink>.
7183 Any of C<must_dep>, C<may_dep>, C<must_no_source>
7184 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
7185 any of the other arguments is treated as an error.
7187 =head3 Interaction with Dependence Analysis
7189 During the dependence analysis, we frequently need to perform
7190 the following operation.  Given a relation between sink iterations
7191 and potential source iterations from a particular source domain,
7192 what is the last potential source iteration corresponding to each
7193 sink iteration.  It can sometimes be convenient to adjust
7194 the set of potential source iterations before or after each such operation.
7195 The prototypical example is fuzzy array dataflow analysis,
7196 where we need to analyze if, based on data-dependent constraints,
7197 the sink iteration can ever be executed without one or more of
7198 the corresponding potential source iterations being executed.
7199 If so, we can introduce extra parameters and select an unknown
7200 but fixed source iteration from the potential source iterations.
7201 To be able to perform such manipulations, C<isl> provides the following
7202 function.
7204         #include <isl/flow.h>
7206         typedef __isl_give isl_restriction *(*isl_access_restrict)(
7207                 __isl_keep isl_map *source_map,
7208                 __isl_keep isl_set *sink, void *source_user,
7209                 void *user);
7210         __isl_give isl_access_info *isl_access_info_set_restrict(
7211                 __isl_take isl_access_info *acc,
7212                 isl_access_restrict fn, void *user);
7214 The function C<isl_access_info_set_restrict> should be called
7215 before calling C<isl_access_info_compute_flow> and registers a callback function
7216 that will be called any time C<isl> is about to compute the last
7217 potential source.  The first argument is the (reverse) proto-dependence,
7218 mapping sink iterations to potential source iterations.
7219 The second argument represents the sink iterations for which
7220 we want to compute the last source iteration.
7221 The third argument is the token corresponding to the source
7222 and the final argument is the token passed to C<isl_access_info_set_restrict>.
7223 The callback is expected to return a restriction on either the input or
7224 the output of the operation computing the last potential source.
7225 If the input needs to be restricted then restrictions are needed
7226 for both the source and the sink iterations.  The sink iterations
7227 and the potential source iterations will be intersected with these sets.
7228 If the output needs to be restricted then only a restriction on the source
7229 iterations is required.
7230 If any error occurs, the callback should return C<NULL>.
7231 An C<isl_restriction> object can be created, freed and inspected
7232 using the following functions.
7234         #include <isl/flow.h>
7236         __isl_give isl_restriction *isl_restriction_input(
7237                 __isl_take isl_set *source_restr,
7238                 __isl_take isl_set *sink_restr);
7239         __isl_give isl_restriction *isl_restriction_output(
7240                 __isl_take isl_set *source_restr);
7241         __isl_give isl_restriction *isl_restriction_none(
7242                 __isl_take isl_map *source_map);
7243         __isl_give isl_restriction *isl_restriction_empty(
7244                 __isl_take isl_map *source_map);
7245         __isl_null isl_restriction *isl_restriction_free(
7246                 __isl_take isl_restriction *restr);
7248 C<isl_restriction_none> and C<isl_restriction_empty> are special
7249 cases of C<isl_restriction_input>.  C<isl_restriction_none>
7250 is essentially equivalent to
7252         isl_restriction_input(isl_set_universe(
7253             isl_space_range(isl_map_get_space(source_map))),
7254                             isl_set_universe(
7255             isl_space_domain(isl_map_get_space(source_map))));
7257 whereas C<isl_restriction_empty> is essentially equivalent to
7259         isl_restriction_input(isl_set_empty(
7260             isl_space_range(isl_map_get_space(source_map))),
7261                             isl_set_universe(
7262             isl_space_domain(isl_map_get_space(source_map))));
7264 =head2 Scheduling
7266 B<The functionality described in this section is fairly new
7267 and may be subject to change.>
7269         #include <isl/schedule.h>
7270         __isl_give isl_schedule *
7271         isl_schedule_constraints_compute_schedule(
7272                 __isl_take isl_schedule_constraints *sc);
7273         __isl_null isl_schedule *isl_schedule_free(
7274                 __isl_take isl_schedule *sched);
7276 The function C<isl_schedule_constraints_compute_schedule> can be
7277 used to compute a schedule that satisfies the given schedule constraints.
7278 These schedule constraints include the iteration domain for which
7279 a schedule should be computed and dependences between pairs of
7280 iterations.  In particular, these dependences include
7281 I<validity> dependences and I<proximity> dependences.
7282 By default, the algorithm used to construct the schedule is similar
7283 to that of C<Pluto>.
7284 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
7285 be selected.
7286 The generated schedule respects all validity dependences.
7287 That is, all dependence distances over these dependences in the
7288 scheduled space are lexicographically positive.
7289 The default algorithm tries to ensure that the dependence distances
7290 over coincidence constraints are zero and to minimize the
7291 dependence distances over proximity dependences.
7292 Moreover, it tries to obtain sequences (bands) of schedule dimensions
7293 for groups of domains where the dependence distances over validity
7294 dependences have only non-negative values.
7295 When using Feautrier's algorithm, the coincidence and proximity constraints
7296 are only taken into account during the extension to a
7297 full-dimensional schedule.
7299 An C<isl_schedule_constraints> object can be constructed
7300 and manipulated using the following functions.
7302         #include <isl/schedule.h>
7303         __isl_give isl_schedule_constraints *
7304         isl_schedule_constraints_copy(
7305                 __isl_keep isl_schedule_constraints *sc);
7306         __isl_give isl_schedule_constraints *
7307         isl_schedule_constraints_on_domain(
7308                 __isl_take isl_union_set *domain);
7309         __isl_give isl_schedule_constraints *
7310         isl_schedule_constraints_set_validity(
7311                 __isl_take isl_schedule_constraints *sc,
7312                 __isl_take isl_union_map *validity);
7313         __isl_give isl_schedule_constraints *
7314         isl_schedule_constraints_set_coincidence(
7315                 __isl_take isl_schedule_constraints *sc,
7316                 __isl_take isl_union_map *coincidence);
7317         __isl_give isl_schedule_constraints *
7318         isl_schedule_constraints_set_proximity(
7319                 __isl_take isl_schedule_constraints *sc,
7320                 __isl_take isl_union_map *proximity);
7321         __isl_give isl_schedule_constraints *
7322         isl_schedule_constraints_set_conditional_validity(
7323                 __isl_take isl_schedule_constraints *sc,
7324                 __isl_take isl_union_map *condition,
7325                 __isl_take isl_union_map *validity);
7326         __isl_null isl_schedule_constraints *
7327         isl_schedule_constraints_free(
7328                 __isl_take isl_schedule_constraints *sc);
7330 The initial C<isl_schedule_constraints> object created by
7331 C<isl_schedule_constraints_on_domain> does not impose any constraints.
7332 That is, it has an empty set of dependences.
7333 The function C<isl_schedule_constraints_set_validity> replaces the
7334 validity dependences, mapping domain elements I<i> to domain
7335 elements that should be scheduled after I<i>.
7336 The function C<isl_schedule_constraints_set_coincidence> replaces the
7337 coincidence dependences, mapping domain elements I<i> to domain
7338 elements that should be scheduled together with I<I>, if possible.
7339 The function C<isl_schedule_constraints_set_proximity> replaces the
7340 proximity dependences, mapping domain elements I<i> to domain
7341 elements that should be scheduled either before I<I>
7342 or as early as possible after I<i>.
7344 The function C<isl_schedule_constraints_set_conditional_validity>
7345 replaces the conditional validity constraints.
7346 A conditional validity constraint is only imposed when any of the corresponding
7347 conditions is satisfied, i.e., when any of them is non-zero.
7348 That is, the scheduler ensures that within each band if the dependence
7349 distances over the condition constraints are not all zero
7350 then all corresponding conditional validity constraints are respected.
7351 A conditional validity constraint corresponds to a condition
7352 if the two are adjacent, i.e., if the domain of one relation intersect
7353 the range of the other relation.
7354 The typical use case of conditional validity constraints is
7355 to allow order constraints between live ranges to be violated
7356 as long as the live ranges themselves are local to the band.
7357 To allow more fine-grained control over which conditions correspond
7358 to which conditional validity constraints, the domains and ranges
7359 of these relations may include I<tags>.  That is, the domains and
7360 ranges of those relation may themselves be wrapped relations
7361 where the iteration domain appears in the domain of those wrapped relations
7362 and the range of the wrapped relations can be arbitrarily chosen
7363 by the user.  Conditions and conditional validity constraints are only
7364 considered adjacent to each other if the entire wrapped relation matches.
7365 In particular, a relation with a tag will never be considered adjacent
7366 to a relation without a tag.
7368 The following function computes a schedule directly from
7369 an iteration domain and validity and proximity dependences
7370 and is implemented in terms of the functions described above.
7371 The use of C<isl_union_set_compute_schedule> is discouraged.
7373         #include <isl/schedule.h>
7374         __isl_give isl_schedule *isl_union_set_compute_schedule(
7375                 __isl_take isl_union_set *domain,
7376                 __isl_take isl_union_map *validity,
7377                 __isl_take isl_union_map *proximity);
7379 A mapping from the domains to the scheduled space can be obtained
7380 from an C<isl_schedule> using the following function.
7382         __isl_give isl_union_map *isl_schedule_get_map(
7383                 __isl_keep isl_schedule *sched);
7385 A representation of the schedule can be printed using
7386          
7387         __isl_give isl_printer *isl_printer_print_schedule(
7388                 __isl_take isl_printer *p,
7389                 __isl_keep isl_schedule *schedule);
7391 A representation of the schedule as a forest of bands can be obtained
7392 using the following function.
7394         __isl_give isl_band_list *isl_schedule_get_band_forest(
7395                 __isl_keep isl_schedule *schedule);
7397 The individual bands can be visited in depth-first post-order
7398 using the following function.
7400         #include <isl/schedule.h>
7401         int isl_schedule_foreach_band(
7402                 __isl_keep isl_schedule *sched,
7403                 int (*fn)(__isl_keep isl_band *band, void *user),
7404                 void *user);
7406 The list can be manipulated as explained in L<"Lists">.
7407 The bands inside the list can be copied and freed using the following
7408 functions.
7410         #include <isl/band.h>
7411         __isl_give isl_band *isl_band_copy(
7412                 __isl_keep isl_band *band);
7413         __isl_null isl_band *isl_band_free(
7414                 __isl_take isl_band *band);
7416 Each band contains zero or more scheduling dimensions.
7417 These are referred to as the members of the band.
7418 The section of the schedule that corresponds to the band is
7419 referred to as the partial schedule of the band.
7420 For those nodes that participate in a band, the outer scheduling
7421 dimensions form the prefix schedule, while the inner scheduling
7422 dimensions form the suffix schedule.
7423 That is, if we take a cut of the band forest, then the union of
7424 the concatenations of the prefix, partial and suffix schedules of
7425 each band in the cut is equal to the entire schedule (modulo
7426 some possible padding at the end with zero scheduling dimensions).
7427 The properties of a band can be inspected using the following functions.
7429         #include <isl/band.h>
7430         int isl_band_has_children(__isl_keep isl_band *band);
7431         __isl_give isl_band_list *isl_band_get_children(
7432                 __isl_keep isl_band *band);
7434         __isl_give isl_union_map *isl_band_get_prefix_schedule(
7435                 __isl_keep isl_band *band);
7436         __isl_give isl_union_map *isl_band_get_partial_schedule(
7437                 __isl_keep isl_band *band);
7438         __isl_give isl_union_map *isl_band_get_suffix_schedule(
7439                 __isl_keep isl_band *band);
7441         int isl_band_n_member(__isl_keep isl_band *band);
7442         int isl_band_member_is_coincident(
7443                 __isl_keep isl_band *band, int pos);
7445         int isl_band_list_foreach_band(
7446                 __isl_keep isl_band_list *list,
7447                 int (*fn)(__isl_keep isl_band *band, void *user),
7448                 void *user);
7450 Note that a scheduling dimension is considered to be ``coincident''
7451 if it satisfies the coincidence constraints within its band.
7452 That is, if the dependence distances of the coincidence
7453 constraints are all zero in that direction (for fixed
7454 iterations of outer bands).
7455 Like C<isl_schedule_foreach_band>,
7456 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
7457 in depth-first post-order.
7459 A band can be tiled using the following function.
7461         #include <isl/band.h>
7462         int isl_band_tile(__isl_keep isl_band *band,
7463                 __isl_take isl_vec *sizes);
7465         int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
7466                 int val);
7467         int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
7468         int isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
7469                 int val);
7470         int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
7472 The C<isl_band_tile> function tiles the band using the given tile sizes
7473 inside its schedule.
7474 A new child band is created to represent the point loops and it is
7475 inserted between the modified band and its children.
7476 The C<tile_scale_tile_loops> option specifies whether the tile
7477 loops iterators should be scaled by the tile sizes.
7478 If the C<tile_shift_point_loops> option is set, then the point loops
7479 are shifted to start at zero.
7481 A band can be split into two nested bands using the following function.
7483         int isl_band_split(__isl_keep isl_band *band, int pos);
7485 The resulting outer band contains the first C<pos> dimensions of C<band>
7486 while the inner band contains the remaining dimensions.
7488 A representation of the band can be printed using
7490         #include <isl/band.h>
7491         __isl_give isl_printer *isl_printer_print_band(
7492                 __isl_take isl_printer *p,
7493                 __isl_keep isl_band *band);
7495 =head3 Options
7497         #include <isl/schedule.h>
7498         int isl_options_set_schedule_max_coefficient(
7499                 isl_ctx *ctx, int val);
7500         int isl_options_get_schedule_max_coefficient(
7501                 isl_ctx *ctx);
7502         int isl_options_set_schedule_max_constant_term(
7503                 isl_ctx *ctx, int val);
7504         int isl_options_get_schedule_max_constant_term(
7505                 isl_ctx *ctx);
7506         int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
7507         int isl_options_get_schedule_fuse(isl_ctx *ctx);
7508         int isl_options_set_schedule_maximize_band_depth(
7509                 isl_ctx *ctx, int val);
7510         int isl_options_get_schedule_maximize_band_depth(
7511                 isl_ctx *ctx);
7512         int isl_options_set_schedule_outer_coincidence(
7513                 isl_ctx *ctx, int val);
7514         int isl_options_get_schedule_outer_coincidence(
7515                 isl_ctx *ctx);
7516         int isl_options_set_schedule_split_scaled(
7517                 isl_ctx *ctx, int val);
7518         int isl_options_get_schedule_split_scaled(
7519                 isl_ctx *ctx);
7520         int isl_options_set_schedule_algorithm(
7521                 isl_ctx *ctx, int val);
7522         int isl_options_get_schedule_algorithm(
7523                 isl_ctx *ctx);
7524         int isl_options_set_schedule_separate_components(
7525                 isl_ctx *ctx, int val);
7526         int isl_options_get_schedule_separate_components(
7527                 isl_ctx *ctx);
7529 =over
7531 =item * schedule_max_coefficient
7533 This option enforces that the coefficients for variable and parameter
7534 dimensions in the calculated schedule are not larger than the specified value.
7535 This option can significantly increase the speed of the scheduling calculation
7536 and may also prevent fusing of unrelated dimensions. A value of -1 means that
7537 this option does not introduce bounds on the variable or parameter
7538 coefficients.
7540 =item * schedule_max_constant_term
7542 This option enforces that the constant coefficients in the calculated schedule
7543 are not larger than the maximal constant term. This option can significantly
7544 increase the speed of the scheduling calculation and may also prevent fusing of
7545 unrelated dimensions. A value of -1 means that this option does not introduce
7546 bounds on the constant coefficients.
7548 =item * schedule_fuse
7550 This option controls the level of fusion.
7551 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
7552 resulting schedule will be distributed as much as possible.
7553 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
7554 try to fuse loops in the resulting schedule.
7556 =item * schedule_maximize_band_depth
7558 If this option is set, we do not split bands at the point
7559 where we detect splitting is necessary. Instead, we
7560 backtrack and split bands as early as possible. This
7561 reduces the number of splits and maximizes the width of
7562 the bands. Wider bands give more possibilities for tiling.
7563 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
7564 then bands will be split as early as possible, even if there is no need.
7565 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
7567 =item * schedule_outer_coincidence
7569 If this option is set, then we try to construct schedules
7570 where the outermost scheduling dimension in each band
7571 satisfies the coincidence constraints.
7573 =item * schedule_split_scaled
7575 If this option is set, then we try to construct schedules in which the
7576 constant term is split off from the linear part if the linear parts of
7577 the scheduling rows for all nodes in the graphs have a common non-trivial
7578 divisor.
7579 The constant term is then placed in a separate band and the linear
7580 part is reduced.
7582 =item * schedule_algorithm
7584 Selects the scheduling algorithm to be used.
7585 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
7586 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
7588 =item * schedule_separate_components
7590 If at any point the dependence graph contains any (weakly connected) components,
7591 then these components are scheduled separately.
7592 If this option is not set, then some iterations of the domains
7593 in these components may be scheduled together.
7594 If this option is set, then the components are given consecutive
7595 schedules.
7597 =back
7599 =head2 AST Generation
7601 This section describes the C<isl> functionality for generating
7602 ASTs that visit all the elements
7603 in a domain in an order specified by a schedule.
7604 In particular, given a C<isl_union_map>, an AST is generated
7605 that visits all the elements in the domain of the C<isl_union_map>
7606 according to the lexicographic order of the corresponding image
7607 element(s).  If the range of the C<isl_union_map> consists of
7608 elements in more than one space, then each of these spaces is handled
7609 separately in an arbitrary order.
7610 It should be noted that the image elements only specify the I<order>
7611 in which the corresponding domain elements should be visited.
7612 No direct relation between the image elements and the loop iterators
7613 in the generated AST should be assumed.
7615 Each AST is generated within a build.  The initial build
7616 simply specifies the constraints on the parameters (if any)
7617 and can be created, inspected, copied and freed using the following functions.
7619         #include <isl/ast_build.h>
7620         __isl_give isl_ast_build *isl_ast_build_from_context(
7621                 __isl_take isl_set *set);
7622         __isl_give isl_ast_build *isl_ast_build_copy(
7623                 __isl_keep isl_ast_build *build);
7624         __isl_null isl_ast_build *isl_ast_build_free(
7625                 __isl_take isl_ast_build *build);
7627 The C<set> argument is usually a parameter set with zero or more parameters.
7628 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
7629 and L</"Fine-grained Control over AST Generation">.
7630 Finally, the AST itself can be constructed using the following
7631 function.
7633         #include <isl/ast_build.h>
7634         __isl_give isl_ast_node *isl_ast_build_ast_from_schedule(
7635                 __isl_keep isl_ast_build *build,
7636                 __isl_take isl_union_map *schedule);
7638 =head3 Inspecting the AST
7640 The basic properties of an AST node can be obtained as follows.
7642         #include <isl/ast.h>
7643         enum isl_ast_node_type isl_ast_node_get_type(
7644                 __isl_keep isl_ast_node *node);
7646 The type of an AST node is one of
7647 C<isl_ast_node_for>,
7648 C<isl_ast_node_if>,
7649 C<isl_ast_node_block> or
7650 C<isl_ast_node_user>.
7651 An C<isl_ast_node_for> represents a for node.
7652 An C<isl_ast_node_if> represents an if node.
7653 An C<isl_ast_node_block> represents a compound node.
7654 An C<isl_ast_node_user> represents an expression statement.
7655 An expression statement typically corresponds to a domain element, i.e.,
7656 one of the elements that is visited by the AST.
7658 Each type of node has its own additional properties.
7660         #include <isl/ast.h>
7661         __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
7662                 __isl_keep isl_ast_node *node);
7663         __isl_give isl_ast_expr *isl_ast_node_for_get_init(
7664                 __isl_keep isl_ast_node *node);
7665         __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
7666                 __isl_keep isl_ast_node *node);
7667         __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
7668                 __isl_keep isl_ast_node *node);
7669         __isl_give isl_ast_node *isl_ast_node_for_get_body(
7670                 __isl_keep isl_ast_node *node);
7671         int isl_ast_node_for_is_degenerate(
7672                 __isl_keep isl_ast_node *node);
7674 An C<isl_ast_for> is considered degenerate if it is known to execute
7675 exactly once.
7677         #include <isl/ast.h>
7678         __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
7679                 __isl_keep isl_ast_node *node);
7680         __isl_give isl_ast_node *isl_ast_node_if_get_then(
7681                 __isl_keep isl_ast_node *node);
7682         int isl_ast_node_if_has_else(
7683                 __isl_keep isl_ast_node *node);
7684         __isl_give isl_ast_node *isl_ast_node_if_get_else(
7685                 __isl_keep isl_ast_node *node);
7687         __isl_give isl_ast_node_list *
7688         isl_ast_node_block_get_children(
7689                 __isl_keep isl_ast_node *node);
7691         __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
7692                 __isl_keep isl_ast_node *node);
7694 Each of the returned C<isl_ast_expr>s can in turn be inspected using
7695 the following functions.
7697         #include <isl/ast.h>
7698         enum isl_ast_expr_type isl_ast_expr_get_type(
7699                 __isl_keep isl_ast_expr *expr);
7701 The type of an AST expression is one of
7702 C<isl_ast_expr_op>,
7703 C<isl_ast_expr_id> or
7704 C<isl_ast_expr_int>.
7705 An C<isl_ast_expr_op> represents the result of an operation.
7706 An C<isl_ast_expr_id> represents an identifier.
7707 An C<isl_ast_expr_int> represents an integer value.
7709 Each type of expression has its own additional properties.
7711         #include <isl/ast.h>
7712         enum isl_ast_op_type isl_ast_expr_get_op_type(
7713                 __isl_keep isl_ast_expr *expr);
7714         int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
7715         __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
7716                 __isl_keep isl_ast_expr *expr, int pos);
7717         int isl_ast_node_foreach_ast_op_type(
7718                 __isl_keep isl_ast_node *node,
7719                 int (*fn)(enum isl_ast_op_type type, void *user),
7720                 void *user);
7722 C<isl_ast_expr_get_op_type> returns the type of the operation
7723 performed.  C<isl_ast_expr_get_op_n_arg> returns the number of
7724 arguments.  C<isl_ast_expr_get_op_arg> returns the specified
7725 argument.
7726 C<isl_ast_node_foreach_ast_op_type> calls C<fn> for each distinct
7727 C<isl_ast_op_type> that appears in C<node>.
7728 The operation type is one of the following.
7730 =over
7732 =item C<isl_ast_op_and>
7734 Logical I<and> of two arguments.
7735 Both arguments can be evaluated.
7737 =item C<isl_ast_op_and_then>
7739 Logical I<and> of two arguments.
7740 The second argument can only be evaluated if the first evaluates to true.
7742 =item C<isl_ast_op_or>
7744 Logical I<or> of two arguments.
7745 Both arguments can be evaluated.
7747 =item C<isl_ast_op_or_else>
7749 Logical I<or> of two arguments.
7750 The second argument can only be evaluated if the first evaluates to false.
7752 =item C<isl_ast_op_max>
7754 Maximum of two or more arguments.
7756 =item C<isl_ast_op_min>
7758 Minimum of two or more arguments.
7760 =item C<isl_ast_op_minus>
7762 Change sign.
7764 =item C<isl_ast_op_add>
7766 Sum of two arguments.
7768 =item C<isl_ast_op_sub>
7770 Difference of two arguments.
7772 =item C<isl_ast_op_mul>
7774 Product of two arguments.
7776 =item C<isl_ast_op_div>
7778 Exact division.  That is, the result is known to be an integer.
7780 =item C<isl_ast_op_fdiv_q>
7782 Result of integer division, rounded towards negative
7783 infinity.
7785 =item C<isl_ast_op_pdiv_q>
7787 Result of integer division, where dividend is known to be non-negative.
7789 =item C<isl_ast_op_pdiv_r>
7791 Remainder of integer division, where dividend is known to be non-negative.
7793 =item C<isl_ast_op_zdiv_r>
7795 Equal to zero iff the remainder on integer division is zero.
7797 =item C<isl_ast_op_cond>
7799 Conditional operator defined on three arguments.
7800 If the first argument evaluates to true, then the result
7801 is equal to the second argument.  Otherwise, the result
7802 is equal to the third argument.
7803 The second and third argument may only be evaluated if
7804 the first argument evaluates to true and false, respectively.
7805 Corresponds to C<a ? b : c> in C.
7807 =item C<isl_ast_op_select>
7809 Conditional operator defined on three arguments.
7810 If the first argument evaluates to true, then the result
7811 is equal to the second argument.  Otherwise, the result
7812 is equal to the third argument.
7813 The second and third argument may be evaluated independently
7814 of the value of the first argument.
7815 Corresponds to C<a * b + (1 - a) * c> in C.
7817 =item C<isl_ast_op_eq>
7819 Equality relation.
7821 =item C<isl_ast_op_le>
7823 Less than or equal relation.
7825 =item C<isl_ast_op_lt>
7827 Less than relation.
7829 =item C<isl_ast_op_ge>
7831 Greater than or equal relation.
7833 =item C<isl_ast_op_gt>
7835 Greater than relation.
7837 =item C<isl_ast_op_call>
7839 A function call.
7840 The number of arguments of the C<isl_ast_expr> is one more than
7841 the number of arguments in the function call, the first argument
7842 representing the function being called.
7844 =item C<isl_ast_op_access>
7846 An array access.
7847 The number of arguments of the C<isl_ast_expr> is one more than
7848 the number of index expressions in the array access, the first argument
7849 representing the array being accessed.
7851 =item C<isl_ast_op_member>
7853 A member access.
7854 This operation has two arguments, a structure and the name of
7855 the member of the structure being accessed.
7857 =back
7859         #include <isl/ast.h>
7860         __isl_give isl_id *isl_ast_expr_get_id(
7861                 __isl_keep isl_ast_expr *expr);
7863 Return the identifier represented by the AST expression.
7865         #include <isl/ast.h>
7866         __isl_give isl_val *isl_ast_expr_get_val(
7867                 __isl_keep isl_ast_expr *expr);
7869 Return the integer represented by the AST expression.
7871 =head3 Properties of ASTs
7873         #include <isl/ast.h>
7874         int isl_ast_expr_is_equal(__isl_keep isl_ast_expr *expr1,
7875                 __isl_keep isl_ast_expr *expr2);
7877 Check if two C<isl_ast_expr>s are equal to each other.
7879 =head3 Manipulating and printing the AST
7881 AST nodes can be copied and freed using the following functions.
7883         #include <isl/ast.h>
7884         __isl_give isl_ast_node *isl_ast_node_copy(
7885                 __isl_keep isl_ast_node *node);
7886         __isl_null isl_ast_node *isl_ast_node_free(
7887                 __isl_take isl_ast_node *node);
7889 AST expressions can be copied and freed using the following functions.
7891         #include <isl/ast.h>
7892         __isl_give isl_ast_expr *isl_ast_expr_copy(
7893                 __isl_keep isl_ast_expr *expr);
7894         __isl_null isl_ast_expr *isl_ast_expr_free(
7895                 __isl_take isl_ast_expr *expr);
7897 New AST expressions can be created either directly or within
7898 the context of an C<isl_ast_build>.
7900         #include <isl/ast.h>
7901         __isl_give isl_ast_expr *isl_ast_expr_from_val(
7902                 __isl_take isl_val *v);
7903         __isl_give isl_ast_expr *isl_ast_expr_from_id(
7904                 __isl_take isl_id *id);
7905         __isl_give isl_ast_expr *isl_ast_expr_neg(
7906                 __isl_take isl_ast_expr *expr);
7907         __isl_give isl_ast_expr *isl_ast_expr_address_of(
7908                 __isl_take isl_ast_expr *expr);
7909         __isl_give isl_ast_expr *isl_ast_expr_add(
7910                 __isl_take isl_ast_expr *expr1,
7911                 __isl_take isl_ast_expr *expr2);
7912         __isl_give isl_ast_expr *isl_ast_expr_sub(
7913                 __isl_take isl_ast_expr *expr1,
7914                 __isl_take isl_ast_expr *expr2);
7915         __isl_give isl_ast_expr *isl_ast_expr_mul(
7916                 __isl_take isl_ast_expr *expr1,
7917                 __isl_take isl_ast_expr *expr2);
7918         __isl_give isl_ast_expr *isl_ast_expr_div(
7919                 __isl_take isl_ast_expr *expr1,
7920                 __isl_take isl_ast_expr *expr2);
7921         __isl_give isl_ast_expr *isl_ast_expr_and(
7922                 __isl_take isl_ast_expr *expr1,
7923                 __isl_take isl_ast_expr *expr2)
7924         __isl_give isl_ast_expr *isl_ast_expr_or(
7925                 __isl_take isl_ast_expr *expr1,
7926                 __isl_take isl_ast_expr *expr2)
7927         __isl_give isl_ast_expr *isl_ast_expr_eq(
7928                 __isl_take isl_ast_expr *expr1,
7929                 __isl_take isl_ast_expr *expr2);
7930         __isl_give isl_ast_expr *isl_ast_expr_le(
7931                 __isl_take isl_ast_expr *expr1,
7932                 __isl_take isl_ast_expr *expr2);
7933         __isl_give isl_ast_expr *isl_ast_expr_lt(
7934                 __isl_take isl_ast_expr *expr1,
7935                 __isl_take isl_ast_expr *expr2);
7936         __isl_give isl_ast_expr *isl_ast_expr_ge(
7937                 __isl_take isl_ast_expr *expr1,
7938                 __isl_take isl_ast_expr *expr2);
7939         __isl_give isl_ast_expr *isl_ast_expr_gt(
7940                 __isl_take isl_ast_expr *expr1,
7941                 __isl_take isl_ast_expr *expr2);
7942         __isl_give isl_ast_expr *isl_ast_expr_access(
7943                 __isl_take isl_ast_expr *array,
7944                 __isl_take isl_ast_expr_list *indices);
7946 The function C<isl_ast_expr_address_of> can be applied to an
7947 C<isl_ast_expr> of type C<isl_ast_op_access> only. It is meant
7948 to represent the address of the C<isl_ast_expr_access>.
7950         #include <isl/ast_build.h>
7951         __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
7952                 __isl_keep isl_ast_build *build,
7953                 __isl_take isl_pw_aff *pa);
7954         __isl_give isl_ast_expr *
7955         isl_ast_build_access_from_pw_multi_aff(
7956                 __isl_keep isl_ast_build *build,
7957                 __isl_take isl_pw_multi_aff *pma);
7958         __isl_give isl_ast_expr *
7959         isl_ast_build_access_from_multi_pw_aff(
7960                 __isl_keep isl_ast_build *build,
7961                 __isl_take isl_multi_pw_aff *mpa);
7962         __isl_give isl_ast_expr *
7963         isl_ast_build_call_from_pw_multi_aff(
7964                 __isl_keep isl_ast_build *build,
7965                 __isl_take isl_pw_multi_aff *pma);
7966         __isl_give isl_ast_expr *
7967         isl_ast_build_call_from_multi_pw_aff(
7968                 __isl_keep isl_ast_build *build,
7969                 __isl_take isl_multi_pw_aff *mpa);
7971 The domains of C<pa>, C<mpa> and C<pma> should correspond
7972 to the schedule space of C<build>.
7973 The tuple id of C<mpa> or C<pma> is used as the array being accessed or
7974 the function being called.
7975 If the accessed space is a nested relation, then it is taken
7976 to represent an access of the member specified by the range
7977 of this nested relation of the structure specified by the domain
7978 of the nested relation.
7980 The following functions can be used to modify an C<isl_ast_expr>.
7982         #include <isl/ast.h>
7983         __isl_give isl_ast_expr *isl_ast_expr_set_op_arg(
7984                 __isl_take isl_ast_expr *expr, int pos,
7985                 __isl_take isl_ast_expr *arg);
7987 Replace the argument of C<expr> at position C<pos> by C<arg>.
7989         #include <isl/ast.h>
7990         __isl_give isl_ast_expr *isl_ast_expr_substitute_ids(
7991                 __isl_take isl_ast_expr *expr,
7992                 __isl_take isl_id_to_ast_expr *id2expr);
7994 The function C<isl_ast_expr_substitute_ids> replaces the
7995 subexpressions of C<expr> of type C<isl_ast_expr_id>
7996 by the corresponding expression in C<id2expr>, if there is any.
7999 User specified data can be attached to an C<isl_ast_node> and obtained
8000 from the same C<isl_ast_node> using the following functions.
8002         #include <isl/ast.h>
8003         __isl_give isl_ast_node *isl_ast_node_set_annotation(
8004                 __isl_take isl_ast_node *node,
8005                 __isl_take isl_id *annotation);
8006         __isl_give isl_id *isl_ast_node_get_annotation(
8007                 __isl_keep isl_ast_node *node);
8009 Basic printing can be performed using the following functions.
8011         #include <isl/ast.h>
8012         __isl_give isl_printer *isl_printer_print_ast_expr(
8013                 __isl_take isl_printer *p,
8014                 __isl_keep isl_ast_expr *expr);
8015         __isl_give isl_printer *isl_printer_print_ast_node(
8016                 __isl_take isl_printer *p,
8017                 __isl_keep isl_ast_node *node);
8018         __isl_give char *isl_ast_expr_to_str(
8019                 __isl_keep isl_ast_expr *expr);
8021 More advanced printing can be performed using the following functions.
8023         #include <isl/ast.h>
8024         __isl_give isl_printer *isl_ast_op_type_print_macro(
8025                 enum isl_ast_op_type type,
8026                 __isl_take isl_printer *p);
8027         __isl_give isl_printer *isl_ast_node_print_macros(
8028                 __isl_keep isl_ast_node *node,
8029                 __isl_take isl_printer *p);
8030         __isl_give isl_printer *isl_ast_node_print(
8031                 __isl_keep isl_ast_node *node,
8032                 __isl_take isl_printer *p,
8033                 __isl_take isl_ast_print_options *options);
8034         __isl_give isl_printer *isl_ast_node_for_print(
8035                 __isl_keep isl_ast_node *node,
8036                 __isl_take isl_printer *p,
8037                 __isl_take isl_ast_print_options *options);
8038         __isl_give isl_printer *isl_ast_node_if_print(
8039                 __isl_keep isl_ast_node *node,
8040                 __isl_take isl_printer *p,
8041                 __isl_take isl_ast_print_options *options);
8043 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
8044 C<isl> may print out an AST that makes use of macros such
8045 as C<floord>, C<min> and C<max>.
8046 C<isl_ast_op_type_print_macro> prints out the macro
8047 corresponding to a specific C<isl_ast_op_type>.
8048 C<isl_ast_node_print_macros> scans the C<isl_ast_node>
8049 for expressions where these macros would be used and prints
8050 out the required macro definitions.
8051 Essentially, C<isl_ast_node_print_macros> calls
8052 C<isl_ast_node_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
8053 as function argument.
8054 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
8055 C<isl_ast_node_if_print> print an C<isl_ast_node>
8056 in C<ISL_FORMAT_C>, but allow for some extra control
8057 through an C<isl_ast_print_options> object.
8058 This object can be created using the following functions.
8060         #include <isl/ast.h>
8061         __isl_give isl_ast_print_options *
8062         isl_ast_print_options_alloc(isl_ctx *ctx);
8063         __isl_give isl_ast_print_options *
8064         isl_ast_print_options_copy(
8065                 __isl_keep isl_ast_print_options *options);
8066         __isl_null isl_ast_print_options *
8067         isl_ast_print_options_free(
8068                 __isl_take isl_ast_print_options *options);
8070         __isl_give isl_ast_print_options *
8071         isl_ast_print_options_set_print_user(
8072                 __isl_take isl_ast_print_options *options,
8073                 __isl_give isl_printer *(*print_user)(
8074                         __isl_take isl_printer *p,
8075                         __isl_take isl_ast_print_options *options,
8076                         __isl_keep isl_ast_node *node, void *user),
8077                 void *user);
8078         __isl_give isl_ast_print_options *
8079         isl_ast_print_options_set_print_for(
8080                 __isl_take isl_ast_print_options *options,
8081                 __isl_give isl_printer *(*print_for)(
8082                         __isl_take isl_printer *p,
8083                         __isl_take isl_ast_print_options *options,
8084                         __isl_keep isl_ast_node *node, void *user),
8085                 void *user);
8087 The callback set by C<isl_ast_print_options_set_print_user>
8088 is called whenever a node of type C<isl_ast_node_user> needs to
8089 be printed.
8090 The callback set by C<isl_ast_print_options_set_print_for>
8091 is called whenever a node of type C<isl_ast_node_for> needs to
8092 be printed.
8093 Note that C<isl_ast_node_for_print> will I<not> call the
8094 callback set by C<isl_ast_print_options_set_print_for> on the node
8095 on which C<isl_ast_node_for_print> is called, but only on nested
8096 nodes of type C<isl_ast_node_for>.  It is therefore safe to
8097 call C<isl_ast_node_for_print> from within the callback set by
8098 C<isl_ast_print_options_set_print_for>.
8100 The following option determines the type to be used for iterators
8101 while printing the AST.
8103         int isl_options_set_ast_iterator_type(
8104                 isl_ctx *ctx, const char *val);
8105         const char *isl_options_get_ast_iterator_type(
8106                 isl_ctx *ctx);
8108 The AST printer only prints body nodes as blocks if these
8109 blocks cannot be safely omitted.
8110 For example, a C<for> node with one body node will not be
8111 surrounded with braces in C<ISL_FORMAT_C>.
8112 A block will always be printed by setting the following option.
8114         int isl_options_set_ast_always_print_block(isl_ctx *ctx,
8115                 int val);
8116         int isl_options_get_ast_always_print_block(isl_ctx *ctx);
8118 =head3 Options
8120         #include <isl/ast_build.h>
8121         int isl_options_set_ast_build_atomic_upper_bound(
8122                 isl_ctx *ctx, int val);
8123         int isl_options_get_ast_build_atomic_upper_bound(
8124                 isl_ctx *ctx);
8125         int isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
8126                 int val);
8127         int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
8128         int isl_options_set_ast_build_exploit_nested_bounds(
8129                 isl_ctx *ctx, int val);
8130         int isl_options_get_ast_build_exploit_nested_bounds(
8131                 isl_ctx *ctx);
8132         int isl_options_set_ast_build_group_coscheduled(
8133                 isl_ctx *ctx, int val);
8134         int isl_options_get_ast_build_group_coscheduled(
8135                 isl_ctx *ctx);
8136         int isl_options_set_ast_build_scale_strides(
8137                 isl_ctx *ctx, int val);
8138         int isl_options_get_ast_build_scale_strides(
8139                 isl_ctx *ctx);
8140         int isl_options_set_ast_build_allow_else(isl_ctx *ctx,
8141                 int val);
8142         int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
8143         int isl_options_set_ast_build_allow_or(isl_ctx *ctx,
8144                 int val);
8145         int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
8147 =over
8149 =item * ast_build_atomic_upper_bound
8151 Generate loop upper bounds that consist of the current loop iterator,
8152 an operator and an expression not involving the iterator.
8153 If this option is not set, then the current loop iterator may appear
8154 several times in the upper bound.
8155 For example, when this option is turned off, AST generation
8156 for the schedule
8158         [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
8160 produces
8162         for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
8163           A(c0);
8165 When the option is turned on, the following AST is generated
8167         for (int c0 = 0; c0 <= min(100, n); c0 += 1)
8168           A(c0);
8170 =item * ast_build_prefer_pdiv
8172 If this option is turned off, then the AST generation will
8173 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
8174 operators, but no C<isl_ast_op_pdiv_q> or
8175 C<isl_ast_op_pdiv_r> operators.
8176 If this options is turned on, then C<isl> will try to convert
8177 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
8178 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
8180 =item * ast_build_exploit_nested_bounds
8182 Simplify conditions based on bounds of nested for loops.
8183 In particular, remove conditions that are implied by the fact
8184 that one or more nested loops have at least one iteration,
8185 meaning that the upper bound is at least as large as the lower bound.
8186 For example, when this option is turned off, AST generation
8187 for the schedule
8189         [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
8190                                         0 <= j <= M }
8192 produces
8194         if (M >= 0)
8195           for (int c0 = 0; c0 <= N; c0 += 1)
8196             for (int c1 = 0; c1 <= M; c1 += 1)
8197               A(c0, c1);
8199 When the option is turned on, the following AST is generated
8201         for (int c0 = 0; c0 <= N; c0 += 1)
8202           for (int c1 = 0; c1 <= M; c1 += 1)
8203             A(c0, c1);
8205 =item * ast_build_group_coscheduled
8207 If two domain elements are assigned the same schedule point, then
8208 they may be executed in any order and they may even appear in different
8209 loops.  If this options is set, then the AST generator will make
8210 sure that coscheduled domain elements do not appear in separate parts
8211 of the AST.  This is useful in case of nested AST generation
8212 if the outer AST generation is given only part of a schedule
8213 and the inner AST generation should handle the domains that are
8214 coscheduled by this initial part of the schedule together.
8215 For example if an AST is generated for a schedule
8217         { A[i] -> [0]; B[i] -> [0] }
8219 then the C<isl_ast_build_set_create_leaf> callback described
8220 below may get called twice, once for each domain.
8221 Setting this option ensures that the callback is only called once
8222 on both domains together.
8224 =item * ast_build_separation_bounds
8226 This option specifies which bounds to use during separation.
8227 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
8228 then all (possibly implicit) bounds on the current dimension will
8229 be used during separation.
8230 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
8231 then only those bounds that are explicitly available will
8232 be used during separation.
8234 =item * ast_build_scale_strides
8236 This option specifies whether the AST generator is allowed
8237 to scale down iterators of strided loops.
8239 =item * ast_build_allow_else
8241 This option specifies whether the AST generator is allowed
8242 to construct if statements with else branches.
8244 =item * ast_build_allow_or
8246 This option specifies whether the AST generator is allowed
8247 to construct if conditions with disjunctions.
8249 =back
8251 =head3 Fine-grained Control over AST Generation
8253 Besides specifying the constraints on the parameters,
8254 an C<isl_ast_build> object can be used to control
8255 various aspects of the AST generation process.
8256 The most prominent way of control is through ``options'',
8257 which can be set using the following function.
8259         #include <isl/ast_build.h>
8260         __isl_give isl_ast_build *
8261         isl_ast_build_set_options(
8262                 __isl_take isl_ast_build *control,
8263                 __isl_take isl_union_map *options);
8265 The options are encoded in an C<isl_union_map>.
8266 The domain of this union relation refers to the schedule domain,
8267 i.e., the range of the schedule passed to C<isl_ast_build_ast_from_schedule>.
8268 In the case of nested AST generation (see L</"Nested AST Generation">),
8269 the domain of C<options> should refer to the extra piece of the schedule.
8270 That is, it should be equal to the range of the wrapped relation in the
8271 range of the schedule.
8272 The range of the options can consist of elements in one or more spaces,
8273 the names of which determine the effect of the option.
8274 The values of the range typically also refer to the schedule dimension
8275 to which the option applies.  In case of nested AST generation
8276 (see L</"Nested AST Generation">), these values refer to the position
8277 of the schedule dimension within the innermost AST generation.
8278 The constraints on the domain elements of
8279 the option should only refer to this dimension and earlier dimensions.
8280 We consider the following spaces.
8282 =over
8284 =item C<separation_class>
8286 This space is a wrapped relation between two one dimensional spaces.
8287 The input space represents the schedule dimension to which the option
8288 applies and the output space represents the separation class.
8289 While constructing a loop corresponding to the specified schedule
8290 dimension(s), the AST generator will try to generate separate loops
8291 for domain elements that are assigned different classes.
8292 If only some of the elements are assigned a class, then those elements
8293 that are not assigned any class will be treated as belonging to a class
8294 that is separate from the explicitly assigned classes.
8295 The typical use case for this option is to separate full tiles from
8296 partial tiles.
8297 The other options, described below, are applied after the separation
8298 into classes.
8300 As an example, consider the separation into full and partial tiles
8301 of a tiling of a triangular domain.
8302 Take, for example, the domain
8304         { A[i,j] : 0 <= i,j and i + j <= 100 }
8306 and a tiling into tiles of 10 by 10.  The input to the AST generator
8307 is then the schedule
8309         { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
8310                                                 i + j <= 100 }
8312 Without any options, the following AST is generated
8314         for (int c0 = 0; c0 <= 10; c0 += 1)
8315           for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
8316             for (int c2 = 10 * c0;
8317                  c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
8318                  c2 += 1)
8319               for (int c3 = 10 * c1;
8320                    c3 <= min(10 * c1 + 9, -c2 + 100);
8321                    c3 += 1)
8322                 A(c2, c3);
8324 Separation into full and partial tiles can be obtained by assigning
8325 a class, say C<0>, to the full tiles.  The full tiles are represented by those
8326 values of the first and second schedule dimensions for which there are
8327 values of the third and fourth dimensions to cover an entire tile.
8328 That is, we need to specify the following option
8330         { [a,b,c,d] -> separation_class[[0]->[0]] :
8331                 exists b': 0 <= 10a,10b' and
8332                            10a+9+10b'+9 <= 100;
8333           [a,b,c,d] -> separation_class[[1]->[0]] :
8334                 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
8336 which simplifies to
8338         { [a, b, c, d] -> separation_class[[1] -> [0]] :
8339                 a >= 0 and b >= 0 and b <= 8 - a;
8340           [a, b, c, d] -> separation_class[[0] -> [0]] :
8341                 a >= 0 and a <= 8 }
8343 With this option, the generated AST is as follows
8345         {
8346           for (int c0 = 0; c0 <= 8; c0 += 1) {
8347             for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
8348               for (int c2 = 10 * c0;
8349                    c2 <= 10 * c0 + 9; c2 += 1)
8350                 for (int c3 = 10 * c1;
8351                      c3 <= 10 * c1 + 9; c3 += 1)
8352                   A(c2, c3);
8353             for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
8354               for (int c2 = 10 * c0;
8355                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
8356                    c2 += 1)
8357                 for (int c3 = 10 * c1;
8358                      c3 <= min(-c2 + 100, 10 * c1 + 9);
8359                      c3 += 1)
8360                   A(c2, c3);
8361           }
8362           for (int c0 = 9; c0 <= 10; c0 += 1)
8363             for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
8364               for (int c2 = 10 * c0;
8365                    c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
8366                    c2 += 1)
8367                 for (int c3 = 10 * c1;
8368                      c3 <= min(10 * c1 + 9, -c2 + 100);
8369                      c3 += 1)
8370                   A(c2, c3);
8371         }
8373 =item C<separate>
8375 This is a single-dimensional space representing the schedule dimension(s)
8376 to which ``separation'' should be applied.  Separation tries to split
8377 a loop into several pieces if this can avoid the generation of guards
8378 inside the loop.
8379 See also the C<atomic> option.
8381 =item C<atomic>
8383 This is a single-dimensional space representing the schedule dimension(s)
8384 for which the domains should be considered ``atomic''.  That is, the
8385 AST generator will make sure that any given domain space will only appear
8386 in a single loop at the specified level.
8388 Consider the following schedule
8390         { a[i] -> [i] : 0 <= i < 10;
8391           b[i] -> [i+1] : 0 <= i < 10 }
8393 If the following option is specified
8395         { [i] -> separate[x] }
8397 then the following AST will be generated
8399         {
8400           a(0);
8401           for (int c0 = 1; c0 <= 9; c0 += 1) {
8402             a(c0);
8403             b(c0 - 1);
8404           }
8405           b(9);
8406         }
8408 If, on the other hand, the following option is specified
8410         { [i] -> atomic[x] }
8412 then the following AST will be generated
8414         for (int c0 = 0; c0 <= 10; c0 += 1) {
8415           if (c0 <= 9)
8416             a(c0);
8417           if (c0 >= 1)
8418             b(c0 - 1);
8419         }
8421 If neither C<atomic> nor C<separate> is specified, then the AST generator
8422 may produce either of these two results or some intermediate form.
8424 =item C<unroll>
8426 This is a single-dimensional space representing the schedule dimension(s)
8427 that should be I<completely> unrolled.
8428 To obtain a partial unrolling, the user should apply an additional
8429 strip-mining to the schedule and fully unroll the inner loop.
8431 =back
8433 Additional control is available through the following functions.
8435         #include <isl/ast_build.h>
8436         __isl_give isl_ast_build *
8437         isl_ast_build_set_iterators(
8438                 __isl_take isl_ast_build *control,
8439                 __isl_take isl_id_list *iterators);
8441 The function C<isl_ast_build_set_iterators> allows the user to
8442 specify a list of iterator C<isl_id>s to be used as iterators.
8443 If the input schedule is injective, then
8444 the number of elements in this list should be as large as the dimension
8445 of the schedule space, but no direct correspondence should be assumed
8446 between dimensions and elements.
8447 If the input schedule is not injective, then an additional number
8448 of C<isl_id>s equal to the largest dimension of the input domains
8449 may be required.
8450 If the number of provided C<isl_id>s is insufficient, then additional
8451 names are automatically generated.
8453         #include <isl/ast_build.h>
8454         __isl_give isl_ast_build *
8455         isl_ast_build_set_create_leaf(
8456                 __isl_take isl_ast_build *control,
8457                 __isl_give isl_ast_node *(*fn)(
8458                         __isl_take isl_ast_build *build,
8459                         void *user), void *user);
8462 C<isl_ast_build_set_create_leaf> function allows for the
8463 specification of a callback that should be called whenever the AST
8464 generator arrives at an element of the schedule domain.
8465 The callback should return an AST node that should be inserted
8466 at the corresponding position of the AST.  The default action (when
8467 the callback is not set) is to continue generating parts of the AST to scan
8468 all the domain elements associated to the schedule domain element
8469 and to insert user nodes, ``calling'' the domain element, for each of them.
8470 The C<build> argument contains the current state of the C<isl_ast_build>.
8471 To ease nested AST generation (see L</"Nested AST Generation">),
8472 all control information that is
8473 specific to the current AST generation such as the options and
8474 the callbacks has been removed from this C<isl_ast_build>.
8475 The callback would typically return the result of a nested
8476 AST generation or a
8477 user defined node created using the following function.
8479         #include <isl/ast.h>
8480         __isl_give isl_ast_node *isl_ast_node_alloc_user(
8481                 __isl_take isl_ast_expr *expr);
8483         #include <isl/ast_build.h>
8484         __isl_give isl_ast_build *
8485         isl_ast_build_set_at_each_domain(
8486                 __isl_take isl_ast_build *build,
8487                 __isl_give isl_ast_node *(*fn)(
8488                         __isl_take isl_ast_node *node,
8489                         __isl_keep isl_ast_build *build,
8490                         void *user), void *user);
8491         __isl_give isl_ast_build *
8492         isl_ast_build_set_before_each_for(
8493                 __isl_take isl_ast_build *build,
8494                 __isl_give isl_id *(*fn)(
8495                         __isl_keep isl_ast_build *build,
8496                         void *user), void *user);
8497         __isl_give isl_ast_build *
8498         isl_ast_build_set_after_each_for(
8499                 __isl_take isl_ast_build *build,
8500                 __isl_give isl_ast_node *(*fn)(
8501                         __isl_take isl_ast_node *node,
8502                         __isl_keep isl_ast_build *build,
8503                         void *user), void *user);
8505 The callback set by C<isl_ast_build_set_at_each_domain> will
8506 be called for each domain AST node.
8507 The callbacks set by C<isl_ast_build_set_before_each_for>
8508 and C<isl_ast_build_set_after_each_for> will be called
8509 for each for AST node.  The first will be called in depth-first
8510 pre-order, while the second will be called in depth-first post-order.
8511 Since C<isl_ast_build_set_before_each_for> is called before the for
8512 node is actually constructed, it is only passed an C<isl_ast_build>.
8513 The returned C<isl_id> will be added as an annotation (using
8514 C<isl_ast_node_set_annotation>) to the constructed for node.
8515 In particular, if the user has also specified an C<after_each_for>
8516 callback, then the annotation can be retrieved from the node passed to
8517 that callback using C<isl_ast_node_get_annotation>.
8518 All callbacks should C<NULL> on failure.
8519 The given C<isl_ast_build> can be used to create new
8520 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
8521 or C<isl_ast_build_call_from_pw_multi_aff>.
8523 =head3 Nested AST Generation
8525 C<isl> allows the user to create an AST within the context
8526 of another AST.  These nested ASTs are created using the
8527 same C<isl_ast_build_ast_from_schedule> function that is used to create the
8528 outer AST.  The C<build> argument should be an C<isl_ast_build>
8529 passed to a callback set by
8530 C<isl_ast_build_set_create_leaf>.
8531 The space of the range of the C<schedule> argument should refer
8532 to this build.  In particular, the space should be a wrapped
8533 relation and the domain of this wrapped relation should be the
8534 same as that of the range of the schedule returned by
8535 C<isl_ast_build_get_schedule> below.
8536 In practice, the new schedule is typically
8537 created by calling C<isl_union_map_range_product> on the old schedule
8538 and some extra piece of the schedule.
8539 The space of the schedule domain is also available from
8540 the C<isl_ast_build>.
8542         #include <isl/ast_build.h>
8543         __isl_give isl_union_map *isl_ast_build_get_schedule(
8544                 __isl_keep isl_ast_build *build);
8545         __isl_give isl_space *isl_ast_build_get_schedule_space(
8546                 __isl_keep isl_ast_build *build);
8547         __isl_give isl_ast_build *isl_ast_build_restrict(
8548                 __isl_take isl_ast_build *build,
8549                 __isl_take isl_set *set);
8551 The C<isl_ast_build_get_schedule> function returns a (partial)
8552 schedule for the domains elements for which part of the AST still needs to
8553 be generated in the current build.
8554 In particular, the domain elements are mapped to those iterations of the loops
8555 enclosing the current point of the AST generation inside which
8556 the domain elements are executed.
8557 No direct correspondence between
8558 the input schedule and this schedule should be assumed.
8559 The space obtained from C<isl_ast_build_get_schedule_space> can be used
8560 to create a set for C<isl_ast_build_restrict> to intersect
8561 with the current build.  In particular, the set passed to
8562 C<isl_ast_build_restrict> can have additional parameters.
8563 The ids of the set dimensions in the space returned by
8564 C<isl_ast_build_get_schedule_space> correspond to the
8565 iterators of the already generated loops.
8566 The user should not rely on the ids of the output dimensions
8567 of the relations in the union relation returned by
8568 C<isl_ast_build_get_schedule> having any particular value.
8570 =head1 Applications
8572 Although C<isl> is mainly meant to be used as a library,
8573 it also contains some basic applications that use some
8574 of the functionality of C<isl>.
8575 The input may be specified in either the L<isl format>
8576 or the L<PolyLib format>.
8578 =head2 C<isl_polyhedron_sample>
8580 C<isl_polyhedron_sample> takes a polyhedron as input and prints
8581 an integer element of the polyhedron, if there is any.
8582 The first column in the output is the denominator and is always
8583 equal to 1.  If the polyhedron contains no integer points,
8584 then a vector of length zero is printed.
8586 =head2 C<isl_pip>
8588 C<isl_pip> takes the same input as the C<example> program
8589 from the C<piplib> distribution, i.e., a set of constraints
8590 on the parameters, a line containing only -1 and finally a set
8591 of constraints on a parametric polyhedron.
8592 The coefficients of the parameters appear in the last columns
8593 (but before the final constant column).
8594 The output is the lexicographic minimum of the parametric polyhedron.
8595 As C<isl> currently does not have its own output format, the output
8596 is just a dump of the internal state.
8598 =head2 C<isl_polyhedron_minimize>
8600 C<isl_polyhedron_minimize> computes the minimum of some linear
8601 or affine objective function over the integer points in a polyhedron.
8602 If an affine objective function
8603 is given, then the constant should appear in the last column.
8605 =head2 C<isl_polytope_scan>
8607 Given a polytope, C<isl_polytope_scan> prints
8608 all integer points in the polytope.
8610 =head2 C<isl_codegen>
8612 Given a schedule, a context set and an options relation,
8613 C<isl_codegen> prints out an AST that scans the domain elements
8614 of the schedule in the order of their image(s) taking into account
8615 the constraints in the context set.