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
9 The C<isl> library offers functionality that is similar
10 to that offered by the C<Omega> and C<Omega+> libraries,
11 but the underlying algorithms are in most cases completely different.
13 The library is by no means complete and some fairly basic
14 functionality is still missing.
15 Still, even in its current form, the library has been successfully
16 used as a backend polyhedral library for the polyhedral
17 scanner C<CLooG> and as part of an equivalence checker of
18 static affine programs.
19 For bug reports, feature requests and questions,
20 visit the the discussion group at
21 L<http://groups.google.com/group/isl-development>.
23 =head2 Backward Incompatible Changes
25 =head3 Changes since isl-0.02
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>.
38 =head3 Changes since isl-0.03
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>.
49 =head3 Changes since isl-0.04
53 =item * All header files have been renamed from C<isl_header.h>
58 =head3 Changes since isl-0.05
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.
81 =head3 Changes since isl-0.06
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.
95 =head3 Changes since isl-0.07
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
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
139 A call to C<isl_qpolynomial_div(div)> call be replaced by
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.
156 =head3 Changes since isl-0.09
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)
171 =head3 Changes since isl-0.10
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.
186 C<isl> is released under the MIT license.
190 Permission is hereby granted, free of charge, to any person obtaining a copy of
191 this software and associated documentation files (the "Software"), to deal in
192 the Software without restriction, including without limitation the rights to
193 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
194 of the Software, and to permit persons to whom the Software is furnished to do
195 so, subject to the following conditions:
197 The above copyright notice and this permission notice shall be included in all
198 copies or substantial portions of the Software.
200 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
201 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
202 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
203 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
204 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
205 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
210 Note that C<isl> currently requires C<GMP>, which is released
211 under the GNU Lesser General Public License (LGPL). This means
212 that code linked against C<isl> is also linked against LGPL code.
216 The source of C<isl> can be obtained either as a tarball
217 or from the git repository. Both are available from
218 L<http://freshmeat.net/projects/isl/>.
219 The installation process depends on how you obtained
222 =head2 Installation from the git repository
226 =item 1 Clone or update the repository
228 The first time the source is obtained, you need to clone
231 git clone git://repo.or.cz/isl.git
233 To obtain updates, you need to pull in the latest changes
237 =item 2 Generate C<configure>
243 After performing the above steps, continue
244 with the L<Common installation instructions>.
246 =head2 Common installation instructions
250 =item 1 Obtain C<GMP>
252 Building C<isl> requires C<GMP>, including its headers files.
253 Your distribution may not provide these header files by default
254 and you may need to install a package called C<gmp-devel> or something
255 similar. Alternatively, C<GMP> can be built from
256 source, available from L<http://gmplib.org/>.
260 C<isl> uses the standard C<autoconf> C<configure> script.
265 optionally followed by some configure options.
266 A complete list of options can be obtained by running
270 Below we discuss some of the more common options.
272 C<isl> can optionally use C<piplib>, but no
273 C<piplib> functionality is currently used by default.
274 The C<--with-piplib> option can
275 be used to specify which C<piplib>
276 library to use, either an installed version (C<system>),
277 an externally built version (C<build>)
278 or no version (C<no>). The option C<build> is mostly useful
279 in C<configure> scripts of larger projects that bundle both C<isl>
286 Installation prefix for C<isl>
288 =item C<--with-gmp-prefix>
290 Installation prefix for C<GMP> (architecture-independent files).
292 =item C<--with-gmp-exec-prefix>
294 Installation prefix for C<GMP> (architecture-dependent files).
296 =item C<--with-piplib>
298 Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
300 =item C<--with-piplib-prefix>
302 Installation prefix for C<system> C<piplib> (architecture-independent files).
304 =item C<--with-piplib-exec-prefix>
306 Installation prefix for C<system> C<piplib> (architecture-dependent files).
308 =item C<--with-piplib-builddir>
310 Location where C<build> C<piplib> was built.
318 =item 4 Install (optional)
324 =head1 Integer Set Library
326 =head2 Initialization
328 All manipulations of integer sets and relations occur within
329 the context of an C<isl_ctx>.
330 A given C<isl_ctx> can only be used within a single thread.
331 All arguments of a function are required to have been allocated
332 within the same context.
333 There are currently no functions available for moving an object
334 from one C<isl_ctx> to another C<isl_ctx>. This means that
335 there is currently no way of safely moving an object from one
336 thread to another, unless the whole C<isl_ctx> is moved.
338 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
339 freed using C<isl_ctx_free>.
340 All objects allocated within an C<isl_ctx> should be freed
341 before the C<isl_ctx> itself is freed.
343 isl_ctx *isl_ctx_alloc();
344 void isl_ctx_free(isl_ctx *ctx);
348 An C<isl_val> represents an integer value, a rational value
349 or one of three special values, infinity, negative infinity and NaN.
350 Some predefined values can be created using the following functions.
353 __isl_give isl_val *isl_val_zero(isl_ctx *ctx);
354 __isl_give isl_val *isl_val_one(isl_ctx *ctx);
355 __isl_give isl_val *isl_val_nan(isl_ctx *ctx);
356 __isl_give isl_val *isl_val_infty(isl_ctx *ctx);
357 __isl_give isl_val *isl_val_neginfty(isl_ctx *ctx);
359 Specific integer values can be created using the following functions.
362 __isl_give isl_val *isl_val_int_from_si(isl_ctx *ctx,
364 __isl_give isl_val *isl_val_int_from_ui(isl_ctx *ctx,
367 They can be copied and freed using the following functions.
370 __isl_give isl_val *isl_val_copy(__isl_keep isl_val *v);
371 void *isl_val_free(__isl_take isl_val *v);
373 They can be inspected using the following functions.
376 isl_ctx *isl_val_get_ctx(__isl_keep isl_val *val);
377 long isl_val_get_num_si(__isl_keep isl_val *v);
378 long isl_val_get_den_si(__isl_keep isl_val *v);
379 double isl_val_get_d(__isl_keep isl_val *v);
381 Note that C<isl_val_get_num_si>, C<isl_val_get_den_si> and
382 C<isl_val_get_d> can only be applied to rational values.
384 An C<isl_val> can be modified using the following function.
387 __isl_give isl_val *isl_val_set_si(__isl_take isl_val *v,
390 The following unary properties are defined on C<isl_val>s.
393 int isl_val_sgn(__isl_keep isl_val *v);
394 int isl_val_is_zero(__isl_keep isl_val *v);
395 int isl_val_is_one(__isl_keep isl_val *v);
396 int isl_val_is_negone(__isl_keep isl_val *v);
397 int isl_val_is_nonneg(__isl_keep isl_val *v);
398 int isl_val_is_nonpos(__isl_keep isl_val *v);
399 int isl_val_is_pos(__isl_keep isl_val *v);
400 int isl_val_is_neg(__isl_keep isl_val *v);
401 int isl_val_is_int(__isl_keep isl_val *v);
402 int isl_val_is_rat(__isl_keep isl_val *v);
403 int isl_val_is_nan(__isl_keep isl_val *v);
404 int isl_val_is_infty(__isl_keep isl_val *v);
405 int isl_val_is_neginfty(__isl_keep isl_val *v);
407 Note that the sign of NaN is undefined.
409 The following binary properties are defined on pairs of C<isl_val>s.
412 int isl_val_lt(__isl_keep isl_val *v1,
413 __isl_keep isl_val *v2);
414 int isl_val_le(__isl_keep isl_val *v1,
415 __isl_keep isl_val *v2);
416 int isl_val_gt(__isl_keep isl_val *v1,
417 __isl_keep isl_val *v2);
418 int isl_val_ge(__isl_keep isl_val *v1,
419 __isl_keep isl_val *v2);
420 int isl_val_eq(__isl_keep isl_val *v1,
421 __isl_keep isl_val *v2);
422 int isl_val_ne(__isl_keep isl_val *v1,
423 __isl_keep isl_val *v2);
425 For integer C<isl_val>s we additionally have the following binary property.
428 int isl_val_is_divisible_by(__isl_keep isl_val *v1,
429 __isl_keep isl_val *v2);
431 An C<isl_val> can also be compared to an integer using the following
432 function. The result is undefined for NaN.
435 int isl_val_cmp_si(__isl_keep isl_val *v, long i);
437 The following unary operations are available on C<isl_val>s.
440 __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
441 __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
442 __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
443 __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
444 __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
446 The following binary operations are available on C<isl_val>s.
449 __isl_give isl_val *isl_val_abs(__isl_take isl_val *v);
450 __isl_give isl_val *isl_val_neg(__isl_take isl_val *v);
451 __isl_give isl_val *isl_val_floor(__isl_take isl_val *v);
452 __isl_give isl_val *isl_val_ceil(__isl_take isl_val *v);
453 __isl_give isl_val *isl_val_trunc(__isl_take isl_val *v);
454 __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
455 __isl_give isl_val *isl_val_min(__isl_take isl_val *v1,
456 __isl_take isl_val *v2);
457 __isl_give isl_val *isl_val_max(__isl_take isl_val *v1,
458 __isl_take isl_val *v2);
459 __isl_give isl_val *isl_val_add(__isl_take isl_val *v1,
460 __isl_take isl_val *v2);
461 __isl_give isl_val *isl_val_add_ui(__isl_take isl_val *v1,
463 __isl_give isl_val *isl_val_sub(__isl_take isl_val *v1,
464 __isl_take isl_val *v2);
465 __isl_give isl_val *isl_val_sub_ui(__isl_take isl_val *v1,
467 __isl_give isl_val *isl_val_mul(__isl_take isl_val *v1,
468 __isl_take isl_val *v2);
469 __isl_give isl_val *isl_val_mul_ui(__isl_take isl_val *v1,
471 __isl_give isl_val *isl_val_div(__isl_take isl_val *v1,
472 __isl_take isl_val *v2);
474 On integer values, we additionally have the following operations.
477 __isl_give isl_val *isl_val_2exp(__isl_take isl_val *v);
478 __isl_give isl_val *isl_val_mod(__isl_take isl_val *v1,
479 __isl_take isl_val *v2);
480 __isl_give isl_val *isl_val_gcd(__isl_take isl_val *v1,
481 __isl_take isl_val *v2);
482 __isl_give isl_val *isl_val_gcdext(__isl_take isl_val *v1,
483 __isl_take isl_val *v2, __isl_give isl_val **x,
484 __isl_give isl_val **y);
486 The function C<isl_val_gcdext> returns the greatest common divisor g
487 of C<v1> and C<v2> as well as two integers C<*x> and C<*y> such
488 that C<*x> * C<v1> + C<*y> * C<v2> = g.
490 A value can be read from input using
493 __isl_give isl_val *isl_val_read_from_str(isl_ctx *ctx,
496 A value can be printed using
499 __isl_give isl_printer *isl_printer_print_val(
500 __isl_take isl_printer *p, __isl_keep isl_val *v);
502 =head2 Integers (obsolescent)
504 All operations on integers, mainly the coefficients
505 of the constraints describing the sets and relations,
506 are performed in exact integer arithmetic using C<GMP>.
507 However, to allow future versions of C<isl> to optionally
508 support fixed integer arithmetic, all calls to C<GMP>
509 are wrapped inside C<isl> specific macros.
510 The basic type is C<isl_int> and the operations below
511 are available on this type.
512 The meanings of these operations are essentially the same
513 as their C<GMP> C<mpz_> counterparts.
514 As always with C<GMP> types, C<isl_int>s need to be
515 initialized with C<isl_int_init> before they can be used
516 and they need to be released with C<isl_int_clear>
518 The user should not assume that an C<isl_int> is represented
519 as a C<mpz_t>, but should instead explicitly convert between
520 C<mpz_t>s and C<isl_int>s using C<isl_int_set_gmp> and
521 C<isl_int_get_gmp> whenever a C<mpz_t> is required.
525 =item isl_int_init(i)
527 =item isl_int_clear(i)
529 =item isl_int_set(r,i)
531 =item isl_int_set_si(r,i)
533 =item isl_int_set_gmp(r,g)
535 =item isl_int_get_gmp(i,g)
537 =item isl_int_abs(r,i)
539 =item isl_int_neg(r,i)
541 =item isl_int_swap(i,j)
543 =item isl_int_swap_or_set(i,j)
545 =item isl_int_add_ui(r,i,j)
547 =item isl_int_sub_ui(r,i,j)
549 =item isl_int_add(r,i,j)
551 =item isl_int_sub(r,i,j)
553 =item isl_int_mul(r,i,j)
555 =item isl_int_mul_ui(r,i,j)
557 =item isl_int_addmul(r,i,j)
559 =item isl_int_submul(r,i,j)
561 =item isl_int_gcd(r,i,j)
563 =item isl_int_lcm(r,i,j)
565 =item isl_int_divexact(r,i,j)
567 =item isl_int_cdiv_q(r,i,j)
569 =item isl_int_fdiv_q(r,i,j)
571 =item isl_int_fdiv_r(r,i,j)
573 =item isl_int_fdiv_q_ui(r,i,j)
575 =item isl_int_read(r,s)
577 =item isl_int_print(out,i,width)
581 =item isl_int_cmp(i,j)
583 =item isl_int_cmp_si(i,si)
585 =item isl_int_eq(i,j)
587 =item isl_int_ne(i,j)
589 =item isl_int_lt(i,j)
591 =item isl_int_le(i,j)
593 =item isl_int_gt(i,j)
595 =item isl_int_ge(i,j)
597 =item isl_int_abs_eq(i,j)
599 =item isl_int_abs_ne(i,j)
601 =item isl_int_abs_lt(i,j)
603 =item isl_int_abs_gt(i,j)
605 =item isl_int_abs_ge(i,j)
607 =item isl_int_is_zero(i)
609 =item isl_int_is_one(i)
611 =item isl_int_is_negone(i)
613 =item isl_int_is_pos(i)
615 =item isl_int_is_neg(i)
617 =item isl_int_is_nonpos(i)
619 =item isl_int_is_nonneg(i)
621 =item isl_int_is_divisible_by(i,j)
625 =head2 Sets and Relations
627 C<isl> uses six types of objects for representing sets and relations,
628 C<isl_basic_set>, C<isl_basic_map>, C<isl_set>, C<isl_map>,
629 C<isl_union_set> and C<isl_union_map>.
630 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
631 can be described as a conjunction of affine constraints, while
632 C<isl_set> and C<isl_map> represent unions of
633 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
634 However, all C<isl_basic_set>s or C<isl_basic_map>s in the union need
635 to live in the same space. C<isl_union_set>s and C<isl_union_map>s
636 represent unions of C<isl_set>s or C<isl_map>s in I<different> spaces,
637 where spaces are considered different if they have a different number
638 of dimensions and/or different names (see L<"Spaces">).
639 The difference between sets and relations (maps) is that sets have
640 one set of variables, while relations have two sets of variables,
641 input variables and output variables.
643 =head2 Memory Management
645 Since a high-level operation on sets and/or relations usually involves
646 several substeps and since the user is usually not interested in
647 the intermediate results, most functions that return a new object
648 will also release all the objects passed as arguments.
649 If the user still wants to use one or more of these arguments
650 after the function call, she should pass along a copy of the
651 object rather than the object itself.
652 The user is then responsible for making sure that the original
653 object gets used somewhere else or is explicitly freed.
655 The arguments and return values of all documented functions are
656 annotated to make clear which arguments are released and which
657 arguments are preserved. In particular, the following annotations
664 C<__isl_give> means that a new object is returned.
665 The user should make sure that the returned pointer is
666 used exactly once as a value for an C<__isl_take> argument.
667 In between, it can be used as a value for as many
668 C<__isl_keep> arguments as the user likes.
669 There is one exception, and that is the case where the
670 pointer returned is C<NULL>. Is this case, the user
671 is free to use it as an C<__isl_take> argument or not.
675 C<__isl_take> means that the object the argument points to
676 is taken over by the function and may no longer be used
677 by the user as an argument to any other function.
678 The pointer value must be one returned by a function
679 returning an C<__isl_give> pointer.
680 If the user passes in a C<NULL> value, then this will
681 be treated as an error in the sense that the function will
682 not perform its usual operation. However, it will still
683 make sure that all the other C<__isl_take> arguments
688 C<__isl_keep> means that the function will only use the object
689 temporarily. After the function has finished, the user
690 can still use it as an argument to other functions.
691 A C<NULL> value will be treated in the same way as
692 a C<NULL> value for an C<__isl_take> argument.
696 =head2 Error Handling
698 C<isl> supports different ways to react in case a runtime error is triggered.
699 Runtime errors arise, e.g., if a function such as C<isl_map_intersect> is called
700 with two maps that have incompatible spaces. There are three possible ways
701 to react on error: to warn, to continue or to abort.
703 The default behavior is to warn. In this mode, C<isl> prints a warning, stores
704 the last error in the corresponding C<isl_ctx> and the function in which the
705 error was triggered returns C<NULL>. An error does not corrupt internal state,
706 such that isl can continue to be used. C<isl> also provides functions to
707 read the last error and to reset the memory that stores the last error. The
708 last error is only stored for information purposes. Its presence does not
709 change the behavior of C<isl>. Hence, resetting an error is not required to
710 continue to use isl, but only to observe new errors.
713 enum isl_error isl_ctx_last_error(isl_ctx *ctx);
714 void isl_ctx_reset_error(isl_ctx *ctx);
716 Another option is to continue on error. This is similar to warn on error mode,
717 except that C<isl> does not print any warning. This allows a program to
718 implement its own error reporting.
720 The last option is to directly abort the execution of the program from within
721 the isl library. This makes it obviously impossible to recover from an error,
722 but it allows to directly spot the error location. By aborting on error,
723 debuggers break at the location the error occurred and can provide a stack
724 trace. Other tools that automatically provide stack traces on abort or that do
725 not want to continue execution after an error was triggered may also prefer to
728 The on error behavior of isl can be specified by calling
729 C<isl_options_set_on_error> or by setting the command line option
730 C<--isl-on-error>. Valid arguments for the function call are
731 C<ISL_ON_ERROR_WARN>, C<ISL_ON_ERROR_CONTINUE> and C<ISL_ON_ERROR_ABORT>. The
732 choices for the command line option are C<warn>, C<continue> and C<abort>.
733 It is also possible to query the current error mode.
735 #include <isl/options.h>
736 int isl_options_set_on_error(isl_ctx *ctx, int val);
737 int isl_options_get_on_error(isl_ctx *ctx);
741 Identifiers are used to identify both individual dimensions
742 and tuples of dimensions. They consist of an optional name and an optional
743 user pointer. The name and the user pointer cannot both be C<NULL>, however.
744 Identifiers with the same name but different pointer values
745 are considered to be distinct.
746 Similarly, identifiers with different names but the same pointer value
747 are also considered to be distinct.
748 Equal identifiers are represented using the same object.
749 Pairs of identifiers can therefore be tested for equality using the
751 Identifiers can be constructed, copied, freed, inspected and printed
752 using the following functions.
755 __isl_give isl_id *isl_id_alloc(isl_ctx *ctx,
756 __isl_keep const char *name, void *user);
757 __isl_give isl_id *isl_id_set_free_user(
758 __isl_take isl_id *id,
759 __isl_give void (*free_user)(void *user));
760 __isl_give isl_id *isl_id_copy(isl_id *id);
761 void *isl_id_free(__isl_take isl_id *id);
763 isl_ctx *isl_id_get_ctx(__isl_keep isl_id *id);
764 void *isl_id_get_user(__isl_keep isl_id *id);
765 __isl_keep const char *isl_id_get_name(__isl_keep isl_id *id);
767 __isl_give isl_printer *isl_printer_print_id(
768 __isl_take isl_printer *p, __isl_keep isl_id *id);
770 The callback set by C<isl_id_set_free_user> is called on the user
771 pointer when the last reference to the C<isl_id> is freed.
772 Note that C<isl_id_get_name> returns a pointer to some internal
773 data structure, so the result can only be used while the
774 corresponding C<isl_id> is alive.
778 Whenever a new set, relation or similiar object is created from scratch,
779 the space in which it lives needs to be specified using an C<isl_space>.
780 Each space involves zero or more parameters and zero, one or two
781 tuples of set or input/output dimensions. The parameters and dimensions
782 are identified by an C<isl_dim_type> and a position.
783 The type C<isl_dim_param> refers to parameters,
784 the type C<isl_dim_set> refers to set dimensions (for spaces
785 with a single tuple of dimensions) and the types C<isl_dim_in>
786 and C<isl_dim_out> refer to input and output dimensions
787 (for spaces with two tuples of dimensions).
788 Local spaces (see L</"Local Spaces">) also contain dimensions
789 of type C<isl_dim_div>.
790 Note that parameters are only identified by their position within
791 a given object. Across different objects, parameters are (usually)
792 identified by their names or identifiers. Only unnamed parameters
793 are identified by their positions across objects. The use of unnamed
794 parameters is discouraged.
796 #include <isl/space.h>
797 __isl_give isl_space *isl_space_alloc(isl_ctx *ctx,
798 unsigned nparam, unsigned n_in, unsigned n_out);
799 __isl_give isl_space *isl_space_params_alloc(isl_ctx *ctx,
801 __isl_give isl_space *isl_space_set_alloc(isl_ctx *ctx,
802 unsigned nparam, unsigned dim);
803 __isl_give isl_space *isl_space_copy(__isl_keep isl_space *space);
804 void *isl_space_free(__isl_take isl_space *space);
805 unsigned isl_space_dim(__isl_keep isl_space *space,
806 enum isl_dim_type type);
808 The space used for creating a parameter domain
809 needs to be created using C<isl_space_params_alloc>.
810 For other sets, the space
811 needs to be created using C<isl_space_set_alloc>, while
812 for a relation, the space
813 needs to be created using C<isl_space_alloc>.
814 C<isl_space_dim> can be used
815 to find out the number of dimensions of each type in
816 a space, where type may be
817 C<isl_dim_param>, C<isl_dim_in> (only for relations),
818 C<isl_dim_out> (only for relations), C<isl_dim_set>
819 (only for sets) or C<isl_dim_all>.
821 To check whether a given space is that of a set or a map
822 or whether it is a parameter space, use these functions:
824 #include <isl/space.h>
825 int isl_space_is_params(__isl_keep isl_space *space);
826 int isl_space_is_set(__isl_keep isl_space *space);
827 int isl_space_is_map(__isl_keep isl_space *space);
829 Spaces can be compared using the following functions:
831 #include <isl/space.h>
832 int isl_space_is_equal(__isl_keep isl_space *space1,
833 __isl_keep isl_space *space2);
834 int isl_space_is_domain(__isl_keep isl_space *space1,
835 __isl_keep isl_space *space2);
836 int isl_space_is_range(__isl_keep isl_space *space1,
837 __isl_keep isl_space *space2);
839 C<isl_space_is_domain> checks whether the first argument is equal
840 to the domain of the second argument. This requires in particular that
841 the first argument is a set space and that the second argument
844 It is often useful to create objects that live in the
845 same space as some other object. This can be accomplished
846 by creating the new objects
847 (see L<Creating New Sets and Relations> or
848 L<Creating New (Piecewise) Quasipolynomials>) based on the space
849 of the original object.
852 __isl_give isl_space *isl_basic_set_get_space(
853 __isl_keep isl_basic_set *bset);
854 __isl_give isl_space *isl_set_get_space(__isl_keep isl_set *set);
856 #include <isl/union_set.h>
857 __isl_give isl_space *isl_union_set_get_space(
858 __isl_keep isl_union_set *uset);
861 __isl_give isl_space *isl_basic_map_get_space(
862 __isl_keep isl_basic_map *bmap);
863 __isl_give isl_space *isl_map_get_space(__isl_keep isl_map *map);
865 #include <isl/union_map.h>
866 __isl_give isl_space *isl_union_map_get_space(
867 __isl_keep isl_union_map *umap);
869 #include <isl/constraint.h>
870 __isl_give isl_space *isl_constraint_get_space(
871 __isl_keep isl_constraint *constraint);
873 #include <isl/polynomial.h>
874 __isl_give isl_space *isl_qpolynomial_get_domain_space(
875 __isl_keep isl_qpolynomial *qp);
876 __isl_give isl_space *isl_qpolynomial_get_space(
877 __isl_keep isl_qpolynomial *qp);
878 __isl_give isl_space *isl_qpolynomial_fold_get_space(
879 __isl_keep isl_qpolynomial_fold *fold);
880 __isl_give isl_space *isl_pw_qpolynomial_get_domain_space(
881 __isl_keep isl_pw_qpolynomial *pwqp);
882 __isl_give isl_space *isl_pw_qpolynomial_get_space(
883 __isl_keep isl_pw_qpolynomial *pwqp);
884 __isl_give isl_space *isl_pw_qpolynomial_fold_get_domain_space(
885 __isl_keep isl_pw_qpolynomial_fold *pwf);
886 __isl_give isl_space *isl_pw_qpolynomial_fold_get_space(
887 __isl_keep isl_pw_qpolynomial_fold *pwf);
888 __isl_give isl_space *isl_union_pw_qpolynomial_get_space(
889 __isl_keep isl_union_pw_qpolynomial *upwqp);
890 __isl_give isl_space *isl_union_pw_qpolynomial_fold_get_space(
891 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
894 __isl_give isl_space *isl_multi_val_get_space(
895 __isl_keep isl_multi_val *mv);
898 __isl_give isl_space *isl_aff_get_domain_space(
899 __isl_keep isl_aff *aff);
900 __isl_give isl_space *isl_aff_get_space(
901 __isl_keep isl_aff *aff);
902 __isl_give isl_space *isl_pw_aff_get_domain_space(
903 __isl_keep isl_pw_aff *pwaff);
904 __isl_give isl_space *isl_pw_aff_get_space(
905 __isl_keep isl_pw_aff *pwaff);
906 __isl_give isl_space *isl_multi_aff_get_domain_space(
907 __isl_keep isl_multi_aff *maff);
908 __isl_give isl_space *isl_multi_aff_get_space(
909 __isl_keep isl_multi_aff *maff);
910 __isl_give isl_space *isl_pw_multi_aff_get_domain_space(
911 __isl_keep isl_pw_multi_aff *pma);
912 __isl_give isl_space *isl_pw_multi_aff_get_space(
913 __isl_keep isl_pw_multi_aff *pma);
914 __isl_give isl_space *isl_union_pw_multi_aff_get_space(
915 __isl_keep isl_union_pw_multi_aff *upma);
916 __isl_give isl_space *isl_multi_pw_aff_get_domain_space(
917 __isl_keep isl_multi_pw_aff *mpa);
918 __isl_give isl_space *isl_multi_pw_aff_get_space(
919 __isl_keep isl_multi_pw_aff *mpa);
921 #include <isl/point.h>
922 __isl_give isl_space *isl_point_get_space(
923 __isl_keep isl_point *pnt);
925 The identifiers or names of the individual dimensions may be set or read off
926 using the following functions.
928 #include <isl/space.h>
929 __isl_give isl_space *isl_space_set_dim_id(
930 __isl_take isl_space *space,
931 enum isl_dim_type type, unsigned pos,
932 __isl_take isl_id *id);
933 int isl_space_has_dim_id(__isl_keep isl_space *space,
934 enum isl_dim_type type, unsigned pos);
935 __isl_give isl_id *isl_space_get_dim_id(
936 __isl_keep isl_space *space,
937 enum isl_dim_type type, unsigned pos);
938 __isl_give isl_space *isl_space_set_dim_name(
939 __isl_take isl_space *space,
940 enum isl_dim_type type, unsigned pos,
941 __isl_keep const char *name);
942 int isl_space_has_dim_name(__isl_keep isl_space *space,
943 enum isl_dim_type type, unsigned pos);
944 __isl_keep const char *isl_space_get_dim_name(
945 __isl_keep isl_space *space,
946 enum isl_dim_type type, unsigned pos);
948 Note that C<isl_space_get_name> returns a pointer to some internal
949 data structure, so the result can only be used while the
950 corresponding C<isl_space> is alive.
951 Also note that every function that operates on two sets or relations
952 requires that both arguments have the same parameters. This also
953 means that if one of the arguments has named parameters, then the
954 other needs to have named parameters too and the names need to match.
955 Pairs of C<isl_set>, C<isl_map>, C<isl_union_set> and/or C<isl_union_map>
956 arguments may have different parameters (as long as they are named),
957 in which case the result will have as parameters the union of the parameters of
960 Given the identifier or name of a dimension (typically a parameter),
961 its position can be obtained from the following function.
963 #include <isl/space.h>
964 int isl_space_find_dim_by_id(__isl_keep isl_space *space,
965 enum isl_dim_type type, __isl_keep isl_id *id);
966 int isl_space_find_dim_by_name(__isl_keep isl_space *space,
967 enum isl_dim_type type, const char *name);
969 The identifiers or names of entire spaces may be set or read off
970 using the following functions.
972 #include <isl/space.h>
973 __isl_give isl_space *isl_space_set_tuple_id(
974 __isl_take isl_space *space,
975 enum isl_dim_type type, __isl_take isl_id *id);
976 __isl_give isl_space *isl_space_reset_tuple_id(
977 __isl_take isl_space *space, enum isl_dim_type type);
978 int isl_space_has_tuple_id(__isl_keep isl_space *space,
979 enum isl_dim_type type);
980 __isl_give isl_id *isl_space_get_tuple_id(
981 __isl_keep isl_space *space, enum isl_dim_type type);
982 __isl_give isl_space *isl_space_set_tuple_name(
983 __isl_take isl_space *space,
984 enum isl_dim_type type, const char *s);
985 int isl_space_has_tuple_name(__isl_keep isl_space *space,
986 enum isl_dim_type type);
987 const char *isl_space_get_tuple_name(__isl_keep isl_space *space,
988 enum isl_dim_type type);
990 The C<type> argument needs to be one of C<isl_dim_in>, C<isl_dim_out>
991 or C<isl_dim_set>. As with C<isl_space_get_name>,
992 the C<isl_space_get_tuple_name> function returns a pointer to some internal
994 Binary operations require the corresponding spaces of their arguments
995 to have the same name.
997 Spaces can be nested. In particular, the domain of a set or
998 the domain or range of a relation can be a nested relation.
999 The following functions can be used to construct and deconstruct
1002 #include <isl/space.h>
1003 int isl_space_is_wrapping(__isl_keep isl_space *space);
1004 __isl_give isl_space *isl_space_wrap(__isl_take isl_space *space);
1005 __isl_give isl_space *isl_space_unwrap(__isl_take isl_space *space);
1007 The input to C<isl_space_is_wrapping> and C<isl_space_unwrap> should
1008 be the space of a set, while that of
1009 C<isl_space_wrap> should be the space of a relation.
1010 Conversely, the output of C<isl_space_unwrap> is the space
1011 of a relation, while that of C<isl_space_wrap> is the space of a set.
1013 Spaces can be created from other spaces
1014 using the following functions.
1016 __isl_give isl_space *isl_space_domain(__isl_take isl_space *space);
1017 __isl_give isl_space *isl_space_from_domain(__isl_take isl_space *space);
1018 __isl_give isl_space *isl_space_range(__isl_take isl_space *space);
1019 __isl_give isl_space *isl_space_from_range(__isl_take isl_space *space);
1020 __isl_give isl_space *isl_space_params(
1021 __isl_take isl_space *space);
1022 __isl_give isl_space *isl_space_set_from_params(
1023 __isl_take isl_space *space);
1024 __isl_give isl_space *isl_space_reverse(__isl_take isl_space *space);
1025 __isl_give isl_space *isl_space_join(__isl_take isl_space *left,
1026 __isl_take isl_space *right);
1027 __isl_give isl_space *isl_space_align_params(
1028 __isl_take isl_space *space1, __isl_take isl_space *space2)
1029 __isl_give isl_space *isl_space_insert_dims(__isl_take isl_space *space,
1030 enum isl_dim_type type, unsigned pos, unsigned n);
1031 __isl_give isl_space *isl_space_add_dims(__isl_take isl_space *space,
1032 enum isl_dim_type type, unsigned n);
1033 __isl_give isl_space *isl_space_drop_dims(__isl_take isl_space *space,
1034 enum isl_dim_type type, unsigned first, unsigned n);
1035 __isl_give isl_space *isl_space_move_dims(__isl_take isl_space *space,
1036 enum isl_dim_type dst_type, unsigned dst_pos,
1037 enum isl_dim_type src_type, unsigned src_pos,
1039 __isl_give isl_space *isl_space_map_from_set(
1040 __isl_take isl_space *space);
1041 __isl_give isl_space *isl_space_map_from_domain_and_range(
1042 __isl_take isl_space *domain,
1043 __isl_take isl_space *range);
1044 __isl_give isl_space *isl_space_zip(__isl_take isl_space *space);
1045 __isl_give isl_space *isl_space_curry(
1046 __isl_take isl_space *space);
1047 __isl_give isl_space *isl_space_uncurry(
1048 __isl_take isl_space *space);
1050 Note that if dimensions are added or removed from a space, then
1051 the name and the internal structure are lost.
1055 A local space is essentially a space with
1056 zero or more existentially quantified variables.
1057 The local space of a (constraint of a) basic set or relation can be obtained
1058 using the following functions.
1060 #include <isl/constraint.h>
1061 __isl_give isl_local_space *isl_constraint_get_local_space(
1062 __isl_keep isl_constraint *constraint);
1064 #include <isl/set.h>
1065 __isl_give isl_local_space *isl_basic_set_get_local_space(
1066 __isl_keep isl_basic_set *bset);
1068 #include <isl/map.h>
1069 __isl_give isl_local_space *isl_basic_map_get_local_space(
1070 __isl_keep isl_basic_map *bmap);
1072 A new local space can be created from a space using
1074 #include <isl/local_space.h>
1075 __isl_give isl_local_space *isl_local_space_from_space(
1076 __isl_take isl_space *space);
1078 They can be inspected, modified, copied and freed using the following functions.
1080 #include <isl/local_space.h>
1081 isl_ctx *isl_local_space_get_ctx(
1082 __isl_keep isl_local_space *ls);
1083 int isl_local_space_is_set(__isl_keep isl_local_space *ls);
1084 int isl_local_space_dim(__isl_keep isl_local_space *ls,
1085 enum isl_dim_type type);
1086 int isl_local_space_has_dim_id(
1087 __isl_keep isl_local_space *ls,
1088 enum isl_dim_type type, unsigned pos);
1089 __isl_give isl_id *isl_local_space_get_dim_id(
1090 __isl_keep isl_local_space *ls,
1091 enum isl_dim_type type, unsigned pos);
1092 int isl_local_space_has_dim_name(
1093 __isl_keep isl_local_space *ls,
1094 enum isl_dim_type type, unsigned pos)
1095 const char *isl_local_space_get_dim_name(
1096 __isl_keep isl_local_space *ls,
1097 enum isl_dim_type type, unsigned pos);
1098 __isl_give isl_local_space *isl_local_space_set_dim_name(
1099 __isl_take isl_local_space *ls,
1100 enum isl_dim_type type, unsigned pos, const char *s);
1101 __isl_give isl_local_space *isl_local_space_set_dim_id(
1102 __isl_take isl_local_space *ls,
1103 enum isl_dim_type type, unsigned pos,
1104 __isl_take isl_id *id);
1105 __isl_give isl_space *isl_local_space_get_space(
1106 __isl_keep isl_local_space *ls);
1107 __isl_give isl_aff *isl_local_space_get_div(
1108 __isl_keep isl_local_space *ls, int pos);
1109 __isl_give isl_local_space *isl_local_space_copy(
1110 __isl_keep isl_local_space *ls);
1111 void *isl_local_space_free(__isl_take isl_local_space *ls);
1113 Note that C<isl_local_space_get_div> can only be used on local spaces
1116 Two local spaces can be compared using
1118 int isl_local_space_is_equal(__isl_keep isl_local_space *ls1,
1119 __isl_keep isl_local_space *ls2);
1121 Local spaces can be created from other local spaces
1122 using the following functions.
1124 __isl_give isl_local_space *isl_local_space_domain(
1125 __isl_take isl_local_space *ls);
1126 __isl_give isl_local_space *isl_local_space_range(
1127 __isl_take isl_local_space *ls);
1128 __isl_give isl_local_space *isl_local_space_from_domain(
1129 __isl_take isl_local_space *ls);
1130 __isl_give isl_local_space *isl_local_space_intersect(
1131 __isl_take isl_local_space *ls1,
1132 __isl_take isl_local_space *ls2);
1133 __isl_give isl_local_space *isl_local_space_add_dims(
1134 __isl_take isl_local_space *ls,
1135 enum isl_dim_type type, unsigned n);
1136 __isl_give isl_local_space *isl_local_space_insert_dims(
1137 __isl_take isl_local_space *ls,
1138 enum isl_dim_type type, unsigned first, unsigned n);
1139 __isl_give isl_local_space *isl_local_space_drop_dims(
1140 __isl_take isl_local_space *ls,
1141 enum isl_dim_type type, unsigned first, unsigned n);
1143 =head2 Input and Output
1145 C<isl> supports its own input/output format, which is similar
1146 to the C<Omega> format, but also supports the C<PolyLib> format
1149 =head3 C<isl> format
1151 The C<isl> format is similar to that of C<Omega>, but has a different
1152 syntax for describing the parameters and allows for the definition
1153 of an existentially quantified variable as the integer division
1154 of an affine expression.
1155 For example, the set of integers C<i> between C<0> and C<n>
1156 such that C<i % 10 <= 6> can be described as
1158 [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
1161 A set or relation can have several disjuncts, separated
1162 by the keyword C<or>. Each disjunct is either a conjunction
1163 of constraints or a projection (C<exists>) of a conjunction
1164 of constraints. The constraints are separated by the keyword
1167 =head3 C<PolyLib> format
1169 If the represented set is a union, then the first line
1170 contains a single number representing the number of disjuncts.
1171 Otherwise, a line containing the number C<1> is optional.
1173 Each disjunct is represented by a matrix of constraints.
1174 The first line contains two numbers representing
1175 the number of rows and columns,
1176 where the number of rows is equal to the number of constraints
1177 and the number of columns is equal to two plus the number of variables.
1178 The following lines contain the actual rows of the constraint matrix.
1179 In each row, the first column indicates whether the constraint
1180 is an equality (C<0>) or inequality (C<1>). The final column
1181 corresponds to the constant term.
1183 If the set is parametric, then the coefficients of the parameters
1184 appear in the last columns before the constant column.
1185 The coefficients of any existentially quantified variables appear
1186 between those of the set variables and those of the parameters.
1188 =head3 Extended C<PolyLib> format
1190 The extended C<PolyLib> format is nearly identical to the
1191 C<PolyLib> format. The only difference is that the line
1192 containing the number of rows and columns of a constraint matrix
1193 also contains four additional numbers:
1194 the number of output dimensions, the number of input dimensions,
1195 the number of local dimensions (i.e., the number of existentially
1196 quantified variables) and the number of parameters.
1197 For sets, the number of ``output'' dimensions is equal
1198 to the number of set dimensions, while the number of ``input''
1203 #include <isl/set.h>
1204 __isl_give isl_basic_set *isl_basic_set_read_from_file(
1205 isl_ctx *ctx, FILE *input);
1206 __isl_give isl_basic_set *isl_basic_set_read_from_str(
1207 isl_ctx *ctx, const char *str);
1208 __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
1210 __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
1213 #include <isl/map.h>
1214 __isl_give isl_basic_map *isl_basic_map_read_from_file(
1215 isl_ctx *ctx, FILE *input);
1216 __isl_give isl_basic_map *isl_basic_map_read_from_str(
1217 isl_ctx *ctx, const char *str);
1218 __isl_give isl_map *isl_map_read_from_file(
1219 isl_ctx *ctx, FILE *input);
1220 __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
1223 #include <isl/union_set.h>
1224 __isl_give isl_union_set *isl_union_set_read_from_file(
1225 isl_ctx *ctx, FILE *input);
1226 __isl_give isl_union_set *isl_union_set_read_from_str(
1227 isl_ctx *ctx, const char *str);
1229 #include <isl/union_map.h>
1230 __isl_give isl_union_map *isl_union_map_read_from_file(
1231 isl_ctx *ctx, FILE *input);
1232 __isl_give isl_union_map *isl_union_map_read_from_str(
1233 isl_ctx *ctx, const char *str);
1235 The input format is autodetected and may be either the C<PolyLib> format
1236 or the C<isl> format.
1240 Before anything can be printed, an C<isl_printer> needs to
1243 __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
1245 __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
1246 void *isl_printer_free(__isl_take isl_printer *printer);
1247 __isl_give char *isl_printer_get_str(
1248 __isl_keep isl_printer *printer);
1250 The printer can be inspected using the following functions.
1252 FILE *isl_printer_get_file(
1253 __isl_keep isl_printer *printer);
1254 int isl_printer_get_output_format(
1255 __isl_keep isl_printer *p);
1257 The behavior of the printer can be modified in various ways
1259 __isl_give isl_printer *isl_printer_set_output_format(
1260 __isl_take isl_printer *p, int output_format);
1261 __isl_give isl_printer *isl_printer_set_indent(
1262 __isl_take isl_printer *p, int indent);
1263 __isl_give isl_printer *isl_printer_indent(
1264 __isl_take isl_printer *p, int indent);
1265 __isl_give isl_printer *isl_printer_set_prefix(
1266 __isl_take isl_printer *p, const char *prefix);
1267 __isl_give isl_printer *isl_printer_set_suffix(
1268 __isl_take isl_printer *p, const char *suffix);
1270 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>,
1271 C<ISL_FORMAT_POLYLIB>, C<ISL_FORMAT_EXT_POLYLIB> or C<ISL_FORMAT_LATEX>
1272 and defaults to C<ISL_FORMAT_ISL>.
1273 Each line in the output is indented by C<indent> (set by
1274 C<isl_printer_set_indent>) spaces
1275 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
1276 In the C<PolyLib> format output,
1277 the coefficients of the existentially quantified variables
1278 appear between those of the set variables and those
1280 The function C<isl_printer_indent> increases the indentation
1281 by the specified amount (which may be negative).
1283 To actually print something, use
1285 #include <isl/printer.h>
1286 __isl_give isl_printer *isl_printer_print_double(
1287 __isl_take isl_printer *p, double d);
1289 #include <isl/set.h>
1290 __isl_give isl_printer *isl_printer_print_basic_set(
1291 __isl_take isl_printer *printer,
1292 __isl_keep isl_basic_set *bset);
1293 __isl_give isl_printer *isl_printer_print_set(
1294 __isl_take isl_printer *printer,
1295 __isl_keep isl_set *set);
1297 #include <isl/map.h>
1298 __isl_give isl_printer *isl_printer_print_basic_map(
1299 __isl_take isl_printer *printer,
1300 __isl_keep isl_basic_map *bmap);
1301 __isl_give isl_printer *isl_printer_print_map(
1302 __isl_take isl_printer *printer,
1303 __isl_keep isl_map *map);
1305 #include <isl/union_set.h>
1306 __isl_give isl_printer *isl_printer_print_union_set(
1307 __isl_take isl_printer *p,
1308 __isl_keep isl_union_set *uset);
1310 #include <isl/union_map.h>
1311 __isl_give isl_printer *isl_printer_print_union_map(
1312 __isl_take isl_printer *p,
1313 __isl_keep isl_union_map *umap);
1315 When called on a file printer, the following function flushes
1316 the file. When called on a string printer, the buffer is cleared.
1318 __isl_give isl_printer *isl_printer_flush(
1319 __isl_take isl_printer *p);
1321 =head2 Creating New Sets and Relations
1323 C<isl> has functions for creating some standard sets and relations.
1327 =item * Empty sets and relations
1329 __isl_give isl_basic_set *isl_basic_set_empty(
1330 __isl_take isl_space *space);
1331 __isl_give isl_basic_map *isl_basic_map_empty(
1332 __isl_take isl_space *space);
1333 __isl_give isl_set *isl_set_empty(
1334 __isl_take isl_space *space);
1335 __isl_give isl_map *isl_map_empty(
1336 __isl_take isl_space *space);
1337 __isl_give isl_union_set *isl_union_set_empty(
1338 __isl_take isl_space *space);
1339 __isl_give isl_union_map *isl_union_map_empty(
1340 __isl_take isl_space *space);
1342 For C<isl_union_set>s and C<isl_union_map>s, the space
1343 is only used to specify the parameters.
1345 =item * Universe sets and relations
1347 __isl_give isl_basic_set *isl_basic_set_universe(
1348 __isl_take isl_space *space);
1349 __isl_give isl_basic_map *isl_basic_map_universe(
1350 __isl_take isl_space *space);
1351 __isl_give isl_set *isl_set_universe(
1352 __isl_take isl_space *space);
1353 __isl_give isl_map *isl_map_universe(
1354 __isl_take isl_space *space);
1355 __isl_give isl_union_set *isl_union_set_universe(
1356 __isl_take isl_union_set *uset);
1357 __isl_give isl_union_map *isl_union_map_universe(
1358 __isl_take isl_union_map *umap);
1360 The sets and relations constructed by the functions above
1361 contain all integer values, while those constructed by the
1362 functions below only contain non-negative values.
1364 __isl_give isl_basic_set *isl_basic_set_nat_universe(
1365 __isl_take isl_space *space);
1366 __isl_give isl_basic_map *isl_basic_map_nat_universe(
1367 __isl_take isl_space *space);
1368 __isl_give isl_set *isl_set_nat_universe(
1369 __isl_take isl_space *space);
1370 __isl_give isl_map *isl_map_nat_universe(
1371 __isl_take isl_space *space);
1373 =item * Identity relations
1375 __isl_give isl_basic_map *isl_basic_map_identity(
1376 __isl_take isl_space *space);
1377 __isl_give isl_map *isl_map_identity(
1378 __isl_take isl_space *space);
1380 The number of input and output dimensions in C<space> needs
1383 =item * Lexicographic order
1385 __isl_give isl_map *isl_map_lex_lt(
1386 __isl_take isl_space *set_space);
1387 __isl_give isl_map *isl_map_lex_le(
1388 __isl_take isl_space *set_space);
1389 __isl_give isl_map *isl_map_lex_gt(
1390 __isl_take isl_space *set_space);
1391 __isl_give isl_map *isl_map_lex_ge(
1392 __isl_take isl_space *set_space);
1393 __isl_give isl_map *isl_map_lex_lt_first(
1394 __isl_take isl_space *space, unsigned n);
1395 __isl_give isl_map *isl_map_lex_le_first(
1396 __isl_take isl_space *space, unsigned n);
1397 __isl_give isl_map *isl_map_lex_gt_first(
1398 __isl_take isl_space *space, unsigned n);
1399 __isl_give isl_map *isl_map_lex_ge_first(
1400 __isl_take isl_space *space, unsigned n);
1402 The first four functions take a space for a B<set>
1403 and return relations that express that the elements in the domain
1404 are lexicographically less
1405 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
1406 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
1407 than the elements in the range.
1408 The last four functions take a space for a map
1409 and return relations that express that the first C<n> dimensions
1410 in the domain are lexicographically less
1411 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
1412 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
1413 than the first C<n> dimensions in the range.
1417 A basic set or relation can be converted to a set or relation
1418 using the following functions.
1420 __isl_give isl_set *isl_set_from_basic_set(
1421 __isl_take isl_basic_set *bset);
1422 __isl_give isl_map *isl_map_from_basic_map(
1423 __isl_take isl_basic_map *bmap);
1425 Sets and relations can be converted to union sets and relations
1426 using the following functions.
1428 __isl_give isl_union_set *isl_union_set_from_basic_set(
1429 __isl_take isl_basic_set *bset);
1430 __isl_give isl_union_map *isl_union_map_from_basic_map(
1431 __isl_take isl_basic_map *bmap);
1432 __isl_give isl_union_set *isl_union_set_from_set(
1433 __isl_take isl_set *set);
1434 __isl_give isl_union_map *isl_union_map_from_map(
1435 __isl_take isl_map *map);
1437 The inverse conversions below can only be used if the input
1438 union set or relation is known to contain elements in exactly one
1441 __isl_give isl_set *isl_set_from_union_set(
1442 __isl_take isl_union_set *uset);
1443 __isl_give isl_map *isl_map_from_union_map(
1444 __isl_take isl_union_map *umap);
1446 A zero-dimensional (basic) set can be constructed on a given parameter domain
1447 using the following function.
1449 __isl_give isl_basic_set *isl_basic_set_from_params(
1450 __isl_take isl_basic_set *bset);
1451 __isl_give isl_set *isl_set_from_params(
1452 __isl_take isl_set *set);
1454 Sets and relations can be copied and freed again using the following
1457 __isl_give isl_basic_set *isl_basic_set_copy(
1458 __isl_keep isl_basic_set *bset);
1459 __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
1460 __isl_give isl_union_set *isl_union_set_copy(
1461 __isl_keep isl_union_set *uset);
1462 __isl_give isl_basic_map *isl_basic_map_copy(
1463 __isl_keep isl_basic_map *bmap);
1464 __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
1465 __isl_give isl_union_map *isl_union_map_copy(
1466 __isl_keep isl_union_map *umap);
1467 void *isl_basic_set_free(__isl_take isl_basic_set *bset);
1468 void *isl_set_free(__isl_take isl_set *set);
1469 void *isl_union_set_free(__isl_take isl_union_set *uset);
1470 void *isl_basic_map_free(__isl_take isl_basic_map *bmap);
1471 void *isl_map_free(__isl_take isl_map *map);
1472 void *isl_union_map_free(__isl_take isl_union_map *umap);
1474 Other sets and relations can be constructed by starting
1475 from a universe set or relation, adding equality and/or
1476 inequality constraints and then projecting out the
1477 existentially quantified variables, if any.
1478 Constraints can be constructed, manipulated and
1479 added to (or removed from) (basic) sets and relations
1480 using the following functions.
1482 #include <isl/constraint.h>
1483 __isl_give isl_constraint *isl_equality_alloc(
1484 __isl_take isl_local_space *ls);
1485 __isl_give isl_constraint *isl_inequality_alloc(
1486 __isl_take isl_local_space *ls);
1487 __isl_give isl_constraint *isl_constraint_set_constant(
1488 __isl_take isl_constraint *constraint, isl_int v);
1489 __isl_give isl_constraint *isl_constraint_set_constant_si(
1490 __isl_take isl_constraint *constraint, int v);
1491 __isl_give isl_constraint *isl_constraint_set_coefficient(
1492 __isl_take isl_constraint *constraint,
1493 enum isl_dim_type type, int pos, isl_int v);
1494 __isl_give isl_constraint *isl_constraint_set_coefficient_si(
1495 __isl_take isl_constraint *constraint,
1496 enum isl_dim_type type, int pos, int v);
1497 __isl_give isl_basic_map *isl_basic_map_add_constraint(
1498 __isl_take isl_basic_map *bmap,
1499 __isl_take isl_constraint *constraint);
1500 __isl_give isl_basic_set *isl_basic_set_add_constraint(
1501 __isl_take isl_basic_set *bset,
1502 __isl_take isl_constraint *constraint);
1503 __isl_give isl_map *isl_map_add_constraint(
1504 __isl_take isl_map *map,
1505 __isl_take isl_constraint *constraint);
1506 __isl_give isl_set *isl_set_add_constraint(
1507 __isl_take isl_set *set,
1508 __isl_take isl_constraint *constraint);
1509 __isl_give isl_basic_set *isl_basic_set_drop_constraint(
1510 __isl_take isl_basic_set *bset,
1511 __isl_take isl_constraint *constraint);
1513 For example, to create a set containing the even integers
1514 between 10 and 42, you would use the following code.
1517 isl_local_space *ls;
1519 isl_basic_set *bset;
1521 space = isl_space_set_alloc(ctx, 0, 2);
1522 bset = isl_basic_set_universe(isl_space_copy(space));
1523 ls = isl_local_space_from_space(space);
1525 c = isl_equality_alloc(isl_local_space_copy(ls));
1526 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1527 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 1, 2);
1528 bset = isl_basic_set_add_constraint(bset, c);
1530 c = isl_inequality_alloc(isl_local_space_copy(ls));
1531 c = isl_constraint_set_constant_si(c, -10);
1532 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, 1);
1533 bset = isl_basic_set_add_constraint(bset, c);
1535 c = isl_inequality_alloc(ls);
1536 c = isl_constraint_set_constant_si(c, 42);
1537 c = isl_constraint_set_coefficient_si(c, isl_dim_set, 0, -1);
1538 bset = isl_basic_set_add_constraint(bset, c);
1540 bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
1544 isl_basic_set *bset;
1545 bset = isl_basic_set_read_from_str(ctx,
1546 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}");
1548 A basic set or relation can also be constructed from two matrices
1549 describing the equalities and the inequalities.
1551 __isl_give isl_basic_set *isl_basic_set_from_constraint_matrices(
1552 __isl_take isl_space *space,
1553 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1554 enum isl_dim_type c1,
1555 enum isl_dim_type c2, enum isl_dim_type c3,
1556 enum isl_dim_type c4);
1557 __isl_give isl_basic_map *isl_basic_map_from_constraint_matrices(
1558 __isl_take isl_space *space,
1559 __isl_take isl_mat *eq, __isl_take isl_mat *ineq,
1560 enum isl_dim_type c1,
1561 enum isl_dim_type c2, enum isl_dim_type c3,
1562 enum isl_dim_type c4, enum isl_dim_type c5);
1564 The C<isl_dim_type> arguments indicate the order in which
1565 different kinds of variables appear in the input matrices
1566 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1567 C<isl_dim_set> and C<isl_dim_div> for sets and
1568 of C<isl_dim_cst>, C<isl_dim_param>,
1569 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div> for relations.
1571 A (basic or union) set or relation can also be constructed from a
1572 (union) (piecewise) (multiple) affine expression
1573 or a list of affine expressions
1574 (See L<"Piecewise Quasi Affine Expressions"> and
1575 L<"Piecewise Multiple Quasi Affine Expressions">).
1577 __isl_give isl_basic_map *isl_basic_map_from_aff(
1578 __isl_take isl_aff *aff);
1579 __isl_give isl_map *isl_map_from_aff(
1580 __isl_take isl_aff *aff);
1581 __isl_give isl_set *isl_set_from_pw_aff(
1582 __isl_take isl_pw_aff *pwaff);
1583 __isl_give isl_map *isl_map_from_pw_aff(
1584 __isl_take isl_pw_aff *pwaff);
1585 __isl_give isl_basic_map *isl_basic_map_from_aff_list(
1586 __isl_take isl_space *domain_space,
1587 __isl_take isl_aff_list *list);
1588 __isl_give isl_basic_map *isl_basic_map_from_multi_aff(
1589 __isl_take isl_multi_aff *maff)
1590 __isl_give isl_map *isl_map_from_multi_aff(
1591 __isl_take isl_multi_aff *maff)
1592 __isl_give isl_set *isl_set_from_pw_multi_aff(
1593 __isl_take isl_pw_multi_aff *pma);
1594 __isl_give isl_map *isl_map_from_pw_multi_aff(
1595 __isl_take isl_pw_multi_aff *pma);
1596 __isl_give isl_union_map *
1597 isl_union_map_from_union_pw_multi_aff(
1598 __isl_take isl_union_pw_multi_aff *upma);
1600 The C<domain_dim> argument describes the domain of the resulting
1601 basic relation. It is required because the C<list> may consist
1602 of zero affine expressions.
1604 =head2 Inspecting Sets and Relations
1606 Usually, the user should not have to care about the actual constraints
1607 of the sets and maps, but should instead apply the abstract operations
1608 explained in the following sections.
1609 Occasionally, however, it may be required to inspect the individual
1610 coefficients of the constraints. This section explains how to do so.
1611 In these cases, it may also be useful to have C<isl> compute
1612 an explicit representation of the existentially quantified variables.
1614 __isl_give isl_set *isl_set_compute_divs(
1615 __isl_take isl_set *set);
1616 __isl_give isl_map *isl_map_compute_divs(
1617 __isl_take isl_map *map);
1618 __isl_give isl_union_set *isl_union_set_compute_divs(
1619 __isl_take isl_union_set *uset);
1620 __isl_give isl_union_map *isl_union_map_compute_divs(
1621 __isl_take isl_union_map *umap);
1623 This explicit representation defines the existentially quantified
1624 variables as integer divisions of the other variables, possibly
1625 including earlier existentially quantified variables.
1626 An explicitly represented existentially quantified variable therefore
1627 has a unique value when the values of the other variables are known.
1628 If, furthermore, the same existentials, i.e., existentials
1629 with the same explicit representations, should appear in the
1630 same order in each of the disjuncts of a set or map, then the user should call
1631 either of the following functions.
1633 __isl_give isl_set *isl_set_align_divs(
1634 __isl_take isl_set *set);
1635 __isl_give isl_map *isl_map_align_divs(
1636 __isl_take isl_map *map);
1638 Alternatively, the existentially quantified variables can be removed
1639 using the following functions, which compute an overapproximation.
1641 __isl_give isl_basic_set *isl_basic_set_remove_divs(
1642 __isl_take isl_basic_set *bset);
1643 __isl_give isl_basic_map *isl_basic_map_remove_divs(
1644 __isl_take isl_basic_map *bmap);
1645 __isl_give isl_set *isl_set_remove_divs(
1646 __isl_take isl_set *set);
1647 __isl_give isl_map *isl_map_remove_divs(
1648 __isl_take isl_map *map);
1650 It is also possible to only remove those divs that are defined
1651 in terms of a given range of dimensions or only those for which
1652 no explicit representation is known.
1654 __isl_give isl_basic_set *
1655 isl_basic_set_remove_divs_involving_dims(
1656 __isl_take isl_basic_set *bset,
1657 enum isl_dim_type type,
1658 unsigned first, unsigned n);
1659 __isl_give isl_basic_map *
1660 isl_basic_map_remove_divs_involving_dims(
1661 __isl_take isl_basic_map *bmap,
1662 enum isl_dim_type type,
1663 unsigned first, unsigned n);
1664 __isl_give isl_set *isl_set_remove_divs_involving_dims(
1665 __isl_take isl_set *set, enum isl_dim_type type,
1666 unsigned first, unsigned n);
1667 __isl_give isl_map *isl_map_remove_divs_involving_dims(
1668 __isl_take isl_map *map, enum isl_dim_type type,
1669 unsigned first, unsigned n);
1671 __isl_give isl_basic_set *
1672 isl_basic_set_remove_unknown_divs(
1673 __isl_take isl_basic_set *bset);
1674 __isl_give isl_set *isl_set_remove_unknown_divs(
1675 __isl_take isl_set *set);
1676 __isl_give isl_map *isl_map_remove_unknown_divs(
1677 __isl_take isl_map *map);
1679 To iterate over all the sets or maps in a union set or map, use
1681 int isl_union_set_foreach_set(__isl_keep isl_union_set *uset,
1682 int (*fn)(__isl_take isl_set *set, void *user),
1684 int isl_union_map_foreach_map(__isl_keep isl_union_map *umap,
1685 int (*fn)(__isl_take isl_map *map, void *user),
1688 The number of sets or maps in a union set or map can be obtained
1691 int isl_union_set_n_set(__isl_keep isl_union_set *uset);
1692 int isl_union_map_n_map(__isl_keep isl_union_map *umap);
1694 To extract the set or map in a given space from a union, use
1696 __isl_give isl_set *isl_union_set_extract_set(
1697 __isl_keep isl_union_set *uset,
1698 __isl_take isl_space *space);
1699 __isl_give isl_map *isl_union_map_extract_map(
1700 __isl_keep isl_union_map *umap,
1701 __isl_take isl_space *space);
1703 To iterate over all the basic sets or maps in a set or map, use
1705 int isl_set_foreach_basic_set(__isl_keep isl_set *set,
1706 int (*fn)(__isl_take isl_basic_set *bset, void *user),
1708 int isl_map_foreach_basic_map(__isl_keep isl_map *map,
1709 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
1712 The callback function C<fn> should return 0 if successful and
1713 -1 if an error occurs. In the latter case, or if any other error
1714 occurs, the above functions will return -1.
1716 It should be noted that C<isl> does not guarantee that
1717 the basic sets or maps passed to C<fn> are disjoint.
1718 If this is required, then the user should call one of
1719 the following functions first.
1721 __isl_give isl_set *isl_set_make_disjoint(
1722 __isl_take isl_set *set);
1723 __isl_give isl_map *isl_map_make_disjoint(
1724 __isl_take isl_map *map);
1726 The number of basic sets in a set can be obtained
1729 int isl_set_n_basic_set(__isl_keep isl_set *set);
1731 To iterate over the constraints of a basic set or map, use
1733 #include <isl/constraint.h>
1735 int isl_basic_set_n_constraint(
1736 __isl_keep isl_basic_set *bset);
1737 int isl_basic_set_foreach_constraint(
1738 __isl_keep isl_basic_set *bset,
1739 int (*fn)(__isl_take isl_constraint *c, void *user),
1741 int isl_basic_map_foreach_constraint(
1742 __isl_keep isl_basic_map *bmap,
1743 int (*fn)(__isl_take isl_constraint *c, void *user),
1745 void *isl_constraint_free(__isl_take isl_constraint *c);
1747 Again, the callback function C<fn> should return 0 if successful and
1748 -1 if an error occurs. In the latter case, or if any other error
1749 occurs, the above functions will return -1.
1750 The constraint C<c> represents either an equality or an inequality.
1751 Use the following function to find out whether a constraint
1752 represents an equality. If not, it represents an inequality.
1754 int isl_constraint_is_equality(
1755 __isl_keep isl_constraint *constraint);
1757 The coefficients of the constraints can be inspected using
1758 the following functions.
1760 int isl_constraint_is_lower_bound(
1761 __isl_keep isl_constraint *constraint,
1762 enum isl_dim_type type, unsigned pos);
1763 int isl_constraint_is_upper_bound(
1764 __isl_keep isl_constraint *constraint,
1765 enum isl_dim_type type, unsigned pos);
1766 void isl_constraint_get_constant(
1767 __isl_keep isl_constraint *constraint, isl_int *v);
1768 void isl_constraint_get_coefficient(
1769 __isl_keep isl_constraint *constraint,
1770 enum isl_dim_type type, int pos, isl_int *v);
1771 int isl_constraint_involves_dims(
1772 __isl_keep isl_constraint *constraint,
1773 enum isl_dim_type type, unsigned first, unsigned n);
1775 The explicit representations of the existentially quantified
1776 variables can be inspected using the following function.
1777 Note that the user is only allowed to use this function
1778 if the inspected set or map is the result of a call
1779 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
1780 The existentially quantified variable is equal to the floor
1781 of the returned affine expression. The affine expression
1782 itself can be inspected using the functions in
1783 L<"Piecewise Quasi Affine Expressions">.
1785 __isl_give isl_aff *isl_constraint_get_div(
1786 __isl_keep isl_constraint *constraint, int pos);
1788 To obtain the constraints of a basic set or map in matrix
1789 form, use the following functions.
1791 __isl_give isl_mat *isl_basic_set_equalities_matrix(
1792 __isl_keep isl_basic_set *bset,
1793 enum isl_dim_type c1, enum isl_dim_type c2,
1794 enum isl_dim_type c3, enum isl_dim_type c4);
1795 __isl_give isl_mat *isl_basic_set_inequalities_matrix(
1796 __isl_keep isl_basic_set *bset,
1797 enum isl_dim_type c1, enum isl_dim_type c2,
1798 enum isl_dim_type c3, enum isl_dim_type c4);
1799 __isl_give isl_mat *isl_basic_map_equalities_matrix(
1800 __isl_keep isl_basic_map *bmap,
1801 enum isl_dim_type c1,
1802 enum isl_dim_type c2, enum isl_dim_type c3,
1803 enum isl_dim_type c4, enum isl_dim_type c5);
1804 __isl_give isl_mat *isl_basic_map_inequalities_matrix(
1805 __isl_keep isl_basic_map *bmap,
1806 enum isl_dim_type c1,
1807 enum isl_dim_type c2, enum isl_dim_type c3,
1808 enum isl_dim_type c4, enum isl_dim_type c5);
1810 The C<isl_dim_type> arguments dictate the order in which
1811 different kinds of variables appear in the resulting matrix
1812 and should be a permutation of C<isl_dim_cst>, C<isl_dim_param>,
1813 C<isl_dim_in>, C<isl_dim_out> and C<isl_dim_div>.
1815 The number of parameters, input, output or set dimensions can
1816 be obtained using the following functions.
1818 unsigned isl_basic_set_dim(__isl_keep isl_basic_set *bset,
1819 enum isl_dim_type type);
1820 unsigned isl_basic_map_dim(__isl_keep isl_basic_map *bmap,
1821 enum isl_dim_type type);
1822 unsigned isl_set_dim(__isl_keep isl_set *set,
1823 enum isl_dim_type type);
1824 unsigned isl_map_dim(__isl_keep isl_map *map,
1825 enum isl_dim_type type);
1827 To check whether the description of a set or relation depends
1828 on one or more given dimensions, it is not necessary to iterate over all
1829 constraints. Instead the following functions can be used.
1831 int isl_basic_set_involves_dims(
1832 __isl_keep isl_basic_set *bset,
1833 enum isl_dim_type type, unsigned first, unsigned n);
1834 int isl_set_involves_dims(__isl_keep isl_set *set,
1835 enum isl_dim_type type, unsigned first, unsigned n);
1836 int isl_basic_map_involves_dims(
1837 __isl_keep isl_basic_map *bmap,
1838 enum isl_dim_type type, unsigned first, unsigned n);
1839 int isl_map_involves_dims(__isl_keep isl_map *map,
1840 enum isl_dim_type type, unsigned first, unsigned n);
1842 Similarly, the following functions can be used to check whether
1843 a given dimension is involved in any lower or upper bound.
1845 int isl_set_dim_has_any_lower_bound(__isl_keep isl_set *set,
1846 enum isl_dim_type type, unsigned pos);
1847 int isl_set_dim_has_any_upper_bound(__isl_keep isl_set *set,
1848 enum isl_dim_type type, unsigned pos);
1850 Note that these functions return true even if there is a bound on
1851 the dimension on only some of the basic sets of C<set>.
1852 To check if they have a bound for all of the basic sets in C<set>,
1853 use the following functions instead.
1855 int isl_set_dim_has_lower_bound(__isl_keep isl_set *set,
1856 enum isl_dim_type type, unsigned pos);
1857 int isl_set_dim_has_upper_bound(__isl_keep isl_set *set,
1858 enum isl_dim_type type, unsigned pos);
1860 The identifiers or names of the domain and range spaces of a set
1861 or relation can be read off or set using the following functions.
1863 __isl_give isl_set *isl_set_set_tuple_id(
1864 __isl_take isl_set *set, __isl_take isl_id *id);
1865 __isl_give isl_set *isl_set_reset_tuple_id(
1866 __isl_take isl_set *set);
1867 int isl_set_has_tuple_id(__isl_keep isl_set *set);
1868 __isl_give isl_id *isl_set_get_tuple_id(
1869 __isl_keep isl_set *set);
1870 __isl_give isl_map *isl_map_set_tuple_id(
1871 __isl_take isl_map *map, enum isl_dim_type type,
1872 __isl_take isl_id *id);
1873 __isl_give isl_map *isl_map_reset_tuple_id(
1874 __isl_take isl_map *map, enum isl_dim_type type);
1875 int isl_map_has_tuple_id(__isl_keep isl_map *map,
1876 enum isl_dim_type type);
1877 __isl_give isl_id *isl_map_get_tuple_id(
1878 __isl_keep isl_map *map, enum isl_dim_type type);
1880 const char *isl_basic_set_get_tuple_name(
1881 __isl_keep isl_basic_set *bset);
1882 __isl_give isl_basic_set *isl_basic_set_set_tuple_name(
1883 __isl_take isl_basic_set *set, const char *s);
1884 int isl_set_has_tuple_name(__isl_keep isl_set *set);
1885 const char *isl_set_get_tuple_name(
1886 __isl_keep isl_set *set);
1887 const char *isl_basic_map_get_tuple_name(
1888 __isl_keep isl_basic_map *bmap,
1889 enum isl_dim_type type);
1890 __isl_give isl_basic_map *isl_basic_map_set_tuple_name(
1891 __isl_take isl_basic_map *bmap,
1892 enum isl_dim_type type, const char *s);
1893 int isl_map_has_tuple_name(__isl_keep isl_map *map,
1894 enum isl_dim_type type);
1895 const char *isl_map_get_tuple_name(
1896 __isl_keep isl_map *map,
1897 enum isl_dim_type type);
1899 As with C<isl_space_get_tuple_name>, the value returned points to
1900 an internal data structure.
1901 The identifiers, positions or names of individual dimensions can be
1902 read off using the following functions.
1904 __isl_give isl_id *isl_basic_set_get_dim_id(
1905 __isl_keep isl_basic_set *bset,
1906 enum isl_dim_type type, unsigned pos);
1907 __isl_give isl_set *isl_set_set_dim_id(
1908 __isl_take isl_set *set, enum isl_dim_type type,
1909 unsigned pos, __isl_take isl_id *id);
1910 int isl_set_has_dim_id(__isl_keep isl_set *set,
1911 enum isl_dim_type type, unsigned pos);
1912 __isl_give isl_id *isl_set_get_dim_id(
1913 __isl_keep isl_set *set, enum isl_dim_type type,
1915 int isl_basic_map_has_dim_id(
1916 __isl_keep isl_basic_map *bmap,
1917 enum isl_dim_type type, unsigned pos);
1918 __isl_give isl_map *isl_map_set_dim_id(
1919 __isl_take isl_map *map, enum isl_dim_type type,
1920 unsigned pos, __isl_take isl_id *id);
1921 int isl_map_has_dim_id(__isl_keep isl_map *map,
1922 enum isl_dim_type type, unsigned pos);
1923 __isl_give isl_id *isl_map_get_dim_id(
1924 __isl_keep isl_map *map, enum isl_dim_type type,
1927 int isl_set_find_dim_by_id(__isl_keep isl_set *set,
1928 enum isl_dim_type type, __isl_keep isl_id *id);
1929 int isl_map_find_dim_by_id(__isl_keep isl_map *map,
1930 enum isl_dim_type type, __isl_keep isl_id *id);
1931 int isl_set_find_dim_by_name(__isl_keep isl_set *set,
1932 enum isl_dim_type type, const char *name);
1933 int isl_map_find_dim_by_name(__isl_keep isl_map *map,
1934 enum isl_dim_type type, const char *name);
1936 const char *isl_constraint_get_dim_name(
1937 __isl_keep isl_constraint *constraint,
1938 enum isl_dim_type type, unsigned pos);
1939 const char *isl_basic_set_get_dim_name(
1940 __isl_keep isl_basic_set *bset,
1941 enum isl_dim_type type, unsigned pos);
1942 int isl_set_has_dim_name(__isl_keep isl_set *set,
1943 enum isl_dim_type type, unsigned pos);
1944 const char *isl_set_get_dim_name(
1945 __isl_keep isl_set *set,
1946 enum isl_dim_type type, unsigned pos);
1947 const char *isl_basic_map_get_dim_name(
1948 __isl_keep isl_basic_map *bmap,
1949 enum isl_dim_type type, unsigned pos);
1950 int isl_map_has_dim_name(__isl_keep isl_map *map,
1951 enum isl_dim_type type, unsigned pos);
1952 const char *isl_map_get_dim_name(
1953 __isl_keep isl_map *map,
1954 enum isl_dim_type type, unsigned pos);
1956 These functions are mostly useful to obtain the identifiers, positions
1957 or names of the parameters. Identifiers of individual dimensions are
1958 essentially only useful for printing. They are ignored by all other
1959 operations and may not be preserved across those operations.
1963 =head3 Unary Properties
1969 The following functions test whether the given set or relation
1970 contains any integer points. The ``plain'' variants do not perform
1971 any computations, but simply check if the given set or relation
1972 is already known to be empty.
1974 int isl_basic_set_plain_is_empty(__isl_keep isl_basic_set *bset);
1975 int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
1976 int isl_set_plain_is_empty(__isl_keep isl_set *set);
1977 int isl_set_is_empty(__isl_keep isl_set *set);
1978 int isl_union_set_is_empty(__isl_keep isl_union_set *uset);
1979 int isl_basic_map_plain_is_empty(__isl_keep isl_basic_map *bmap);
1980 int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
1981 int isl_map_plain_is_empty(__isl_keep isl_map *map);
1982 int isl_map_is_empty(__isl_keep isl_map *map);
1983 int isl_union_map_is_empty(__isl_keep isl_union_map *umap);
1985 =item * Universality
1987 int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
1988 int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
1989 int isl_set_plain_is_universe(__isl_keep isl_set *set);
1991 =item * Single-valuedness
1993 int isl_basic_map_is_single_valued(
1994 __isl_keep isl_basic_map *bmap);
1995 int isl_map_plain_is_single_valued(
1996 __isl_keep isl_map *map);
1997 int isl_map_is_single_valued(__isl_keep isl_map *map);
1998 int isl_union_map_is_single_valued(__isl_keep isl_union_map *umap);
2002 int isl_map_plain_is_injective(__isl_keep isl_map *map);
2003 int isl_map_is_injective(__isl_keep isl_map *map);
2004 int isl_union_map_plain_is_injective(
2005 __isl_keep isl_union_map *umap);
2006 int isl_union_map_is_injective(
2007 __isl_keep isl_union_map *umap);
2011 int isl_map_is_bijective(__isl_keep isl_map *map);
2012 int isl_union_map_is_bijective(__isl_keep isl_union_map *umap);
2016 int isl_basic_map_plain_is_fixed(
2017 __isl_keep isl_basic_map *bmap,
2018 enum isl_dim_type type, unsigned pos,
2020 int isl_set_plain_is_fixed(__isl_keep isl_set *set,
2021 enum isl_dim_type type, unsigned pos,
2023 int isl_map_plain_is_fixed(__isl_keep isl_map *map,
2024 enum isl_dim_type type, unsigned pos,
2027 Check if the relation obviously lies on a hyperplane where the given dimension
2028 has a fixed value and if so, return that value in C<*val>.
2032 To check whether a set is a parameter domain, use this function:
2034 int isl_set_is_params(__isl_keep isl_set *set);
2035 int isl_union_set_is_params(
2036 __isl_keep isl_union_set *uset);
2040 The following functions check whether the domain of the given
2041 (basic) set is a wrapped relation.
2043 int isl_basic_set_is_wrapping(
2044 __isl_keep isl_basic_set *bset);
2045 int isl_set_is_wrapping(__isl_keep isl_set *set);
2047 =item * Internal Product
2049 int isl_basic_map_can_zip(
2050 __isl_keep isl_basic_map *bmap);
2051 int isl_map_can_zip(__isl_keep isl_map *map);
2053 Check whether the product of domain and range of the given relation
2055 i.e., whether both domain and range are nested relations.
2059 int isl_basic_map_can_curry(
2060 __isl_keep isl_basic_map *bmap);
2061 int isl_map_can_curry(__isl_keep isl_map *map);
2063 Check whether the domain of the (basic) relation is a wrapped relation.
2065 int isl_basic_map_can_uncurry(
2066 __isl_keep isl_basic_map *bmap);
2067 int isl_map_can_uncurry(__isl_keep isl_map *map);
2069 Check whether the range of the (basic) relation is a wrapped relation.
2073 =head3 Binary Properties
2079 int isl_set_plain_is_equal(__isl_keep isl_set *set1,
2080 __isl_keep isl_set *set2);
2081 int isl_set_is_equal(__isl_keep isl_set *set1,
2082 __isl_keep isl_set *set2);
2083 int isl_union_set_is_equal(
2084 __isl_keep isl_union_set *uset1,
2085 __isl_keep isl_union_set *uset2);
2086 int isl_basic_map_is_equal(
2087 __isl_keep isl_basic_map *bmap1,
2088 __isl_keep isl_basic_map *bmap2);
2089 int isl_map_is_equal(__isl_keep isl_map *map1,
2090 __isl_keep isl_map *map2);
2091 int isl_map_plain_is_equal(__isl_keep isl_map *map1,
2092 __isl_keep isl_map *map2);
2093 int isl_union_map_is_equal(
2094 __isl_keep isl_union_map *umap1,
2095 __isl_keep isl_union_map *umap2);
2097 =item * Disjointness
2099 int isl_set_plain_is_disjoint(__isl_keep isl_set *set1,
2100 __isl_keep isl_set *set2);
2101 int isl_set_is_disjoint(__isl_keep isl_set *set1,
2102 __isl_keep isl_set *set2);
2103 int isl_map_is_disjoint(__isl_keep isl_map *map1,
2104 __isl_keep isl_map *map2);
2108 int isl_basic_set_is_subset(
2109 __isl_keep isl_basic_set *bset1,
2110 __isl_keep isl_basic_set *bset2);
2111 int isl_set_is_subset(__isl_keep isl_set *set1,
2112 __isl_keep isl_set *set2);
2113 int isl_set_is_strict_subset(
2114 __isl_keep isl_set *set1,
2115 __isl_keep isl_set *set2);
2116 int isl_union_set_is_subset(
2117 __isl_keep isl_union_set *uset1,
2118 __isl_keep isl_union_set *uset2);
2119 int isl_union_set_is_strict_subset(
2120 __isl_keep isl_union_set *uset1,
2121 __isl_keep isl_union_set *uset2);
2122 int isl_basic_map_is_subset(
2123 __isl_keep isl_basic_map *bmap1,
2124 __isl_keep isl_basic_map *bmap2);
2125 int isl_basic_map_is_strict_subset(
2126 __isl_keep isl_basic_map *bmap1,
2127 __isl_keep isl_basic_map *bmap2);
2128 int isl_map_is_subset(
2129 __isl_keep isl_map *map1,
2130 __isl_keep isl_map *map2);
2131 int isl_map_is_strict_subset(
2132 __isl_keep isl_map *map1,
2133 __isl_keep isl_map *map2);
2134 int isl_union_map_is_subset(
2135 __isl_keep isl_union_map *umap1,
2136 __isl_keep isl_union_map *umap2);
2137 int isl_union_map_is_strict_subset(
2138 __isl_keep isl_union_map *umap1,
2139 __isl_keep isl_union_map *umap2);
2141 Check whether the first argument is a (strict) subset of the
2146 int isl_set_plain_cmp(__isl_keep isl_set *set1,
2147 __isl_keep isl_set *set2);
2149 This function is useful for sorting C<isl_set>s.
2150 The order depends on the internal representation of the inputs.
2151 The order is fixed over different calls to the function (assuming
2152 the internal representation of the inputs has not changed), but may
2153 change over different versions of C<isl>.
2157 =head2 Unary Operations
2163 __isl_give isl_set *isl_set_complement(
2164 __isl_take isl_set *set);
2165 __isl_give isl_map *isl_map_complement(
2166 __isl_take isl_map *map);
2170 __isl_give isl_basic_map *isl_basic_map_reverse(
2171 __isl_take isl_basic_map *bmap);
2172 __isl_give isl_map *isl_map_reverse(
2173 __isl_take isl_map *map);
2174 __isl_give isl_union_map *isl_union_map_reverse(
2175 __isl_take isl_union_map *umap);
2179 __isl_give isl_basic_set *isl_basic_set_project_out(
2180 __isl_take isl_basic_set *bset,
2181 enum isl_dim_type type, unsigned first, unsigned n);
2182 __isl_give isl_basic_map *isl_basic_map_project_out(
2183 __isl_take isl_basic_map *bmap,
2184 enum isl_dim_type type, unsigned first, unsigned n);
2185 __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
2186 enum isl_dim_type type, unsigned first, unsigned n);
2187 __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
2188 enum isl_dim_type type, unsigned first, unsigned n);
2189 __isl_give isl_basic_set *isl_basic_set_params(
2190 __isl_take isl_basic_set *bset);
2191 __isl_give isl_basic_set *isl_basic_map_domain(
2192 __isl_take isl_basic_map *bmap);
2193 __isl_give isl_basic_set *isl_basic_map_range(
2194 __isl_take isl_basic_map *bmap);
2195 __isl_give isl_set *isl_set_params(__isl_take isl_set *set);
2196 __isl_give isl_set *isl_map_params(__isl_take isl_map *map);
2197 __isl_give isl_set *isl_map_domain(
2198 __isl_take isl_map *bmap);
2199 __isl_give isl_set *isl_map_range(
2200 __isl_take isl_map *map);
2201 __isl_give isl_set *isl_union_set_params(
2202 __isl_take isl_union_set *uset);
2203 __isl_give isl_set *isl_union_map_params(
2204 __isl_take isl_union_map *umap);
2205 __isl_give isl_union_set *isl_union_map_domain(
2206 __isl_take isl_union_map *umap);
2207 __isl_give isl_union_set *isl_union_map_range(
2208 __isl_take isl_union_map *umap);
2210 __isl_give isl_basic_map *isl_basic_map_domain_map(
2211 __isl_take isl_basic_map *bmap);
2212 __isl_give isl_basic_map *isl_basic_map_range_map(
2213 __isl_take isl_basic_map *bmap);
2214 __isl_give isl_map *isl_map_domain_map(__isl_take isl_map *map);
2215 __isl_give isl_map *isl_map_range_map(__isl_take isl_map *map);
2216 __isl_give isl_union_map *isl_union_map_domain_map(
2217 __isl_take isl_union_map *umap);
2218 __isl_give isl_union_map *isl_union_map_range_map(
2219 __isl_take isl_union_map *umap);
2221 The functions above construct a (basic, regular or union) relation
2222 that maps (a wrapped version of) the input relation to its domain or range.
2226 __isl_give isl_basic_set *isl_basic_set_eliminate(
2227 __isl_take isl_basic_set *bset,
2228 enum isl_dim_type type,
2229 unsigned first, unsigned n);
2230 __isl_give isl_set *isl_set_eliminate(
2231 __isl_take isl_set *set, enum isl_dim_type type,
2232 unsigned first, unsigned n);
2233 __isl_give isl_basic_map *isl_basic_map_eliminate(
2234 __isl_take isl_basic_map *bmap,
2235 enum isl_dim_type type,
2236 unsigned first, unsigned n);
2237 __isl_give isl_map *isl_map_eliminate(
2238 __isl_take isl_map *map, enum isl_dim_type type,
2239 unsigned first, unsigned n);
2241 Eliminate the coefficients for the given dimensions from the constraints,
2242 without removing the dimensions.
2246 __isl_give isl_basic_set *isl_basic_set_fix(
2247 __isl_take isl_basic_set *bset,
2248 enum isl_dim_type type, unsigned pos,
2250 __isl_give isl_basic_set *isl_basic_set_fix_si(
2251 __isl_take isl_basic_set *bset,
2252 enum isl_dim_type type, unsigned pos, int value);
2253 __isl_give isl_set *isl_set_fix(__isl_take isl_set *set,
2254 enum isl_dim_type type, unsigned pos,
2256 __isl_give isl_set *isl_set_fix_si(__isl_take isl_set *set,
2257 enum isl_dim_type type, unsigned pos, int value);
2258 __isl_give isl_basic_map *isl_basic_map_fix_si(
2259 __isl_take isl_basic_map *bmap,
2260 enum isl_dim_type type, unsigned pos, int value);
2261 __isl_give isl_map *isl_map_fix(__isl_take isl_map *map,
2262 enum isl_dim_type type, unsigned pos,
2264 __isl_give isl_map *isl_map_fix_si(__isl_take isl_map *map,
2265 enum isl_dim_type type, unsigned pos, int value);
2267 Intersect the set or relation with the hyperplane where the given
2268 dimension has the fixed given value.
2270 __isl_give isl_basic_map *isl_basic_map_lower_bound_si(
2271 __isl_take isl_basic_map *bmap,
2272 enum isl_dim_type type, unsigned pos, int value);
2273 __isl_give isl_basic_map *isl_basic_map_upper_bound_si(
2274 __isl_take isl_basic_map *bmap,
2275 enum isl_dim_type type, unsigned pos, int value);
2276 __isl_give isl_set *isl_set_lower_bound(
2277 __isl_take isl_set *set,
2278 enum isl_dim_type type, unsigned pos,
2280 __isl_give isl_set *isl_set_lower_bound_si(
2281 __isl_take isl_set *set,
2282 enum isl_dim_type type, unsigned pos, int value);
2283 __isl_give isl_map *isl_map_lower_bound_si(
2284 __isl_take isl_map *map,
2285 enum isl_dim_type type, unsigned pos, int value);
2286 __isl_give isl_set *isl_set_upper_bound(
2287 __isl_take isl_set *set,
2288 enum isl_dim_type type, unsigned pos,
2290 __isl_give isl_set *isl_set_upper_bound_si(
2291 __isl_take isl_set *set,
2292 enum isl_dim_type type, unsigned pos, int value);
2293 __isl_give isl_map *isl_map_upper_bound_si(
2294 __isl_take isl_map *map,
2295 enum isl_dim_type type, unsigned pos, int value);
2297 Intersect the set or relation with the half-space where the given
2298 dimension has a value bounded by the fixed given value.
2300 __isl_give isl_set *isl_set_equate(__isl_take isl_set *set,
2301 enum isl_dim_type type1, int pos1,
2302 enum isl_dim_type type2, int pos2);
2303 __isl_give isl_basic_map *isl_basic_map_equate(
2304 __isl_take isl_basic_map *bmap,
2305 enum isl_dim_type type1, int pos1,
2306 enum isl_dim_type type2, int pos2);
2307 __isl_give isl_map *isl_map_equate(__isl_take isl_map *map,
2308 enum isl_dim_type type1, int pos1,
2309 enum isl_dim_type type2, int pos2);
2311 Intersect the set or relation with the hyperplane where the given
2312 dimensions are equal to each other.
2314 __isl_give isl_map *isl_map_oppose(__isl_take isl_map *map,
2315 enum isl_dim_type type1, int pos1,
2316 enum isl_dim_type type2, int pos2);
2318 Intersect the relation with the hyperplane where the given
2319 dimensions have opposite values.
2321 __isl_give isl_basic_map *isl_basic_map_order_ge(
2322 __isl_take isl_basic_map *bmap,
2323 enum isl_dim_type type1, int pos1,
2324 enum isl_dim_type type2, int pos2);
2325 __isl_give isl_map *isl_map_order_lt(__isl_take isl_map *map,
2326 enum isl_dim_type type1, int pos1,
2327 enum isl_dim_type type2, int pos2);
2328 __isl_give isl_basic_map *isl_basic_map_order_gt(
2329 __isl_take isl_basic_map *bmap,
2330 enum isl_dim_type type1, int pos1,
2331 enum isl_dim_type type2, int pos2);
2332 __isl_give isl_map *isl_map_order_gt(__isl_take isl_map *map,
2333 enum isl_dim_type type1, int pos1,
2334 enum isl_dim_type type2, int pos2);
2336 Intersect the relation with the half-space where the given
2337 dimensions satisfy the given ordering.
2341 __isl_give isl_map *isl_set_identity(
2342 __isl_take isl_set *set);
2343 __isl_give isl_union_map *isl_union_set_identity(
2344 __isl_take isl_union_set *uset);
2346 Construct an identity relation on the given (union) set.
2350 __isl_give isl_basic_set *isl_basic_map_deltas(
2351 __isl_take isl_basic_map *bmap);
2352 __isl_give isl_set *isl_map_deltas(__isl_take isl_map *map);
2353 __isl_give isl_union_set *isl_union_map_deltas(
2354 __isl_take isl_union_map *umap);
2356 These functions return a (basic) set containing the differences
2357 between image elements and corresponding domain elements in the input.
2359 __isl_give isl_basic_map *isl_basic_map_deltas_map(
2360 __isl_take isl_basic_map *bmap);
2361 __isl_give isl_map *isl_map_deltas_map(
2362 __isl_take isl_map *map);
2363 __isl_give isl_union_map *isl_union_map_deltas_map(
2364 __isl_take isl_union_map *umap);
2366 The functions above construct a (basic, regular or union) relation
2367 that maps (a wrapped version of) the input relation to its delta set.
2371 Simplify the representation of a set or relation by trying
2372 to combine pairs of basic sets or relations into a single
2373 basic set or relation.
2375 __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
2376 __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
2377 __isl_give isl_union_set *isl_union_set_coalesce(
2378 __isl_take isl_union_set *uset);
2379 __isl_give isl_union_map *isl_union_map_coalesce(
2380 __isl_take isl_union_map *umap);
2382 One of the methods for combining pairs of basic sets or relations
2383 can result in coefficients that are much larger than those that appear
2384 in the constraints of the input. By default, the coefficients are
2385 not allowed to grow larger, but this can be changed by unsetting
2386 the following option.
2388 int isl_options_set_coalesce_bounded_wrapping(
2389 isl_ctx *ctx, int val);
2390 int isl_options_get_coalesce_bounded_wrapping(
2393 =item * Detecting equalities
2395 __isl_give isl_basic_set *isl_basic_set_detect_equalities(
2396 __isl_take isl_basic_set *bset);
2397 __isl_give isl_basic_map *isl_basic_map_detect_equalities(
2398 __isl_take isl_basic_map *bmap);
2399 __isl_give isl_set *isl_set_detect_equalities(
2400 __isl_take isl_set *set);
2401 __isl_give isl_map *isl_map_detect_equalities(
2402 __isl_take isl_map *map);
2403 __isl_give isl_union_set *isl_union_set_detect_equalities(
2404 __isl_take isl_union_set *uset);
2405 __isl_give isl_union_map *isl_union_map_detect_equalities(
2406 __isl_take isl_union_map *umap);
2408 Simplify the representation of a set or relation by detecting implicit
2411 =item * Removing redundant constraints
2413 __isl_give isl_basic_set *isl_basic_set_remove_redundancies(
2414 __isl_take isl_basic_set *bset);
2415 __isl_give isl_set *isl_set_remove_redundancies(
2416 __isl_take isl_set *set);
2417 __isl_give isl_basic_map *isl_basic_map_remove_redundancies(
2418 __isl_take isl_basic_map *bmap);
2419 __isl_give isl_map *isl_map_remove_redundancies(
2420 __isl_take isl_map *map);
2424 __isl_give isl_basic_set *isl_set_convex_hull(
2425 __isl_take isl_set *set);
2426 __isl_give isl_basic_map *isl_map_convex_hull(
2427 __isl_take isl_map *map);
2429 If the input set or relation has any existentially quantified
2430 variables, then the result of these operations is currently undefined.
2434 __isl_give isl_basic_set *
2435 isl_set_unshifted_simple_hull(
2436 __isl_take isl_set *set);
2437 __isl_give isl_basic_map *
2438 isl_map_unshifted_simple_hull(
2439 __isl_take isl_map *map);
2440 __isl_give isl_basic_set *isl_set_simple_hull(
2441 __isl_take isl_set *set);
2442 __isl_give isl_basic_map *isl_map_simple_hull(
2443 __isl_take isl_map *map);
2444 __isl_give isl_union_map *isl_union_map_simple_hull(
2445 __isl_take isl_union_map *umap);
2447 These functions compute a single basic set or relation
2448 that contains the whole input set or relation.
2449 In particular, the output is described by translates
2450 of the constraints describing the basic sets or relations in the input.
2451 In case of C<isl_set_unshifted_simple_hull>, only the original
2452 constraints are used, without any translation.
2456 (See \autoref{s:simple hull}.)
2462 __isl_give isl_basic_set *isl_basic_set_affine_hull(
2463 __isl_take isl_basic_set *bset);
2464 __isl_give isl_basic_set *isl_set_affine_hull(
2465 __isl_take isl_set *set);
2466 __isl_give isl_union_set *isl_union_set_affine_hull(
2467 __isl_take isl_union_set *uset);
2468 __isl_give isl_basic_map *isl_basic_map_affine_hull(
2469 __isl_take isl_basic_map *bmap);
2470 __isl_give isl_basic_map *isl_map_affine_hull(
2471 __isl_take isl_map *map);
2472 __isl_give isl_union_map *isl_union_map_affine_hull(
2473 __isl_take isl_union_map *umap);
2475 In case of union sets and relations, the affine hull is computed
2478 =item * Polyhedral hull
2480 __isl_give isl_basic_set *isl_set_polyhedral_hull(
2481 __isl_take isl_set *set);
2482 __isl_give isl_basic_map *isl_map_polyhedral_hull(
2483 __isl_take isl_map *map);
2484 __isl_give isl_union_set *isl_union_set_polyhedral_hull(
2485 __isl_take isl_union_set *uset);
2486 __isl_give isl_union_map *isl_union_map_polyhedral_hull(
2487 __isl_take isl_union_map *umap);
2489 These functions compute a single basic set or relation
2490 not involving any existentially quantified variables
2491 that contains the whole input set or relation.
2492 In case of union sets and relations, the polyhedral hull is computed
2495 =item * Other approximations
2497 __isl_give isl_basic_set *
2498 isl_basic_set_drop_constraints_involving_dims(
2499 __isl_take isl_basic_set *bset,
2500 enum isl_dim_type type,
2501 unsigned first, unsigned n);
2502 __isl_give isl_basic_map *
2503 isl_basic_map_drop_constraints_involving_dims(
2504 __isl_take isl_basic_map *bmap,
2505 enum isl_dim_type type,
2506 unsigned first, unsigned n);
2507 __isl_give isl_basic_set *
2508 isl_basic_set_drop_constraints_not_involving_dims(
2509 __isl_take isl_basic_set *bset,
2510 enum isl_dim_type type,
2511 unsigned first, unsigned n);
2512 __isl_give isl_set *
2513 isl_set_drop_constraints_involving_dims(
2514 __isl_take isl_set *set,
2515 enum isl_dim_type type,
2516 unsigned first, unsigned n);
2517 __isl_give isl_map *
2518 isl_map_drop_constraints_involving_dims(
2519 __isl_take isl_map *map,
2520 enum isl_dim_type type,
2521 unsigned first, unsigned n);
2523 These functions drop any constraints (not) involving the specified dimensions.
2524 Note that the result depends on the representation of the input.
2528 __isl_give isl_basic_set *isl_basic_set_sample(
2529 __isl_take isl_basic_set *bset);
2530 __isl_give isl_basic_set *isl_set_sample(
2531 __isl_take isl_set *set);
2532 __isl_give isl_basic_map *isl_basic_map_sample(
2533 __isl_take isl_basic_map *bmap);
2534 __isl_give isl_basic_map *isl_map_sample(
2535 __isl_take isl_map *map);
2537 If the input (basic) set or relation is non-empty, then return
2538 a singleton subset of the input. Otherwise, return an empty set.
2540 =item * Optimization
2542 #include <isl/ilp.h>
2543 enum isl_lp_result isl_basic_set_max(
2544 __isl_keep isl_basic_set *bset,
2545 __isl_keep isl_aff *obj, isl_int *opt)
2546 enum isl_lp_result isl_set_min(__isl_keep isl_set *set,
2547 __isl_keep isl_aff *obj, isl_int *opt);
2548 enum isl_lp_result isl_set_max(__isl_keep isl_set *set,
2549 __isl_keep isl_aff *obj, isl_int *opt);
2551 Compute the minimum or maximum of the integer affine expression C<obj>
2552 over the points in C<set>, returning the result in C<opt>.
2553 The return value may be one of C<isl_lp_error>,
2554 C<isl_lp_ok>, C<isl_lp_unbounded> or C<isl_lp_empty>.
2556 =item * Parametric optimization
2558 __isl_give isl_pw_aff *isl_set_dim_min(
2559 __isl_take isl_set *set, int pos);
2560 __isl_give isl_pw_aff *isl_set_dim_max(
2561 __isl_take isl_set *set, int pos);
2562 __isl_give isl_pw_aff *isl_map_dim_max(
2563 __isl_take isl_map *map, int pos);
2565 Compute the minimum or maximum of the given set or output dimension
2566 as a function of the parameters (and input dimensions), but independently
2567 of the other set or output dimensions.
2568 For lexicographic optimization, see L<"Lexicographic Optimization">.
2572 The following functions compute either the set of (rational) coefficient
2573 values of valid constraints for the given set or the set of (rational)
2574 values satisfying the constraints with coefficients from the given set.
2575 Internally, these two sets of functions perform essentially the
2576 same operations, except that the set of coefficients is assumed to
2577 be a cone, while the set of values may be any polyhedron.
2578 The current implementation is based on the Farkas lemma and
2579 Fourier-Motzkin elimination, but this may change or be made optional
2580 in future. In particular, future implementations may use different
2581 dualization algorithms or skip the elimination step.
2583 __isl_give isl_basic_set *isl_basic_set_coefficients(
2584 __isl_take isl_basic_set *bset);
2585 __isl_give isl_basic_set *isl_set_coefficients(
2586 __isl_take isl_set *set);
2587 __isl_give isl_union_set *isl_union_set_coefficients(
2588 __isl_take isl_union_set *bset);
2589 __isl_give isl_basic_set *isl_basic_set_solutions(
2590 __isl_take isl_basic_set *bset);
2591 __isl_give isl_basic_set *isl_set_solutions(
2592 __isl_take isl_set *set);
2593 __isl_give isl_union_set *isl_union_set_solutions(
2594 __isl_take isl_union_set *bset);
2598 __isl_give isl_map *isl_map_fixed_power(
2599 __isl_take isl_map *map, isl_int exp);
2600 __isl_give isl_union_map *isl_union_map_fixed_power(
2601 __isl_take isl_union_map *umap, isl_int exp);
2603 Compute the given power of C<map>, where C<exp> is assumed to be non-zero.
2604 If the exponent C<exp> is negative, then the -C<exp> th power of the inverse
2605 of C<map> is computed.
2607 __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
2609 __isl_give isl_union_map *isl_union_map_power(
2610 __isl_take isl_union_map *umap, int *exact);
2612 Compute a parametric representation for all positive powers I<k> of C<map>.
2613 The result maps I<k> to a nested relation corresponding to the
2614 I<k>th power of C<map>.
2615 The result may be an overapproximation. If the result is known to be exact,
2616 then C<*exact> is set to C<1>.
2618 =item * Transitive closure
2620 __isl_give isl_map *isl_map_transitive_closure(
2621 __isl_take isl_map *map, int *exact);
2622 __isl_give isl_union_map *isl_union_map_transitive_closure(
2623 __isl_take isl_union_map *umap, int *exact);
2625 Compute the transitive closure of C<map>.
2626 The result may be an overapproximation. If the result is known to be exact,
2627 then C<*exact> is set to C<1>.
2629 =item * Reaching path lengths
2631 __isl_give isl_map *isl_map_reaching_path_lengths(
2632 __isl_take isl_map *map, int *exact);
2634 Compute a relation that maps each element in the range of C<map>
2635 to the lengths of all paths composed of edges in C<map> that
2636 end up in the given element.
2637 The result may be an overapproximation. If the result is known to be exact,
2638 then C<*exact> is set to C<1>.
2639 To compute the I<maximal> path length, the resulting relation
2640 should be postprocessed by C<isl_map_lexmax>.
2641 In particular, if the input relation is a dependence relation
2642 (mapping sources to sinks), then the maximal path length corresponds
2643 to the free schedule.
2644 Note, however, that C<isl_map_lexmax> expects the maximum to be
2645 finite, so if the path lengths are unbounded (possibly due to
2646 the overapproximation), then you will get an error message.
2650 __isl_give isl_basic_set *isl_basic_map_wrap(
2651 __isl_take isl_basic_map *bmap);
2652 __isl_give isl_set *isl_map_wrap(
2653 __isl_take isl_map *map);
2654 __isl_give isl_union_set *isl_union_map_wrap(
2655 __isl_take isl_union_map *umap);
2656 __isl_give isl_basic_map *isl_basic_set_unwrap(
2657 __isl_take isl_basic_set *bset);
2658 __isl_give isl_map *isl_set_unwrap(
2659 __isl_take isl_set *set);
2660 __isl_give isl_union_map *isl_union_set_unwrap(
2661 __isl_take isl_union_set *uset);
2665 Remove any internal structure of domain (and range) of the given
2666 set or relation. If there is any such internal structure in the input,
2667 then the name of the space is also removed.
2669 __isl_give isl_basic_set *isl_basic_set_flatten(
2670 __isl_take isl_basic_set *bset);
2671 __isl_give isl_set *isl_set_flatten(
2672 __isl_take isl_set *set);
2673 __isl_give isl_basic_map *isl_basic_map_flatten_domain(
2674 __isl_take isl_basic_map *bmap);
2675 __isl_give isl_basic_map *isl_basic_map_flatten_range(
2676 __isl_take isl_basic_map *bmap);
2677 __isl_give isl_map *isl_map_flatten_range(
2678 __isl_take isl_map *map);
2679 __isl_give isl_map *isl_map_flatten_domain(
2680 __isl_take isl_map *map);
2681 __isl_give isl_basic_map *isl_basic_map_flatten(
2682 __isl_take isl_basic_map *bmap);
2683 __isl_give isl_map *isl_map_flatten(
2684 __isl_take isl_map *map);
2686 __isl_give isl_map *isl_set_flatten_map(
2687 __isl_take isl_set *set);
2689 The function above constructs a relation
2690 that maps the input set to a flattened version of the set.
2694 Lift the input set to a space with extra dimensions corresponding
2695 to the existentially quantified variables in the input.
2696 In particular, the result lives in a wrapped map where the domain
2697 is the original space and the range corresponds to the original
2698 existentially quantified variables.
2700 __isl_give isl_basic_set *isl_basic_set_lift(
2701 __isl_take isl_basic_set *bset);
2702 __isl_give isl_set *isl_set_lift(
2703 __isl_take isl_set *set);
2704 __isl_give isl_union_set *isl_union_set_lift(
2705 __isl_take isl_union_set *uset);
2707 Given a local space that contains the existentially quantified
2708 variables of a set, a basic relation that, when applied to
2709 a basic set, has essentially the same effect as C<isl_basic_set_lift>,
2710 can be constructed using the following function.
2712 #include <isl/local_space.h>
2713 __isl_give isl_basic_map *isl_local_space_lifting(
2714 __isl_take isl_local_space *ls);
2716 =item * Internal Product
2718 __isl_give isl_basic_map *isl_basic_map_zip(
2719 __isl_take isl_basic_map *bmap);
2720 __isl_give isl_map *isl_map_zip(
2721 __isl_take isl_map *map);
2722 __isl_give isl_union_map *isl_union_map_zip(
2723 __isl_take isl_union_map *umap);
2725 Given a relation with nested relations for domain and range,
2726 interchange the range of the domain with the domain of the range.
2730 __isl_give isl_basic_map *isl_basic_map_curry(
2731 __isl_take isl_basic_map *bmap);
2732 __isl_give isl_basic_map *isl_basic_map_uncurry(
2733 __isl_take isl_basic_map *bmap);
2734 __isl_give isl_map *isl_map_curry(
2735 __isl_take isl_map *map);
2736 __isl_give isl_map *isl_map_uncurry(
2737 __isl_take isl_map *map);
2738 __isl_give isl_union_map *isl_union_map_curry(
2739 __isl_take isl_union_map *umap);
2740 __isl_give isl_union_map *isl_union_map_uncurry(
2741 __isl_take isl_union_map *umap);
2743 Given a relation with a nested relation for domain,
2744 the C<curry> functions
2745 move the range of the nested relation out of the domain
2746 and use it as the domain of a nested relation in the range,
2747 with the original range as range of this nested relation.
2748 The C<uncurry> functions perform the inverse operation.
2750 =item * Aligning parameters
2752 __isl_give isl_basic_set *isl_basic_set_align_params(
2753 __isl_take isl_basic_set *bset,
2754 __isl_take isl_space *model);
2755 __isl_give isl_set *isl_set_align_params(
2756 __isl_take isl_set *set,
2757 __isl_take isl_space *model);
2758 __isl_give isl_basic_map *isl_basic_map_align_params(
2759 __isl_take isl_basic_map *bmap,
2760 __isl_take isl_space *model);
2761 __isl_give isl_map *isl_map_align_params(
2762 __isl_take isl_map *map,
2763 __isl_take isl_space *model);
2765 Change the order of the parameters of the given set or relation
2766 such that the first parameters match those of C<model>.
2767 This may involve the introduction of extra parameters.
2768 All parameters need to be named.
2770 =item * Dimension manipulation
2772 __isl_give isl_basic_set *isl_basic_set_add_dims(
2773 __isl_take isl_basic_set *bset,
2774 enum isl_dim_type type, unsigned n);
2775 __isl_give isl_set *isl_set_add_dims(
2776 __isl_take isl_set *set,
2777 enum isl_dim_type type, unsigned n);
2778 __isl_give isl_map *isl_map_add_dims(
2779 __isl_take isl_map *map,
2780 enum isl_dim_type type, unsigned n);
2781 __isl_give isl_basic_set *isl_basic_set_insert_dims(
2782 __isl_take isl_basic_set *bset,
2783 enum isl_dim_type type, unsigned pos,
2785 __isl_give isl_basic_map *isl_basic_map_insert_dims(
2786 __isl_take isl_basic_map *bmap,
2787 enum isl_dim_type type, unsigned pos,
2789 __isl_give isl_set *isl_set_insert_dims(
2790 __isl_take isl_set *set,
2791 enum isl_dim_type type, unsigned pos, unsigned n);
2792 __isl_give isl_map *isl_map_insert_dims(
2793 __isl_take isl_map *map,
2794 enum isl_dim_type type, unsigned pos, unsigned n);
2795 __isl_give isl_basic_set *isl_basic_set_move_dims(
2796 __isl_take isl_basic_set *bset,
2797 enum isl_dim_type dst_type, unsigned dst_pos,
2798 enum isl_dim_type src_type, unsigned src_pos,
2800 __isl_give isl_basic_map *isl_basic_map_move_dims(
2801 __isl_take isl_basic_map *bmap,
2802 enum isl_dim_type dst_type, unsigned dst_pos,
2803 enum isl_dim_type src_type, unsigned src_pos,
2805 __isl_give isl_set *isl_set_move_dims(
2806 __isl_take isl_set *set,
2807 enum isl_dim_type dst_type, unsigned dst_pos,
2808 enum isl_dim_type src_type, unsigned src_pos,
2810 __isl_give isl_map *isl_map_move_dims(
2811 __isl_take isl_map *map,
2812 enum isl_dim_type dst_type, unsigned dst_pos,
2813 enum isl_dim_type src_type, unsigned src_pos,
2816 It is usually not advisable to directly change the (input or output)
2817 space of a set or a relation as this removes the name and the internal
2818 structure of the space. However, the above functions can be useful
2819 to add new parameters, assuming
2820 C<isl_set_align_params> and C<isl_map_align_params>
2825 =head2 Binary Operations
2827 The two arguments of a binary operation not only need to live
2828 in the same C<isl_ctx>, they currently also need to have
2829 the same (number of) parameters.
2831 =head3 Basic Operations
2835 =item * Intersection
2837 __isl_give isl_basic_set *isl_basic_set_intersect_params(
2838 __isl_take isl_basic_set *bset1,
2839 __isl_take isl_basic_set *bset2);
2840 __isl_give isl_basic_set *isl_basic_set_intersect(
2841 __isl_take isl_basic_set *bset1,
2842 __isl_take isl_basic_set *bset2);
2843 __isl_give isl_set *isl_set_intersect_params(
2844 __isl_take isl_set *set,
2845 __isl_take isl_set *params);
2846 __isl_give isl_set *isl_set_intersect(
2847 __isl_take isl_set *set1,
2848 __isl_take isl_set *set2);
2849 __isl_give isl_union_set *isl_union_set_intersect_params(
2850 __isl_take isl_union_set *uset,
2851 __isl_take isl_set *set);
2852 __isl_give isl_union_map *isl_union_map_intersect_params(
2853 __isl_take isl_union_map *umap,
2854 __isl_take isl_set *set);
2855 __isl_give isl_union_set *isl_union_set_intersect(
2856 __isl_take isl_union_set *uset1,
2857 __isl_take isl_union_set *uset2);
2858 __isl_give isl_basic_map *isl_basic_map_intersect_domain(
2859 __isl_take isl_basic_map *bmap,
2860 __isl_take isl_basic_set *bset);
2861 __isl_give isl_basic_map *isl_basic_map_intersect_range(
2862 __isl_take isl_basic_map *bmap,
2863 __isl_take isl_basic_set *bset);
2864 __isl_give isl_basic_map *isl_basic_map_intersect(
2865 __isl_take isl_basic_map *bmap1,
2866 __isl_take isl_basic_map *bmap2);
2867 __isl_give isl_map *isl_map_intersect_params(
2868 __isl_take isl_map *map,
2869 __isl_take isl_set *params);
2870 __isl_give isl_map *isl_map_intersect_domain(
2871 __isl_take isl_map *map,
2872 __isl_take isl_set *set);
2873 __isl_give isl_map *isl_map_intersect_range(
2874 __isl_take isl_map *map,
2875 __isl_take isl_set *set);
2876 __isl_give isl_map *isl_map_intersect(
2877 __isl_take isl_map *map1,
2878 __isl_take isl_map *map2);
2879 __isl_give isl_union_map *isl_union_map_intersect_domain(
2880 __isl_take isl_union_map *umap,
2881 __isl_take isl_union_set *uset);
2882 __isl_give isl_union_map *isl_union_map_intersect_range(
2883 __isl_take isl_union_map *umap,
2884 __isl_take isl_union_set *uset);
2885 __isl_give isl_union_map *isl_union_map_intersect(
2886 __isl_take isl_union_map *umap1,
2887 __isl_take isl_union_map *umap2);
2889 The second argument to the C<_params> functions needs to be
2890 a parametric (basic) set. For the other functions, a parametric set
2891 for either argument is only allowed if the other argument is
2892 a parametric set as well.
2896 __isl_give isl_set *isl_basic_set_union(
2897 __isl_take isl_basic_set *bset1,
2898 __isl_take isl_basic_set *bset2);
2899 __isl_give isl_map *isl_basic_map_union(
2900 __isl_take isl_basic_map *bmap1,
2901 __isl_take isl_basic_map *bmap2);
2902 __isl_give isl_set *isl_set_union(
2903 __isl_take isl_set *set1,
2904 __isl_take isl_set *set2);
2905 __isl_give isl_map *isl_map_union(
2906 __isl_take isl_map *map1,
2907 __isl_take isl_map *map2);
2908 __isl_give isl_union_set *isl_union_set_union(
2909 __isl_take isl_union_set *uset1,
2910 __isl_take isl_union_set *uset2);
2911 __isl_give isl_union_map *isl_union_map_union(
2912 __isl_take isl_union_map *umap1,
2913 __isl_take isl_union_map *umap2);
2915 =item * Set difference
2917 __isl_give isl_set *isl_set_subtract(
2918 __isl_take isl_set *set1,
2919 __isl_take isl_set *set2);
2920 __isl_give isl_map *isl_map_subtract(
2921 __isl_take isl_map *map1,
2922 __isl_take isl_map *map2);
2923 __isl_give isl_map *isl_map_subtract_domain(
2924 __isl_take isl_map *map,
2925 __isl_take isl_set *dom);
2926 __isl_give isl_map *isl_map_subtract_range(
2927 __isl_take isl_map *map,
2928 __isl_take isl_set *dom);
2929 __isl_give isl_union_set *isl_union_set_subtract(
2930 __isl_take isl_union_set *uset1,
2931 __isl_take isl_union_set *uset2);
2932 __isl_give isl_union_map *isl_union_map_subtract(
2933 __isl_take isl_union_map *umap1,
2934 __isl_take isl_union_map *umap2);
2935 __isl_give isl_union_map *isl_union_map_subtract_domain(
2936 __isl_take isl_union_map *umap,
2937 __isl_take isl_union_set *dom);
2938 __isl_give isl_union_map *isl_union_map_subtract_range(
2939 __isl_take isl_union_map *umap,
2940 __isl_take isl_union_set *dom);
2944 __isl_give isl_basic_set *isl_basic_set_apply(
2945 __isl_take isl_basic_set *bset,
2946 __isl_take isl_basic_map *bmap);
2947 __isl_give isl_set *isl_set_apply(
2948 __isl_take isl_set *set,
2949 __isl_take isl_map *map);
2950 __isl_give isl_union_set *isl_union_set_apply(
2951 __isl_take isl_union_set *uset,
2952 __isl_take isl_union_map *umap);
2953 __isl_give isl_basic_map *isl_basic_map_apply_domain(
2954 __isl_take isl_basic_map *bmap1,
2955 __isl_take isl_basic_map *bmap2);
2956 __isl_give isl_basic_map *isl_basic_map_apply_range(
2957 __isl_take isl_basic_map *bmap1,
2958 __isl_take isl_basic_map *bmap2);
2959 __isl_give isl_map *isl_map_apply_domain(
2960 __isl_take isl_map *map1,
2961 __isl_take isl_map *map2);
2962 __isl_give isl_union_map *isl_union_map_apply_domain(
2963 __isl_take isl_union_map *umap1,
2964 __isl_take isl_union_map *umap2);
2965 __isl_give isl_map *isl_map_apply_range(
2966 __isl_take isl_map *map1,
2967 __isl_take isl_map *map2);
2968 __isl_give isl_union_map *isl_union_map_apply_range(
2969 __isl_take isl_union_map *umap1,
2970 __isl_take isl_union_map *umap2);
2974 __isl_give isl_basic_set *
2975 isl_basic_set_preimage_multi_aff(
2976 __isl_take isl_basic_set *bset,
2977 __isl_take isl_multi_aff *ma);
2978 __isl_give isl_set *isl_set_preimage_multi_aff(
2979 __isl_take isl_set *set,
2980 __isl_take isl_multi_aff *ma);
2981 __isl_give isl_set *isl_set_preimage_pw_multi_aff(
2982 __isl_take isl_set *set,
2983 __isl_take isl_pw_multi_aff *pma);
2984 __isl_give isl_map *isl_map_preimage_domain_multi_aff(
2985 __isl_take isl_map *map,
2986 __isl_take isl_multi_aff *ma);
2987 __isl_give isl_union_map *
2988 isl_union_map_preimage_domain_multi_aff(
2989 __isl_take isl_union_map *umap,
2990 __isl_take isl_multi_aff *ma);
2992 These functions compute the preimage of the given set or map domain under
2993 the given function. In other words, the expression is plugged
2994 into the set description or into the domain of the map.
2995 Objects of types C<isl_multi_aff> and C<isl_pw_multi_aff> are described in
2996 L</"Piecewise Multiple Quasi Affine Expressions">.
2998 =item * Cartesian Product
3000 __isl_give isl_set *isl_set_product(
3001 __isl_take isl_set *set1,
3002 __isl_take isl_set *set2);
3003 __isl_give isl_union_set *isl_union_set_product(
3004 __isl_take isl_union_set *uset1,
3005 __isl_take isl_union_set *uset2);
3006 __isl_give isl_basic_map *isl_basic_map_domain_product(
3007 __isl_take isl_basic_map *bmap1,
3008 __isl_take isl_basic_map *bmap2);
3009 __isl_give isl_basic_map *isl_basic_map_range_product(
3010 __isl_take isl_basic_map *bmap1,
3011 __isl_take isl_basic_map *bmap2);
3012 __isl_give isl_basic_map *isl_basic_map_product(
3013 __isl_take isl_basic_map *bmap1,
3014 __isl_take isl_basic_map *bmap2);
3015 __isl_give isl_map *isl_map_domain_product(
3016 __isl_take isl_map *map1,
3017 __isl_take isl_map *map2);
3018 __isl_give isl_map *isl_map_range_product(
3019 __isl_take isl_map *map1,
3020 __isl_take isl_map *map2);
3021 __isl_give isl_union_map *isl_union_map_domain_product(
3022 __isl_take isl_union_map *umap1,
3023 __isl_take isl_union_map *umap2);
3024 __isl_give isl_union_map *isl_union_map_range_product(
3025 __isl_take isl_union_map *umap1,
3026 __isl_take isl_union_map *umap2);
3027 __isl_give isl_map *isl_map_product(
3028 __isl_take isl_map *map1,
3029 __isl_take isl_map *map2);
3030 __isl_give isl_union_map *isl_union_map_product(
3031 __isl_take isl_union_map *umap1,
3032 __isl_take isl_union_map *umap2);
3034 The above functions compute the cross product of the given
3035 sets or relations. The domains and ranges of the results
3036 are wrapped maps between domains and ranges of the inputs.
3037 To obtain a ``flat'' product, use the following functions
3040 __isl_give isl_basic_set *isl_basic_set_flat_product(
3041 __isl_take isl_basic_set *bset1,
3042 __isl_take isl_basic_set *bset2);
3043 __isl_give isl_set *isl_set_flat_product(
3044 __isl_take isl_set *set1,
3045 __isl_take isl_set *set2);
3046 __isl_give isl_basic_map *isl_basic_map_flat_range_product(
3047 __isl_take isl_basic_map *bmap1,
3048 __isl_take isl_basic_map *bmap2);
3049 __isl_give isl_map *isl_map_flat_domain_product(
3050 __isl_take isl_map *map1,
3051 __isl_take isl_map *map2);
3052 __isl_give isl_map *isl_map_flat_range_product(
3053 __isl_take isl_map *map1,
3054 __isl_take isl_map *map2);
3055 __isl_give isl_union_map *isl_union_map_flat_range_product(
3056 __isl_take isl_union_map *umap1,
3057 __isl_take isl_union_map *umap2);
3058 __isl_give isl_basic_map *isl_basic_map_flat_product(
3059 __isl_take isl_basic_map *bmap1,
3060 __isl_take isl_basic_map *bmap2);
3061 __isl_give isl_map *isl_map_flat_product(
3062 __isl_take isl_map *map1,
3063 __isl_take isl_map *map2);
3065 =item * Simplification
3067 __isl_give isl_basic_set *isl_basic_set_gist(
3068 __isl_take isl_basic_set *bset,
3069 __isl_take isl_basic_set *context);
3070 __isl_give isl_set *isl_set_gist(__isl_take isl_set *set,
3071 __isl_take isl_set *context);
3072 __isl_give isl_set *isl_set_gist_params(
3073 __isl_take isl_set *set,
3074 __isl_take isl_set *context);
3075 __isl_give isl_union_set *isl_union_set_gist(
3076 __isl_take isl_union_set *uset,
3077 __isl_take isl_union_set *context);
3078 __isl_give isl_union_set *isl_union_set_gist_params(
3079 __isl_take isl_union_set *uset,
3080 __isl_take isl_set *set);
3081 __isl_give isl_basic_map *isl_basic_map_gist(
3082 __isl_take isl_basic_map *bmap,
3083 __isl_take isl_basic_map *context);
3084 __isl_give isl_map *isl_map_gist(__isl_take isl_map *map,
3085 __isl_take isl_map *context);
3086 __isl_give isl_map *isl_map_gist_params(
3087 __isl_take isl_map *map,
3088 __isl_take isl_set *context);
3089 __isl_give isl_map *isl_map_gist_domain(
3090 __isl_take isl_map *map,
3091 __isl_take isl_set *context);
3092 __isl_give isl_map *isl_map_gist_range(
3093 __isl_take isl_map *map,
3094 __isl_take isl_set *context);
3095 __isl_give isl_union_map *isl_union_map_gist(
3096 __isl_take isl_union_map *umap,
3097 __isl_take isl_union_map *context);
3098 __isl_give isl_union_map *isl_union_map_gist_params(
3099 __isl_take isl_union_map *umap,
3100 __isl_take isl_set *set);
3101 __isl_give isl_union_map *isl_union_map_gist_domain(
3102 __isl_take isl_union_map *umap,
3103 __isl_take isl_union_set *uset);
3104 __isl_give isl_union_map *isl_union_map_gist_range(
3105 __isl_take isl_union_map *umap,
3106 __isl_take isl_union_set *uset);
3108 The gist operation returns a set or relation that has the
3109 same intersection with the context as the input set or relation.
3110 Any implicit equality in the intersection is made explicit in the result,
3111 while all inequalities that are redundant with respect to the intersection
3113 In case of union sets and relations, the gist operation is performed
3118 =head3 Lexicographic Optimization
3120 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
3121 the following functions
3122 compute a set that contains the lexicographic minimum or maximum
3123 of the elements in C<set> (or C<bset>) for those values of the parameters
3124 that satisfy C<dom>.
3125 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3126 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
3128 In other words, the union of the parameter values
3129 for which the result is non-empty and of C<*empty>
3132 __isl_give isl_set *isl_basic_set_partial_lexmin(
3133 __isl_take isl_basic_set *bset,
3134 __isl_take isl_basic_set *dom,
3135 __isl_give isl_set **empty);
3136 __isl_give isl_set *isl_basic_set_partial_lexmax(
3137 __isl_take isl_basic_set *bset,
3138 __isl_take isl_basic_set *dom,
3139 __isl_give isl_set **empty);
3140 __isl_give isl_set *isl_set_partial_lexmin(
3141 __isl_take isl_set *set, __isl_take isl_set *dom,
3142 __isl_give isl_set **empty);
3143 __isl_give isl_set *isl_set_partial_lexmax(
3144 __isl_take isl_set *set, __isl_take isl_set *dom,
3145 __isl_give isl_set **empty);
3147 Given a (basic) set C<set> (or C<bset>), the following functions simply
3148 return a set containing the lexicographic minimum or maximum
3149 of the elements in C<set> (or C<bset>).
3150 In case of union sets, the optimum is computed per space.
3152 __isl_give isl_set *isl_basic_set_lexmin(
3153 __isl_take isl_basic_set *bset);
3154 __isl_give isl_set *isl_basic_set_lexmax(
3155 __isl_take isl_basic_set *bset);
3156 __isl_give isl_set *isl_set_lexmin(
3157 __isl_take isl_set *set);
3158 __isl_give isl_set *isl_set_lexmax(
3159 __isl_take isl_set *set);
3160 __isl_give isl_union_set *isl_union_set_lexmin(
3161 __isl_take isl_union_set *uset);
3162 __isl_give isl_union_set *isl_union_set_lexmax(
3163 __isl_take isl_union_set *uset);
3165 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
3166 the following functions
3167 compute a relation that maps each element of C<dom>
3168 to the single lexicographic minimum or maximum
3169 of the elements that are associated to that same
3170 element in C<map> (or C<bmap>).
3171 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
3172 that contains the elements in C<dom> that do not map
3173 to any elements in C<map> (or C<bmap>).
3174 In other words, the union of the domain of the result and of C<*empty>
3177 __isl_give isl_map *isl_basic_map_partial_lexmax(
3178 __isl_take isl_basic_map *bmap,
3179 __isl_take isl_basic_set *dom,
3180 __isl_give isl_set **empty);
3181 __isl_give isl_map *isl_basic_map_partial_lexmin(
3182 __isl_take isl_basic_map *bmap,
3183 __isl_take isl_basic_set *dom,
3184 __isl_give isl_set **empty);
3185 __isl_give isl_map *isl_map_partial_lexmax(
3186 __isl_take isl_map *map, __isl_take isl_set *dom,
3187 __isl_give isl_set **empty);
3188 __isl_give isl_map *isl_map_partial_lexmin(
3189 __isl_take isl_map *map, __isl_take isl_set *dom,
3190 __isl_give isl_set **empty);
3192 Given a (basic) map C<map> (or C<bmap>), the following functions simply
3193 return a map mapping each element in the domain of
3194 C<map> (or C<bmap>) to the lexicographic minimum or maximum
3195 of all elements associated to that element.
3196 In case of union relations, the optimum is computed per space.
3198 __isl_give isl_map *isl_basic_map_lexmin(
3199 __isl_take isl_basic_map *bmap);
3200 __isl_give isl_map *isl_basic_map_lexmax(
3201 __isl_take isl_basic_map *bmap);
3202 __isl_give isl_map *isl_map_lexmin(
3203 __isl_take isl_map *map);
3204 __isl_give isl_map *isl_map_lexmax(
3205 __isl_take isl_map *map);
3206 __isl_give isl_union_map *isl_union_map_lexmin(
3207 __isl_take isl_union_map *umap);
3208 __isl_give isl_union_map *isl_union_map_lexmax(
3209 __isl_take isl_union_map *umap);
3211 The following functions return their result in the form of
3212 a piecewise multi-affine expression
3213 (See L<"Piecewise Multiple Quasi Affine Expressions">),
3214 but are otherwise equivalent to the corresponding functions
3215 returning a basic set or relation.
3217 __isl_give isl_pw_multi_aff *
3218 isl_basic_map_lexmin_pw_multi_aff(
3219 __isl_take isl_basic_map *bmap);
3220 __isl_give isl_pw_multi_aff *
3221 isl_basic_set_partial_lexmin_pw_multi_aff(
3222 __isl_take isl_basic_set *bset,
3223 __isl_take isl_basic_set *dom,
3224 __isl_give isl_set **empty);
3225 __isl_give isl_pw_multi_aff *
3226 isl_basic_set_partial_lexmax_pw_multi_aff(
3227 __isl_take isl_basic_set *bset,
3228 __isl_take isl_basic_set *dom,
3229 __isl_give isl_set **empty);
3230 __isl_give isl_pw_multi_aff *
3231 isl_basic_map_partial_lexmin_pw_multi_aff(
3232 __isl_take isl_basic_map *bmap,
3233 __isl_take isl_basic_set *dom,
3234 __isl_give isl_set **empty);
3235 __isl_give isl_pw_multi_aff *
3236 isl_basic_map_partial_lexmax_pw_multi_aff(
3237 __isl_take isl_basic_map *bmap,
3238 __isl_take isl_basic_set *dom,
3239 __isl_give isl_set **empty);
3240 __isl_give isl_pw_multi_aff *isl_set_lexmin_pw_multi_aff(
3241 __isl_take isl_set *set);
3242 __isl_give isl_pw_multi_aff *isl_set_lexmax_pw_multi_aff(
3243 __isl_take isl_set *set);
3244 __isl_give isl_pw_multi_aff *isl_map_lexmin_pw_multi_aff(
3245 __isl_take isl_map *map);
3246 __isl_give isl_pw_multi_aff *isl_map_lexmax_pw_multi_aff(
3247 __isl_take isl_map *map);
3251 Lists are defined over several element types, including
3252 C<isl_val>, C<isl_id>, C<isl_aff>, C<isl_pw_aff>, C<isl_constraint>,
3253 C<isl_basic_set>, C<isl_set>, C<isl_ast_expr> and C<isl_ast_node>.
3254 Here we take lists of C<isl_set>s as an example.
3255 Lists can be created, copied, modified and freed using the following functions.
3257 #include <isl/list.h>
3258 __isl_give isl_set_list *isl_set_list_from_set(
3259 __isl_take isl_set *el);
3260 __isl_give isl_set_list *isl_set_list_alloc(
3261 isl_ctx *ctx, int n);
3262 __isl_give isl_set_list *isl_set_list_copy(
3263 __isl_keep isl_set_list *list);
3264 __isl_give isl_set_list *isl_set_list_insert(
3265 __isl_take isl_set_list *list, unsigned pos,
3266 __isl_take isl_set *el);
3267 __isl_give isl_set_list *isl_set_list_add(
3268 __isl_take isl_set_list *list,
3269 __isl_take isl_set *el);
3270 __isl_give isl_set_list *isl_set_list_drop(
3271 __isl_take isl_set_list *list,
3272 unsigned first, unsigned n);
3273 __isl_give isl_set_list *isl_set_list_set_set(
3274 __isl_take isl_set_list *list, int index,
3275 __isl_take isl_set *set);
3276 __isl_give isl_set_list *isl_set_list_concat(
3277 __isl_take isl_set_list *list1,
3278 __isl_take isl_set_list *list2);
3279 __isl_give isl_set_list *isl_set_list_sort(
3280 __isl_take isl_set_list *list,
3281 int (*cmp)(__isl_keep isl_set *a,
3282 __isl_keep isl_set *b, void *user),
3284 void *isl_set_list_free(__isl_take isl_set_list *list);
3286 C<isl_set_list_alloc> creates an empty list with a capacity for
3287 C<n> elements. C<isl_set_list_from_set> creates a list with a single
3290 Lists can be inspected using the following functions.
3292 #include <isl/list.h>
3293 isl_ctx *isl_set_list_get_ctx(__isl_keep isl_set_list *list);
3294 int isl_set_list_n_set(__isl_keep isl_set_list *list);
3295 __isl_give isl_set *isl_set_list_get_set(
3296 __isl_keep isl_set_list *list, int index);
3297 int isl_set_list_foreach(__isl_keep isl_set_list *list,
3298 int (*fn)(__isl_take isl_set *el, void *user),
3300 int isl_set_list_foreach_scc(__isl_keep isl_set_list *list,
3301 int (*follows)(__isl_keep isl_set *a,
3302 __isl_keep isl_set *b, void *user),
3304 int (*fn)(__isl_take isl_set *el, void *user),
3307 The function C<isl_set_list_foreach_scc> calls C<fn> on each of the
3308 strongly connected components of the graph with as vertices the elements
3309 of C<list> and a directed edge from vertex C<b> to vertex C<a>
3310 iff C<follows(a, b)> returns C<1>. The callbacks C<follows> and C<fn>
3311 should return C<-1> on error.
3313 Lists can be printed using
3315 #include <isl/list.h>
3316 __isl_give isl_printer *isl_printer_print_set_list(
3317 __isl_take isl_printer *p,
3318 __isl_keep isl_set_list *list);
3320 =head2 Multiple Values
3322 An C<isl_multi_val> object represents a sequence of zero or more values,
3323 living in a set space.
3325 An C<isl_multi_val> can be constructed from an C<isl_val_list>
3326 using the following function
3328 #include <isl/val.h>
3329 __isl_give isl_multi_val *isl_multi_val_from_val_list(
3330 __isl_take isl_space *space,
3331 __isl_take isl_val_list *list);
3333 The zero multiple value (with value zero for each set dimension)
3334 can be created using the following function.
3336 #include <isl/val.h>
3337 __isl_give isl_multi_val *isl_multi_val_zero(
3338 __isl_take isl_space *space);
3340 Multiple values can be copied and freed using
3342 #include <isl/val.h>
3343 __isl_give isl_multi_val *isl_multi_val_copy(
3344 __isl_keep isl_multi_val *mv);
3345 void *isl_multi_val_free(__isl_take isl_multi_val *mv);
3347 They can be inspected using
3349 #include <isl/val.h>
3350 isl_ctx *isl_multi_val_get_ctx(
3351 __isl_keep isl_multi_val *mv);
3352 unsigned isl_multi_val_dim(__isl_keep isl_multi_val *mv,
3353 enum isl_dim_type type);
3354 __isl_give isl_val *isl_multi_val_get_val(
3355 __isl_keep isl_multi_val *mv, int pos);
3356 const char *isl_multi_val_get_tuple_name(
3357 __isl_keep isl_multi_val *mv,
3358 enum isl_dim_type type);
3360 They can be modified using
3362 #include <isl/val.h>
3363 __isl_give isl_multi_val *isl_multi_val_set_val(
3364 __isl_take isl_multi_val *mv, int pos,
3365 __isl_take isl_val *val);
3366 __isl_give isl_multi_val *isl_multi_val_set_dim_name(
3367 __isl_take isl_multi_val *mv,
3368 enum isl_dim_type type, unsigned pos, const char *s);
3369 __isl_give isl_multi_val *isl_multi_val_set_tuple_name(
3370 __isl_take isl_multi_val *mv,
3371 enum isl_dim_type type, const char *s);
3372 __isl_give isl_multi_val *isl_multi_val_set_tuple_id(
3373 __isl_take isl_multi_val *mv,
3374 enum isl_dim_type type, __isl_take isl_id *id);
3376 __isl_give isl_multi_val *isl_multi_val_insert_dims(
3377 __isl_take isl_multi_val *mv,
3378 enum isl_dim_type type, unsigned first, unsigned n);
3379 __isl_give isl_multi_val *isl_multi_val_add_dims(
3380 __isl_take isl_multi_val *mv,
3381 enum isl_dim_type type, unsigned n);
3382 __isl_give isl_multi_val *isl_multi_val_drop_dims(
3383 __isl_take isl_multi_val *mv,
3384 enum isl_dim_type type, unsigned first, unsigned n);
3388 #include <isl/val.h>
3389 __isl_give isl_multi_val *isl_multi_val_align_params(
3390 __isl_take isl_multi_val *mv,
3391 __isl_take isl_space *model);
3392 __isl_give isl_multi_val *isl_multi_val_range_splice(
3393 __isl_take isl_multi_val *mv1, unsigned pos,
3394 __isl_take isl_multi_val *mv2);
3395 __isl_give isl_multi_val *isl_multi_val_range_product(
3396 __isl_take isl_multi_val *mv1,
3397 __isl_take isl_multi_val *mv2);
3398 __isl_give isl_multi_val *isl_multi_val_flat_range_product(
3399 __isl_take isl_multi_val *mv1,
3400 __isl_take isl_multi_aff *mv2);
3404 Vectors can be created, copied and freed using the following functions.
3406 #include <isl/vec.h>
3407 __isl_give isl_vec *isl_vec_alloc(isl_ctx *ctx,
3409 __isl_give isl_vec *isl_vec_copy(__isl_keep isl_vec *vec);
3410 void *isl_vec_free(__isl_take isl_vec *vec);
3412 Note that the elements of a newly created vector may have arbitrary values.
3413 The elements can be changed and inspected using the following functions.
3415 isl_ctx *isl_vec_get_ctx(__isl_keep isl_vec *vec);
3416 int isl_vec_size(__isl_keep isl_vec *vec);
3417 int isl_vec_get_element(__isl_keep isl_vec *vec,
3418 int pos, isl_int *v);
3419 __isl_give isl_vec *isl_vec_set_element(
3420 __isl_take isl_vec *vec, int pos, isl_int v);
3421 __isl_give isl_vec *isl_vec_set_element_si(
3422 __isl_take isl_vec *vec, int pos, int v);
3423 __isl_give isl_vec *isl_vec_set(__isl_take isl_vec *vec,
3425 __isl_give isl_vec *isl_vec_set_si(__isl_take isl_vec *vec,
3427 __isl_give isl_vec *isl_vec_fdiv_r(__isl_take isl_vec *vec,
3430 C<isl_vec_get_element> will return a negative value if anything went wrong.
3431 In that case, the value of C<*v> is undefined.
3433 The following function can be used to concatenate two vectors.
3435 __isl_give isl_vec *isl_vec_concat(__isl_take isl_vec *vec1,
3436 __isl_take isl_vec *vec2);
3440 Matrices can be created, copied and freed using the following functions.
3442 #include <isl/mat.h>
3443 __isl_give isl_mat *isl_mat_alloc(isl_ctx *ctx,
3444 unsigned n_row, unsigned n_col);
3445 __isl_give isl_mat *isl_mat_copy(__isl_keep isl_mat *mat);
3446 void *isl_mat_free(__isl_take isl_mat *mat);
3448 Note that the elements of a newly created matrix may have arbitrary values.
3449 The elements can be changed and inspected using the following functions.
3451 isl_ctx *isl_mat_get_ctx(__isl_keep isl_mat *mat);
3452 int isl_mat_rows(__isl_keep isl_mat *mat);
3453 int isl_mat_cols(__isl_keep isl_mat *mat);
3454 int isl_mat_get_element(__isl_keep isl_mat *mat,
3455 int row, int col, isl_int *v);
3456 __isl_give isl_mat *isl_mat_set_element(__isl_take isl_mat *mat,
3457 int row, int col, isl_int v);
3458 __isl_give isl_mat *isl_mat_set_element_si(__isl_take isl_mat *mat,
3459 int row, int col, int v);
3461 C<isl_mat_get_element> will return a negative value if anything went wrong.
3462 In that case, the value of C<*v> is undefined.
3464 The following function can be used to compute the (right) inverse
3465 of a matrix, i.e., a matrix such that the product of the original
3466 and the inverse (in that order) is a multiple of the identity matrix.
3467 The input matrix is assumed to be of full row-rank.
3469 __isl_give isl_mat *isl_mat_right_inverse(__isl_take isl_mat *mat);
3471 The following function can be used to compute the (right) kernel
3472 (or null space) of a matrix, i.e., a matrix such that the product of
3473 the original and the kernel (in that order) is the zero matrix.
3475 __isl_give isl_mat *isl_mat_right_kernel(__isl_take isl_mat *mat);
3477 =head2 Piecewise Quasi Affine Expressions
3479 The zero quasi affine expression or the quasi affine expression
3480 that is equal to a specified dimension on a given domain can be created using
3482 __isl_give isl_aff *isl_aff_zero_on_domain(
3483 __isl_take isl_local_space *ls);
3484 __isl_give isl_pw_aff *isl_pw_aff_zero_on_domain(
3485 __isl_take isl_local_space *ls);
3486 __isl_give isl_aff *isl_aff_var_on_domain(
3487 __isl_take isl_local_space *ls,
3488 enum isl_dim_type type, unsigned pos);
3489 __isl_give isl_pw_aff *isl_pw_aff_var_on_domain(
3490 __isl_take isl_local_space *ls,
3491 enum isl_dim_type type, unsigned pos);
3493 Note that the space in which the resulting objects live is a map space
3494 with the given space as domain and a one-dimensional range.
3496 An empty piecewise quasi affine expression (one with no cells)
3497 or a piecewise quasi affine expression with a single cell can
3498 be created using the following functions.
3500 #include <isl/aff.h>
3501 __isl_give isl_pw_aff *isl_pw_aff_empty(
3502 __isl_take isl_space *space);
3503 __isl_give isl_pw_aff *isl_pw_aff_alloc(
3504 __isl_take isl_set *set, __isl_take isl_aff *aff);
3505 __isl_give isl_pw_aff *isl_pw_aff_from_aff(
3506 __isl_take isl_aff *aff);
3508 A piecewise quasi affine expression that is equal to 1 on a set
3509 and 0 outside the set can be created using the following function.
3511 #include <isl/aff.h>
3512 __isl_give isl_pw_aff *isl_set_indicator_function(
3513 __isl_take isl_set *set);
3515 Quasi affine expressions can be copied and freed using
3517 #include <isl/aff.h>
3518 __isl_give isl_aff *isl_aff_copy(__isl_keep isl_aff *aff);
3519 void *isl_aff_free(__isl_take isl_aff *aff);
3521 __isl_give isl_pw_aff *isl_pw_aff_copy(
3522 __isl_keep isl_pw_aff *pwaff);
3523 void *isl_pw_aff_free(__isl_take isl_pw_aff *pwaff);
3525 A (rational) bound on a dimension can be extracted from an C<isl_constraint>
3526 using the following function. The constraint is required to have
3527 a non-zero coefficient for the specified dimension.
3529 #include <isl/constraint.h>
3530 __isl_give isl_aff *isl_constraint_get_bound(
3531 __isl_keep isl_constraint *constraint,
3532 enum isl_dim_type type, int pos);
3534 The entire affine expression of the constraint can also be extracted
3535 using the following function.
3537 #include <isl/constraint.h>
3538 __isl_give isl_aff *isl_constraint_get_aff(
3539 __isl_keep isl_constraint *constraint);
3541 Conversely, an equality constraint equating
3542 the affine expression to zero or an inequality constraint enforcing
3543 the affine expression to be non-negative, can be constructed using
3545 __isl_give isl_constraint *isl_equality_from_aff(
3546 __isl_take isl_aff *aff);
3547 __isl_give isl_constraint *isl_inequality_from_aff(
3548 __isl_take isl_aff *aff);
3550 The expression can be inspected using
3552 #include <isl/aff.h>
3553 isl_ctx *isl_aff_get_ctx(__isl_keep isl_aff *aff);
3554 int isl_aff_dim(__isl_keep isl_aff *aff,
3555 enum isl_dim_type type);
3556 __isl_give isl_local_space *isl_aff_get_domain_local_space(
3557 __isl_keep isl_aff *aff);
3558 __isl_give isl_local_space *isl_aff_get_local_space(
3559 __isl_keep isl_aff *aff);
3560 const char *isl_aff_get_dim_name(__isl_keep isl_aff *aff,
3561 enum isl_dim_type type, unsigned pos);
3562 const char *isl_pw_aff_get_dim_name(
3563 __isl_keep isl_pw_aff *pa,
3564 enum isl_dim_type type, unsigned pos);
3565 int isl_pw_aff_has_dim_id(__isl_keep isl_pw_aff *pa,
3566 enum isl_dim_type type, unsigned pos);
3567 __isl_give isl_id *isl_pw_aff_get_dim_id(
3568 __isl_keep isl_pw_aff *pa,
3569 enum isl_dim_type type, unsigned pos);
3570 __isl_give isl_id *isl_pw_aff_get_tuple_id(
3571 __isl_keep isl_pw_aff *pa,
3572 enum isl_dim_type type);
3573 int isl_aff_get_constant(__isl_keep isl_aff *aff,
3575 int isl_aff_get_coefficient(__isl_keep isl_aff *aff,
3576 enum isl_dim_type type, int pos, isl_int *v);
3577 int isl_aff_get_denominator(__isl_keep isl_aff *aff,
3579 __isl_give isl_aff *isl_aff_get_div(
3580 __isl_keep isl_aff *aff, int pos);
3582 int isl_pw_aff_n_piece(__isl_keep isl_pw_aff *pwaff);
3583 int isl_pw_aff_foreach_piece(__isl_keep isl_pw_aff *pwaff,
3584 int (*fn)(__isl_take isl_set *set,
3585 __isl_take isl_aff *aff,
3586 void *user), void *user);
3588 int isl_aff_is_cst(__isl_keep isl_aff *aff);
3589 int isl_pw_aff_is_cst(__isl_keep isl_pw_aff *pwaff);
3591 int isl_aff_involves_dims(__isl_keep isl_aff *aff,
3592 enum isl_dim_type type, unsigned first, unsigned n);
3593 int isl_pw_aff_involves_dims(__isl_keep isl_pw_aff *pwaff,
3594 enum isl_dim_type type, unsigned first, unsigned n);
3596 isl_ctx *isl_pw_aff_get_ctx(__isl_keep isl_pw_aff *pwaff);
3597 unsigned isl_pw_aff_dim(__isl_keep isl_pw_aff *pwaff,
3598 enum isl_dim_type type);
3599 int isl_pw_aff_is_empty(__isl_keep isl_pw_aff *pwaff);
3601 It can be modified using
3603 #include <isl/aff.h>
3604 __isl_give isl_pw_aff *isl_pw_aff_set_tuple_id(
3605 __isl_take isl_pw_aff *pwaff,
3606 enum isl_dim_type type, __isl_take isl_id *id);
3607 __isl_give isl_aff *isl_aff_set_dim_name(
3608 __isl_take isl_aff *aff, enum isl_dim_type type,
3609 unsigned pos, const char *s);
3610 __isl_give isl_aff *isl_aff_set_dim_id(
3611 __isl_take isl_aff *aff, enum isl_dim_type type,
3612 unsigned pos, __isl_take isl_id *id);
3613 __isl_give isl_pw_aff *isl_pw_aff_set_dim_id(
3614 __isl_take isl_pw_aff *pma,
3615 enum isl_dim_type type, unsigned pos,
3616 __isl_take isl_id *id);
3617 __isl_give isl_aff *isl_aff_set_constant(
3618 __isl_take isl_aff *aff, isl_int v);
3619 __isl_give isl_aff *isl_aff_set_constant_si(
3620 __isl_take isl_aff *aff, int v);
3621 __isl_give isl_aff *isl_aff_set_coefficient(
3622 __isl_take isl_aff *aff,
3623 enum isl_dim_type type, int pos, isl_int v);
3624 __isl_give isl_aff *isl_aff_set_coefficient_si(
3625 __isl_take isl_aff *aff,
3626 enum isl_dim_type type, int pos, int v);
3627 __isl_give isl_aff *isl_aff_set_denominator(
3628 __isl_take isl_aff *aff, isl_int v);
3630 __isl_give isl_aff *isl_aff_add_constant(
3631 __isl_take isl_aff *aff, isl_int v);
3632 __isl_give isl_aff *isl_aff_add_constant_si(
3633 __isl_take isl_aff *aff, int v);
3634 __isl_give isl_aff *isl_aff_add_constant_num(
3635 __isl_take isl_aff *aff, isl_int v);
3636 __isl_give isl_aff *isl_aff_add_constant_num_si(
3637 __isl_take isl_aff *aff, int v);
3638 __isl_give isl_aff *isl_aff_add_coefficient(
3639 __isl_take isl_aff *aff,
3640 enum isl_dim_type type, int pos, isl_int v);
3641 __isl_give isl_aff *isl_aff_add_coefficient_si(
3642 __isl_take isl_aff *aff,
3643 enum isl_dim_type type, int pos, int v);
3645 __isl_give isl_aff *isl_aff_insert_dims(
3646 __isl_take isl_aff *aff,
3647 enum isl_dim_type type, unsigned first, unsigned n);
3648 __isl_give isl_pw_aff *isl_pw_aff_insert_dims(
3649 __isl_take isl_pw_aff *pwaff,
3650 enum isl_dim_type type, unsigned first, unsigned n);
3651 __isl_give isl_aff *isl_aff_add_dims(
3652 __isl_take isl_aff *aff,
3653 enum isl_dim_type type, unsigned n);
3654 __isl_give isl_pw_aff *isl_pw_aff_add_dims(
3655 __isl_take isl_pw_aff *pwaff,
3656 enum isl_dim_type type, unsigned n);
3657 __isl_give isl_aff *isl_aff_drop_dims(
3658 __isl_take isl_aff *aff,
3659 enum isl_dim_type type, unsigned first, unsigned n);
3660 __isl_give isl_pw_aff *isl_pw_aff_drop_dims(
3661 __isl_take isl_pw_aff *pwaff,
3662 enum isl_dim_type type, unsigned first, unsigned n);
3664 Note that the C<set_constant> and C<set_coefficient> functions
3665 set the I<numerator> of the constant or coefficient, while
3666 C<add_constant> and C<add_coefficient> add an integer value to
3667 the possibly rational constant or coefficient.
3668 The C<add_constant_num> functions add an integer value to
3671 To check whether an affine expressions is obviously zero
3672 or obviously equal to some other affine expression, use
3674 #include <isl/aff.h>
3675 int isl_aff_plain_is_zero(__isl_keep isl_aff *aff);
3676 int isl_aff_plain_is_equal(__isl_keep isl_aff *aff1,
3677 __isl_keep isl_aff *aff2);
3678 int isl_pw_aff_plain_is_equal(
3679 __isl_keep isl_pw_aff *pwaff1,
3680 __isl_keep isl_pw_aff *pwaff2);
3684 #include <isl/aff.h>
3685 __isl_give isl_aff *isl_aff_add(__isl_take isl_aff *aff1,
3686 __isl_take isl_aff *aff2);
3687 __isl_give isl_pw_aff *isl_pw_aff_add(
3688 __isl_take isl_pw_aff *pwaff1,
3689 __isl_take isl_pw_aff *pwaff2);
3690 __isl_give isl_pw_aff *isl_pw_aff_min(
3691 __isl_take isl_pw_aff *pwaff1,
3692 __isl_take isl_pw_aff *pwaff2);
3693 __isl_give isl_pw_aff *isl_pw_aff_max(
3694 __isl_take isl_pw_aff *pwaff1,
3695 __isl_take isl_pw_aff *pwaff2);
3696 __isl_give isl_aff *isl_aff_sub(__isl_take isl_aff *aff1,
3697 __isl_take isl_aff *aff2);
3698 __isl_give isl_pw_aff *isl_pw_aff_sub(
3699 __isl_take isl_pw_aff *pwaff1,
3700 __isl_take isl_pw_aff *pwaff2);
3701 __isl_give isl_aff *isl_aff_neg(__isl_take isl_aff *aff);
3702 __isl_give isl_pw_aff *isl_pw_aff_neg(
3703 __isl_take isl_pw_aff *pwaff);
3704 __isl_give isl_aff *isl_aff_ceil(__isl_take isl_aff *aff);
3705 __isl_give isl_pw_aff *isl_pw_aff_ceil(
3706 __isl_take isl_pw_aff *pwaff);
3707 __isl_give isl_aff *isl_aff_floor(__isl_take isl_aff *aff);
3708 __isl_give isl_pw_aff *isl_pw_aff_floor(
3709 __isl_take isl_pw_aff *pwaff);
3710 __isl_give isl_aff *isl_aff_mod(__isl_take isl_aff *aff,
3712 __isl_give isl_pw_aff *isl_pw_aff_mod(
3713 __isl_take isl_pw_aff *pwaff, isl_int mod);
3714 __isl_give isl_aff *isl_aff_scale(__isl_take isl_aff *aff,
3716 __isl_give isl_pw_aff *isl_pw_aff_scale(
3717 __isl_take isl_pw_aff *pwaff, isl_int f);
3718 __isl_give isl_aff *isl_aff_scale_down(__isl_take isl_aff *aff,
3720 __isl_give isl_aff *isl_aff_scale_down_ui(
3721 __isl_take isl_aff *aff, unsigned f);
3722 __isl_give isl_pw_aff *isl_pw_aff_scale_down(
3723 __isl_take isl_pw_aff *pwaff, isl_int f);
3725 __isl_give isl_pw_aff *isl_pw_aff_list_min(
3726 __isl_take isl_pw_aff_list *list);
3727 __isl_give isl_pw_aff *isl_pw_aff_list_max(
3728 __isl_take isl_pw_aff_list *list);
3730 __isl_give isl_pw_aff *isl_pw_aff_coalesce(
3731 __isl_take isl_pw_aff *pwqp);
3733 __isl_give isl_aff *isl_aff_align_params(
3734 __isl_take isl_aff *aff,
3735 __isl_take isl_space *model);
3736 __isl_give isl_pw_aff *isl_pw_aff_align_params(
3737 __isl_take isl_pw_aff *pwaff,
3738 __isl_take isl_space *model);
3740 __isl_give isl_aff *isl_aff_project_domain_on_params(
3741 __isl_take isl_aff *aff);
3743 __isl_give isl_aff *isl_aff_gist_params(
3744 __isl_take isl_aff *aff,
3745 __isl_take isl_set *context);
3746 __isl_give isl_aff *isl_aff_gist(__isl_take isl_aff *aff,
3747 __isl_take isl_set *context);
3748 __isl_give isl_pw_aff *isl_pw_aff_gist_params(
3749 __isl_take isl_pw_aff *pwaff,
3750 __isl_take isl_set *context);
3751 __isl_give isl_pw_aff *isl_pw_aff_gist(
3752 __isl_take isl_pw_aff *pwaff,
3753 __isl_take isl_set *context);
3755 __isl_give isl_set *isl_pw_aff_domain(
3756 __isl_take isl_pw_aff *pwaff);
3757 __isl_give isl_pw_aff *isl_pw_aff_intersect_domain(
3758 __isl_take isl_pw_aff *pa,
3759 __isl_take isl_set *set);
3760 __isl_give isl_pw_aff *isl_pw_aff_intersect_params(
3761 __isl_take isl_pw_aff *pa,
3762 __isl_take isl_set *set);
3764 __isl_give isl_aff *isl_aff_mul(__isl_take isl_aff *aff1,
3765 __isl_take isl_aff *aff2);
3766 __isl_give isl_aff *isl_aff_div(__isl_take isl_aff *aff1,
3767 __isl_take isl_aff *aff2);
3768 __isl_give isl_pw_aff *isl_pw_aff_mul(
3769 __isl_take isl_pw_aff *pwaff1,
3770 __isl_take isl_pw_aff *pwaff2);
3771 __isl_give isl_pw_aff *isl_pw_aff_div(
3772 __isl_take isl_pw_aff *pa1,
3773 __isl_take isl_pw_aff *pa2);
3774 __isl_give isl_pw_aff *isl_pw_aff_tdiv_q(
3775 __isl_take isl_pw_aff *pa1,
3776 __isl_take isl_pw_aff *pa2);
3777 __isl_give isl_pw_aff *isl_pw_aff_tdiv_r(
3778 __isl_take isl_pw_aff *pa1,
3779 __isl_take isl_pw_aff *pa2);
3781 When multiplying two affine expressions, at least one of the two needs
3782 to be a constant. Similarly, when dividing an affine expression by another,
3783 the second expression needs to be a constant.
3784 C<isl_pw_aff_tdiv_q> computes the quotient of an integer division with
3785 rounding towards zero. C<isl_pw_aff_tdiv_r> computes the corresponding
3788 #include <isl/aff.h>
3789 __isl_give isl_aff *isl_aff_pullback_multi_aff(
3790 __isl_take isl_aff *aff,
3791 __isl_take isl_multi_aff *ma);
3792 __isl_give isl_pw_aff *isl_pw_aff_pullback_multi_aff(
3793 __isl_take isl_pw_aff *pa,
3794 __isl_take isl_multi_aff *ma);
3795 __isl_give isl_pw_aff *isl_pw_aff_pullback_pw_multi_aff(
3796 __isl_take isl_pw_aff *pa,
3797 __isl_take isl_pw_multi_aff *pma);
3799 These functions precompose the input expression by the given
3800 C<isl_multi_aff> or C<isl_pw_multi_aff>. In other words,
3801 the C<isl_multi_aff> or C<isl_pw_multi_aff> is plugged
3802 into the (piecewise) affine expression.
3803 Objects of type C<isl_multi_aff> are described in
3804 L</"Piecewise Multiple Quasi Affine Expressions">.
3806 #include <isl/aff.h>
3807 __isl_give isl_basic_set *isl_aff_zero_basic_set(
3808 __isl_take isl_aff *aff);
3809 __isl_give isl_basic_set *isl_aff_neg_basic_set(
3810 __isl_take isl_aff *aff);
3811 __isl_give isl_basic_set *isl_aff_le_basic_set(
3812 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3813 __isl_give isl_basic_set *isl_aff_ge_basic_set(
3814 __isl_take isl_aff *aff1, __isl_take isl_aff *aff2);
3815 __isl_give isl_set *isl_pw_aff_eq_set(
3816 __isl_take isl_pw_aff *pwaff1,
3817 __isl_take isl_pw_aff *pwaff2);
3818 __isl_give isl_set *isl_pw_aff_ne_set(
3819 __isl_take isl_pw_aff *pwaff1,
3820 __isl_take isl_pw_aff *pwaff2);
3821 __isl_give isl_set *isl_pw_aff_le_set(
3822 __isl_take isl_pw_aff *pwaff1,
3823 __isl_take isl_pw_aff *pwaff2);
3824 __isl_give isl_set *isl_pw_aff_lt_set(
3825 __isl_take isl_pw_aff *pwaff1,
3826 __isl_take isl_pw_aff *pwaff2);
3827 __isl_give isl_set *isl_pw_aff_ge_set(
3828 __isl_take isl_pw_aff *pwaff1,
3829 __isl_take isl_pw_aff *pwaff2);
3830 __isl_give isl_set *isl_pw_aff_gt_set(
3831 __isl_take isl_pw_aff *pwaff1,
3832 __isl_take isl_pw_aff *pwaff2);
3834 __isl_give isl_set *isl_pw_aff_list_eq_set(
3835 __isl_take isl_pw_aff_list *list1,
3836 __isl_take isl_pw_aff_list *list2);
3837 __isl_give isl_set *isl_pw_aff_list_ne_set(
3838 __isl_take isl_pw_aff_list *list1,
3839 __isl_take isl_pw_aff_list *list2);
3840 __isl_give isl_set *isl_pw_aff_list_le_set(
3841 __isl_take isl_pw_aff_list *list1,
3842 __isl_take isl_pw_aff_list *list2);
3843 __isl_give isl_set *isl_pw_aff_list_lt_set(
3844 __isl_take isl_pw_aff_list *list1,
3845 __isl_take isl_pw_aff_list *list2);
3846 __isl_give isl_set *isl_pw_aff_list_ge_set(
3847 __isl_take isl_pw_aff_list *list1,
3848 __isl_take isl_pw_aff_list *list2);
3849 __isl_give isl_set *isl_pw_aff_list_gt_set(
3850 __isl_take isl_pw_aff_list *list1,
3851 __isl_take isl_pw_aff_list *list2);
3853 The function C<isl_aff_neg_basic_set> returns a basic set
3854 containing those elements in the domain space
3855 of C<aff> where C<aff> is negative.
3856 The function C<isl_aff_ge_basic_set> returns a basic set
3857 containing those elements in the shared space
3858 of C<aff1> and C<aff2> where C<aff1> is greater than or equal to C<aff2>.
3859 The function C<isl_pw_aff_ge_set> returns a set
3860 containing those elements in the shared domain
3861 of C<pwaff1> and C<pwaff2> where C<pwaff1> is greater than or equal to C<pwaff2>.
3862 The functions operating on C<isl_pw_aff_list> apply the corresponding
3863 C<isl_pw_aff> function to each pair of elements in the two lists.
3865 #include <isl/aff.h>
3866 __isl_give isl_set *isl_pw_aff_nonneg_set(
3867 __isl_take isl_pw_aff *pwaff);
3868 __isl_give isl_set *isl_pw_aff_zero_set(
3869 __isl_take isl_pw_aff *pwaff);
3870 __isl_give isl_set *isl_pw_aff_non_zero_set(
3871 __isl_take isl_pw_aff *pwaff);
3873 The function C<isl_pw_aff_nonneg_set> returns a set
3874 containing those elements in the domain
3875 of C<pwaff> where C<pwaff> is non-negative.
3877 #include <isl/aff.h>
3878 __isl_give isl_pw_aff *isl_pw_aff_cond(
3879 __isl_take isl_pw_aff *cond,
3880 __isl_take isl_pw_aff *pwaff_true,
3881 __isl_take isl_pw_aff *pwaff_false);
3883 The function C<isl_pw_aff_cond> performs a conditional operator
3884 and returns an expression that is equal to C<pwaff_true>
3885 for elements where C<cond> is non-zero and equal to C<pwaff_false> for elements
3886 where C<cond> is zero.
3888 #include <isl/aff.h>
3889 __isl_give isl_pw_aff *isl_pw_aff_union_min(
3890 __isl_take isl_pw_aff *pwaff1,
3891 __isl_take isl_pw_aff *pwaff2);
3892 __isl_give isl_pw_aff *isl_pw_aff_union_max(
3893 __isl_take isl_pw_aff *pwaff1,
3894 __isl_take isl_pw_aff *pwaff2);
3895 __isl_give isl_pw_aff *isl_pw_aff_union_add(
3896 __isl_take isl_pw_aff *pwaff1,
3897 __isl_take isl_pw_aff *pwaff2);
3899 The function C<isl_pw_aff_union_max> computes a piecewise quasi-affine
3900 expression with a domain that is the union of those of C<pwaff1> and
3901 C<pwaff2> and such that on each cell, the quasi-affine expression is
3902 the maximum of those of C<pwaff1> and C<pwaff2>. If only one of
3903 C<pwaff1> or C<pwaff2> is defined on a given cell, then the
3904 associated expression is the defined one.
3906 An expression can be read from input using
3908 #include <isl/aff.h>
3909 __isl_give isl_aff *isl_aff_read_from_str(
3910 isl_ctx *ctx, const char *str);
3911 __isl_give isl_pw_aff *isl_pw_aff_read_from_str(
3912 isl_ctx *ctx, const char *str);
3914 An expression can be printed using
3916 #include <isl/aff.h>
3917 __isl_give isl_printer *isl_printer_print_aff(
3918 __isl_take isl_printer *p, __isl_keep isl_aff *aff);
3920 __isl_give isl_printer *isl_printer_print_pw_aff(
3921 __isl_take isl_printer *p,
3922 __isl_keep isl_pw_aff *pwaff);
3924 =head2 Piecewise Multiple Quasi Affine Expressions
3926 An C<isl_multi_aff> object represents a sequence of
3927 zero or more affine expressions, all defined on the same domain space.
3928 Similarly, an C<isl_multi_pw_aff> object represents a sequence of
3929 zero or more piecewise affine expressions.
3931 An C<isl_multi_aff> can be constructed from a single
3932 C<isl_aff> or an C<isl_aff_list> using the
3933 following functions. Similarly for C<isl_multi_pw_aff>.
3935 #include <isl/aff.h>
3936 __isl_give isl_multi_aff *isl_multi_aff_from_aff(
3937 __isl_take isl_aff *aff);
3938 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_from_pw_aff(
3939 __isl_take isl_pw_aff *pa);
3940 __isl_give isl_multi_aff *isl_multi_aff_from_aff_list(
3941 __isl_take isl_space *space,
3942 __isl_take isl_aff_list *list);
3944 An empty piecewise multiple quasi affine expression (one with no cells),
3945 the zero piecewise multiple quasi affine expression (with value zero
3946 for each output dimension),
3947 a piecewise multiple quasi affine expression with a single cell (with
3948 either a universe or a specified domain) or
3949 a zero-dimensional piecewise multiple quasi affine expression
3951 can be created using the following functions.
3953 #include <isl/aff.h>
3954 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_empty(
3955 __isl_take isl_space *space);
3956 __isl_give isl_multi_aff *isl_multi_aff_zero(
3957 __isl_take isl_space *space);
3958 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_zero(
3959 __isl_take isl_space *space);
3960 __isl_give isl_multi_aff *isl_multi_aff_identity(
3961 __isl_take isl_space *space);
3962 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_identity(
3963 __isl_take isl_space *space);
3964 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_identity(
3965 __isl_take isl_space *space);
3966 __isl_give isl_pw_multi_aff *
3967 isl_pw_multi_aff_from_multi_aff(
3968 __isl_take isl_multi_aff *ma);
3969 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_alloc(
3970 __isl_take isl_set *set,
3971 __isl_take isl_multi_aff *maff);
3972 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_domain(
3973 __isl_take isl_set *set);
3975 __isl_give isl_union_pw_multi_aff *
3976 isl_union_pw_multi_aff_empty(
3977 __isl_take isl_space *space);
3978 __isl_give isl_union_pw_multi_aff *
3979 isl_union_pw_multi_aff_add_pw_multi_aff(
3980 __isl_take isl_union_pw_multi_aff *upma,
3981 __isl_take isl_pw_multi_aff *pma);
3982 __isl_give isl_union_pw_multi_aff *
3983 isl_union_pw_multi_aff_from_domain(
3984 __isl_take isl_union_set *uset);
3986 A piecewise multiple quasi affine expression can also be initialized
3987 from an C<isl_set> or C<isl_map>, provided the C<isl_set> is a singleton
3988 and the C<isl_map> is single-valued.
3989 In case of a conversion from an C<isl_union_set> or an C<isl_union_map>
3990 to an C<isl_union_pw_multi_aff>, these properties need to hold in each space.
3992 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_set(
3993 __isl_take isl_set *set);
3994 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_from_map(
3995 __isl_take isl_map *map);
3997 __isl_give isl_union_pw_multi_aff *
3998 isl_union_pw_multi_aff_from_union_set(
3999 __isl_take isl_union_set *uset);
4000 __isl_give isl_union_pw_multi_aff *
4001 isl_union_pw_multi_aff_from_union_map(
4002 __isl_take isl_union_map *umap);
4004 Multiple quasi affine expressions can be copied and freed using
4006 #include <isl/aff.h>
4007 __isl_give isl_multi_aff *isl_multi_aff_copy(
4008 __isl_keep isl_multi_aff *maff);
4009 void *isl_multi_aff_free(__isl_take isl_multi_aff *maff);
4011 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_copy(
4012 __isl_keep isl_pw_multi_aff *pma);
4013 void *isl_pw_multi_aff_free(
4014 __isl_take isl_pw_multi_aff *pma);
4016 __isl_give isl_union_pw_multi_aff *
4017 isl_union_pw_multi_aff_copy(
4018 __isl_keep isl_union_pw_multi_aff *upma);
4019 void *isl_union_pw_multi_aff_free(
4020 __isl_take isl_union_pw_multi_aff *upma);
4022 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_copy(
4023 __isl_keep isl_multi_pw_aff *mpa);
4024 void *isl_multi_pw_aff_free(
4025 __isl_take isl_multi_pw_aff *mpa);
4027 The expression can be inspected using
4029 #include <isl/aff.h>
4030 isl_ctx *isl_multi_aff_get_ctx(
4031 __isl_keep isl_multi_aff *maff);
4032 isl_ctx *isl_pw_multi_aff_get_ctx(
4033 __isl_keep isl_pw_multi_aff *pma);
4034 isl_ctx *isl_union_pw_multi_aff_get_ctx(
4035 __isl_keep isl_union_pw_multi_aff *upma);
4036 isl_ctx *isl_multi_pw_aff_get_ctx(
4037 __isl_keep isl_multi_pw_aff *mpa);
4038 unsigned isl_multi_aff_dim(__isl_keep isl_multi_aff *maff,
4039 enum isl_dim_type type);
4040 unsigned isl_pw_multi_aff_dim(
4041 __isl_keep isl_pw_multi_aff *pma,
4042 enum isl_dim_type type);
4043 unsigned isl_multi_pw_aff_dim(
4044 __isl_keep isl_multi_pw_aff *mpa,
4045 enum isl_dim_type type);
4046 __isl_give isl_aff *isl_multi_aff_get_aff(
4047 __isl_keep isl_multi_aff *multi, int pos);
4048 __isl_give isl_pw_aff *isl_pw_multi_aff_get_pw_aff(
4049 __isl_keep isl_pw_multi_aff *pma, int pos);
4050 __isl_give isl_pw_aff *isl_multi_pw_aff_get_pw_aff(
4051 __isl_keep isl_multi_pw_aff *mpa, int pos);
4052 const char *isl_pw_multi_aff_get_dim_name(
4053 __isl_keep isl_pw_multi_aff *pma,
4054 enum isl_dim_type type, unsigned pos);
4055 __isl_give isl_id *isl_pw_multi_aff_get_dim_id(
4056 __isl_keep isl_pw_multi_aff *pma,
4057 enum isl_dim_type type, unsigned pos);
4058 const char *isl_multi_aff_get_tuple_name(
4059 __isl_keep isl_multi_aff *multi,
4060 enum isl_dim_type type);
4061 int isl_pw_multi_aff_has_tuple_name(
4062 __isl_keep isl_pw_multi_aff *pma,
4063 enum isl_dim_type type);
4064 const char *isl_pw_multi_aff_get_tuple_name(
4065 __isl_keep isl_pw_multi_aff *pma,
4066 enum isl_dim_type type);
4067 int isl_pw_multi_aff_has_tuple_id(
4068 __isl_keep isl_pw_multi_aff *pma,
4069 enum isl_dim_type type);
4070 __isl_give isl_id *isl_pw_multi_aff_get_tuple_id(
4071 __isl_keep isl_pw_multi_aff *pma,
4072 enum isl_dim_type type);
4074 int isl_pw_multi_aff_foreach_piece(
4075 __isl_keep isl_pw_multi_aff *pma,
4076 int (*fn)(__isl_take isl_set *set,
4077 __isl_take isl_multi_aff *maff,
4078 void *user), void *user);
4080 int isl_union_pw_multi_aff_foreach_pw_multi_aff(
4081 __isl_keep isl_union_pw_multi_aff *upma,
4082 int (*fn)(__isl_take isl_pw_multi_aff *pma,
4083 void *user), void *user);
4085 It can be modified using
4087 #include <isl/aff.h>
4088 __isl_give isl_multi_aff *isl_multi_aff_set_aff(
4089 __isl_take isl_multi_aff *multi, int pos,
4090 __isl_take isl_aff *aff);
4091 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_pw_aff(
4092 __isl_take isl_pw_multi_aff *pma, unsigned pos,
4093 __isl_take isl_pw_aff *pa);
4094 __isl_give isl_multi_aff *isl_multi_aff_set_dim_name(
4095 __isl_take isl_multi_aff *maff,
4096 enum isl_dim_type type, unsigned pos, const char *s);
4097 __isl_give isl_multi_aff *isl_multi_aff_set_tuple_name(
4098 __isl_take isl_multi_aff *maff,
4099 enum isl_dim_type type, const char *s);
4100 __isl_give isl_multi_aff *isl_multi_aff_set_tuple_id(
4101 __isl_take isl_multi_aff *maff,
4102 enum isl_dim_type type, __isl_take isl_id *id);
4103 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_set_tuple_id(
4104 __isl_take isl_pw_multi_aff *pma,
4105 enum isl_dim_type type, __isl_take isl_id *id);
4107 __isl_give isl_multi_pw_aff *
4108 isl_multi_pw_aff_set_dim_name(
4109 __isl_take isl_multi_pw_aff *mpa,
4110 enum isl_dim_type type, unsigned pos, const char *s);
4111 __isl_give isl_multi_pw_aff *
4112 isl_multi_pw_aff_set_tuple_name(
4113 __isl_take isl_multi_pw_aff *mpa,
4114 enum isl_dim_type type, const char *s);
4116 __isl_give isl_multi_aff *isl_multi_aff_insert_dims(
4117 __isl_take isl_multi_aff *ma,
4118 enum isl_dim_type type, unsigned first, unsigned n);
4119 __isl_give isl_multi_aff *isl_multi_aff_add_dims(
4120 __isl_take isl_multi_aff *ma,
4121 enum isl_dim_type type, unsigned n);
4122 __isl_give isl_multi_aff *isl_multi_aff_drop_dims(
4123 __isl_take isl_multi_aff *maff,
4124 enum isl_dim_type type, unsigned first, unsigned n);
4125 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_drop_dims(
4126 __isl_take isl_pw_multi_aff *pma,
4127 enum isl_dim_type type, unsigned first, unsigned n);
4129 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_insert_dims(
4130 __isl_take isl_multi_pw_aff *mpa,
4131 enum isl_dim_type type, unsigned first, unsigned n);
4132 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_add_dims(
4133 __isl_take isl_multi_pw_aff *mpa,
4134 enum isl_dim_type type, unsigned n);
4136 To check whether two multiple affine expressions are
4137 obviously equal to each other, use
4139 int isl_multi_aff_plain_is_equal(__isl_keep isl_multi_aff *maff1,
4140 __isl_keep isl_multi_aff *maff2);
4141 int isl_pw_multi_aff_plain_is_equal(
4142 __isl_keep isl_pw_multi_aff *pma1,
4143 __isl_keep isl_pw_multi_aff *pma2);
4147 #include <isl/aff.h>
4148 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmin(
4149 __isl_take isl_pw_multi_aff *pma1,
4150 __isl_take isl_pw_multi_aff *pma2);
4151 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_lexmax(
4152 __isl_take isl_pw_multi_aff *pma1,
4153 __isl_take isl_pw_multi_aff *pma2);
4154 __isl_give isl_multi_aff *isl_multi_aff_add(
4155 __isl_take isl_multi_aff *maff1,
4156 __isl_take isl_multi_aff *maff2);
4157 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_add(
4158 __isl_take isl_pw_multi_aff *pma1,
4159 __isl_take isl_pw_multi_aff *pma2);
4160 __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_add(
4161 __isl_take isl_union_pw_multi_aff *upma1,
4162 __isl_take isl_union_pw_multi_aff *upma2);
4163 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_union_add(
4164 __isl_take isl_pw_multi_aff *pma1,
4165 __isl_take isl_pw_multi_aff *pma2);
4166 __isl_give isl_multi_aff *isl_multi_aff_sub(
4167 __isl_take isl_multi_aff *ma1,
4168 __isl_take isl_multi_aff *ma2);
4169 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_sub(
4170 __isl_take isl_pw_multi_aff *pma1,
4171 __isl_take isl_pw_multi_aff *pma2);
4172 __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_sub(
4173 __isl_take isl_union_pw_multi_aff *upma1,
4174 __isl_take isl_union_pw_multi_aff *upma2);
4176 C<isl_multi_aff_sub> subtracts the second argument from the first.
4178 __isl_give isl_multi_aff *isl_multi_aff_scale(
4179 __isl_take isl_multi_aff *maff,
4181 __isl_give isl_multi_aff *isl_multi_aff_scale_vec(
4182 __isl_take isl_multi_aff *ma,
4183 __isl_take isl_vec *v);
4184 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_scale_vec(
4185 __isl_take isl_pw_multi_aff *pma,
4186 __isl_take isl_vec *v);
4187 __isl_give isl_union_pw_multi_aff *isl_union_pw_multi_aff_scale_vec(
4188 __isl_take isl_union_pw_multi_aff *upma,
4189 __isl_take isl_vec *v);
4191 C<isl_multi_aff_scale_vec> scales the first elements of C<ma>
4192 by the corresponding elements of C<v>.
4194 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_params(
4195 __isl_take isl_pw_multi_aff *pma,
4196 __isl_take isl_set *set);
4197 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_intersect_domain(
4198 __isl_take isl_pw_multi_aff *pma,
4199 __isl_take isl_set *set);
4200 __isl_give isl_union_pw_multi_aff *
4201 isl_union_pw_multi_aff_intersect_domain(
4202 __isl_take isl_union_pw_multi_aff *upma,
4203 __isl_take isl_union_set *uset);
4204 __isl_give isl_multi_aff *isl_multi_aff_lift(
4205 __isl_take isl_multi_aff *maff,
4206 __isl_give isl_local_space **ls);
4207 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_coalesce(
4208 __isl_take isl_pw_multi_aff *pma);
4209 __isl_give isl_multi_aff *isl_multi_aff_align_params(
4210 __isl_take isl_multi_aff *multi,
4211 __isl_take isl_space *model);
4212 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_align_params(
4213 __isl_take isl_pw_multi_aff *pma,
4214 __isl_take isl_space *model);
4215 __isl_give isl_pw_multi_aff *
4216 isl_pw_multi_aff_project_domain_on_params(
4217 __isl_take isl_pw_multi_aff *pma);
4218 __isl_give isl_multi_aff *isl_multi_aff_gist_params(
4219 __isl_take isl_multi_aff *maff,
4220 __isl_take isl_set *context);
4221 __isl_give isl_multi_aff *isl_multi_aff_gist(
4222 __isl_take isl_multi_aff *maff,
4223 __isl_take isl_set *context);
4224 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist_params(
4225 __isl_take isl_pw_multi_aff *pma,
4226 __isl_take isl_set *set);
4227 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_gist(
4228 __isl_take isl_pw_multi_aff *pma,
4229 __isl_take isl_set *set);
4230 __isl_give isl_set *isl_pw_multi_aff_domain(
4231 __isl_take isl_pw_multi_aff *pma);
4232 __isl_give isl_union_set *isl_union_pw_multi_aff_domain(
4233 __isl_take isl_union_pw_multi_aff *upma);
4234 __isl_give isl_multi_aff *isl_multi_aff_range_splice(
4235 __isl_take isl_multi_aff *ma1, unsigned pos,
4236 __isl_take isl_multi_aff *ma2);
4237 __isl_give isl_multi_aff *isl_multi_aff_splice(
4238 __isl_take isl_multi_aff *ma1,
4239 unsigned in_pos, unsigned out_pos,
4240 __isl_take isl_multi_aff *ma2);
4241 __isl_give isl_multi_aff *isl_multi_aff_range_product(
4242 __isl_take isl_multi_aff *ma1,
4243 __isl_take isl_multi_aff *ma2);
4244 __isl_give isl_multi_aff *isl_multi_aff_flat_range_product(
4245 __isl_take isl_multi_aff *ma1,
4246 __isl_take isl_multi_aff *ma2);
4247 __isl_give isl_multi_aff *isl_multi_aff_product(
4248 __isl_take isl_multi_aff *ma1,
4249 __isl_take isl_multi_aff *ma2);
4250 __isl_give isl_pw_multi_aff *
4251 isl_pw_multi_aff_range_product(
4252 __isl_take isl_pw_multi_aff *pma1,
4253 __isl_take isl_pw_multi_aff *pma2);
4254 __isl_give isl_pw_multi_aff *
4255 isl_pw_multi_aff_flat_range_product(
4256 __isl_take isl_pw_multi_aff *pma1,
4257 __isl_take isl_pw_multi_aff *pma2);
4258 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_product(
4259 __isl_take isl_pw_multi_aff *pma1,
4260 __isl_take isl_pw_multi_aff *pma2);
4261 __isl_give isl_union_pw_multi_aff *
4262 isl_union_pw_multi_aff_flat_range_product(
4263 __isl_take isl_union_pw_multi_aff *upma1,
4264 __isl_take isl_union_pw_multi_aff *upma2);
4265 __isl_give isl_multi_pw_aff *
4266 isl_multi_pw_aff_range_splice(
4267 __isl_take isl_multi_pw_aff *mpa1, unsigned pos,
4268 __isl_take isl_multi_pw_aff *mpa2);
4269 __isl_give isl_multi_pw_aff *isl_multi_pw_aff_splice(
4270 __isl_take isl_multi_pw_aff *mpa1,
4271 unsigned in_pos, unsigned out_pos,
4272 __isl_take isl_multi_pw_aff *mpa2);
4273 __isl_give isl_multi_pw_aff *
4274 isl_multi_pw_aff_range_product(
4275 __isl_take isl_multi_pw_aff *mpa1,
4276 __isl_take isl_multi_pw_aff *mpa2);
4277 __isl_give isl_multi_pw_aff *
4278 isl_multi_pw_aff_flat_range_product(
4279 __isl_take isl_multi_pw_aff *mpa1,
4280 __isl_take isl_multi_pw_aff *mpa2);
4282 If the C<ls> argument of C<isl_multi_aff_lift> is not C<NULL>,
4283 then it is assigned the local space that lies at the basis of
4284 the lifting applied.
4286 #include <isl/aff.h>
4287 __isl_give isl_multi_aff *isl_multi_aff_pullback_multi_aff(
4288 __isl_take isl_multi_aff *ma1,
4289 __isl_take isl_multi_aff *ma2);
4290 __isl_give isl_pw_multi_aff *
4291 isl_pw_multi_aff_pullback_multi_aff(
4292 __isl_take isl_pw_multi_aff *pma,
4293 __isl_take isl_multi_aff *ma);
4294 __isl_give isl_pw_multi_aff *
4295 isl_pw_multi_aff_pullback_pw_multi_aff(
4296 __isl_take isl_pw_multi_aff *pma1,
4297 __isl_take isl_pw_multi_aff *pma2);
4299 The function C<isl_multi_aff_pullback_multi_aff> precomposes C<ma1> by C<ma2>.
4300 In other words, C<ma2> is plugged
4303 __isl_give isl_set *isl_multi_aff_lex_le_set(
4304 __isl_take isl_multi_aff *ma1,
4305 __isl_take isl_multi_aff *ma2);
4306 __isl_give isl_set *isl_multi_aff_lex_ge_set(
4307 __isl_take isl_multi_aff *ma1,
4308 __isl_take isl_multi_aff *ma2);
4310 The function C<isl_multi_aff_lex_le_set> returns a set
4311 containing those elements in the shared domain space
4312 where C<ma1> is lexicographically smaller than or
4315 An expression can be read from input using
4317 #include <isl/aff.h>
4318 __isl_give isl_multi_aff *isl_multi_aff_read_from_str(
4319 isl_ctx *ctx, const char *str);
4320 __isl_give isl_pw_multi_aff *isl_pw_multi_aff_read_from_str(
4321 isl_ctx *ctx, const char *str);
4322 __isl_give isl_union_pw_multi_aff *
4323 isl_union_pw_multi_aff_read_from_str(
4324 isl_ctx *ctx, const char *str);
4326 An expression can be printed using
4328 #include <isl/aff.h>
4329 __isl_give isl_printer *isl_printer_print_multi_aff(
4330 __isl_take isl_printer *p,
4331 __isl_keep isl_multi_aff *maff);
4332 __isl_give isl_printer *isl_printer_print_pw_multi_aff(
4333 __isl_take isl_printer *p,
4334 __isl_keep isl_pw_multi_aff *pma);
4335 __isl_give isl_printer *isl_printer_print_union_pw_multi_aff(
4336 __isl_take isl_printer *p,
4337 __isl_keep isl_union_pw_multi_aff *upma);
4338 __isl_give isl_printer *isl_printer_print_multi_pw_aff(
4339 __isl_take isl_printer *p,
4340 __isl_keep isl_multi_pw_aff *mpa);
4344 Points are elements of a set. They can be used to construct
4345 simple sets (boxes) or they can be used to represent the
4346 individual elements of a set.
4347 The zero point (the origin) can be created using
4349 __isl_give isl_point *isl_point_zero(__isl_take isl_space *space);
4351 The coordinates of a point can be inspected, set and changed
4354 int isl_point_get_coordinate(__isl_keep isl_point *pnt,
4355 enum isl_dim_type type, int pos, isl_int *v);
4356 __isl_give isl_point *isl_point_set_coordinate(
4357 __isl_take isl_point *pnt,
4358 enum isl_dim_type type, int pos, isl_int v);
4360 __isl_give isl_point *isl_point_add_ui(
4361 __isl_take isl_point *pnt,
4362 enum isl_dim_type type, int pos, unsigned val);
4363 __isl_give isl_point *isl_point_sub_ui(
4364 __isl_take isl_point *pnt,
4365 enum isl_dim_type type, int pos, unsigned val);
4367 Other properties can be obtained using
4369 isl_ctx *isl_point_get_ctx(__isl_keep isl_point *pnt);
4371 Points can be copied or freed using
4373 __isl_give isl_point *isl_point_copy(
4374 __isl_keep isl_point *pnt);
4375 void isl_point_free(__isl_take isl_point *pnt);
4377 A singleton set can be created from a point using
4379 __isl_give isl_basic_set *isl_basic_set_from_point(
4380 __isl_take isl_point *pnt);
4381 __isl_give isl_set *isl_set_from_point(
4382 __isl_take isl_point *pnt);
4384 and a box can be created from two opposite extremal points using
4386 __isl_give isl_basic_set *isl_basic_set_box_from_points(
4387 __isl_take isl_point *pnt1,
4388 __isl_take isl_point *pnt2);
4389 __isl_give isl_set *isl_set_box_from_points(
4390 __isl_take isl_point *pnt1,
4391 __isl_take isl_point *pnt2);
4393 All elements of a B<bounded> (union) set can be enumerated using
4394 the following functions.
4396 int isl_set_foreach_point(__isl_keep isl_set *set,
4397 int (*fn)(__isl_take isl_point *pnt, void *user),
4399 int isl_union_set_foreach_point(__isl_keep isl_union_set *uset,
4400 int (*fn)(__isl_take isl_point *pnt, void *user),
4403 The function C<fn> is called for each integer point in
4404 C<set> with as second argument the last argument of
4405 the C<isl_set_foreach_point> call. The function C<fn>
4406 should return C<0> on success and C<-1> on failure.
4407 In the latter case, C<isl_set_foreach_point> will stop
4408 enumerating and return C<-1> as well.
4409 If the enumeration is performed successfully and to completion,
4410 then C<isl_set_foreach_point> returns C<0>.
4412 To obtain a single point of a (basic) set, use
4414 __isl_give isl_point *isl_basic_set_sample_point(
4415 __isl_take isl_basic_set *bset);
4416 __isl_give isl_point *isl_set_sample_point(
4417 __isl_take isl_set *set);
4419 If C<set> does not contain any (integer) points, then the
4420 resulting point will be ``void'', a property that can be
4423 int isl_point_is_void(__isl_keep isl_point *pnt);
4425 =head2 Piecewise Quasipolynomials
4427 A piecewise quasipolynomial is a particular kind of function that maps
4428 a parametric point to a rational value.
4429 More specifically, a quasipolynomial is a polynomial expression in greatest
4430 integer parts of affine expressions of parameters and variables.
4431 A piecewise quasipolynomial is a subdivision of a given parametric
4432 domain into disjoint cells with a quasipolynomial associated to
4433 each cell. The value of the piecewise quasipolynomial at a given
4434 point is the value of the quasipolynomial associated to the cell
4435 that contains the point. Outside of the union of cells,
4436 the value is assumed to be zero.
4437 For example, the piecewise quasipolynomial
4439 [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
4441 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
4442 A given piecewise quasipolynomial has a fixed domain dimension.
4443 Union piecewise quasipolynomials are used to contain piecewise quasipolynomials
4444 defined over different domains.
4445 Piecewise quasipolynomials are mainly used by the C<barvinok>
4446 library for representing the number of elements in a parametric set or map.
4447 For example, the piecewise quasipolynomial above represents
4448 the number of points in the map
4450 [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
4452 =head3 Input and Output
4454 Piecewise quasipolynomials can be read from input using
4456 __isl_give isl_union_pw_qpolynomial *
4457 isl_union_pw_qpolynomial_read_from_str(
4458 isl_ctx *ctx, const char *str);
4460 Quasipolynomials and piecewise quasipolynomials can be printed
4461 using the following functions.
4463 __isl_give isl_printer *isl_printer_print_qpolynomial(
4464 __isl_take isl_printer *p,
4465 __isl_keep isl_qpolynomial *qp);
4467 __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
4468 __isl_take isl_printer *p,
4469 __isl_keep isl_pw_qpolynomial *pwqp);
4471 __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial(
4472 __isl_take isl_printer *p,
4473 __isl_keep isl_union_pw_qpolynomial *upwqp);
4475 The output format of the printer
4476 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4477 For C<isl_printer_print_union_pw_qpolynomial>, only C<ISL_FORMAT_ISL>
4479 In case of printing in C<ISL_FORMAT_C>, the user may want
4480 to set the names of all dimensions
4482 __isl_give isl_qpolynomial *isl_qpolynomial_set_dim_name(
4483 __isl_take isl_qpolynomial *qp,
4484 enum isl_dim_type type, unsigned pos,
4486 __isl_give isl_pw_qpolynomial *
4487 isl_pw_qpolynomial_set_dim_name(
4488 __isl_take isl_pw_qpolynomial *pwqp,
4489 enum isl_dim_type type, unsigned pos,
4492 =head3 Creating New (Piecewise) Quasipolynomials
4494 Some simple quasipolynomials can be created using the following functions.
4495 More complicated quasipolynomials can be created by applying
4496 operations such as addition and multiplication
4497 on the resulting quasipolynomials
4499 __isl_give isl_qpolynomial *isl_qpolynomial_zero_on_domain(
4500 __isl_take isl_space *domain);
4501 __isl_give isl_qpolynomial *isl_qpolynomial_one_on_domain(
4502 __isl_take isl_space *domain);
4503 __isl_give isl_qpolynomial *isl_qpolynomial_infty_on_domain(
4504 __isl_take isl_space *domain);
4505 __isl_give isl_qpolynomial *isl_qpolynomial_neginfty_on_domain(
4506 __isl_take isl_space *domain);
4507 __isl_give isl_qpolynomial *isl_qpolynomial_nan_on_domain(
4508 __isl_take isl_space *domain);
4509 __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst_on_domain(
4510 __isl_take isl_space *domain,
4511 const isl_int n, const isl_int d);
4512 __isl_give isl_qpolynomial *isl_qpolynomial_var_on_domain(
4513 __isl_take isl_space *domain,
4514 enum isl_dim_type type, unsigned pos);
4515 __isl_give isl_qpolynomial *isl_qpolynomial_from_aff(
4516 __isl_take isl_aff *aff);
4518 Note that the space in which a quasipolynomial lives is a map space
4519 with a one-dimensional range. The C<domain> argument in some of
4520 the functions above corresponds to the domain of this map space.
4522 The zero piecewise quasipolynomial or a piecewise quasipolynomial
4523 with a single cell can be created using the following functions.
4524 Multiple of these single cell piecewise quasipolynomials can
4525 be combined to create more complicated piecewise quasipolynomials.
4527 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
4528 __isl_take isl_space *space);
4529 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
4530 __isl_take isl_set *set,
4531 __isl_take isl_qpolynomial *qp);
4532 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_qpolynomial(
4533 __isl_take isl_qpolynomial *qp);
4534 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_from_pw_aff(
4535 __isl_take isl_pw_aff *pwaff);
4537 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_zero(
4538 __isl_take isl_space *space);
4539 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_from_pw_qpolynomial(
4540 __isl_take isl_pw_qpolynomial *pwqp);
4541 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add_pw_qpolynomial(
4542 __isl_take isl_union_pw_qpolynomial *upwqp,
4543 __isl_take isl_pw_qpolynomial *pwqp);
4545 Quasipolynomials can be copied and freed again using the following
4548 __isl_give isl_qpolynomial *isl_qpolynomial_copy(
4549 __isl_keep isl_qpolynomial *qp);
4550 void *isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
4552 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
4553 __isl_keep isl_pw_qpolynomial *pwqp);
4554 void *isl_pw_qpolynomial_free(
4555 __isl_take isl_pw_qpolynomial *pwqp);
4557 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_copy(
4558 __isl_keep isl_union_pw_qpolynomial *upwqp);
4559 void *isl_union_pw_qpolynomial_free(
4560 __isl_take isl_union_pw_qpolynomial *upwqp);
4562 =head3 Inspecting (Piecewise) Quasipolynomials
4564 To iterate over all piecewise quasipolynomials in a union
4565 piecewise quasipolynomial, use the following function
4567 int isl_union_pw_qpolynomial_foreach_pw_qpolynomial(
4568 __isl_keep isl_union_pw_qpolynomial *upwqp,
4569 int (*fn)(__isl_take isl_pw_qpolynomial *pwqp, void *user),
4572 To extract the piecewise quasipolynomial in a given space from a union, use
4574 __isl_give isl_pw_qpolynomial *
4575 isl_union_pw_qpolynomial_extract_pw_qpolynomial(
4576 __isl_keep isl_union_pw_qpolynomial *upwqp,
4577 __isl_take isl_space *space);
4579 To iterate over the cells in a piecewise quasipolynomial,
4580 use either of the following two functions
4582 int isl_pw_qpolynomial_foreach_piece(
4583 __isl_keep isl_pw_qpolynomial *pwqp,
4584 int (*fn)(__isl_take isl_set *set,
4585 __isl_take isl_qpolynomial *qp,
4586 void *user), void *user);
4587 int isl_pw_qpolynomial_foreach_lifted_piece(
4588 __isl_keep isl_pw_qpolynomial *pwqp,
4589 int (*fn)(__isl_take isl_set *set,
4590 __isl_take isl_qpolynomial *qp,
4591 void *user), void *user);
4593 As usual, the function C<fn> should return C<0> on success
4594 and C<-1> on failure. The difference between
4595 C<isl_pw_qpolynomial_foreach_piece> and
4596 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
4597 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
4598 compute unique representations for all existentially quantified
4599 variables and then turn these existentially quantified variables
4600 into extra set variables, adapting the associated quasipolynomial
4601 accordingly. This means that the C<set> passed to C<fn>
4602 will not have any existentially quantified variables, but that
4603 the dimensions of the sets may be different for different
4604 invocations of C<fn>.
4606 To iterate over all terms in a quasipolynomial,
4609 int isl_qpolynomial_foreach_term(
4610 __isl_keep isl_qpolynomial *qp,
4611 int (*fn)(__isl_take isl_term *term,
4612 void *user), void *user);
4614 The terms themselves can be inspected and freed using
4617 unsigned isl_term_dim(__isl_keep isl_term *term,
4618 enum isl_dim_type type);
4619 void isl_term_get_num(__isl_keep isl_term *term,
4621 void isl_term_get_den(__isl_keep isl_term *term,
4623 int isl_term_get_exp(__isl_keep isl_term *term,
4624 enum isl_dim_type type, unsigned pos);
4625 __isl_give isl_aff *isl_term_get_div(
4626 __isl_keep isl_term *term, unsigned pos);
4627 void isl_term_free(__isl_take isl_term *term);
4629 Each term is a product of parameters, set variables and
4630 integer divisions. The function C<isl_term_get_exp>
4631 returns the exponent of a given dimensions in the given term.
4632 The C<isl_int>s in the arguments of C<isl_term_get_num>
4633 and C<isl_term_get_den> need to have been initialized
4634 using C<isl_int_init> before calling these functions.
4636 =head3 Properties of (Piecewise) Quasipolynomials
4638 To check whether a quasipolynomial is actually a constant,
4639 use the following function.
4641 int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
4642 isl_int *n, isl_int *d);
4644 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
4645 then the numerator and denominator of the constant
4646 are returned in C<*n> and C<*d>, respectively.
4648 To check whether two union piecewise quasipolynomials are
4649 obviously equal, use
4651 int isl_union_pw_qpolynomial_plain_is_equal(
4652 __isl_keep isl_union_pw_qpolynomial *upwqp1,
4653 __isl_keep isl_union_pw_qpolynomial *upwqp2);
4655 =head3 Operations on (Piecewise) Quasipolynomials
4657 __isl_give isl_qpolynomial *isl_qpolynomial_scale(
4658 __isl_take isl_qpolynomial *qp, isl_int v);
4659 __isl_give isl_qpolynomial *isl_qpolynomial_neg(
4660 __isl_take isl_qpolynomial *qp);
4661 __isl_give isl_qpolynomial *isl_qpolynomial_add(
4662 __isl_take isl_qpolynomial *qp1,
4663 __isl_take isl_qpolynomial *qp2);
4664 __isl_give isl_qpolynomial *isl_qpolynomial_sub(
4665 __isl_take isl_qpolynomial *qp1,
4666 __isl_take isl_qpolynomial *qp2);
4667 __isl_give isl_qpolynomial *isl_qpolynomial_mul(
4668 __isl_take isl_qpolynomial *qp1,
4669 __isl_take isl_qpolynomial *qp2);
4670 __isl_give isl_qpolynomial *isl_qpolynomial_pow(
4671 __isl_take isl_qpolynomial *qp, unsigned exponent);
4673 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
4674 __isl_take isl_pw_qpolynomial *pwqp1,
4675 __isl_take isl_pw_qpolynomial *pwqp2);
4676 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
4677 __isl_take isl_pw_qpolynomial *pwqp1,
4678 __isl_take isl_pw_qpolynomial *pwqp2);
4679 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
4680 __isl_take isl_pw_qpolynomial *pwqp1,
4681 __isl_take isl_pw_qpolynomial *pwqp2);
4682 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
4683 __isl_take isl_pw_qpolynomial *pwqp);
4684 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
4685 __isl_take isl_pw_qpolynomial *pwqp1,
4686 __isl_take isl_pw_qpolynomial *pwqp2);
4687 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_pow(
4688 __isl_take isl_pw_qpolynomial *pwqp, unsigned exponent);
4690 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_add(
4691 __isl_take isl_union_pw_qpolynomial *upwqp1,
4692 __isl_take isl_union_pw_qpolynomial *upwqp2);
4693 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_sub(
4694 __isl_take isl_union_pw_qpolynomial *upwqp1,
4695 __isl_take isl_union_pw_qpolynomial *upwqp2);
4696 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_mul(
4697 __isl_take isl_union_pw_qpolynomial *upwqp1,
4698 __isl_take isl_union_pw_qpolynomial *upwqp2);
4700 __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
4701 __isl_take isl_pw_qpolynomial *pwqp,
4702 __isl_take isl_point *pnt);
4704 __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_eval(
4705 __isl_take isl_union_pw_qpolynomial *upwqp,
4706 __isl_take isl_point *pnt);
4708 __isl_give isl_set *isl_pw_qpolynomial_domain(
4709 __isl_take isl_pw_qpolynomial *pwqp);
4710 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
4711 __isl_take isl_pw_qpolynomial *pwpq,
4712 __isl_take isl_set *set);
4713 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_params(
4714 __isl_take isl_pw_qpolynomial *pwpq,
4715 __isl_take isl_set *set);
4717 __isl_give isl_union_set *isl_union_pw_qpolynomial_domain(
4718 __isl_take isl_union_pw_qpolynomial *upwqp);
4719 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_intersect_domain(
4720 __isl_take isl_union_pw_qpolynomial *upwpq,
4721 __isl_take isl_union_set *uset);
4722 __isl_give isl_union_pw_qpolynomial *
4723 isl_union_pw_qpolynomial_intersect_params(
4724 __isl_take isl_union_pw_qpolynomial *upwpq,
4725 __isl_take isl_set *set);
4727 __isl_give isl_qpolynomial *isl_qpolynomial_align_params(
4728 __isl_take isl_qpolynomial *qp,
4729 __isl_take isl_space *model);
4731 __isl_give isl_qpolynomial *isl_qpolynomial_project_domain_on_params(
4732 __isl_take isl_qpolynomial *qp);
4733 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_project_domain_on_params(
4734 __isl_take isl_pw_qpolynomial *pwqp);
4736 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_coalesce(
4737 __isl_take isl_union_pw_qpolynomial *upwqp);
4739 __isl_give isl_qpolynomial *isl_qpolynomial_gist_params(
4740 __isl_take isl_qpolynomial *qp,
4741 __isl_take isl_set *context);
4742 __isl_give isl_qpolynomial *isl_qpolynomial_gist(
4743 __isl_take isl_qpolynomial *qp,
4744 __isl_take isl_set *context);
4746 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist_params(
4747 __isl_take isl_pw_qpolynomial *pwqp,
4748 __isl_take isl_set *context);
4749 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_gist(
4750 __isl_take isl_pw_qpolynomial *pwqp,
4751 __isl_take isl_set *context);
4753 __isl_give isl_union_pw_qpolynomial *
4754 isl_union_pw_qpolynomial_gist_params(
4755 __isl_take isl_union_pw_qpolynomial *upwqp,
4756 __isl_take isl_set *context);
4757 __isl_give isl_union_pw_qpolynomial *isl_union_pw_qpolynomial_gist(
4758 __isl_take isl_union_pw_qpolynomial *upwqp,
4759 __isl_take isl_union_set *context);
4761 The gist operation applies the gist operation to each of
4762 the cells in the domain of the input piecewise quasipolynomial.
4763 The context is also exploited
4764 to simplify the quasipolynomials associated to each cell.
4766 __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_to_polynomial(
4767 __isl_take isl_pw_qpolynomial *pwqp, int sign);
4768 __isl_give isl_union_pw_qpolynomial *
4769 isl_union_pw_qpolynomial_to_polynomial(
4770 __isl_take isl_union_pw_qpolynomial *upwqp, int sign);
4772 Approximate each quasipolynomial by a polynomial. If C<sign> is positive,
4773 the polynomial will be an overapproximation. If C<sign> is negative,
4774 it will be an underapproximation. If C<sign> is zero, the approximation
4775 will lie somewhere in between.
4777 =head2 Bounds on Piecewise Quasipolynomials and Piecewise Quasipolynomial Reductions
4779 A piecewise quasipolynomial reduction is a piecewise
4780 reduction (or fold) of quasipolynomials.
4781 In particular, the reduction can be maximum or a minimum.
4782 The objects are mainly used to represent the result of
4783 an upper or lower bound on a quasipolynomial over its domain,
4784 i.e., as the result of the following function.
4786 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_bound(
4787 __isl_take isl_pw_qpolynomial *pwqp,
4788 enum isl_fold type, int *tight);
4790 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_bound(
4791 __isl_take isl_union_pw_qpolynomial *upwqp,
4792 enum isl_fold type, int *tight);
4794 The C<type> argument may be either C<isl_fold_min> or C<isl_fold_max>.
4795 If C<tight> is not C<NULL>, then C<*tight> is set to C<1>
4796 is the returned bound is known be tight, i.e., for each value
4797 of the parameters there is at least
4798 one element in the domain that reaches the bound.
4799 If the domain of C<pwqp> is not wrapping, then the bound is computed
4800 over all elements in that domain and the result has a purely parametric
4801 domain. If the domain of C<pwqp> is wrapping, then the bound is
4802 computed over the range of the wrapped relation. The domain of the
4803 wrapped relation becomes the domain of the result.
4805 A (piecewise) quasipolynomial reduction can be copied or freed using the
4806 following functions.
4808 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_copy(
4809 __isl_keep isl_qpolynomial_fold *fold);
4810 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_copy(
4811 __isl_keep isl_pw_qpolynomial_fold *pwf);
4812 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_copy(
4813 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4814 void isl_qpolynomial_fold_free(
4815 __isl_take isl_qpolynomial_fold *fold);
4816 void *isl_pw_qpolynomial_fold_free(
4817 __isl_take isl_pw_qpolynomial_fold *pwf);
4818 void *isl_union_pw_qpolynomial_fold_free(
4819 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4821 =head3 Printing Piecewise Quasipolynomial Reductions
4823 Piecewise quasipolynomial reductions can be printed
4824 using the following function.
4826 __isl_give isl_printer *isl_printer_print_pw_qpolynomial_fold(
4827 __isl_take isl_printer *p,
4828 __isl_keep isl_pw_qpolynomial_fold *pwf);
4829 __isl_give isl_printer *isl_printer_print_union_pw_qpolynomial_fold(
4830 __isl_take isl_printer *p,
4831 __isl_keep isl_union_pw_qpolynomial_fold *upwf);
4833 For C<isl_printer_print_pw_qpolynomial_fold>,
4834 output format of the printer
4835 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
4836 For C<isl_printer_print_union_pw_qpolynomial_fold>,
4837 output format of the printer
4838 needs to be set to C<ISL_FORMAT_ISL>.
4839 In case of printing in C<ISL_FORMAT_C>, the user may want
4840 to set the names of all dimensions
4842 __isl_give isl_pw_qpolynomial_fold *
4843 isl_pw_qpolynomial_fold_set_dim_name(
4844 __isl_take isl_pw_qpolynomial_fold *pwf,
4845 enum isl_dim_type type, unsigned pos,
4848 =head3 Inspecting (Piecewise) Quasipolynomial Reductions
4850 To iterate over all piecewise quasipolynomial reductions in a union
4851 piecewise quasipolynomial reduction, use the following function
4853 int isl_union_pw_qpolynomial_fold_foreach_pw_qpolynomial_fold(
4854 __isl_keep isl_union_pw_qpolynomial_fold *upwf,
4855 int (*fn)(__isl_take isl_pw_qpolynomial_fold *pwf,
4856 void *user), void *user);
4858 To iterate over the cells in a piecewise quasipolynomial reduction,
4859 use either of the following two functions
4861 int isl_pw_qpolynomial_fold_foreach_piece(
4862 __isl_keep isl_pw_qpolynomial_fold *pwf,
4863 int (*fn)(__isl_take isl_set *set,
4864 __isl_take isl_qpolynomial_fold *fold,
4865 void *user), void *user);
4866 int isl_pw_qpolynomial_fold_foreach_lifted_piece(
4867 __isl_keep isl_pw_qpolynomial_fold *pwf,
4868 int (*fn)(__isl_take isl_set *set,
4869 __isl_take isl_qpolynomial_fold *fold,
4870 void *user), void *user);
4872 See L<Inspecting (Piecewise) Quasipolynomials> for an explanation
4873 of the difference between these two functions.
4875 To iterate over all quasipolynomials in a reduction, use
4877 int isl_qpolynomial_fold_foreach_qpolynomial(
4878 __isl_keep isl_qpolynomial_fold *fold,
4879 int (*fn)(__isl_take isl_qpolynomial *qp,
4880 void *user), void *user);
4882 =head3 Properties of Piecewise Quasipolynomial Reductions
4884 To check whether two union piecewise quasipolynomial reductions are
4885 obviously equal, use
4887 int isl_union_pw_qpolynomial_fold_plain_is_equal(
4888 __isl_keep isl_union_pw_qpolynomial_fold *upwf1,
4889 __isl_keep isl_union_pw_qpolynomial_fold *upwf2);
4891 =head3 Operations on Piecewise Quasipolynomial Reductions
4893 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_scale(
4894 __isl_take isl_qpolynomial_fold *fold, isl_int v);
4896 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_add(
4897 __isl_take isl_pw_qpolynomial_fold *pwf1,
4898 __isl_take isl_pw_qpolynomial_fold *pwf2);
4900 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_fold(
4901 __isl_take isl_pw_qpolynomial_fold *pwf1,
4902 __isl_take isl_pw_qpolynomial_fold *pwf2);
4904 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_fold(
4905 __isl_take isl_union_pw_qpolynomial_fold *upwf1,
4906 __isl_take isl_union_pw_qpolynomial_fold *upwf2);
4908 __isl_give isl_qpolynomial *isl_pw_qpolynomial_fold_eval(
4909 __isl_take isl_pw_qpolynomial_fold *pwf,
4910 __isl_take isl_point *pnt);
4912 __isl_give isl_qpolynomial *isl_union_pw_qpolynomial_fold_eval(
4913 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4914 __isl_take isl_point *pnt);
4916 __isl_give isl_pw_qpolynomial_fold *
4917 isl_pw_qpolynomial_fold_intersect_params(
4918 __isl_take isl_pw_qpolynomial_fold *pwf,
4919 __isl_take isl_set *set);
4921 __isl_give isl_union_set *isl_union_pw_qpolynomial_fold_domain(
4922 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4923 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_intersect_domain(
4924 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4925 __isl_take isl_union_set *uset);
4926 __isl_give isl_union_pw_qpolynomial_fold *
4927 isl_union_pw_qpolynomial_fold_intersect_params(
4928 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4929 __isl_take isl_set *set);
4931 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_project_domain_on_params(
4932 __isl_take isl_pw_qpolynomial_fold *pwf);
4934 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_coalesce(
4935 __isl_take isl_pw_qpolynomial_fold *pwf);
4937 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_coalesce(
4938 __isl_take isl_union_pw_qpolynomial_fold *upwf);
4940 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist_params(
4941 __isl_take isl_qpolynomial_fold *fold,
4942 __isl_take isl_set *context);
4943 __isl_give isl_qpolynomial_fold *isl_qpolynomial_fold_gist(
4944 __isl_take isl_qpolynomial_fold *fold,
4945 __isl_take isl_set *context);
4947 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist(
4948 __isl_take isl_pw_qpolynomial_fold *pwf,
4949 __isl_take isl_set *context);
4950 __isl_give isl_pw_qpolynomial_fold *isl_pw_qpolynomial_fold_gist_params(
4951 __isl_take isl_pw_qpolynomial_fold *pwf,
4952 __isl_take isl_set *context);
4954 __isl_give isl_union_pw_qpolynomial_fold *isl_union_pw_qpolynomial_fold_gist(
4955 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4956 __isl_take isl_union_set *context);
4957 __isl_give isl_union_pw_qpolynomial_fold *
4958 isl_union_pw_qpolynomial_fold_gist_params(
4959 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4960 __isl_take isl_set *context);
4962 The gist operation applies the gist operation to each of
4963 the cells in the domain of the input piecewise quasipolynomial reduction.
4964 In future, the operation will also exploit the context
4965 to simplify the quasipolynomial reductions associated to each cell.
4967 __isl_give isl_pw_qpolynomial_fold *
4968 isl_set_apply_pw_qpolynomial_fold(
4969 __isl_take isl_set *set,
4970 __isl_take isl_pw_qpolynomial_fold *pwf,
4972 __isl_give isl_pw_qpolynomial_fold *
4973 isl_map_apply_pw_qpolynomial_fold(
4974 __isl_take isl_map *map,
4975 __isl_take isl_pw_qpolynomial_fold *pwf,
4977 __isl_give isl_union_pw_qpolynomial_fold *
4978 isl_union_set_apply_union_pw_qpolynomial_fold(
4979 __isl_take isl_union_set *uset,
4980 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4982 __isl_give isl_union_pw_qpolynomial_fold *
4983 isl_union_map_apply_union_pw_qpolynomial_fold(
4984 __isl_take isl_union_map *umap,
4985 __isl_take isl_union_pw_qpolynomial_fold *upwf,
4988 The functions taking a map
4989 compose the given map with the given piecewise quasipolynomial reduction.
4990 That is, compute a bound (of the same type as C<pwf> or C<upwf> itself)
4991 over all elements in the intersection of the range of the map
4992 and the domain of the piecewise quasipolynomial reduction
4993 as a function of an element in the domain of the map.
4994 The functions taking a set compute a bound over all elements in the
4995 intersection of the set and the domain of the
4996 piecewise quasipolynomial reduction.
4998 =head2 Parametric Vertex Enumeration
5000 The parametric vertex enumeration described in this section
5001 is mainly intended to be used internally and by the C<barvinok>
5004 #include <isl/vertices.h>
5005 __isl_give isl_vertices *isl_basic_set_compute_vertices(
5006 __isl_keep isl_basic_set *bset);
5008 The function C<isl_basic_set_compute_vertices> performs the
5009 actual computation of the parametric vertices and the chamber
5010 decomposition and store the result in an C<isl_vertices> object.
5011 This information can be queried by either iterating over all
5012 the vertices or iterating over all the chambers or cells
5013 and then iterating over all vertices that are active on the chamber.
5015 int isl_vertices_foreach_vertex(
5016 __isl_keep isl_vertices *vertices,
5017 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5020 int isl_vertices_foreach_cell(
5021 __isl_keep isl_vertices *vertices,
5022 int (*fn)(__isl_take isl_cell *cell, void *user),
5024 int isl_cell_foreach_vertex(__isl_keep isl_cell *cell,
5025 int (*fn)(__isl_take isl_vertex *vertex, void *user),
5028 Other operations that can be performed on an C<isl_vertices> object are
5031 isl_ctx *isl_vertices_get_ctx(
5032 __isl_keep isl_vertices *vertices);
5033 int isl_vertices_get_n_vertices(
5034 __isl_keep isl_vertices *vertices);
5035 void isl_vertices_free(__isl_take isl_vertices *vertices);
5037 Vertices can be inspected and destroyed using the following functions.
5039 isl_ctx *isl_vertex_get_ctx(__isl_keep isl_vertex *vertex);
5040 int isl_vertex_get_id(__isl_keep isl_vertex *vertex);
5041 __isl_give isl_basic_set *isl_vertex_get_domain(
5042 __isl_keep isl_vertex *vertex);
5043 __isl_give isl_basic_set *isl_vertex_get_expr(
5044 __isl_keep isl_vertex *vertex);
5045 void isl_vertex_free(__isl_take isl_vertex *vertex);
5047 C<isl_vertex_get_expr> returns a singleton parametric set describing
5048 the vertex, while C<isl_vertex_get_domain> returns the activity domain
5050 Note that C<isl_vertex_get_domain> and C<isl_vertex_get_expr> return
5051 B<rational> basic sets, so they should mainly be used for inspection
5052 and should not be mixed with integer sets.
5054 Chambers can be inspected and destroyed using the following functions.
5056 isl_ctx *isl_cell_get_ctx(__isl_keep isl_cell *cell);
5057 __isl_give isl_basic_set *isl_cell_get_domain(
5058 __isl_keep isl_cell *cell);
5059 void isl_cell_free(__isl_take isl_cell *cell);
5061 =head1 Polyhedral Compilation Library
5063 This section collects functionality in C<isl> that has been specifically
5064 designed for use during polyhedral compilation.
5066 =head2 Dependence Analysis
5068 C<isl> contains specialized functionality for performing
5069 array dataflow analysis. That is, given a I<sink> access relation
5070 and a collection of possible I<source> access relations,
5071 C<isl> can compute relations that describe
5072 for each iteration of the sink access, which iteration
5073 of which of the source access relations was the last
5074 to access the same data element before the given iteration
5076 The resulting dependence relations map source iterations
5077 to the corresponding sink iterations.
5078 To compute standard flow dependences, the sink should be
5079 a read, while the sources should be writes.
5080 If any of the source accesses are marked as being I<may>
5081 accesses, then there will be a dependence from the last
5082 I<must> access B<and> from any I<may> access that follows
5083 this last I<must> access.
5084 In particular, if I<all> sources are I<may> accesses,
5085 then memory based dependence analysis is performed.
5086 If, on the other hand, all sources are I<must> accesses,
5087 then value based dependence analysis is performed.
5089 #include <isl/flow.h>
5091 typedef int (*isl_access_level_before)(void *first, void *second);
5093 __isl_give isl_access_info *isl_access_info_alloc(
5094 __isl_take isl_map *sink,
5095 void *sink_user, isl_access_level_before fn,
5097 __isl_give isl_access_info *isl_access_info_add_source(
5098 __isl_take isl_access_info *acc,
5099 __isl_take isl_map *source, int must,
5101 void *isl_access_info_free(__isl_take isl_access_info *acc);
5103 __isl_give isl_flow *isl_access_info_compute_flow(
5104 __isl_take isl_access_info *acc);
5106 int isl_flow_foreach(__isl_keep isl_flow *deps,
5107 int (*fn)(__isl_take isl_map *dep, int must,
5108 void *dep_user, void *user),
5110 __isl_give isl_map *isl_flow_get_no_source(
5111 __isl_keep isl_flow *deps, int must);
5112 void isl_flow_free(__isl_take isl_flow *deps);
5114 The function C<isl_access_info_compute_flow> performs the actual
5115 dependence analysis. The other functions are used to construct
5116 the input for this function or to read off the output.
5118 The input is collected in an C<isl_access_info>, which can
5119 be created through a call to C<isl_access_info_alloc>.
5120 The arguments to this functions are the sink access relation
5121 C<sink>, a token C<sink_user> used to identify the sink
5122 access to the user, a callback function for specifying the
5123 relative order of source and sink accesses, and the number
5124 of source access relations that will be added.
5125 The callback function has type C<int (*)(void *first, void *second)>.
5126 The function is called with two user supplied tokens identifying
5127 either a source or the sink and it should return the shared nesting
5128 level and the relative order of the two accesses.
5129 In particular, let I<n> be the number of loops shared by
5130 the two accesses. If C<first> precedes C<second> textually,
5131 then the function should return I<2 * n + 1>; otherwise,
5132 it should return I<2 * n>.
5133 The sources can be added to the C<isl_access_info> by performing
5134 (at most) C<max_source> calls to C<isl_access_info_add_source>.
5135 C<must> indicates whether the source is a I<must> access
5136 or a I<may> access. Note that a multi-valued access relation
5137 should only be marked I<must> if every iteration in the domain
5138 of the relation accesses I<all> elements in its image.
5139 The C<source_user> token is again used to identify
5140 the source access. The range of the source access relation
5141 C<source> should have the same dimension as the range
5142 of the sink access relation.
5143 The C<isl_access_info_free> function should usually not be
5144 called explicitly, because it is called implicitly by
5145 C<isl_access_info_compute_flow>.
5147 The result of the dependence analysis is collected in an
5148 C<isl_flow>. There may be elements of
5149 the sink access for which no preceding source access could be
5150 found or for which all preceding sources are I<may> accesses.
5151 The relations containing these elements can be obtained through
5152 calls to C<isl_flow_get_no_source>, the first with C<must> set
5153 and the second with C<must> unset.
5154 In the case of standard flow dependence analysis,
5155 with the sink a read and the sources I<must> writes,
5156 the first relation corresponds to the reads from uninitialized
5157 array elements and the second relation is empty.
5158 The actual flow dependences can be extracted using
5159 C<isl_flow_foreach>. This function will call the user-specified
5160 callback function C<fn> for each B<non-empty> dependence between
5161 a source and the sink. The callback function is called
5162 with four arguments, the actual flow dependence relation
5163 mapping source iterations to sink iterations, a boolean that
5164 indicates whether it is a I<must> or I<may> dependence, a token
5165 identifying the source and an additional C<void *> with value
5166 equal to the third argument of the C<isl_flow_foreach> call.
5167 A dependence is marked I<must> if it originates from a I<must>
5168 source and if it is not followed by any I<may> sources.
5170 After finishing with an C<isl_flow>, the user should call
5171 C<isl_flow_free> to free all associated memory.
5173 A higher-level interface to dependence analysis is provided
5174 by the following function.
5176 #include <isl/flow.h>
5178 int isl_union_map_compute_flow(__isl_take isl_union_map *sink,
5179 __isl_take isl_union_map *must_source,
5180 __isl_take isl_union_map *may_source,
5181 __isl_take isl_union_map *schedule,
5182 __isl_give isl_union_map **must_dep,
5183 __isl_give isl_union_map **may_dep,
5184 __isl_give isl_union_map **must_no_source,
5185 __isl_give isl_union_map **may_no_source);
5187 The arrays are identified by the tuple names of the ranges
5188 of the accesses. The iteration domains by the tuple names
5189 of the domains of the accesses and of the schedule.
5190 The relative order of the iteration domains is given by the
5191 schedule. The relations returned through C<must_no_source>
5192 and C<may_no_source> are subsets of C<sink>.
5193 Any of C<must_dep>, C<may_dep>, C<must_no_source>
5194 or C<may_no_source> may be C<NULL>, but a C<NULL> value for
5195 any of the other arguments is treated as an error.
5197 =head3 Interaction with Dependence Analysis
5199 During the dependence analysis, we frequently need to perform
5200 the following operation. Given a relation between sink iterations
5201 and potential source iterations from a particular source domain,
5202 what is the last potential source iteration corresponding to each
5203 sink iteration. It can sometimes be convenient to adjust
5204 the set of potential source iterations before or after each such operation.
5205 The prototypical example is fuzzy array dataflow analysis,
5206 where we need to analyze if, based on data-dependent constraints,
5207 the sink iteration can ever be executed without one or more of
5208 the corresponding potential source iterations being executed.
5209 If so, we can introduce extra parameters and select an unknown
5210 but fixed source iteration from the potential source iterations.
5211 To be able to perform such manipulations, C<isl> provides the following
5214 #include <isl/flow.h>
5216 typedef __isl_give isl_restriction *(*isl_access_restrict)(
5217 __isl_keep isl_map *source_map,
5218 __isl_keep isl_set *sink, void *source_user,
5220 __isl_give isl_access_info *isl_access_info_set_restrict(
5221 __isl_take isl_access_info *acc,
5222 isl_access_restrict fn, void *user);
5224 The function C<isl_access_info_set_restrict> should be called
5225 before calling C<isl_access_info_compute_flow> and registers a callback function
5226 that will be called any time C<isl> is about to compute the last
5227 potential source. The first argument is the (reverse) proto-dependence,
5228 mapping sink iterations to potential source iterations.
5229 The second argument represents the sink iterations for which
5230 we want to compute the last source iteration.
5231 The third argument is the token corresponding to the source
5232 and the final argument is the token passed to C<isl_access_info_set_restrict>.
5233 The callback is expected to return a restriction on either the input or
5234 the output of the operation computing the last potential source.
5235 If the input needs to be restricted then restrictions are needed
5236 for both the source and the sink iterations. The sink iterations
5237 and the potential source iterations will be intersected with these sets.
5238 If the output needs to be restricted then only a restriction on the source
5239 iterations is required.
5240 If any error occurs, the callback should return C<NULL>.
5241 An C<isl_restriction> object can be created, freed and inspected
5242 using the following functions.
5244 #include <isl/flow.h>
5246 __isl_give isl_restriction *isl_restriction_input(
5247 __isl_take isl_set *source_restr,
5248 __isl_take isl_set *sink_restr);
5249 __isl_give isl_restriction *isl_restriction_output(
5250 __isl_take isl_set *source_restr);
5251 __isl_give isl_restriction *isl_restriction_none(
5252 __isl_take isl_map *source_map);
5253 __isl_give isl_restriction *isl_restriction_empty(
5254 __isl_take isl_map *source_map);
5255 void *isl_restriction_free(
5256 __isl_take isl_restriction *restr);
5257 isl_ctx *isl_restriction_get_ctx(
5258 __isl_keep isl_restriction *restr);
5260 C<isl_restriction_none> and C<isl_restriction_empty> are special
5261 cases of C<isl_restriction_input>. C<isl_restriction_none>
5262 is essentially equivalent to
5264 isl_restriction_input(isl_set_universe(
5265 isl_space_range(isl_map_get_space(source_map))),
5267 isl_space_domain(isl_map_get_space(source_map))));
5269 whereas C<isl_restriction_empty> is essentially equivalent to
5271 isl_restriction_input(isl_set_empty(
5272 isl_space_range(isl_map_get_space(source_map))),
5274 isl_space_domain(isl_map_get_space(source_map))));
5278 B<The functionality described in this section is fairly new
5279 and may be subject to change.>
5281 The following function can be used to compute a schedule
5282 for a union of domains.
5283 By default, the algorithm used to construct the schedule is similar
5284 to that of C<Pluto>.
5285 Alternatively, Feautrier's multi-dimensional scheduling algorithm can
5287 The generated schedule respects all C<validity> dependences.
5288 That is, all dependence distances over these dependences in the
5289 scheduled space are lexicographically positive.
5290 The default algorithm tries to minimize the dependence distances over
5291 C<proximity> dependences.
5292 Moreover, it tries to obtain sequences (bands) of schedule dimensions
5293 for groups of domains where the dependence distances have only
5294 non-negative values.
5295 When using Feautrier's algorithm, the C<proximity> dependence
5296 distances are only minimized during the extension to a
5297 full-dimensional schedule.
5299 #include <isl/schedule.h>
5300 __isl_give isl_schedule *isl_union_set_compute_schedule(
5301 __isl_take isl_union_set *domain,
5302 __isl_take isl_union_map *validity,
5303 __isl_take isl_union_map *proximity);
5304 void *isl_schedule_free(__isl_take isl_schedule *sched);
5306 A mapping from the domains to the scheduled space can be obtained
5307 from an C<isl_schedule> using the following function.
5309 __isl_give isl_union_map *isl_schedule_get_map(
5310 __isl_keep isl_schedule *sched);
5312 A representation of the schedule can be printed using
5314 __isl_give isl_printer *isl_printer_print_schedule(
5315 __isl_take isl_printer *p,
5316 __isl_keep isl_schedule *schedule);
5318 A representation of the schedule as a forest of bands can be obtained
5319 using the following function.
5321 __isl_give isl_band_list *isl_schedule_get_band_forest(
5322 __isl_keep isl_schedule *schedule);
5324 The individual bands can be visited in depth-first post-order
5325 using the following function.
5327 #include <isl/schedule.h>
5328 int isl_schedule_foreach_band(
5329 __isl_keep isl_schedule *sched,
5330 int (*fn)(__isl_keep isl_band *band, void *user),
5333 The list can be manipulated as explained in L<"Lists">.
5334 The bands inside the list can be copied and freed using the following
5337 #include <isl/band.h>
5338 __isl_give isl_band *isl_band_copy(
5339 __isl_keep isl_band *band);
5340 void *isl_band_free(__isl_take isl_band *band);
5342 Each band contains zero or more scheduling dimensions.
5343 These are referred to as the members of the band.
5344 The section of the schedule that corresponds to the band is
5345 referred to as the partial schedule of the band.
5346 For those nodes that participate in a band, the outer scheduling
5347 dimensions form the prefix schedule, while the inner scheduling
5348 dimensions form the suffix schedule.
5349 That is, if we take a cut of the band forest, then the union of
5350 the concatenations of the prefix, partial and suffix schedules of
5351 each band in the cut is equal to the entire schedule (modulo
5352 some possible padding at the end with zero scheduling dimensions).
5353 The properties of a band can be inspected using the following functions.
5355 #include <isl/band.h>
5356 isl_ctx *isl_band_get_ctx(__isl_keep isl_band *band);
5358 int isl_band_has_children(__isl_keep isl_band *band);
5359 __isl_give isl_band_list *isl_band_get_children(
5360 __isl_keep isl_band *band);
5362 __isl_give isl_union_map *isl_band_get_prefix_schedule(
5363 __isl_keep isl_band *band);
5364 __isl_give isl_union_map *isl_band_get_partial_schedule(
5365 __isl_keep isl_band *band);
5366 __isl_give isl_union_map *isl_band_get_suffix_schedule(
5367 __isl_keep isl_band *band);
5369 int isl_band_n_member(__isl_keep isl_band *band);
5370 int isl_band_member_is_zero_distance(
5371 __isl_keep isl_band *band, int pos);
5373 int isl_band_list_foreach_band(
5374 __isl_keep isl_band_list *list,
5375 int (*fn)(__isl_keep isl_band *band, void *user),
5378 Note that a scheduling dimension is considered to be ``zero
5379 distance'' if it does not carry any proximity dependences
5381 That is, if the dependence distances of the proximity
5382 dependences are all zero in that direction (for fixed
5383 iterations of outer bands).
5384 Like C<isl_schedule_foreach_band>,
5385 the function C<isl_band_list_foreach_band> calls C<fn> on the bands
5386 in depth-first post-order.
5388 A band can be tiled using the following function.
5390 #include <isl/band.h>
5391 int isl_band_tile(__isl_keep isl_band *band,
5392 __isl_take isl_vec *sizes);
5394 int isl_options_set_tile_scale_tile_loops(isl_ctx *ctx,
5396 int isl_options_get_tile_scale_tile_loops(isl_ctx *ctx);
5397 int isl_options_set_tile_shift_point_loops(isl_ctx *ctx,
5399 int isl_options_get_tile_shift_point_loops(isl_ctx *ctx);
5401 The C<isl_band_tile> function tiles the band using the given tile sizes
5402 inside its schedule.
5403 A new child band is created to represent the point loops and it is
5404 inserted between the modified band and its children.
5405 The C<tile_scale_tile_loops> option specifies whether the tile
5406 loops iterators should be scaled by the tile sizes.
5407 If the C<tile_shift_point_loops> option is set, then the point loops
5408 are shifted to start at zero.
5410 A band can be split into two nested bands using the following function.
5412 int isl_band_split(__isl_keep isl_band *band, int pos);
5414 The resulting outer band contains the first C<pos> dimensions of C<band>
5415 while the inner band contains the remaining dimensions.
5417 A representation of the band can be printed using
5419 #include <isl/band.h>
5420 __isl_give isl_printer *isl_printer_print_band(
5421 __isl_take isl_printer *p,
5422 __isl_keep isl_band *band);
5426 #include <isl/schedule.h>
5427 int isl_options_set_schedule_max_coefficient(
5428 isl_ctx *ctx, int val);
5429 int isl_options_get_schedule_max_coefficient(
5431 int isl_options_set_schedule_max_constant_term(
5432 isl_ctx *ctx, int val);
5433 int isl_options_get_schedule_max_constant_term(
5435 int isl_options_set_schedule_fuse(isl_ctx *ctx, int val);
5436 int isl_options_get_schedule_fuse(isl_ctx *ctx);
5437 int isl_options_set_schedule_maximize_band_depth(
5438 isl_ctx *ctx, int val);
5439 int isl_options_get_schedule_maximize_band_depth(
5441 int isl_options_set_schedule_outer_zero_distance(
5442 isl_ctx *ctx, int val);
5443 int isl_options_get_schedule_outer_zero_distance(
5445 int isl_options_set_schedule_split_scaled(
5446 isl_ctx *ctx, int val);
5447 int isl_options_get_schedule_split_scaled(
5449 int isl_options_set_schedule_algorithm(
5450 isl_ctx *ctx, int val);
5451 int isl_options_get_schedule_algorithm(
5453 int isl_options_set_schedule_separate_components(
5454 isl_ctx *ctx, int val);
5455 int isl_options_get_schedule_separate_components(
5460 =item * schedule_max_coefficient
5462 This option enforces that the coefficients for variable and parameter
5463 dimensions in the calculated schedule are not larger than the specified value.
5464 This option can significantly increase the speed of the scheduling calculation
5465 and may also prevent fusing of unrelated dimensions. A value of -1 means that
5466 this option does not introduce bounds on the variable or parameter
5469 =item * schedule_max_constant_term
5471 This option enforces that the constant coefficients in the calculated schedule
5472 are not larger than the maximal constant term. This option can significantly
5473 increase the speed of the scheduling calculation and may also prevent fusing of
5474 unrelated dimensions. A value of -1 means that this option does not introduce
5475 bounds on the constant coefficients.
5477 =item * schedule_fuse
5479 This option controls the level of fusion.
5480 If this option is set to C<ISL_SCHEDULE_FUSE_MIN>, then loops in the
5481 resulting schedule will be distributed as much as possible.
5482 If this option is set to C<ISL_SCHEDULE_FUSE_MAX>, then C<isl> will
5483 try to fuse loops in the resulting schedule.
5485 =item * schedule_maximize_band_depth
5487 If this option is set, we do not split bands at the point
5488 where we detect splitting is necessary. Instead, we
5489 backtrack and split bands as early as possible. This
5490 reduces the number of splits and maximizes the width of
5491 the bands. Wider bands give more possibilities for tiling.
5492 Note that if the C<schedule_fuse> option is set to C<ISL_SCHEDULE_FUSE_MIN>,
5493 then bands will be split as early as possible, even if there is no need.
5494 The C<schedule_maximize_band_depth> option therefore has no effect in this case.
5496 =item * schedule_outer_zero_distance
5498 If this option is set, then we try to construct schedules
5499 where the outermost scheduling dimension in each band
5500 results in a zero dependence distance over the proximity
5503 =item * schedule_split_scaled
5505 If this option is set, then we try to construct schedules in which the
5506 constant term is split off from the linear part if the linear parts of
5507 the scheduling rows for all nodes in the graphs have a common non-trivial
5509 The constant term is then placed in a separate band and the linear
5512 =item * schedule_algorithm
5514 Selects the scheduling algorithm to be used.
5515 Available scheduling algorithms are C<ISL_SCHEDULE_ALGORITHM_ISL>
5516 and C<ISL_SCHEDULE_ALGORITHM_FEAUTRIER>.
5518 =item * schedule_separate_components
5520 If at any point the dependence graph contains any (weakly connected) components,
5521 then these components are scheduled separately.
5522 If this option is not set, then some iterations of the domains
5523 in these components may be scheduled together.
5524 If this option is set, then the components are given consecutive
5529 =head2 AST Generation
5531 This section describes the C<isl> functionality for generating
5532 ASTs that visit all the elements
5533 in a domain in an order specified by a schedule.
5534 In particular, given a C<isl_union_map>, an AST is generated
5535 that visits all the elements in the domain of the C<isl_union_map>
5536 according to the lexicographic order of the corresponding image
5537 element(s). If the range of the C<isl_union_map> consists of
5538 elements in more than one space, then each of these spaces is handled
5539 separately in an arbitrary order.
5540 It should be noted that the image elements only specify the I<order>
5541 in which the corresponding domain elements should be visited.
5542 No direct relation between the image elements and the loop iterators
5543 in the generated AST should be assumed.
5545 Each AST is generated within a build. The initial build
5546 simply specifies the constraints on the parameters (if any)
5547 and can be created, inspected, copied and freed using the following functions.
5549 #include <isl/ast_build.h>
5550 __isl_give isl_ast_build *isl_ast_build_from_context(
5551 __isl_take isl_set *set);
5552 isl_ctx *isl_ast_build_get_ctx(
5553 __isl_keep isl_ast_build *build);
5554 __isl_give isl_ast_build *isl_ast_build_copy(
5555 __isl_keep isl_ast_build *build);
5556 void *isl_ast_build_free(
5557 __isl_take isl_ast_build *build);
5559 The C<set> argument is usually a parameter set with zero or more parameters.
5560 More C<isl_ast_build> functions are described in L</"Nested AST Generation">
5561 and L</"Fine-grained Control over AST Generation">.
5562 Finally, the AST itself can be constructed using the following
5565 #include <isl/ast_build.h>
5566 __isl_give isl_ast_node *isl_ast_build_ast_from_schedule(
5567 __isl_keep isl_ast_build *build,
5568 __isl_take isl_union_map *schedule);
5570 =head3 Inspecting the AST
5572 The basic properties of an AST node can be obtained as follows.
5574 #include <isl/ast.h>
5575 isl_ctx *isl_ast_node_get_ctx(
5576 __isl_keep isl_ast_node *node);
5577 enum isl_ast_node_type isl_ast_node_get_type(
5578 __isl_keep isl_ast_node *node);
5580 The type of an AST node is one of
5581 C<isl_ast_node_for>,
5583 C<isl_ast_node_block> or
5584 C<isl_ast_node_user>.
5585 An C<isl_ast_node_for> represents a for node.
5586 An C<isl_ast_node_if> represents an if node.
5587 An C<isl_ast_node_block> represents a compound node.
5588 An C<isl_ast_node_user> represents an expression statement.
5589 An expression statement typically corresponds to a domain element, i.e.,
5590 one of the elements that is visited by the AST.
5592 Each type of node has its own additional properties.
5594 #include <isl/ast.h>
5595 __isl_give isl_ast_expr *isl_ast_node_for_get_iterator(
5596 __isl_keep isl_ast_node *node);
5597 __isl_give isl_ast_expr *isl_ast_node_for_get_init(
5598 __isl_keep isl_ast_node *node);
5599 __isl_give isl_ast_expr *isl_ast_node_for_get_cond(
5600 __isl_keep isl_ast_node *node);
5601 __isl_give isl_ast_expr *isl_ast_node_for_get_inc(
5602 __isl_keep isl_ast_node *node);
5603 __isl_give isl_ast_node *isl_ast_node_for_get_body(
5604 __isl_keep isl_ast_node *node);
5605 int isl_ast_node_for_is_degenerate(
5606 __isl_keep isl_ast_node *node);
5608 An C<isl_ast_for> is considered degenerate if it is known to execute
5611 #include <isl/ast.h>
5612 __isl_give isl_ast_expr *isl_ast_node_if_get_cond(
5613 __isl_keep isl_ast_node *node);
5614 __isl_give isl_ast_node *isl_ast_node_if_get_then(
5615 __isl_keep isl_ast_node *node);
5616 int isl_ast_node_if_has_else(
5617 __isl_keep isl_ast_node *node);
5618 __isl_give isl_ast_node *isl_ast_node_if_get_else(
5619 __isl_keep isl_ast_node *node);
5621 __isl_give isl_ast_node_list *
5622 isl_ast_node_block_get_children(
5623 __isl_keep isl_ast_node *node);
5625 __isl_give isl_ast_expr *isl_ast_node_user_get_expr(
5626 __isl_keep isl_ast_node *node);
5628 Each of the returned C<isl_ast_expr>s can in turn be inspected using
5629 the following functions.
5631 #include <isl/ast.h>
5632 isl_ctx *isl_ast_expr_get_ctx(
5633 __isl_keep isl_ast_expr *expr);
5634 enum isl_ast_expr_type isl_ast_expr_get_type(
5635 __isl_keep isl_ast_expr *expr);
5637 The type of an AST expression is one of
5639 C<isl_ast_expr_id> or
5640 C<isl_ast_expr_int>.
5641 An C<isl_ast_expr_op> represents the result of an operation.
5642 An C<isl_ast_expr_id> represents an identifier.
5643 An C<isl_ast_expr_int> represents an integer value.
5645 Each type of expression has its own additional properties.
5647 #include <isl/ast.h>
5648 enum isl_ast_op_type isl_ast_expr_get_op_type(
5649 __isl_keep isl_ast_expr *expr);
5650 int isl_ast_expr_get_op_n_arg(__isl_keep isl_ast_expr *expr);
5651 __isl_give isl_ast_expr *isl_ast_expr_get_op_arg(
5652 __isl_keep isl_ast_expr *expr, int pos);
5653 int isl_ast_node_foreach_ast_op_type(
5654 __isl_keep isl_ast_node *node,
5655 int (*fn)(enum isl_ast_op_type type, void *user),
5658 C<isl_ast_expr_get_op_type> returns the type of the operation
5659 performed. C<isl_ast_expr_get_op_n_arg> returns the number of
5660 arguments. C<isl_ast_expr_get_op_arg> returns the specified
5662 C<isl_ast_node_foreach_ast_op_type> calls C<fn> for each distinct
5663 C<isl_ast_op_type> that appears in C<node>.
5664 The operation type is one of the following.
5668 =item C<isl_ast_op_and>
5670 Logical I<and> of two arguments.
5671 Both arguments can be evaluated.
5673 =item C<isl_ast_op_and_then>
5675 Logical I<and> of two arguments.
5676 The second argument can only be evaluated if the first evaluates to true.
5678 =item C<isl_ast_op_or>
5680 Logical I<or> of two arguments.
5681 Both arguments can be evaluated.
5683 =item C<isl_ast_op_or_else>
5685 Logical I<or> of two arguments.
5686 The second argument can only be evaluated if the first evaluates to false.
5688 =item C<isl_ast_op_max>
5690 Maximum of two or more arguments.
5692 =item C<isl_ast_op_min>
5694 Minimum of two or more arguments.
5696 =item C<isl_ast_op_minus>
5700 =item C<isl_ast_op_add>
5702 Sum of two arguments.
5704 =item C<isl_ast_op_sub>
5706 Difference of two arguments.
5708 =item C<isl_ast_op_mul>
5710 Product of two arguments.
5712 =item C<isl_ast_op_div>
5714 Exact division. That is, the result is known to be an integer.
5716 =item C<isl_ast_op_fdiv_q>
5718 Result of integer division, rounded towards negative
5721 =item C<isl_ast_op_pdiv_q>
5723 Result of integer division, where dividend is known to be non-negative.
5725 =item C<isl_ast_op_pdiv_r>
5727 Remainder of integer division, where dividend is known to be non-negative.
5729 =item C<isl_ast_op_cond>
5731 Conditional operator defined on three arguments.
5732 If the first argument evaluates to true, then the result
5733 is equal to the second argument. Otherwise, the result
5734 is equal to the third argument.
5735 The second and third argument may only be evaluated if
5736 the first argument evaluates to true and false, respectively.
5737 Corresponds to C<a ? b : c> in C.
5739 =item C<isl_ast_op_select>
5741 Conditional operator defined on three arguments.
5742 If the first argument evaluates to true, then the result
5743 is equal to the second argument. Otherwise, the result
5744 is equal to the third argument.
5745 The second and third argument may be evaluated independently
5746 of the value of the first argument.
5747 Corresponds to C<a * b + (1 - a) * c> in C.
5749 =item C<isl_ast_op_eq>
5753 =item C<isl_ast_op_le>
5755 Less than or equal relation.
5757 =item C<isl_ast_op_lt>
5761 =item C<isl_ast_op_ge>
5763 Greater than or equal relation.
5765 =item C<isl_ast_op_gt>
5767 Greater than relation.
5769 =item C<isl_ast_op_call>
5772 The number of arguments of the C<isl_ast_expr> is one more than
5773 the number of arguments in the function call, the first argument
5774 representing the function being called.
5778 #include <isl/ast.h>
5779 __isl_give isl_id *isl_ast_expr_get_id(
5780 __isl_keep isl_ast_expr *expr);
5782 Return the identifier represented by the AST expression.
5784 #include <isl/ast.h>
5785 int isl_ast_expr_get_int(__isl_keep isl_ast_expr *expr,
5788 Return the integer represented by the AST expression.
5789 Note that the integer is returned through the C<v> argument.
5790 The return value of the function itself indicates whether the
5791 operation was performed successfully.
5793 =head3 Manipulating and printing the AST
5795 AST nodes can be copied and freed using the following functions.
5797 #include <isl/ast.h>
5798 __isl_give isl_ast_node *isl_ast_node_copy(
5799 __isl_keep isl_ast_node *node);
5800 void *isl_ast_node_free(__isl_take isl_ast_node *node);
5802 AST expressions can be copied and freed using the following functions.
5804 #include <isl/ast.h>
5805 __isl_give isl_ast_expr *isl_ast_expr_copy(
5806 __isl_keep isl_ast_expr *expr);
5807 void *isl_ast_expr_free(__isl_take isl_ast_expr *expr);
5809 New AST expressions can be created either directly or within
5810 the context of an C<isl_ast_build>.
5812 #include <isl/ast.h>
5813 __isl_give isl_ast_expr *isl_ast_expr_from_id(
5814 __isl_take isl_id *id);
5815 __isl_give isl_ast_expr *isl_ast_expr_neg(
5816 __isl_take isl_ast_expr *expr);
5817 __isl_give isl_ast_expr *isl_ast_expr_add(
5818 __isl_take isl_ast_expr *expr1,
5819 __isl_take isl_ast_expr *expr2);
5820 __isl_give isl_ast_expr *isl_ast_expr_sub(
5821 __isl_take isl_ast_expr *expr1,
5822 __isl_take isl_ast_expr *expr2);
5823 __isl_give isl_ast_expr *isl_ast_expr_mul(
5824 __isl_take isl_ast_expr *expr1,
5825 __isl_take isl_ast_expr *expr2);
5826 __isl_give isl_ast_expr *isl_ast_expr_div(
5827 __isl_take isl_ast_expr *expr1,
5828 __isl_take isl_ast_expr *expr2);
5829 __isl_give isl_ast_expr *isl_ast_expr_and(
5830 __isl_take isl_ast_expr *expr1,
5831 __isl_take isl_ast_expr *expr2)
5832 __isl_give isl_ast_expr *isl_ast_expr_or(
5833 __isl_take isl_ast_expr *expr1,
5834 __isl_take isl_ast_expr *expr2)
5836 #include <isl/ast_build.h>
5837 __isl_give isl_ast_expr *isl_ast_build_expr_from_pw_aff(
5838 __isl_keep isl_ast_build *build,
5839 __isl_take isl_pw_aff *pa);
5840 __isl_give isl_ast_expr *
5841 isl_ast_build_call_from_pw_multi_aff(
5842 __isl_keep isl_ast_build *build,
5843 __isl_take isl_pw_multi_aff *pma);
5845 The domains of C<pa> and C<pma> should correspond
5846 to the schedule space of C<build>.
5847 The tuple id of C<pma> is used as the function being called.
5849 User specified data can be attached to an C<isl_ast_node> and obtained
5850 from the same C<isl_ast_node> using the following functions.
5852 #include <isl/ast.h>
5853 __isl_give isl_ast_node *isl_ast_node_set_annotation(
5854 __isl_take isl_ast_node *node,
5855 __isl_take isl_id *annotation);
5856 __isl_give isl_id *isl_ast_node_get_annotation(
5857 __isl_keep isl_ast_node *node);
5859 Basic printing can be performed using the following functions.
5861 #include <isl/ast.h>
5862 __isl_give isl_printer *isl_printer_print_ast_expr(
5863 __isl_take isl_printer *p,
5864 __isl_keep isl_ast_expr *expr);
5865 __isl_give isl_printer *isl_printer_print_ast_node(
5866 __isl_take isl_printer *p,
5867 __isl_keep isl_ast_node *node);
5869 More advanced printing can be performed using the following functions.
5871 #include <isl/ast.h>
5872 __isl_give isl_printer *isl_ast_op_type_print_macro(
5873 enum isl_ast_op_type type,
5874 __isl_take isl_printer *p);
5875 __isl_give isl_printer *isl_ast_node_print_macros(
5876 __isl_keep isl_ast_node *node,
5877 __isl_take isl_printer *p);
5878 __isl_give isl_printer *isl_ast_node_print(
5879 __isl_keep isl_ast_node *node,
5880 __isl_take isl_printer *p,
5881 __isl_take isl_ast_print_options *options);
5882 __isl_give isl_printer *isl_ast_node_for_print(
5883 __isl_keep isl_ast_node *node,
5884 __isl_take isl_printer *p,
5885 __isl_take isl_ast_print_options *options);
5886 __isl_give isl_printer *isl_ast_node_if_print(
5887 __isl_keep isl_ast_node *node,
5888 __isl_take isl_printer *p,
5889 __isl_take isl_ast_print_options *options);
5891 While printing an C<isl_ast_node> in C<ISL_FORMAT_C>,
5892 C<isl> may print out an AST that makes use of macros such
5893 as C<floord>, C<min> and C<max>.
5894 C<isl_ast_op_type_print_macro> prints out the macro
5895 corresponding to a specific C<isl_ast_op_type>.
5896 C<isl_ast_node_print_macros> scans the C<isl_ast_node>
5897 for expressions where these macros would be used and prints
5898 out the required macro definitions.
5899 Essentially, C<isl_ast_node_print_macros> calls
5900 C<isl_ast_node_foreach_ast_op_type> with C<isl_ast_op_type_print_macro>
5901 as function argument.
5902 C<isl_ast_node_print>, C<isl_ast_node_for_print> and
5903 C<isl_ast_node_if_print> print an C<isl_ast_node>
5904 in C<ISL_FORMAT_C>, but allow for some extra control
5905 through an C<isl_ast_print_options> object.
5906 This object can be created using the following functions.
5908 #include <isl/ast.h>
5909 __isl_give isl_ast_print_options *
5910 isl_ast_print_options_alloc(isl_ctx *ctx);
5911 __isl_give isl_ast_print_options *
5912 isl_ast_print_options_copy(
5913 __isl_keep isl_ast_print_options *options);
5914 void *isl_ast_print_options_free(
5915 __isl_take isl_ast_print_options *options);
5917 __isl_give isl_ast_print_options *
5918 isl_ast_print_options_set_print_user(
5919 __isl_take isl_ast_print_options *options,
5920 __isl_give isl_printer *(*print_user)(
5921 __isl_take isl_printer *p,
5922 __isl_take isl_ast_print_options *options,
5923 __isl_keep isl_ast_node *node, void *user),
5925 __isl_give isl_ast_print_options *
5926 isl_ast_print_options_set_print_for(
5927 __isl_take isl_ast_print_options *options,
5928 __isl_give isl_printer *(*print_for)(
5929 __isl_take isl_printer *p,
5930 __isl_take isl_ast_print_options *options,
5931 __isl_keep isl_ast_node *node, void *user),
5934 The callback set by C<isl_ast_print_options_set_print_user>
5935 is called whenever a node of type C<isl_ast_node_user> needs to
5937 The callback set by C<isl_ast_print_options_set_print_for>
5938 is called whenever a node of type C<isl_ast_node_for> needs to
5940 Note that C<isl_ast_node_for_print> will I<not> call the
5941 callback set by C<isl_ast_print_options_set_print_for> on the node
5942 on which C<isl_ast_node_for_print> is called, but only on nested
5943 nodes of type C<isl_ast_node_for>. It is therefore safe to
5944 call C<isl_ast_node_for_print> from within the callback set by
5945 C<isl_ast_print_options_set_print_for>.
5947 The following option determines the type to be used for iterators
5948 while printing the AST.
5950 int isl_options_set_ast_iterator_type(
5951 isl_ctx *ctx, const char *val);
5952 const char *isl_options_get_ast_iterator_type(
5957 #include <isl/ast_build.h>
5958 int isl_options_set_ast_build_atomic_upper_bound(
5959 isl_ctx *ctx, int val);
5960 int isl_options_get_ast_build_atomic_upper_bound(
5962 int isl_options_set_ast_build_prefer_pdiv(isl_ctx *ctx,
5964 int isl_options_get_ast_build_prefer_pdiv(isl_ctx *ctx);
5965 int isl_options_set_ast_build_exploit_nested_bounds(
5966 isl_ctx *ctx, int val);
5967 int isl_options_get_ast_build_exploit_nested_bounds(
5969 int isl_options_set_ast_build_group_coscheduled(
5970 isl_ctx *ctx, int val);
5971 int isl_options_get_ast_build_group_coscheduled(
5973 int isl_options_set_ast_build_scale_strides(
5974 isl_ctx *ctx, int val);
5975 int isl_options_get_ast_build_scale_strides(
5977 int isl_options_set_ast_build_allow_else(isl_ctx *ctx,
5979 int isl_options_get_ast_build_allow_else(isl_ctx *ctx);
5980 int isl_options_set_ast_build_allow_or(isl_ctx *ctx,
5982 int isl_options_get_ast_build_allow_or(isl_ctx *ctx);
5986 =item * ast_build_atomic_upper_bound
5988 Generate loop upper bounds that consist of the current loop iterator,
5989 an operator and an expression not involving the iterator.
5990 If this option is not set, then the current loop iterator may appear
5991 several times in the upper bound.
5992 For example, when this option is turned off, AST generation
5995 [n] -> { A[i] -> [i] : 0 <= i <= 100, n }
5999 for (int c0 = 0; c0 <= 100 && n >= c0; c0 += 1)
6002 When the option is turned on, the following AST is generated
6004 for (int c0 = 0; c0 <= min(100, n); c0 += 1)
6007 =item * ast_build_prefer_pdiv
6009 If this option is turned off, then the AST generation will
6010 produce ASTs that may only contain C<isl_ast_op_fdiv_q>
6011 operators, but no C<isl_ast_op_pdiv_q> or
6012 C<isl_ast_op_pdiv_r> operators.
6013 If this options is turned on, then C<isl> will try to convert
6014 some of the C<isl_ast_op_fdiv_q> operators to (expressions containing)
6015 C<isl_ast_op_pdiv_q> or C<isl_ast_op_pdiv_r> operators.
6017 =item * ast_build_exploit_nested_bounds
6019 Simplify conditions based on bounds of nested for loops.
6020 In particular, remove conditions that are implied by the fact
6021 that one or more nested loops have at least one iteration,
6022 meaning that the upper bound is at least as large as the lower bound.
6023 For example, when this option is turned off, AST generation
6026 [N,M] -> { A[i,j] -> [i,j] : 0 <= i <= N and
6032 for (int c0 = 0; c0 <= N; c0 += 1)
6033 for (int c1 = 0; c1 <= M; c1 += 1)
6036 When the option is turned on, the following AST is generated
6038 for (int c0 = 0; c0 <= N; c0 += 1)
6039 for (int c1 = 0; c1 <= M; c1 += 1)
6042 =item * ast_build_group_coscheduled
6044 If two domain elements are assigned the same schedule point, then
6045 they may be executed in any order and they may even appear in different
6046 loops. If this options is set, then the AST generator will make
6047 sure that coscheduled domain elements do not appear in separate parts
6048 of the AST. This is useful in case of nested AST generation
6049 if the outer AST generation is given only part of a schedule
6050 and the inner AST generation should handle the domains that are
6051 coscheduled by this initial part of the schedule together.
6052 For example if an AST is generated for a schedule
6054 { A[i] -> [0]; B[i] -> [0] }
6056 then the C<isl_ast_build_set_create_leaf> callback described
6057 below may get called twice, once for each domain.
6058 Setting this option ensures that the callback is only called once
6059 on both domains together.
6061 =item * ast_build_separation_bounds
6063 This option specifies which bounds to use during separation.
6064 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_IMPLICIT>
6065 then all (possibly implicit) bounds on the current dimension will
6066 be used during separation.
6067 If this option is set to C<ISL_AST_BUILD_SEPARATION_BOUNDS_EXPLICIT>
6068 then only those bounds that are explicitly available will
6069 be used during separation.
6071 =item * ast_build_scale_strides
6073 This option specifies whether the AST generator is allowed
6074 to scale down iterators of strided loops.
6076 =item * ast_build_allow_else
6078 This option specifies whether the AST generator is allowed
6079 to construct if statements with else branches.
6081 =item * ast_build_allow_or
6083 This option specifies whether the AST generator is allowed
6084 to construct if conditions with disjunctions.
6088 =head3 Fine-grained Control over AST Generation
6090 Besides specifying the constraints on the parameters,
6091 an C<isl_ast_build> object can be used to control
6092 various aspects of the AST generation process.
6093 The most prominent way of control is through ``options'',
6094 which can be set using the following function.
6096 #include <isl/ast_build.h>
6097 __isl_give isl_ast_build *
6098 isl_ast_build_set_options(
6099 __isl_take isl_ast_build *control,
6100 __isl_take isl_union_map *options);
6102 The options are encoded in an <isl_union_map>.
6103 The domain of this union relation refers to the schedule domain,
6104 i.e., the range of the schedule passed to C<isl_ast_build_ast_from_schedule>.
6105 In the case of nested AST generation (see L</"Nested AST Generation">),
6106 the domain of C<options> should refer to the extra piece of the schedule.
6107 That is, it should be equal to the range of the wrapped relation in the
6108 range of the schedule.
6109 The range of the options can consist of elements in one or more spaces,
6110 the names of which determine the effect of the option.
6111 The values of the range typically also refer to the schedule dimension
6112 to which the option applies. In case of nested AST generation
6113 (see L</"Nested AST Generation">), these values refer to the position
6114 of the schedule dimension within the innermost AST generation.
6115 The constraints on the domain elements of
6116 the option should only refer to this dimension and earlier dimensions.
6117 We consider the following spaces.
6121 =item C<separation_class>
6123 This space is a wrapped relation between two one dimensional spaces.
6124 The input space represents the schedule dimension to which the option
6125 applies and the output space represents the separation class.
6126 While constructing a loop corresponding to the specified schedule
6127 dimension(s), the AST generator will try to generate separate loops
6128 for domain elements that are assigned different classes.
6129 If only some of the elements are assigned a class, then those elements
6130 that are not assigned any class will be treated as belonging to a class
6131 that is separate from the explicitly assigned classes.
6132 The typical use case for this option is to separate full tiles from
6134 The other options, described below, are applied after the separation
6137 As an example, consider the separation into full and partial tiles
6138 of a tiling of a triangular domain.
6139 Take, for example, the domain
6141 { A[i,j] : 0 <= i,j and i + j <= 100 }
6143 and a tiling into tiles of 10 by 10. The input to the AST generator
6144 is then the schedule
6146 { A[i,j] -> [([i/10]),[j/10],i,j] : 0 <= i,j and
6149 Without any options, the following AST is generated
6151 for (int c0 = 0; c0 <= 10; c0 += 1)
6152 for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6153 for (int c2 = 10 * c0;
6154 c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6156 for (int c3 = 10 * c1;
6157 c3 <= min(10 * c1 + 9, -c2 + 100);
6161 Separation into full and partial tiles can be obtained by assigning
6162 a class, say C<0>, to the full tiles. The full tiles are represented by those
6163 values of the first and second schedule dimensions for which there are
6164 values of the third and fourth dimensions to cover an entire tile.
6165 That is, we need to specify the following option
6167 { [a,b,c,d] -> separation_class[[0]->[0]] :
6168 exists b': 0 <= 10a,10b' and
6169 10a+9+10b'+9 <= 100;
6170 [a,b,c,d] -> separation_class[[1]->[0]] :
6171 0 <= 10a,10b and 10a+9+10b+9 <= 100 }
6175 { [a, b, c, d] -> separation_class[[1] -> [0]] :
6176 a >= 0 and b >= 0 and b <= 8 - a;
6177 [a, b, c, d] -> separation_class[[0] -> [0]] :
6180 With this option, the generated AST is as follows
6183 for (int c0 = 0; c0 <= 8; c0 += 1) {
6184 for (int c1 = 0; c1 <= -c0 + 8; c1 += 1)
6185 for (int c2 = 10 * c0;
6186 c2 <= 10 * c0 + 9; c2 += 1)
6187 for (int c3 = 10 * c1;
6188 c3 <= 10 * c1 + 9; c3 += 1)
6190 for (int c1 = -c0 + 9; c1 <= -c0 + 10; c1 += 1)
6191 for (int c2 = 10 * c0;
6192 c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6194 for (int c3 = 10 * c1;
6195 c3 <= min(-c2 + 100, 10 * c1 + 9);
6199 for (int c0 = 9; c0 <= 10; c0 += 1)
6200 for (int c1 = 0; c1 <= -c0 + 10; c1 += 1)
6201 for (int c2 = 10 * c0;
6202 c2 <= min(-10 * c1 + 100, 10 * c0 + 9);
6204 for (int c3 = 10 * c1;
6205 c3 <= min(10 * c1 + 9, -c2 + 100);
6212 This is a single-dimensional space representing the schedule dimension(s)
6213 to which ``separation'' should be applied. Separation tries to split
6214 a loop into several pieces if this can avoid the generation of guards
6216 See also the C<atomic> option.
6220 This is a single-dimensional space representing the schedule dimension(s)
6221 for which the domains should be considered ``atomic''. That is, the
6222 AST generator will make sure that any given domain space will only appear
6223 in a single loop at the specified level.
6225 Consider the following schedule
6227 { a[i] -> [i] : 0 <= i < 10;
6228 b[i] -> [i+1] : 0 <= i < 10 }
6230 If the following option is specified
6232 { [i] -> separate[x] }
6234 then the following AST will be generated
6238 for (int c0 = 1; c0 <= 9; c0 += 1) {
6245 If, on the other hand, the following option is specified
6247 { [i] -> atomic[x] }
6249 then the following AST will be generated
6251 for (int c0 = 0; c0 <= 10; c0 += 1) {
6258 If neither C<atomic> nor C<separate> is specified, then the AST generator
6259 may produce either of these two results or some intermediate form.
6263 This is a single-dimensional space representing the schedule dimension(s)
6264 that should be I<completely> unrolled.
6265 To obtain a partial unrolling, the user should apply an additional
6266 strip-mining to the schedule and fully unroll the inner loop.
6270 Additional control is available through the following functions.
6272 #include <isl/ast_build.h>
6273 __isl_give isl_ast_build *
6274 isl_ast_build_set_iterators(
6275 __isl_take isl_ast_build *control,
6276 __isl_take isl_id_list *iterators);
6278 The function C<isl_ast_build_set_iterators> allows the user to
6279 specify a list of iterator C<isl_id>s to be used as iterators.
6280 If the input schedule is injective, then
6281 the number of elements in this list should be as large as the dimension
6282 of the schedule space, but no direct correspondence should be assumed
6283 between dimensions and elements.
6284 If the input schedule is not injective, then an additional number
6285 of C<isl_id>s equal to the largest dimension of the input domains
6287 If the number of provided C<isl_id>s is insufficient, then additional
6288 names are automatically generated.
6290 #include <isl/ast_build.h>
6291 __isl_give isl_ast_build *
6292 isl_ast_build_set_create_leaf(
6293 __isl_take isl_ast_build *control,
6294 __isl_give isl_ast_node *(*fn)(
6295 __isl_take isl_ast_build *build,
6296 void *user), void *user);
6299 C<isl_ast_build_set_create_leaf> function allows for the
6300 specification of a callback that should be called whenever the AST
6301 generator arrives at an element of the schedule domain.
6302 The callback should return an AST node that should be inserted
6303 at the corresponding position of the AST. The default action (when
6304 the callback is not set) is to continue generating parts of the AST to scan
6305 all the domain elements associated to the schedule domain element
6306 and to insert user nodes, ``calling'' the domain element, for each of them.
6307 The C<build> argument contains the current state of the C<isl_ast_build>.
6308 To ease nested AST generation (see L</"Nested AST Generation">),
6309 all control information that is
6310 specific to the current AST generation such as the options and
6311 the callbacks has been removed from this C<isl_ast_build>.
6312 The callback would typically return the result of a nested
6314 user defined node created using the following function.
6316 #include <isl/ast.h>
6317 __isl_give isl_ast_node *isl_ast_node_alloc_user(
6318 __isl_take isl_ast_expr *expr);
6320 #include <isl/ast_build.h>
6321 __isl_give isl_ast_build *
6322 isl_ast_build_set_at_each_domain(
6323 __isl_take isl_ast_build *build,
6324 __isl_give isl_ast_node *(*fn)(
6325 __isl_take isl_ast_node *node,
6326 __isl_keep isl_ast_build *build,
6327 void *user), void *user);
6328 __isl_give isl_ast_build *
6329 isl_ast_build_set_before_each_for(
6330 __isl_take isl_ast_build *build,
6331 __isl_give isl_id *(*fn)(
6332 __isl_keep isl_ast_build *build,
6333 void *user), void *user);
6334 __isl_give isl_ast_build *
6335 isl_ast_build_set_after_each_for(
6336 __isl_take isl_ast_build *build,
6337 __isl_give isl_ast_node *(*fn)(
6338 __isl_take isl_ast_node *node,
6339 __isl_keep isl_ast_build *build,
6340 void *user), void *user);
6342 The callback set by C<isl_ast_build_set_at_each_domain> will
6343 be called for each domain AST node.
6344 The callbacks set by C<isl_ast_build_set_before_each_for>
6345 and C<isl_ast_build_set_after_each_for> will be called
6346 for each for AST node. The first will be called in depth-first
6347 pre-order, while the second will be called in depth-first post-order.
6348 Since C<isl_ast_build_set_before_each_for> is called before the for
6349 node is actually constructed, it is only passed an C<isl_ast_build>.
6350 The returned C<isl_id> will be added as an annotation (using
6351 C<isl_ast_node_set_annotation>) to the constructed for node.
6352 In particular, if the user has also specified an C<after_each_for>
6353 callback, then the annotation can be retrieved from the node passed to
6354 that callback using C<isl_ast_node_get_annotation>.
6355 All callbacks should C<NULL> on failure.
6356 The given C<isl_ast_build> can be used to create new
6357 C<isl_ast_expr> objects using C<isl_ast_build_expr_from_pw_aff>
6358 or C<isl_ast_build_call_from_pw_multi_aff>.
6360 =head3 Nested AST Generation
6362 C<isl> allows the user to create an AST within the context
6363 of another AST. These nested ASTs are created using the
6364 same C<isl_ast_build_ast_from_schedule> function that is used to create the
6365 outer AST. The C<build> argument should be an C<isl_ast_build>
6366 passed to a callback set by
6367 C<isl_ast_build_set_create_leaf>.
6368 The space of the range of the C<schedule> argument should refer
6369 to this build. In particular, the space should be a wrapped
6370 relation and the domain of this wrapped relation should be the
6371 same as that of the range of the schedule returned by
6372 C<isl_ast_build_get_schedule> below.
6373 In practice, the new schedule is typically
6374 created by calling C<isl_union_map_range_product> on the old schedule
6375 and some extra piece of the schedule.
6376 The space of the schedule domain is also available from
6377 the C<isl_ast_build>.
6379 #include <isl/ast_build.h>
6380 __isl_give isl_union_map *isl_ast_build_get_schedule(
6381 __isl_keep isl_ast_build *build);
6382 __isl_give isl_space *isl_ast_build_get_schedule_space(
6383 __isl_keep isl_ast_build *build);
6384 __isl_give isl_ast_build *isl_ast_build_restrict(
6385 __isl_take isl_ast_build *build,
6386 __isl_take isl_set *set);
6388 The C<isl_ast_build_get_schedule> function returns a (partial)
6389 schedule for the domains elements for which part of the AST still needs to
6390 be generated in the current build.
6391 In particular, the domain elements are mapped to those iterations of the loops
6392 enclosing the current point of the AST generation inside which
6393 the domain elements are executed.
6394 No direct correspondence between
6395 the input schedule and this schedule should be assumed.
6396 The space obtained from C<isl_ast_build_get_schedule_space> can be used
6397 to create a set for C<isl_ast_build_restrict> to intersect
6398 with the current build. In particular, the set passed to
6399 C<isl_ast_build_restrict> can have additional parameters.
6400 The ids of the set dimensions in the space returned by
6401 C<isl_ast_build_get_schedule_space> correspond to the
6402 iterators of the already generated loops.
6403 The user should not rely on the ids of the output dimensions
6404 of the relations in the union relation returned by
6405 C<isl_ast_build_get_schedule> having any particular value.
6409 Although C<isl> is mainly meant to be used as a library,
6410 it also contains some basic applications that use some
6411 of the functionality of C<isl>.
6412 The input may be specified in either the L<isl format>
6413 or the L<PolyLib format>.
6415 =head2 C<isl_polyhedron_sample>
6417 C<isl_polyhedron_sample> takes a polyhedron as input and prints
6418 an integer element of the polyhedron, if there is any.
6419 The first column in the output is the denominator and is always
6420 equal to 1. If the polyhedron contains no integer points,
6421 then a vector of length zero is printed.
6425 C<isl_pip> takes the same input as the C<example> program
6426 from the C<piplib> distribution, i.e., a set of constraints
6427 on the parameters, a line containing only -1 and finally a set
6428 of constraints on a parametric polyhedron.
6429 The coefficients of the parameters appear in the last columns
6430 (but before the final constant column).
6431 The output is the lexicographic minimum of the parametric polyhedron.
6432 As C<isl> currently does not have its own output format, the output
6433 is just a dump of the internal state.
6435 =head2 C<isl_polyhedron_minimize>
6437 C<isl_polyhedron_minimize> computes the minimum of some linear
6438 or affine objective function over the integer points in a polyhedron.
6439 If an affine objective function
6440 is given, then the constant should appear in the last column.
6442 =head2 C<isl_polytope_scan>
6444 Given a polytope, C<isl_polytope_scan> prints
6445 all integer points in the polytope.
6447 =head2 C<isl_codegen>
6449 Given a schedule, a context set and an options relation,
6450 C<isl_codegen> prints out an AST that scans the domain elements
6451 of the schedule in the order of their image(s) taking into account
6452 the constraints in the context set.