doc/user.pod

   1 =head1 Introduction
   2
   3 C<isl> is a thread-safe C library for manipulating
   4 sets and relations of integer points bounded by affine constraints.
   5 The descriptions of the sets and relations may involve
   6 both parameters and existentially quantified variables.
   7 All computations are performed in exact integer arithmetic
   8 using C<GMP>.
   9 The C<isl> library offers functionality that is similar
  10 to that offered by the C<Omega> and C<Omega+> libraries,
  11 but the underlying algorithms are in most cases completely different.
  12
  13 The library is by no means complete and some fairly basic
  14 functionality is still missing.
  15 Still, even in its current form, the library has been successfully
  16 used as a backend polyhedral library for the polyhedral
  17 scanner C<CLooG> and as part of an equivalence checker of
  18 static affine programs.
  19
  20 =head1 Installation
  21
  22 The source of C<isl> can be obtained either as a tarball
  23 or from the git repository.  Both are available from
  24 L<http://freshmeat.net/projects/isl/>.
  25 The installation process depends on how you obtained
  26 the source.
  27
  28 =head2 Installation from the git repository
  29
  30 =over
  31
  32 =item 1 Clone or update the repository
  33
  34 The first time the source is obtained, you need to clone
  35 the repository.
  36
  37         git clone git://repo.or.cz/isl.git
  38
  39 To obtain updates, you need to pull in the latest changes
  40
  41         git pull
  42
  43 =item 2 Get submodule (optional)
  44
  45 C<isl> can optionally use the C<piplib> library and provides
  46 this library as a submodule.  If you want to use it, then
  47 after you have cloned C<isl>, you need to grab the submodules
  48
  49         git submodule init
  50         git submodule update
  51
  52 To obtain updates, you only need
  53
  54         git submodule update
  55
  56 Note that C<isl> currently does not use any C<piplib>
  57 functionality by default.
  58
  59 =item 3 Generate C<configure>
  60
  61         ./autogen.sh
  62
  63 =back
  64
  65 After performing the above steps, continue
  66 with the L<Common installation instructions>.
  67
  68 =head2 Common installation instructions
  69
  70 =over
  71
  72 =item 1 Obtain C<GMP>
  73
  74 Building C<isl> requires C<GMP>, including its headers files.
  75 Your distribution may not provide these header files by default
  76 and you may need to install a package called C<gmp-devel> or something
  77 similar.  Alternatively, C<GMP> can be built from
  78 source, available from L<http://gmplib.org/>.
  79
  80 =item 2 Configure
  81
  82 C<isl> uses the standard C<autoconf> C<configure> script.
  83 To run it, just type
  84
  85         ./configure
  86
  87 optionally followed by some configure options.
  88 A complete list of options can be obtained by running
  89
  90         ./configure --help
  91
  92 Below we discuss some of the more common options.
  93
  94 C<isl> can optionally use C<piplib>, but no
  95 C<piplib> functionality is currently used by default.
  96 The C<--with-piplib> option can
  97 be used to specify which C<piplib>
  98 library to use, either an installed version (C<system>),
  99 an externally built version (C<build>)
 100 or no version (C<no>).  The option C<build> is mostly useful
 101 in C<configure> scripts of larger projects that bundle both C<isl>
 102 and C<piplib>.
 103
 104 =over
 105
 106 =item C<--prefix>
 107
 108 Installation prefix for C<isl>
 109
 110 =item C<--with-gmp-prefix>
 111
 112 Installation prefix for C<GMP> (architecture-independent files).
 113
 114 =item C<--with-gmp-exec-prefix>
 115
 116 Installation prefix for C<GMP> (architecture-dependent files).
 117
 118 =item C<--with-piplib>
 119
 120 Which copy of C<piplib> to use, either C<no> (default), C<system> or C<build>.
 121
 122 =item C<--with-piplib-prefix>
 123
 124 Installation prefix for C<system> C<piplib> (architecture-independent files).
 125
 126 =item C<--with-piplib-exec-prefix>
 127
 128 Installation prefix for C<system> C<piplib> (architecture-dependent files).
 129
 130 =item C<--with-piplib-builddir>
 131
 132 Location where C<build> C<piplib> was built.
 133
 134 =back
 135
 136 =item 3 Compile
 137
 138         make
 139
 140 =item 4 Install (optional)
 141
 142         make install
 143
 144 =back
 145
 146 =head1 Library
 147
 148 =head2 Initialization
 149
 150 All manipulations of integer sets and relations occur within
 151 the context of an C<isl_ctx>.
 152 A given C<isl_ctx> can only be used within a single thread.
 153 All arguments of a function are required to have been allocated
 154 within the same context.
 155 There are currently no functions available for moving an object
 156 from one C<isl_ctx> to another C<isl_ctx>.  This means that
 157 there is currently no way of safely moving an object from one
 158 thread to another, unless the whole C<isl_ctx> is moved.
 159
 160 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
 161 freed using C<isl_ctx_free>.
 162 All objects allocated within an C<isl_ctx> should be freed
 163 before the C<isl_ctx> itself is freed.
 164
 165         isl_ctx *isl_ctx_alloc();
 166         void isl_ctx_free(isl_ctx *ctx);
 167
 168 =head2 Integers
 169
 170 All operations on integers, mainly the coefficients
 171 of the constraints describing the sets and relations,
 172 are performed in exact integer arithmetic using C<GMP>.
 173 However, to allow future versions of C<isl> to optionally
 174 support fixed integer arithmetic, all calls to C<GMP>
 175 are wrapped inside C<isl> specific macros.
 176 The basic type is C<isl_int> and the following operations
 177 are available on this type.
 178 The meanings of these operations are essentially the same
 179 as their C<GMP> C<mpz_> counterparts.
 180 As always with C<GMP> types, C<isl_int>s need to be
 181 initialized with C<isl_int_init> before they can be used
 182 and they need to be released with C<isl_int_clear>
 183 after the last use.
 184
 185 =over
 186
 187 =item isl_int_init(i)
 188
 189 =item isl_int_clear(i)
 190
 191 =item isl_int_set(r,i)
 192
 193 =item isl_int_set_si(r,i)
 194
 195 =item isl_int_abs(r,i)
 196
 197 =item isl_int_neg(r,i)
 198
 199 =item isl_int_swap(i,j)
 200
 201 =item isl_int_swap_or_set(i,j)
 202
 203 =item isl_int_add_ui(r,i,j)
 204
 205 =item isl_int_sub_ui(r,i,j)
 206
 207 =item isl_int_add(r,i,j)
 208
 209 =item isl_int_sub(r,i,j)
 210
 211 =item isl_int_mul(r,i,j)
 212
 213 =item isl_int_mul_ui(r,i,j)
 214
 215 =item isl_int_addmul(r,i,j)
 216
 217 =item isl_int_submul(r,i,j)
 218
 219 =item isl_int_gcd(r,i,j)
 220
 221 =item isl_int_lcm(r,i,j)
 222
 223 =item isl_int_divexact(r,i,j)
 224
 225 =item isl_int_cdiv_q(r,i,j)
 226
 227 =item isl_int_fdiv_q(r,i,j)
 228
 229 =item isl_int_fdiv_r(r,i,j)
 230
 231 =item isl_int_fdiv_q_ui(r,i,j)
 232
 233 =item isl_int_read(r,s)
 234
 235 =item isl_int_print(out,i,width)
 236
 237 =item isl_int_sgn(i)
 238
 239 =item isl_int_cmp(i,j)
 240
 241 =item isl_int_cmp_si(i,si)
 242
 243 =item isl_int_eq(i,j)
 244
 245 =item isl_int_ne(i,j)
 246
 247 =item isl_int_lt(i,j)
 248
 249 =item isl_int_le(i,j)
 250
 251 =item isl_int_gt(i,j)
 252
 253 =item isl_int_ge(i,j)
 254
 255 =item isl_int_abs_eq(i,j)
 256
 257 =item isl_int_abs_ne(i,j)
 258
 259 =item isl_int_abs_lt(i,j)
 260
 261 =item isl_int_abs_gt(i,j)
 262
 263 =item isl_int_abs_ge(i,j)
 264
 265 =item isl_int_is_zero(i)
 266
 267 =item isl_int_is_one(i)
 268
 269 =item isl_int_is_negone(i)
 270
 271 =item isl_int_is_pos(i)
 272
 273 =item isl_int_is_neg(i)
 274
 275 =item isl_int_is_nonpos(i)
 276
 277 =item isl_int_is_nonneg(i)
 278
 279 =item isl_int_is_divisible_by(i,j)
 280
 281 =back
 282
 283 =head2 Sets and Relations
 284
 285 C<isl> uses four types of objects for representing sets and relations,
 286 C<isl_basic_set>, C<isl_basic_map>, C<isl_set> and C<isl_map>.
 287 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
 288 can be described as a conjunction of affine constraints, while
 289 C<isl_set> and C<isl_map> represent unions of
 290 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
 291 The difference between sets and relations (maps) is that sets have
 292 one set of variables, while relations have two sets of variables,
 293 input variables and output variables.
 294
 295 =head2 Memory Management
 296
 297 Since a high-level operation on sets and/or relations usually involves
 298 several substeps and since the user is usually not interested in
 299 the intermediate results, most functions that return a new object
 300 will also release all the objects passed as arguments.
 301 If the user still wants to use one or more of these arguments
 302 after the function call, she should pass along a copy of the
 303 object rather than the object itself.
 304 The user is then responsible for make sure that the original
 305 object gets used somewhere else or is explicitly freed.
 306
 307 The arguments and return values of all documents functions are
 308 annotated to make clear which arguments are released and which
 309 arguments are preserved.  In particular, the following annotations
 310 are used
 311
 312 =over
 313
 314 =item C<__isl_give>
 315
 316 C<__isl_give> means that a new object is returned.
 317 The user should make sure that the returned pointer is
 318 used exactly once as a value for an C<__isl_take> argument.
 319 In between, it can be used as a value for as many
 320 C<__isl_keep> arguments as the user likes.
 321 There is one exception, and that is the case where the
 322 pointer returned is C<NULL>.  Is this case, the user
 323 is free to use it as an C<__isl_take> argument or not.
 324
 325 =item C<__isl_take>
 326
 327 C<__isl_take> means that the object the argument points to
 328 is taken over by the function and may no longer be used
 329 by the user as an argument to any other function.
 330 The pointer value must be one returned by a function
 331 returning an C<__isl_give> pointer.
 332 If the user passes in a C<NULL> value, then this will
 333 be treated as an error in the sense that the function will
 334 not perform its usual operation.  However, it will still
 335 make sure that all the the other C<__isl_take> arguments
 336 are released.
 337
 338 =item C<__isl_keep>
 339
 340 C<__isl_keep> means that the function will only use the object
 341 temporarily.  After the function has finished, the user
 342 can still use it as an argument to other functions.
 343 A C<NULL> value will be treated in the same way as
 344 a C<NULL> value for an C<__isl_take> argument.
 345
 346 =back
 347
 348 =head2 Dimension Specifications
 349
 350 Whenever a new set or relation is created from scratch,
 351 its dimension needs to be specified using an C<isl_dim>.
 352
 353         #include <isl_dim.h>
 354         __isl_give isl_dim *isl_dim_alloc(isl_ctx *ctx,
 355                 unsigned nparam, unsigned n_in, unsigned n_out);
 356         __isl_give isl_dim *isl_dim_set_alloc(isl_ctx *ctx,
 357                 unsigned nparam, unsigned dim);
 358         __isl_give isl_dim *isl_dim_copy(__isl_keep isl_dim *dim);
 359         void isl_dim_free(__isl_take isl_dim *dim);
 360         unsigned isl_dim_size(__isl_keep isl_dim *dim,
 361                 enum isl_dim_type type);
 362
 363 The dimension specification used for creating a set
 364 needs to be created using C<isl_dim_set_alloc>, while
 365 that for creating a relation
 366 needs to be created using C<isl_dim_alloc>.
 367 C<isl_dim_size> can be used
 368 to find out the number of dimensions of each type in
 369 a dimension specification, where type may be
 370 C<isl_dim_param>, C<isl_dim_in> (only for relations),
 371 C<isl_dim_out> (only for relations), C<isl_dim_set>
 372 (only for sets) or C<isl_dim_all>.
 373
 374 It is often useful to create sets or maps that live in the
 375 same space as some other set or map.  This can be accomplished
 376 by creating the new sets or maps
 377 (see L<Creating New Sets and Relations>) based on the dimension
 378 specification of the original set or map.
 379
 380         #include <isl_set.h>
 381         __isl_give isl_dim *isl_basic_set_get_dim(
 382                 __isl_keep isl_basic_set *bset);
 383         __isl_give isl_dim *isl_set_get_dim(__isl_keep isl_set *set);
 384
 385         #include <isl_map.h>
 386         __isl_give isl_dim *isl_basic_map_get_dim(
 387                 __isl_keep isl_basic_map *bmap);
 388         __isl_give isl_dim *isl_map_get_dim(__isl_keep isl_map *map);
 389
 390 The names of the individual dimensions may be set or read off
 391 using the following functions.
 392
 393         #include <isl_dim.h>
 394         __isl_give isl_dim *isl_dim_set_name(__isl_take isl_dim *dim,
 395                                  enum isl_dim_type type, unsigned pos,
 396                                  __isl_keep const char *name);
 397         __isl_keep const char *isl_dim_get_name(__isl_keep isl_dim *dim,
 398                                  enum isl_dim_type type, unsigned pos);
 399
 400 Note that C<isl_dim_get_name> returns a pointer to some internal
 401 data structure, so the result can only be used while the
 402 corresponding C<isl_dim> is alive.
 403 Also note that every function that operates on two sets or relations
 404 requires that both arguments have the same parameters.  This also
 405 means that if one of the arguments has named parameters, then the
 406 other needs to have named parameters too and the names need to match.
 407
 408 =head2 Input and Output
 409
 410 C<isl> supports its own input/output format, which is similar
 411 to the C<Omega> format, but also supports the C<PolyLib> format
 412 in some cases.
 413
 414 =head3 C<isl> format
 415
 416 The C<isl> format is similar to that of C<Omega>, but has a different
 417 syntax for describing the parameters and allows for the definition
 418 of an existentially quantified variable as the integer division
 419 of an affine expression.
 420 For example, the set of integers C<i> between C<0> and C<n>
 421 such that C<i % 10 <= 6> can be described as
 422
 423         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
 424                                 i - 10 a <= 6) }
 425
 426 A set or relation can have several disjuncts, separated
 427 by the keyword C<or>.  Each disjunct is either a conjunction
 428 of constraints or a projection (C<exists>) of a conjunction
 429 of constraints.  The constraints are separated by the keyword
 430 C<and>.
 431
 432 =head3 C<PolyLib> format
 433
 434 If the represented set is a union, then the first line
 435 contains a single number representing the number of disjuncts.
 436 Otherwise, a line containing the number C<1> is optional.
 437
 438 Each disjunct is represented by a matrix of constraints.
 439 The first line contains two numbers representing
 440 the number of rows and columns,
 441 where the number of rows is equal to the number of constraints
 442 and the number of columns is equal to two plus the number of variables.
 443 The following lines contain the actual rows of the constraint matrix.
 444 In each row, the first column indicates whether the constraint
 445 is an equality (C<0>) or inequality (C<1>).  The final column
 446 corresponds to the constant term.
 447
 448 If the set is parametric, then the coefficients of the parameters
 449 appear in the last columns before the constant column.
 450 The coefficients of any existentially quantified variables appear
 451 between those of the set variables and those of the parameters.
 452
 453 =head3 Input
 454
 455         #include <isl_set.h>
 456         __isl_give isl_basic_set *isl_basic_set_read_from_file(
 457                 isl_ctx *ctx, FILE *input, int nparam);
 458         __isl_give isl_basic_set *isl_basic_set_read_from_str(
 459                 isl_ctx *ctx, const char *str, int nparam);
 460         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
 461                 FILE *input, int nparam);
 462         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
 463                 const char *str, int nparam);
 464
 465         #include <isl_map.h>
 466         __isl_give isl_basic_map *isl_basic_map_read_from_file(
 467                 isl_ctx *ctx, FILE *input, int nparam);
 468         __isl_give isl_basic_map *isl_basic_map_read_from_str(
 469                 isl_ctx *ctx, const char *str, int nparam);
 470         __isl_give isl_map *isl_map_read_from_file(
 471                 struct isl_ctx *ctx, FILE *input, int nparam);
 472         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
 473                 const char *str, int nparam);
 474
 475 The input format is autodetected and may be either the C<PolyLib> format
 476 or the C<isl> format.
 477 C<nparam> specifies how many of the final columns in
 478 the C<PolyLib> format correspond to parameters.
 479 If input is given in the C<isl> format, then the number
 480 of parameters needs to be equal to C<nparam>.
 481 If C<nparam> is negative, then any number of parameters
 482 is accepted in the C<isl> format and zero parameters
 483 are assumed in the C<PolyLib> format.
 484
 485 =head3 Output
 486
 487 Before anything can be printed, an C<isl_printer> needs to
 488 be created.
 489
 490         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
 491                 FILE *file);
 492         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
 493         void isl_printer_free(__isl_take isl_printer *printer);
 494         __isl_give char *isl_printer_get_str(
 495                 __isl_keep isl_printer *printer);
 496
 497 The behavior of the printer can be modified in various ways
 498
 499         __isl_give isl_printer *isl_printer_set_output_format(
 500                 __isl_take isl_printer *p, int output_format);
 501         __isl_give isl_printer *isl_printer_set_indent(
 502                 __isl_take isl_printer *p, int indent);
 503         __isl_give isl_printer *isl_printer_set_prefix(
 504                 __isl_take isl_printer *p, const char *prefix);
 505         __isl_give isl_printer *isl_printer_set_suffix(
 506                 __isl_take isl_printer *p, const char *suffix);
 507
 508 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>
 509 or C<ISL_FORMAT_POLYLIB> and defaults to C<ISL_FORMAT_ISL>.
 510 Each line in the output is indented by C<indent> spaces
 511 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
 512 In the C<PolyLib> format output,
 513 the coefficients of the existentially quantified variables
 514 appear between those of the set variables and those
 515 of the parameters.
 516
 517 To actually print something, use
 518
 519         #include <isl_set.h>
 520         __isl_give isl_printer *isl_printer_print_basic_set(
 521                 __isl_take isl_printer *printer,
 522                 __isl_keep isl_basic_set *bset);
 523         __isl_give isl_printer *isl_printer_print_set(
 524                 __isl_take isl_printer *printer,
 525                 __isl_keep isl_set *set);
 526
 527         #include <isl_map.h>
 528         __isl_give isl_printer *isl_printer_print_basic_map(
 529                 __isl_take isl_printer *printer,
 530                 __isl_keep isl_basic_map *bmap);
 531         __isl_give isl_printer *isl_printer_print_map(
 532                 __isl_take isl_printer *printer,
 533                 __isl_keep isl_map *map);
 534
 535 =head2 Creating New Sets and Relations
 536
 537 C<isl> has functions for creating some standard sets and relations.
 538
 539 =over
 540
 541 =item * Empty sets and relations
 542
 543         __isl_give isl_basic_set *isl_basic_set_empty(
 544                 __isl_take isl_dim *dim);
 545         __isl_give isl_basic_map *isl_basic_map_empty(
 546                 __isl_take isl_dim *dim);
 547         __isl_give isl_set *isl_set_empty(
 548                 __isl_take isl_dim *dim);
 549         __isl_give isl_map *isl_map_empty(
 550                 __isl_take isl_dim *dim);
 551
 552 =item * Universe sets and relations
 553
 554         __isl_give isl_basic_set *isl_basic_set_universe(
 555                 __isl_take isl_dim *dim);
 556         __isl_give isl_basic_map *isl_basic_map_universe(
 557                 __isl_take isl_dim *dim);
 558         __isl_give isl_set *isl_set_universe(
 559                 __isl_take isl_dim *dim);
 560         __isl_give isl_map *isl_map_universe(
 561                 __isl_take isl_dim *dim);
 562
 563 =item * Identity relations
 564
 565         __isl_give isl_basic_map *isl_basic_map_identity(
 566                 __isl_take isl_dim *set_dim);
 567         __isl_give isl_map *isl_map_identity(
 568                 __isl_take isl_dim *set_dim);
 569
 570 These functions take a dimension specification for a B<set>
 571 and return an identity relation between two such sets.
 572
 573 =item * Lexicographic order
 574
 575         __isl_give isl_map *isl_map_lex_lt(
 576                 __isl_take isl_dim *set_dim);
 577         __isl_give isl_map *isl_map_lex_le(
 578                 __isl_take isl_dim *set_dim);
 579         __isl_give isl_map *isl_map_lex_gt(
 580                 __isl_take isl_dim *set_dim);
 581         __isl_give isl_map *isl_map_lex_ge(
 582                 __isl_take isl_dim *set_dim);
 583
 584 These functions take a dimension specification for a B<set>
 585 and return relations that express that the elements in the domain
 586 are lexicographically less
 587 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
 588 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
 589 than the elements in the range.
 590
 591 =back
 592
 593 A basic set or relation can be converted to a set or relation
 594 using the following functions.
 595
 596         __isl_give isl_set *isl_set_from_basic_set(
 597                 __isl_take isl_basic_set *bset);
 598         __isl_give isl_map *isl_map_from_basic_map(
 599                 __isl_take isl_basic_map *bmap);
 600
 601 Sets and relations can be copied and freed again using the following
 602 functions.
 603
 604         __isl_give isl_basic_set *isl_basic_set_copy(
 605                 __isl_keep isl_basic_set *bset);
 606         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
 607         __isl_give isl_basic_map *isl_basic_map_copy(
 608                 __isl_keep isl_basic_map *bmap);
 609         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
 610         void isl_basic_set_free(__isl_take isl_basic_set *bset);
 611         void isl_set_free(__isl_take isl_set *set);
 612         void isl_basic_map_free(__isl_take isl_basic_map *bmap);
 613         void isl_map_free(__isl_take isl_map *map);
 614
 615 Other sets and relations can be constructed by starting
 616 from a universe set or relation, adding equality and/or
 617 inequality constraints and then projecting out the
 618 existentially quantified variables, if any.
 619 Constraints can be constructed, manipulated and
 620 added to basic sets and relations using the following functions.
 621
 622         #include <isl_constraint.h>
 623         __isl_give isl_constraint *isl_equality_alloc(
 624                 __isl_take isl_dim *dim);
 625         __isl_give isl_constraint *isl_inequality_alloc(
 626                 __isl_take isl_dim *dim);
 627         void isl_constraint_set_constant(
 628                 __isl_keep isl_constraint *constraint, isl_int v);
 629         void isl_constraint_set_coefficient(
 630                 __isl_keep isl_constraint *constraint,
 631                 enum isl_dim_type type, int pos, isl_int v);
 632         __isl_give isl_basic_map *isl_basic_map_add_constraint(
 633                 __isl_take isl_basic_map *bmap,
 634                 __isl_take isl_constraint *constraint);
 635         __isl_give isl_basic_set *isl_basic_set_add_constraint(
 636                 __isl_take isl_basic_set *bset,
 637                 __isl_take isl_constraint *constraint);
 638
 639 For example, to create a set containing the even integers
 640 between 10 and 42, you would use the following code.
 641
 642         isl_int v;
 643         struct isl_dim *dim;
 644         struct isl_constraint *c;
 645         struct isl_basic_set *bset;
 646
 647         isl_int_init(v);
 648         dim = isl_dim_set_alloc(ctx, 0, 2);
 649         bset = isl_basic_set_universe(isl_dim_copy(dim));
 650
 651         c = isl_equality_alloc(isl_dim_copy(dim));
 652         isl_int_set_si(v, -1);
 653         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 654         isl_int_set_si(v, 2);
 655         isl_constraint_set_coefficient(c, isl_dim_set, 1, v);
 656         bset = isl_basic_set_add_constraint(bset, c);
 657
 658         c = isl_inequality_alloc(isl_dim_copy(dim));
 659         isl_int_set_si(v, -10);
 660         isl_constraint_set_constant(c, v);
 661         isl_int_set_si(v, 1);
 662         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 663         bset = isl_basic_set_add_constraint(bset, c);
 664
 665         c = isl_inequality_alloc(dim);
 666         isl_int_set_si(v, 42);
 667         isl_constraint_set_constant(c, v);
 668         isl_int_set_si(v, -1);
 669         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 670         bset = isl_basic_set_add_constraint(bset, c);
 671
 672         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
 673
 674         isl_int_clear(v);
 675
 676 Or, alternatively,
 677
 678         struct isl_basic_set *bset;
 679         bset = isl_basic_set_read_from_str(ctx,
 680                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}", -1);
 681
 682 =head2 Inspecting Sets and Relations
 683
 684 Usually, the user should not have to care about the actual constraints
 685 of the sets and maps, but should instead apply the abstract operations
 686 explained in the following sections.
 687 Occasionally, however, it may be required to inspect the individual
 688 coefficients of the constraints.  This section explains how to do so.
 689 In these cases, it may also be useful to have C<isl> compute
 690 an explicit representation of the existentially quantified variables.
 691
 692         __isl_give isl_set *isl_set_compute_divs(
 693                 __isl_take isl_set *set);
 694         __isl_give isl_map *isl_map_compute_divs(
 695                 __isl_take isl_map *map);
 696
 697 This explicit representation defines the existentially quantified
 698 variables as integer divisions of the other variables, possibly
 699 including earlier existentially quantified variables.
 700 An explicitly represented existentially quantified variable therefore
 701 has a unique value when the values of the other variables are known.
 702 If, furthermore, the same existentials, i.e., existentials
 703 with the same explicit representations, should appear in the
 704 same order in each of the disjuncts of a set or map, then the user should call
 705 either of the following functions.
 706
 707         __isl_give isl_set *isl_set_align_divs(
 708                 __isl_take isl_set *set);
 709         __isl_give isl_map *isl_map_align_divs(
 710                 __isl_take isl_map *map);
 711
 712 To iterate over all the basic sets or maps in a set or map, use
 713
 714         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
 715                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
 716                 void *user);
 717         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
 718                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
 719                 void *user);
 720
 721 The callback function C<fn> should return 0 if successful and
 722 -1 if an error occurs.  In the latter case, or if any other error
 723 occurs, the above functions will return -1.
 724
 725 It should be noted that C<isl> does not guarantee that
 726 the basic sets or maps passed to C<fn> are disjoint.
 727 If this is required, then the user should call one of
 728 the following functions first.
 729
 730         __isl_give isl_set *isl_set_make_disjoint(
 731                 __isl_take isl_set *set);
 732         __isl_give isl_map *isl_map_make_disjoint(
 733                 __isl_take isl_map *map);
 734
 735 To iterate over the constraints of a basic set or map, use
 736
 737         #include <isl_constraint.h>
 738
 739         int isl_basic_map_foreach_constraint(
 740                 __isl_keep isl_basic_map *bmap,
 741                 int (*fn)(__isl_take isl_constraint *c, void *user),
 742                 void *user);
 743         void isl_constraint_free(struct isl_constraint *c);
 744
 745 Again, the callback function C<fn> should return 0 if successful and
 746 -1 if an error occurs.  In the latter case, or if any other error
 747 occurs, the above functions will return -1.
 748
 749 The coefficients of the constraints can be inspected using
 750 the following functions.
 751
 752         void isl_constraint_get_constant(
 753                 __isl_keep isl_constraint *constraint, isl_int *v);
 754         void isl_constraint_get_coefficient(
 755                 __isl_keep isl_constraint *constraint,
 756                 enum isl_dim_type type, int pos, isl_int *v);
 757
 758 The explicit representations of the existentially quantified
 759 variables can be inspected using the following functions.
 760 Note that the user is only allowed to use these functions
 761 if the inspected set or map is the result of a call
 762 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
 763
 764         __isl_give isl_div *isl_constraint_div(
 765                 __isl_keep isl_constraint *constraint, int pos);
 766         void isl_div_get_constant(__isl_keep isl_div *div,
 767                 isl_int *v);
 768         void isl_div_get_denominator(__isl_keep isl_div *div,
 769                 isl_int *v);
 770         void isl_div_get_coefficient(__isl_keep isl_div *div,
 771                 enum isl_dim_type type, int pos, isl_int *v);
 772
 773 =head2 Properties
 774
 775 =head3 Unary Properties
 776
 777 =over
 778
 779 =item * Emptiness
 780
 781 The following functions test whether the given set or relation
 782 contains any integer points.  The ``fast'' variants do not perform
 783 any computations, but simply check if the given set or relation
 784 is already known to be empty.
 785
 786         int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
 787         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
 788         int isl_set_is_empty(__isl_keep isl_set *set);
 789         int isl_basic_map_fast_is_empty(__isl_keep isl_basic_map *bmap);
 790         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
 791         int isl_map_fast_is_empty(__isl_keep isl_map *map);
 792         int isl_map_is_empty(__isl_keep isl_map *map);
 793
 794 =item * Universality
 795
 796         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
 797         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
 798         int isl_set_fast_is_universe(__isl_keep isl_set *set);
 799
 800 =back
 801
 802 =head3 Binary Properties
 803
 804 =over
 805
 806 =item * Equality
 807
 808         int isl_set_fast_is_equal(__isl_keep isl_set *set1,
 809                 __isl_keep isl_set *set2);
 810         int isl_set_is_equal(__isl_keep isl_set *set1,
 811                 __isl_keep isl_set *set2);
 812         int isl_map_is_equal(__isl_keep isl_map *map1,
 813                 __isl_keep isl_map *map2);
 814         int isl_map_fast_is_equal(__isl_keep isl_map *map1,
 815                 __isl_keep isl_map *map2);
 816         int isl_basic_map_is_equal(
 817                 __isl_keep isl_basic_map *bmap1,
 818                 __isl_keep isl_basic_map *bmap2);
 819
 820 =item * Disjointness
 821
 822         int isl_set_fast_is_disjoint(__isl_keep isl_set *set1,
 823                 __isl_keep isl_set *set2);
 824
 825 =item * Subset
 826
 827         int isl_set_is_subset(__isl_keep isl_set *set1,
 828                 __isl_keep isl_set *set2);
 829         int isl_set_is_strict_subset(
 830                 __isl_keep isl_set *set1,
 831                 __isl_keep isl_set *set2);
 832         int isl_basic_map_is_subset(
 833                 __isl_keep isl_basic_map *bmap1,
 834                 __isl_keep isl_basic_map *bmap2);
 835         int isl_basic_map_is_strict_subset(
 836                 __isl_keep isl_basic_map *bmap1,
 837                 __isl_keep isl_basic_map *bmap2);
 838         int isl_map_is_subset(
 839                 __isl_keep isl_map *map1,
 840                 __isl_keep isl_map *map2);
 841         int isl_map_is_strict_subset(
 842                 __isl_keep isl_map *map1,
 843                 __isl_keep isl_map *map2);
 844
 845 =back
 846
 847 =head2 Unary Operations
 848
 849 =over
 850
 851 =item * Complement
 852
 853         __isl_give isl_set *isl_set_complement(
 854                 __isl_take isl_set *set);
 855
 856 =item * Projection
 857
 858         __isl_give isl_basic_set *isl_basic_set_project_out(
 859                 __isl_take isl_basic_set *bset,
 860                 enum isl_dim_type type, unsigned first, unsigned n);
 861         __isl_give isl_basic_map *isl_basic_map_project_out(
 862                 __isl_take isl_basic_map *bmap,
 863                 enum isl_dim_type type, unsigned first, unsigned n);
 864         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
 865                 enum isl_dim_type type, unsigned first, unsigned n);
 866         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
 867                 enum isl_dim_type type, unsigned first, unsigned n);
 868         __isl_give isl_basic_set *isl_basic_map_domain(
 869                 __isl_take isl_basic_map *bmap);
 870         __isl_give isl_basic_set *isl_basic_map_range(
 871                 __isl_take isl_basic_map *bmap);
 872         __isl_give isl_set *isl_map_domain(
 873                 __isl_take isl_map *bmap);
 874         __isl_give isl_set *isl_map_range(
 875                 __isl_take isl_map *map);
 876
 877 =item * Coalescing
 878
 879 Simplify the representation of a set or relation by trying
 880 to combine pairs of basic sets or relations into a single
 881 basic set or relation.
 882
 883         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
 884         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
 885
 886 =item * Convex hull
 887
 888         __isl_give isl_basic_set *isl_set_convex_hull(
 889                 __isl_take isl_set *set);
 890         __isl_give isl_basic_map *isl_map_convex_hull(
 891                 __isl_take isl_map *map);
 892
 893 If the input set or relation has any existentially quantified
 894 variables, then the result of these operations is currently undefined.
 895
 896 =item * Affine hull
 897
 898         __isl_give isl_basic_set *isl_basic_set_affine_hull(
 899                 __isl_take isl_basic_set *bset);
 900         __isl_give isl_basic_set *isl_set_affine_hull(
 901                 __isl_take isl_set *set);
 902         __isl_give isl_basic_map *isl_basic_map_affine_hull(
 903                 __isl_take isl_basic_map *bmap);
 904         __isl_give isl_basic_map *isl_map_affine_hull(
 905                 __isl_take isl_map *map);
 906
 907 =item * Power
 908
 909         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
 910                 unsigned param, int *exact);
 911
 912 Compute a parametric representation for all positive powers I<k> of C<map>.
 913 The power I<k> is equated to the parameter at position C<param>.
 914 The result may be an overapproximation.  If the result is exact,
 915 then C<*exact> is set to C<1>.
 916 The current implementation only produces exact results for particular
 917 cases of piecewise translations (i.e., piecewise uniform dependences).
 918
 919 =item * Transitive closure
 920
 921         __isl_give isl_map *isl_map_transitive_closure(
 922                 __isl_take isl_map *map, int *exact);
 923
 924 Compute the transitive closure of C<map>.
 925 The result may be an overapproximation.  If the result is known to be exact,
 926 then C<*exact> is set to C<1>.
 927 The current implementation only produces exact results for particular
 928 cases of piecewise translations (i.e., piecewise uniform dependences).
 929
 930 =back
 931
 932 =head2 Binary Operations
 933
 934 The two arguments of a binary operation not only need to live
 935 in the same C<isl_ctx>, they currently also need to have
 936 the same (number of) parameters.
 937
 938 =head3 Basic Operations
 939
 940 =over
 941
 942 =item * Intersection
 943
 944         __isl_give isl_basic_set *isl_basic_set_intersect(
 945                 __isl_take isl_basic_set *bset1,
 946                 __isl_take isl_basic_set *bset2);
 947         __isl_give isl_set *isl_set_intersect(
 948                 __isl_take isl_set *set1,
 949                 __isl_take isl_set *set2);
 950         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
 951                 __isl_take isl_basic_map *bmap,
 952                 __isl_take isl_basic_set *bset);
 953         __isl_give isl_basic_map *isl_basic_map_intersect_range(
 954                 __isl_take isl_basic_map *bmap,
 955                 __isl_take isl_basic_set *bset);
 956         __isl_give isl_basic_map *isl_basic_map_intersect(
 957                 __isl_take isl_basic_map *bmap1,
 958                 __isl_take isl_basic_map *bmap2);
 959         __isl_give isl_map *isl_map_intersect_domain(
 960                 __isl_take isl_map *map,
 961                 __isl_take isl_set *set);
 962         __isl_give isl_map *isl_map_intersect_range(
 963                 __isl_take isl_map *map,
 964                 __isl_take isl_set *set);
 965         __isl_give isl_map *isl_map_intersect(
 966                 __isl_take isl_map *map1,
 967                 __isl_take isl_map *map2);
 968
 969 =item * Union
 970
 971         __isl_give isl_set *isl_basic_set_union(
 972                 __isl_take isl_basic_set *bset1,
 973                 __isl_take isl_basic_set *bset2);
 974         __isl_give isl_map *isl_basic_map_union(
 975                 __isl_take isl_basic_map *bmap1,
 976                 __isl_take isl_basic_map *bmap2);
 977         __isl_give isl_set *isl_set_union(
 978                 __isl_take isl_set *set1,
 979                 __isl_take isl_set *set2);
 980         __isl_give isl_map *isl_map_union(
 981                 __isl_take isl_map *map1,
 982                 __isl_take isl_map *map2);
 983
 984 =item * Set difference
 985
 986         __isl_give isl_set *isl_set_subtract(
 987                 __isl_take isl_set *set1,
 988                 __isl_take isl_set *set2);
 989         __isl_give isl_map *isl_map_subtract(
 990                 __isl_take isl_map *map1,
 991                 __isl_take isl_map *map2);
 992
 993 =item * Application
 994
 995         __isl_give isl_basic_set *isl_basic_set_apply(
 996                 __isl_take isl_basic_set *bset,
 997                 __isl_take isl_basic_map *bmap);
 998         __isl_give isl_set *isl_set_apply(
 999                 __isl_take isl_set *set,
1000                 __isl_take isl_map *map);
1001         __isl_give isl_basic_map *isl_basic_map_apply_domain(
1002                 __isl_take isl_basic_map *bmap1,
1003                 __isl_take isl_basic_map *bmap2);
1004         __isl_give isl_basic_map *isl_basic_map_apply_range(
1005                 __isl_take isl_basic_map *bmap1,
1006                 __isl_take isl_basic_map *bmap2);
1007         __isl_give isl_map *isl_map_apply_domain(
1008                 __isl_take isl_map *map1,
1009                 __isl_take isl_map *map2);
1010         __isl_give isl_map *isl_map_apply_range(
1011                 __isl_take isl_map *map1,
1012                 __isl_take isl_map *map2);
1013
1014 =back
1015
1016 =head3 Lexicographic Optimization
1017
1018 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
1019 the following functions
1020 compute a set that contains the lexicographic minimum or maximum
1021 of the elements in C<set> (or C<bset>) for those values of the parameters
1022 that satisfy C<dom>.
1023 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
1024 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
1025 has no elements.
1026 In other words, the union of the parameter values
1027 for which the result is non-empty and of C<*empty>
1028 is equal to C<dom>.
1029
1030         __isl_give isl_set *isl_basic_set_partial_lexmin(
1031                 __isl_take isl_basic_set *bset,
1032                 __isl_take isl_basic_set *dom,
1033                 __isl_give isl_set **empty);
1034         __isl_give isl_set *isl_basic_set_partial_lexmax(
1035                 __isl_take isl_basic_set *bset,
1036                 __isl_take isl_basic_set *dom,
1037                 __isl_give isl_set **empty);
1038         __isl_give isl_set *isl_set_partial_lexmin(
1039                 __isl_take isl_set *set, __isl_take isl_set *dom,
1040                 __isl_give isl_set **empty);
1041         __isl_give isl_set *isl_set_partial_lexmax(
1042                 __isl_take isl_set *set, __isl_take isl_set *dom,
1043                 __isl_give isl_set **empty);
1044
1045 Given a (basic) set C<set> (or C<bset>), the following functions simply
1046 return a set containing the lexicographic minimum or maximum
1047 of the elements in C<set> (or C<bset>).
1048
1049         __isl_give isl_set *isl_basic_set_lexmin(
1050                 __isl_take isl_basic_set *bset);
1051         __isl_give isl_set *isl_basic_set_lexmax(
1052                 __isl_take isl_basic_set *bset);
1053         __isl_give isl_set *isl_set_lexmin(
1054                 __isl_take isl_set *set);
1055         __isl_give isl_set *isl_set_lexmax(
1056                 __isl_take isl_set *set);
1057
1058 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
1059 the following functions
1060 compute a relation that maps each element of C<dom>
1061 to the single lexicographic minimum or maximum
1062 of the elements that are associated to that same
1063 element in C<map> (or C<bmap>).
1064 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
1065 that contains the elements in C<dom> that do not map
1066 to any elements in C<map> (or C<bmap>).
1067 In other words, the union of the domain of the result and of C<*empty>
1068 is equal to C<dom>.
1069
1070         __isl_give isl_map *isl_basic_map_partial_lexmax(
1071                 __isl_take isl_basic_map *bmap,
1072                 __isl_take isl_basic_set *dom,
1073                 __isl_give isl_set **empty);
1074         __isl_give isl_map *isl_basic_map_partial_lexmin(
1075                 __isl_take isl_basic_map *bmap,
1076                 __isl_take isl_basic_set *dom,
1077                 __isl_give isl_set **empty);
1078         __isl_give isl_map *isl_map_partial_lexmax(
1079                 __isl_take isl_map *map, __isl_take isl_set *dom,
1080                 __isl_give isl_set **empty);
1081         __isl_give isl_map *isl_map_partial_lexmin(
1082                 __isl_take isl_map *map, __isl_take isl_set *dom,
1083                 __isl_give isl_set **empty);
1084
1085 Given a (basic) map C<map> (or C<bmap>), the following functions simply
1086 return a map mapping each element in the domain of
1087 C<map> (or C<bmap>) to the lexicographic minimum or maximum
1088 of all elements associated to that element.
1089
1090         __isl_give isl_map *isl_basic_map_lexmin(
1091                 __isl_take isl_basic_map *bmap);
1092         __isl_give isl_map *isl_basic_map_lexmax(
1093                 __isl_take isl_basic_map *bmap);
1094         __isl_give isl_map *isl_map_lexmin(
1095                 __isl_take isl_map *map);
1096         __isl_give isl_map *isl_map_lexmax(
1097                 __isl_take isl_map *map);
1098
1099 =head2 Points
1100
1101 Points are elements of a set.  They can be used to construct
1102 simple sets (boxes) or they can be used to represent the
1103 individual elements of a set.
1104 The zero point (the origin) can be created using
1105
1106         __isl_give isl_point *isl_point_zero(__isl_take isl_dim *dim);
1107
1108 The coordinates of a point can be inspected, set and changed
1109 using
1110
1111         void isl_point_get_coordinate(__isl_keep isl_point *pnt,
1112                 enum isl_dim_type type, int pos, isl_int *v);
1113         __isl_give isl_point *isl_point_set_coordinate(
1114                 __isl_take isl_point *pnt,
1115                 enum isl_dim_type type, int pos, isl_int v);
1116
1117         __isl_give isl_point *isl_point_add_ui(
1118                 __isl_take isl_point *pnt,
1119                 enum isl_dim_type type, int pos, unsigned val);
1120         __isl_give isl_point *isl_point_sub_ui(
1121                 __isl_take isl_point *pnt,
1122                 enum isl_dim_type type, int pos, unsigned val);
1123
1124 Points can be copied or freed using
1125
1126         __isl_give isl_point *isl_point_copy(
1127                 __isl_keep isl_point *pnt);
1128         void isl_point_free(__isl_take isl_point *pnt);
1129
1130 A singleton set can be created from a point using
1131
1132         __isl_give isl_set *isl_set_from_point(
1133                 __isl_take isl_point *pnt);
1134
1135 and a box can be created from two opposite extremal points using
1136
1137         __isl_give isl_set *isl_set_box_from_points(
1138                 __isl_take isl_point *pnt1,
1139                 __isl_take isl_point *pnt2);
1140
1141 All elements of a B<bounded> set can be enumerated using
1142 the following function.
1143
1144         int isl_set_foreach_point(__isl_keep isl_set *set,
1145                 int (*fn)(__isl_take isl_point *pnt, void *user),
1146                 void *user);
1147
1148 The function C<fn> is called for each integer point in
1149 C<set> with as second argument the last argument of
1150 the C<isl_set_foreach_point> call.  The function C<fn>
1151 should return C<0> on success and C<-1> on failure.
1152 In the latter case, C<isl_set_foreach_point> will stop
1153 enumerating and return C<-1> as well.
1154 If the enumeration is performed successfully and to completion,
1155 then C<isl_set_foreach_point> returns C<0>.
1156
1157 To obtain a single point of a set, use
1158
1159         __isl_give isl_point *isl_set_sample_point(
1160                 __isl_take isl_set *set);
1161
1162 If C<set> does not contain any (integer) points, then the
1163 resulting point will be ``void'', a property that can be
1164 tested using
1165
1166         int isl_point_is_void(__isl_keep isl_point *pnt);
1167
1168 =head2 Piecewise Quasipolynomials
1169
1170 A piecewise quasipolynomial is a particular kind of function that maps
1171 a parametric point to a rational value.
1172 More specifically, a quasipolynomial is a polynomial expression in greatest
1173 integer parts of affine expressions of parameters and variables.
1174 A piecewise quasipolynomial is a subdivision of a given parametric
1175 domain into disjoint cells with a quasipolynomial associated to
1176 each cell.  The value of the piecewise quasipolynomial at a given
1177 point is the value of the quasipolynomial associated to the cell
1178 that contains the point.  Outside of the union of cells,
1179 the value is assumed to be zero.
1180 For example, the piecewise quasipolynomial
1181
1182         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
1183
1184 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
1185 Piecewise quasipolynomials are mainly used by the C<barvinok>
1186 library for representing the number of elements in a parametric set or map.
1187 For example, the piecewise quasipolynomial above represents
1188 the number of point in the map
1189
1190         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
1191
1192 =head3 Printing (Piecewise) Quasipolynomials
1193
1194 Quasipolynomials and piecewise quasipolynomials can be printed
1195 using the following functions.
1196
1197         __isl_give isl_printer *isl_printer_print_qpolynomial(
1198                 __isl_take isl_printer *p,
1199                 __isl_keep isl_qpolynomial *qp);
1200
1201         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
1202                 __isl_take isl_printer *p,
1203                 __isl_keep isl_pw_qpolynomial *pwqp);
1204
1205 The output format of the printer
1206 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
1207
1208 =head3 Creating New (Piecewise) Quasipolynomials
1209
1210 Some simple quasipolynomials can be created using the following functions.
1211 More complicated quasipolynomials can be created by applying
1212 operations such as addition and multiplication
1213 on the resulting quasipolynomials
1214
1215         __isl_give isl_qpolynomial *isl_qpolynomial_zero(
1216                 __isl_take isl_dim *dim);
1217         __isl_give isl_qpolynomial *isl_qpolynomial_infty(
1218                 __isl_take isl_dim *dim);
1219         __isl_give isl_qpolynomial *isl_qpolynomial_nan(
1220                 __isl_take isl_dim *dim);
1221         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst(
1222                 __isl_take isl_dim *dim,
1223                 const isl_int n, const isl_int d);
1224         __isl_give isl_qpolynomial *isl_qpolynomial_div(
1225                 __isl_take isl_div *div);
1226         __isl_give isl_qpolynomial *isl_qpolynomial_var(
1227                 __isl_take isl_dim *dim,
1228                 enum isl_dim_type type, unsigned pos);
1229
1230 The zero piecewise quasipolynomial or a piecewise quasipolynomial
1231 with a single cell can be created using the following functions.
1232 Multiple of these single cell piecewise quasipolynomials can
1233 be combined to create more complicated piecewise quasipolynomials.
1234
1235         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
1236                 __isl_take isl_dim *dim);
1237         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
1238                 __isl_take isl_set *set,
1239                 __isl_take isl_qpolynomial *qp);
1240
1241 Quasipolynomials can be copied and freed again using the following
1242 functions.
1243
1244         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
1245                 __isl_keep isl_qpolynomial *qp);
1246         void isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
1247
1248         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
1249                 __isl_keep isl_pw_qpolynomial *pwqp);
1250         void isl_pw_qpolynomial_free(
1251                 __isl_take isl_pw_qpolynomial *pwqp);
1252
1253 =head3 Inspecting (Piecewise) Quasipolynomials
1254
1255 To iterate over the cells in a piecewise quasipolynomial,
1256 use either of the following two functions
1257
1258         int isl_pw_qpolynomial_foreach_piece(
1259                 __isl_keep isl_pw_qpolynomial *pwqp,
1260                 int (*fn)(__isl_take isl_set *set,
1261                           __isl_take isl_qpolynomial *qp,
1262                           void *user), void *user);
1263         int isl_pw_qpolynomial_foreach_lifted_piece(
1264                 __isl_keep isl_pw_qpolynomial *pwqp,
1265                 int (*fn)(__isl_take isl_set *set,
1266                           __isl_take isl_qpolynomial *qp,
1267                           void *user), void *user);
1268
1269 As usual, the function C<fn> should return C<0> on success
1270 and C<-1> on failure.  The difference between
1271 C<isl_pw_qpolynomial_foreach_piece> and
1272 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
1273 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
1274 compute unique representations for all existentially quantified
1275 variables and then turn these existentially quantified variables
1276 into extra set variables, adapting the associated quasipolynomial
1277 accordingly.  This means that the C<set> passed to C<fn>
1278 will not have any existentially quantified variables, but that
1279 the dimensions of the sets may be different for different
1280 invocations of C<fn>.
1281
1282 To iterate over all terms in a quasipolynomial,
1283 use
1284
1285         int isl_qpolynomial_foreach_term(
1286                 __isl_keep isl_qpolynomial *qp,
1287                 int (*fn)(__isl_take isl_term *term,
1288                           void *user), void *user);
1289
1290 The terms themselves can be inspected and freed using
1291 these functions
1292
1293         unsigned isl_term_dim(__isl_keep isl_term *term,
1294                 enum isl_dim_type type);
1295         void isl_term_get_num(__isl_keep isl_term *term,
1296                 isl_int *n);
1297         void isl_term_get_den(__isl_keep isl_term *term,
1298                 isl_int *d);
1299         int isl_term_get_exp(__isl_keep isl_term *term,
1300                 enum isl_dim_type type, unsigned pos);
1301         __isl_give isl_div *isl_term_get_div(
1302                 __isl_keep isl_term *term, unsigned pos);
1303         void isl_term_free(__isl_take isl_term *term);
1304
1305 Each term is a product of parameters, set variables and
1306 integer divisions.  The function C<isl_term_get_exp>
1307 returns the exponent of a given dimensions in the given term.
1308 The C<isl_int>s in the arguments of C<isl_term_get_num>
1309 and C<isl_term_get_den> need to have been initialized
1310 using C<isl_int_init> before calling these functions.
1311
1312 =head3 Properties of (Piecewise) Quasipolynomials
1313
1314 To check whether a quasipolynomial is actually a constant,
1315 use the following function.
1316
1317         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
1318                 isl_int *n, isl_int *d);
1319
1320 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
1321 then the numerator and denominator of the constant
1322 are returned in C<*n> and C<*d>, respectively.
1323
1324 =head3 Operations on (Piecewise) Quasipolynomials
1325
1326         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
1327                 __isl_take isl_qpolynomial *qp);
1328         __isl_give isl_qpolynomial *isl_qpolynomial_add(
1329                 __isl_take isl_qpolynomial *qp1,
1330                 __isl_take isl_qpolynomial *qp2);
1331         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
1332                 __isl_take isl_qpolynomial *qp1,
1333                 __isl_take isl_qpolynomial *qp2);
1334
1335         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
1336                 __isl_take isl_pw_qpolynomial *pwqp1,
1337                 __isl_take isl_pw_qpolynomial *pwqp2);
1338         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
1339                 __isl_take isl_pw_qpolynomial *pwqp1,
1340                 __isl_take isl_pw_qpolynomial *pwqp2);
1341         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
1342                 __isl_take isl_pw_qpolynomial *pwqp1,
1343                 __isl_take isl_pw_qpolynomial *pwqp2);
1344         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
1345                 __isl_take isl_pw_qpolynomial *pwqp);
1346         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
1347                 __isl_take isl_pw_qpolynomial *pwqp1,
1348                 __isl_take isl_pw_qpolynomial *pwqp2);
1349
1350         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
1351                 __isl_take isl_pw_qpolynomial *pwqp,
1352                 __isl_take isl_point *pnt);
1353
1354         __isl_give isl_set *isl_pw_qpolynomial_domain(
1355                 __isl_take isl_pw_qpolynomial *pwqp);
1356         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
1357                 __isl_take isl_pw_qpolynomial *pwpq,
1358                 __isl_take isl_set *set);
1359
1360 =head2 Dependence Analysis
1361
1362 C<isl> contains specialized functionality for performing
1363 array dataflow analysis.  That is, given a I<sink> access relation
1364 and a collection of possible I<source> access relations,
1365 C<isl> can compute relations that describe
1366 for each iteration of the sink access, which iteration
1367 of which of the source access relations was the last
1368 to access the same data element before the given iteration
1369 of the sink access.
1370 To compute standard flow dependences, the sink should be
1371 a read, while the sources should be writes.
1372
1373         #include <isl_flow.h>
1374
1375         __isl_give isl_access_info *isl_access_info_alloc(
1376                 __isl_take isl_map *sink,
1377                 void *sink_user, isl_access_level_before fn,
1378                 int max_source);
1379         __isl_give isl_access_info *isl_access_info_add_source(
1380                 __isl_take isl_access_info *acc,
1381                 __isl_take isl_map *source, void *source_user);
1382
1383         __isl_give isl_flow *isl_access_info_compute_flow(
1384                 __isl_take isl_access_info *acc);
1385
1386         int isl_flow_foreach(__isl_keep isl_flow *deps,
1387                 int (*fn)(__isl_take isl_map *dep, void *dep_user,
1388                           void *user),
1389                 void *user);
1390         __isl_give isl_set *isl_flow_get_no_source(
1391                 __isl_keep isl_flow *deps);
1392         void isl_flow_free(__isl_take isl_flow *deps);
1393
1394 The function C<isl_access_info_compute_flow> performs the actual
1395 dependence analysis.  The other functions are used to construct
1396 the input for this function or to read off the output.
1397
1398 The input is collected in an C<isl_access_info>, which can
1399 be created through a call to C<isl_access_info_alloc>.
1400 The arguments to this functions are the sink access relation
1401 C<sink>, a token C<sink_user> used to identify the sink
1402 access to the user, a callback function for specifying the
1403 relative order of source and sink accesses, and the number
1404 of source access relations that will be added.
1405 The callback function has type C<int (*)(void *first, void *second)>.
1406 The function is called with two user supplied tokens identifying
1407 either a source or the sink and it should return the shared nesting
1408 level and the relative order of the two accesses.
1409 In particular, let I<n> be the number of loops shared by
1410 the two accesses.  If C<first> precedes C<second> textually,
1411 then the function should return I<2 * n + 1>; otherwise,
1412 it should return I<2 * n>.
1413 The sources can be added to the C<isl_access_info> by performing
1414 (at most) C<max_source> calls to C<isl_access_info_add_source>.
1415 The C<source_user> token is again used to identify
1416 the source access.  The range of the source access relation
1417 C<source> should have the same dimension as the range
1418 of the sink access relation.
1419
1420 The result of the dependence analysis is collected in an
1421 C<isl_flow>.  There may be elements in the domain of
1422 the sink access for which no preceding source access could be
1423 find.  The set of these elements can be obtained through
1424 a call to C<isl_flow_get_no_source>.
1425 In the case of standard flow dependence analysis,
1426 this set corresponds to the reads from uninitialized
1427 array elements.
1428 The actual flow dependences can be extracted using
1429 C<isl_flow_foreach>.  This function will call the user-specified
1430 callback function C<fn> for each B<non-empty> dependence between
1431 a source and the sink.  The callback function is called
1432 with three arguments, the actual flow dependence relation
1433 mapping source iterations to sink iterations, a token
1434 identifying the source and an additional C<void *> with value
1435 equal to the third argument of the C<isl_flow_foreach> call.
1436
1437 After finishing with an C<isl_flow>, the user should call
1438 C<isl_flow_free> to free all associated memory.
1439
1440 =head1 Applications
1441
1442 Although C<isl> is mainly meant to be used as a library,
1443 it also contains some basic applications that use some
1444 of the functionality of C<isl>.
1445 The input may be specified in either the L<isl format>
1446 or the L<PolyLib format>.
1447
1448 =head2 C<isl_polyhedron_sample>
1449
1450 C<isl_polyhedron_sample> takes a polyhedron as input and prints
1451 an integer element of the polyhedron, if there is any.
1452 The first column in the output is the denominator and is always
1453 equal to 1.  If the polyhedron contains no integer points,
1454 then a vector of length zero is printed.
1455
1456 =head2 C<isl_pip>
1457
1458 C<isl_pip> takes the same input as the C<example> program
1459 from the C<piplib> distribution, i.e., a set of constraints
1460 on the parameters, a line contains only -1 and finally a set
1461 of constraints on a parametric polyhedron.
1462 The coefficients of the parameters appear in the last columns
1463 (but before the final constant column).
1464 The output is the lexicographic minimum of the parametric polyhedron.
1465 As C<isl> currently does not have its own output format, the output
1466 is just a dump of the internal state.
1467
1468 =head2 C<isl_polyhedron_minimize>
1469
1470 C<isl_polyhedron_minimize> computes the minimum of some linear
1471 or affine objective function over the integer points in a polyhedron.
1472 If an affine objective function
1473 is given, then the constant should appear in the last column.
1474
1475 =head2 C<isl_polytope_scan>
1476
1477 Given a polytope, C<isl_polytope_scan> prints
1478 all integer points in the polytope.
1479
1480 =head1 C<isl-polylib>
1481
1482 The C<isl-polylib> library provides the following functions for converting
1483 between C<isl> objects and C<PolyLib> objects.
1484 The library is distributed separately for licensing reasons.
1485
1486         #include <isl_set_polylib.h>
1487         __isl_give isl_basic_set *isl_basic_set_new_from_polylib(
1488                 Polyhedron *P, __isl_take isl_dim *dim);
1489         Polyhedron *isl_basic_set_to_polylib(
1490                 __isl_keep isl_basic_set *bset);
1491         __isl_give isl_set *isl_set_new_from_polylib(Polyhedron *D,
1492                 __isl_take isl_dim *dim);
1493         Polyhedron *isl_set_to_polylib(__isl_keep isl_set *set);
1494
1495         #include <isl_map_polylib.h>
1496         __isl_give isl_basic_map *isl_basic_map_new_from_polylib(
1497                 Polyhedron *P, __isl_take isl_dim *dim);
1498         __isl_give isl_map *isl_map_new_from_polylib(Polyhedron *D,
1499                 __isl_take isl_dim *dim);
1500         Polyhedron *isl_basic_map_to_polylib(
1501                 __isl_keep isl_basic_map *bmap);
1502         Polyhedron *isl_map_to_polylib(__isl_keep isl_map *map);