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 objects that live in the
 375 same space as some other object.  This can be accomplished
 376 by creating the new objects
 377 (see L<Creating New Sets and Relations> or
 378 L<Creating New (Piecewise) Quasipolynomials>) based on the dimension
 379 specification of the original object.
 380
 381         #include <isl_set.h>
 382         __isl_give isl_dim *isl_basic_set_get_dim(
 383                 __isl_keep isl_basic_set *bset);
 384         __isl_give isl_dim *isl_set_get_dim(__isl_keep isl_set *set);
 385
 386         #include <isl_map.h>
 387         __isl_give isl_dim *isl_basic_map_get_dim(
 388                 __isl_keep isl_basic_map *bmap);
 389         __isl_give isl_dim *isl_map_get_dim(__isl_keep isl_map *map);
 390
 391         #include <isl_polynomial.h>
 392         __isl_give isl_dim *isl_qpolynomial_get_dim(
 393                 __isl_keep isl_qpolynomial *qp);
 394         __isl_give isl_dim *isl_pw_qpolynomial_get_dim(
 395                 __isl_keep isl_pw_qpolynomial *pwqp);
 396
 397 The names of the individual dimensions may be set or read off
 398 using the following functions.
 399
 400         #include <isl_dim.h>
 401         __isl_give isl_dim *isl_dim_set_name(__isl_take isl_dim *dim,
 402                                  enum isl_dim_type type, unsigned pos,
 403                                  __isl_keep const char *name);
 404         __isl_keep const char *isl_dim_get_name(__isl_keep isl_dim *dim,
 405                                  enum isl_dim_type type, unsigned pos);
 406
 407 Note that C<isl_dim_get_name> returns a pointer to some internal
 408 data structure, so the result can only be used while the
 409 corresponding C<isl_dim> is alive.
 410 Also note that every function that operates on two sets or relations
 411 requires that both arguments have the same parameters.  This also
 412 means that if one of the arguments has named parameters, then the
 413 other needs to have named parameters too and the names need to match.
 414
 415 =head2 Input and Output
 416
 417 C<isl> supports its own input/output format, which is similar
 418 to the C<Omega> format, but also supports the C<PolyLib> format
 419 in some cases.
 420
 421 =head3 C<isl> format
 422
 423 The C<isl> format is similar to that of C<Omega>, but has a different
 424 syntax for describing the parameters and allows for the definition
 425 of an existentially quantified variable as the integer division
 426 of an affine expression.
 427 For example, the set of integers C<i> between C<0> and C<n>
 428 such that C<i % 10 <= 6> can be described as
 429
 430         [n] -> { [i] : exists (a = [i/10] : 0 <= i and i <= n and
 431                                 i - 10 a <= 6) }
 432
 433 A set or relation can have several disjuncts, separated
 434 by the keyword C<or>.  Each disjunct is either a conjunction
 435 of constraints or a projection (C<exists>) of a conjunction
 436 of constraints.  The constraints are separated by the keyword
 437 C<and>.
 438
 439 =head3 C<PolyLib> format
 440
 441 If the represented set is a union, then the first line
 442 contains a single number representing the number of disjuncts.
 443 Otherwise, a line containing the number C<1> is optional.
 444
 445 Each disjunct is represented by a matrix of constraints.
 446 The first line contains two numbers representing
 447 the number of rows and columns,
 448 where the number of rows is equal to the number of constraints
 449 and the number of columns is equal to two plus the number of variables.
 450 The following lines contain the actual rows of the constraint matrix.
 451 In each row, the first column indicates whether the constraint
 452 is an equality (C<0>) or inequality (C<1>).  The final column
 453 corresponds to the constant term.
 454
 455 If the set is parametric, then the coefficients of the parameters
 456 appear in the last columns before the constant column.
 457 The coefficients of any existentially quantified variables appear
 458 between those of the set variables and those of the parameters.
 459
 460 =head3 Input
 461
 462         #include <isl_set.h>
 463         __isl_give isl_basic_set *isl_basic_set_read_from_file(
 464                 isl_ctx *ctx, FILE *input, int nparam);
 465         __isl_give isl_basic_set *isl_basic_set_read_from_str(
 466                 isl_ctx *ctx, const char *str, int nparam);
 467         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
 468                 FILE *input, int nparam);
 469         __isl_give isl_set *isl_set_read_from_str(isl_ctx *ctx,
 470                 const char *str, int nparam);
 471
 472         #include <isl_map.h>
 473         __isl_give isl_basic_map *isl_basic_map_read_from_file(
 474                 isl_ctx *ctx, FILE *input, int nparam);
 475         __isl_give isl_basic_map *isl_basic_map_read_from_str(
 476                 isl_ctx *ctx, const char *str, int nparam);
 477         __isl_give isl_map *isl_map_read_from_file(
 478                 struct isl_ctx *ctx, FILE *input, int nparam);
 479         __isl_give isl_map *isl_map_read_from_str(isl_ctx *ctx,
 480                 const char *str, int nparam);
 481
 482 The input format is autodetected and may be either the C<PolyLib> format
 483 or the C<isl> format.
 484 C<nparam> specifies how many of the final columns in
 485 the C<PolyLib> format correspond to parameters.
 486 If input is given in the C<isl> format, then the number
 487 of parameters needs to be equal to C<nparam>.
 488 If C<nparam> is negative, then any number of parameters
 489 is accepted in the C<isl> format and zero parameters
 490 are assumed in the C<PolyLib> format.
 491
 492 =head3 Output
 493
 494 Before anything can be printed, an C<isl_printer> needs to
 495 be created.
 496
 497         __isl_give isl_printer *isl_printer_to_file(isl_ctx *ctx,
 498                 FILE *file);
 499         __isl_give isl_printer *isl_printer_to_str(isl_ctx *ctx);
 500         void isl_printer_free(__isl_take isl_printer *printer);
 501         __isl_give char *isl_printer_get_str(
 502                 __isl_keep isl_printer *printer);
 503
 504 The behavior of the printer can be modified in various ways
 505
 506         __isl_give isl_printer *isl_printer_set_output_format(
 507                 __isl_take isl_printer *p, int output_format);
 508         __isl_give isl_printer *isl_printer_set_indent(
 509                 __isl_take isl_printer *p, int indent);
 510         __isl_give isl_printer *isl_printer_set_prefix(
 511                 __isl_take isl_printer *p, const char *prefix);
 512         __isl_give isl_printer *isl_printer_set_suffix(
 513                 __isl_take isl_printer *p, const char *suffix);
 514
 515 The C<output_format> may be either C<ISL_FORMAT_ISL>, C<ISL_FORMAT_OMEGA>
 516 or C<ISL_FORMAT_POLYLIB> and defaults to C<ISL_FORMAT_ISL>.
 517 Each line in the output is indented by C<indent> spaces
 518 (default: 0), prefixed by C<prefix> and suffixed by C<suffix>.
 519 In the C<PolyLib> format output,
 520 the coefficients of the existentially quantified variables
 521 appear between those of the set variables and those
 522 of the parameters.
 523
 524 To actually print something, use
 525
 526         #include <isl_set.h>
 527         __isl_give isl_printer *isl_printer_print_basic_set(
 528                 __isl_take isl_printer *printer,
 529                 __isl_keep isl_basic_set *bset);
 530         __isl_give isl_printer *isl_printer_print_set(
 531                 __isl_take isl_printer *printer,
 532                 __isl_keep isl_set *set);
 533
 534         #include <isl_map.h>
 535         __isl_give isl_printer *isl_printer_print_basic_map(
 536                 __isl_take isl_printer *printer,
 537                 __isl_keep isl_basic_map *bmap);
 538         __isl_give isl_printer *isl_printer_print_map(
 539                 __isl_take isl_printer *printer,
 540                 __isl_keep isl_map *map);
 541
 542 When called on a file printer, the following function flushes
 543 the file.  When called on a string printer, the buffer is cleared.
 544
 545         __isl_give isl_printer *isl_printer_flush(
 546                 __isl_take isl_printer *p);
 547
 548 =head2 Creating New Sets and Relations
 549
 550 C<isl> has functions for creating some standard sets and relations.
 551
 552 =over
 553
 554 =item * Empty sets and relations
 555
 556         __isl_give isl_basic_set *isl_basic_set_empty(
 557                 __isl_take isl_dim *dim);
 558         __isl_give isl_basic_map *isl_basic_map_empty(
 559                 __isl_take isl_dim *dim);
 560         __isl_give isl_set *isl_set_empty(
 561                 __isl_take isl_dim *dim);
 562         __isl_give isl_map *isl_map_empty(
 563                 __isl_take isl_dim *dim);
 564
 565 =item * Universe sets and relations
 566
 567         __isl_give isl_basic_set *isl_basic_set_universe(
 568                 __isl_take isl_dim *dim);
 569         __isl_give isl_basic_map *isl_basic_map_universe(
 570                 __isl_take isl_dim *dim);
 571         __isl_give isl_set *isl_set_universe(
 572                 __isl_take isl_dim *dim);
 573         __isl_give isl_map *isl_map_universe(
 574                 __isl_take isl_dim *dim);
 575
 576 =item * Identity relations
 577
 578         __isl_give isl_basic_map *isl_basic_map_identity(
 579                 __isl_take isl_dim *set_dim);
 580         __isl_give isl_map *isl_map_identity(
 581                 __isl_take isl_dim *set_dim);
 582
 583 These functions take a dimension specification for a B<set>
 584 and return an identity relation between two such sets.
 585
 586 =item * Lexicographic order
 587
 588         __isl_give isl_map *isl_map_lex_lt(
 589                 __isl_take isl_dim *set_dim);
 590         __isl_give isl_map *isl_map_lex_le(
 591                 __isl_take isl_dim *set_dim);
 592         __isl_give isl_map *isl_map_lex_gt(
 593                 __isl_take isl_dim *set_dim);
 594         __isl_give isl_map *isl_map_lex_ge(
 595                 __isl_take isl_dim *set_dim);
 596         __isl_give isl_map *isl_map_lex_lt_first(
 597                 __isl_take isl_dim *dim, unsigned n);
 598         __isl_give isl_map *isl_map_lex_le_first(
 599                 __isl_take isl_dim *dim, unsigned n);
 600         __isl_give isl_map *isl_map_lex_gt_first(
 601                 __isl_take isl_dim *dim, unsigned n);
 602         __isl_give isl_map *isl_map_lex_ge_first(
 603                 __isl_take isl_dim *dim, unsigned n);
 604
 605 The first four functions take a dimension specification for a B<set>
 606 and return relations that express that the elements in the domain
 607 are lexicographically less
 608 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
 609 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
 610 than the elements in the range.
 611 The last four functions take a dimension specification for a map
 612 and return relations that express that the first C<n> dimensions
 613 in the domain are lexicographically less
 614 (C<isl_map_lex_lt_first>), less or equal (C<isl_map_lex_le_first>),
 615 greater (C<isl_map_lex_gt_first>) or greater or equal (C<isl_map_lex_ge_first>)
 616 than the first C<n> dimensions in the range.
 617
 618 =back
 619
 620 A basic set or relation can be converted to a set or relation
 621 using the following functions.
 622
 623         __isl_give isl_set *isl_set_from_basic_set(
 624                 __isl_take isl_basic_set *bset);
 625         __isl_give isl_map *isl_map_from_basic_map(
 626                 __isl_take isl_basic_map *bmap);
 627
 628 Sets and relations can be copied and freed again using the following
 629 functions.
 630
 631         __isl_give isl_basic_set *isl_basic_set_copy(
 632                 __isl_keep isl_basic_set *bset);
 633         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
 634         __isl_give isl_basic_map *isl_basic_map_copy(
 635                 __isl_keep isl_basic_map *bmap);
 636         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
 637         void isl_basic_set_free(__isl_take isl_basic_set *bset);
 638         void isl_set_free(__isl_take isl_set *set);
 639         void isl_basic_map_free(__isl_take isl_basic_map *bmap);
 640         void isl_map_free(__isl_take isl_map *map);
 641
 642 Other sets and relations can be constructed by starting
 643 from a universe set or relation, adding equality and/or
 644 inequality constraints and then projecting out the
 645 existentially quantified variables, if any.
 646 Constraints can be constructed, manipulated and
 647 added to basic sets and relations using the following functions.
 648
 649         #include <isl_constraint.h>
 650         __isl_give isl_constraint *isl_equality_alloc(
 651                 __isl_take isl_dim *dim);
 652         __isl_give isl_constraint *isl_inequality_alloc(
 653                 __isl_take isl_dim *dim);
 654         void isl_constraint_set_constant(
 655                 __isl_keep isl_constraint *constraint, isl_int v);
 656         void isl_constraint_set_coefficient(
 657                 __isl_keep isl_constraint *constraint,
 658                 enum isl_dim_type type, int pos, isl_int v);
 659         __isl_give isl_basic_map *isl_basic_map_add_constraint(
 660                 __isl_take isl_basic_map *bmap,
 661                 __isl_take isl_constraint *constraint);
 662         __isl_give isl_basic_set *isl_basic_set_add_constraint(
 663                 __isl_take isl_basic_set *bset,
 664                 __isl_take isl_constraint *constraint);
 665
 666 For example, to create a set containing the even integers
 667 between 10 and 42, you would use the following code.
 668
 669         isl_int v;
 670         struct isl_dim *dim;
 671         struct isl_constraint *c;
 672         struct isl_basic_set *bset;
 673
 674         isl_int_init(v);
 675         dim = isl_dim_set_alloc(ctx, 0, 2);
 676         bset = isl_basic_set_universe(isl_dim_copy(dim));
 677
 678         c = isl_equality_alloc(isl_dim_copy(dim));
 679         isl_int_set_si(v, -1);
 680         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 681         isl_int_set_si(v, 2);
 682         isl_constraint_set_coefficient(c, isl_dim_set, 1, v);
 683         bset = isl_basic_set_add_constraint(bset, c);
 684
 685         c = isl_inequality_alloc(isl_dim_copy(dim));
 686         isl_int_set_si(v, -10);
 687         isl_constraint_set_constant(c, v);
 688         isl_int_set_si(v, 1);
 689         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 690         bset = isl_basic_set_add_constraint(bset, c);
 691
 692         c = isl_inequality_alloc(dim);
 693         isl_int_set_si(v, 42);
 694         isl_constraint_set_constant(c, v);
 695         isl_int_set_si(v, -1);
 696         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 697         bset = isl_basic_set_add_constraint(bset, c);
 698
 699         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
 700
 701         isl_int_clear(v);
 702
 703 Or, alternatively,
 704
 705         struct isl_basic_set *bset;
 706         bset = isl_basic_set_read_from_str(ctx,
 707                 "{[i] : exists (a : i = 2a and i >= 10 and i <= 42)}", -1);
 708
 709 =head2 Inspecting Sets and Relations
 710
 711 Usually, the user should not have to care about the actual constraints
 712 of the sets and maps, but should instead apply the abstract operations
 713 explained in the following sections.
 714 Occasionally, however, it may be required to inspect the individual
 715 coefficients of the constraints.  This section explains how to do so.
 716 In these cases, it may also be useful to have C<isl> compute
 717 an explicit representation of the existentially quantified variables.
 718
 719         __isl_give isl_set *isl_set_compute_divs(
 720                 __isl_take isl_set *set);
 721         __isl_give isl_map *isl_map_compute_divs(
 722                 __isl_take isl_map *map);
 723
 724 This explicit representation defines the existentially quantified
 725 variables as integer divisions of the other variables, possibly
 726 including earlier existentially quantified variables.
 727 An explicitly represented existentially quantified variable therefore
 728 has a unique value when the values of the other variables are known.
 729 If, furthermore, the same existentials, i.e., existentials
 730 with the same explicit representations, should appear in the
 731 same order in each of the disjuncts of a set or map, then the user should call
 732 either of the following functions.
 733
 734         __isl_give isl_set *isl_set_align_divs(
 735                 __isl_take isl_set *set);
 736         __isl_give isl_map *isl_map_align_divs(
 737                 __isl_take isl_map *map);
 738
 739 To iterate over all the basic sets or maps in a set or map, use
 740
 741         int isl_set_foreach_basic_set(__isl_keep isl_set *set,
 742                 int (*fn)(__isl_take isl_basic_set *bset, void *user),
 743                 void *user);
 744         int isl_map_foreach_basic_map(__isl_keep isl_map *map,
 745                 int (*fn)(__isl_take isl_basic_map *bmap, void *user),
 746                 void *user);
 747
 748 The callback function C<fn> should return 0 if successful and
 749 -1 if an error occurs.  In the latter case, or if any other error
 750 occurs, the above functions will return -1.
 751
 752 It should be noted that C<isl> does not guarantee that
 753 the basic sets or maps passed to C<fn> are disjoint.
 754 If this is required, then the user should call one of
 755 the following functions first.
 756
 757         __isl_give isl_set *isl_set_make_disjoint(
 758                 __isl_take isl_set *set);
 759         __isl_give isl_map *isl_map_make_disjoint(
 760                 __isl_take isl_map *map);
 761
 762 To iterate over the constraints of a basic set or map, use
 763
 764         #include <isl_constraint.h>
 765
 766         int isl_basic_map_foreach_constraint(
 767                 __isl_keep isl_basic_map *bmap,
 768                 int (*fn)(__isl_take isl_constraint *c, void *user),
 769                 void *user);
 770         void isl_constraint_free(struct isl_constraint *c);
 771
 772 Again, the callback function C<fn> should return 0 if successful and
 773 -1 if an error occurs.  In the latter case, or if any other error
 774 occurs, the above functions will return -1.
 775
 776 The coefficients of the constraints can be inspected using
 777 the following functions.
 778
 779         void isl_constraint_get_constant(
 780                 __isl_keep isl_constraint *constraint, isl_int *v);
 781         void isl_constraint_get_coefficient(
 782                 __isl_keep isl_constraint *constraint,
 783                 enum isl_dim_type type, int pos, isl_int *v);
 784
 785 The explicit representations of the existentially quantified
 786 variables can be inspected using the following functions.
 787 Note that the user is only allowed to use these functions
 788 if the inspected set or map is the result of a call
 789 to C<isl_set_compute_divs> or C<isl_map_compute_divs>.
 790
 791         __isl_give isl_div *isl_constraint_div(
 792                 __isl_keep isl_constraint *constraint, int pos);
 793         void isl_div_get_constant(__isl_keep isl_div *div,
 794                 isl_int *v);
 795         void isl_div_get_denominator(__isl_keep isl_div *div,
 796                 isl_int *v);
 797         void isl_div_get_coefficient(__isl_keep isl_div *div,
 798                 enum isl_dim_type type, int pos, isl_int *v);
 799
 800 =head2 Properties
 801
 802 =head3 Unary Properties
 803
 804 =over
 805
 806 =item * Emptiness
 807
 808 The following functions test whether the given set or relation
 809 contains any integer points.  The ``fast'' variants do not perform
 810 any computations, but simply check if the given set or relation
 811 is already known to be empty.
 812
 813         int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
 814         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
 815         int isl_set_is_empty(__isl_keep isl_set *set);
 816         int isl_basic_map_fast_is_empty(__isl_keep isl_basic_map *bmap);
 817         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
 818         int isl_map_fast_is_empty(__isl_keep isl_map *map);
 819         int isl_map_is_empty(__isl_keep isl_map *map);
 820
 821 =item * Universality
 822
 823         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
 824         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
 825         int isl_set_fast_is_universe(__isl_keep isl_set *set);
 826
 827 =back
 828
 829 =head3 Binary Properties
 830
 831 =over
 832
 833 =item * Equality
 834
 835         int isl_set_fast_is_equal(__isl_keep isl_set *set1,
 836                 __isl_keep isl_set *set2);
 837         int isl_set_is_equal(__isl_keep isl_set *set1,
 838                 __isl_keep isl_set *set2);
 839         int isl_map_is_equal(__isl_keep isl_map *map1,
 840                 __isl_keep isl_map *map2);
 841         int isl_map_fast_is_equal(__isl_keep isl_map *map1,
 842                 __isl_keep isl_map *map2);
 843         int isl_basic_map_is_equal(
 844                 __isl_keep isl_basic_map *bmap1,
 845                 __isl_keep isl_basic_map *bmap2);
 846
 847 =item * Disjointness
 848
 849         int isl_set_fast_is_disjoint(__isl_keep isl_set *set1,
 850                 __isl_keep isl_set *set2);
 851
 852 =item * Subset
 853
 854         int isl_set_is_subset(__isl_keep isl_set *set1,
 855                 __isl_keep isl_set *set2);
 856         int isl_set_is_strict_subset(
 857                 __isl_keep isl_set *set1,
 858                 __isl_keep isl_set *set2);
 859         int isl_basic_map_is_subset(
 860                 __isl_keep isl_basic_map *bmap1,
 861                 __isl_keep isl_basic_map *bmap2);
 862         int isl_basic_map_is_strict_subset(
 863                 __isl_keep isl_basic_map *bmap1,
 864                 __isl_keep isl_basic_map *bmap2);
 865         int isl_map_is_subset(
 866                 __isl_keep isl_map *map1,
 867                 __isl_keep isl_map *map2);
 868         int isl_map_is_strict_subset(
 869                 __isl_keep isl_map *map1,
 870                 __isl_keep isl_map *map2);
 871
 872 =back
 873
 874 =head2 Unary Operations
 875
 876 =over
 877
 878 =item * Complement
 879
 880         __isl_give isl_set *isl_set_complement(
 881                 __isl_take isl_set *set);
 882
 883 =item * Inverse map
 884
 885         __isl_give isl_basic_map *isl_basic_map_reverse(
 886                 __isl_take isl_basic_map *bmap);
 887         __isl_give isl_map *isl_map_reverse(
 888                 __isl_take isl_map *map);
 889
 890 =item * Projection
 891
 892         __isl_give isl_basic_set *isl_basic_set_project_out(
 893                 __isl_take isl_basic_set *bset,
 894                 enum isl_dim_type type, unsigned first, unsigned n);
 895         __isl_give isl_basic_map *isl_basic_map_project_out(
 896                 __isl_take isl_basic_map *bmap,
 897                 enum isl_dim_type type, unsigned first, unsigned n);
 898         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
 899                 enum isl_dim_type type, unsigned first, unsigned n);
 900         __isl_give isl_map *isl_map_project_out(__isl_take isl_map *map,
 901                 enum isl_dim_type type, unsigned first, unsigned n);
 902         __isl_give isl_basic_set *isl_basic_map_domain(
 903                 __isl_take isl_basic_map *bmap);
 904         __isl_give isl_basic_set *isl_basic_map_range(
 905                 __isl_take isl_basic_map *bmap);
 906         __isl_give isl_set *isl_map_domain(
 907                 __isl_take isl_map *bmap);
 908         __isl_give isl_set *isl_map_range(
 909                 __isl_take isl_map *map);
 910
 911 =item * Coalescing
 912
 913 Simplify the representation of a set or relation by trying
 914 to combine pairs of basic sets or relations into a single
 915 basic set or relation.
 916
 917         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
 918         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
 919
 920 =item * Convex hull
 921
 922         __isl_give isl_basic_set *isl_set_convex_hull(
 923                 __isl_take isl_set *set);
 924         __isl_give isl_basic_map *isl_map_convex_hull(
 925                 __isl_take isl_map *map);
 926
 927 If the input set or relation has any existentially quantified
 928 variables, then the result of these operations is currently undefined.
 929
 930 =item * Simple hull
 931
 932         __isl_give isl_basic_set *isl_set_simple_hull(
 933                 __isl_take isl_set *set);
 934         __isl_give isl_basic_map *isl_map_simple_hull(
 935                 __isl_take isl_map *map);
 936
 937 These functions compute a single basic set or relation
 938 that contains the whole input set or relation.
 939 In particular, the output is described by translates
 940 of the constraints describing the basic sets or relations in the input.
 941
 942 =begin latex
 943
 944 (See \autoref{s:simple hull}.)
 945
 946 =end latex
 947
 948 =item * Affine hull
 949
 950         __isl_give isl_basic_set *isl_basic_set_affine_hull(
 951                 __isl_take isl_basic_set *bset);
 952         __isl_give isl_basic_set *isl_set_affine_hull(
 953                 __isl_take isl_set *set);
 954         __isl_give isl_basic_map *isl_basic_map_affine_hull(
 955                 __isl_take isl_basic_map *bmap);
 956         __isl_give isl_basic_map *isl_map_affine_hull(
 957                 __isl_take isl_map *map);
 958
 959 =item * Power
 960
 961         __isl_give isl_map *isl_map_power(__isl_take isl_map *map,
 962                 unsigned param, int *exact);
 963
 964 Compute a parametric representation for all positive powers I<k> of C<map>.
 965 The power I<k> is equated to the parameter at position C<param>.
 966 The result may be an overapproximation.  If the result is exact,
 967 then C<*exact> is set to C<1>.
 968 The current implementation only produces exact results for particular
 969 cases of piecewise translations (i.e., piecewise uniform dependences).
 970
 971 =item * Transitive closure
 972
 973         __isl_give isl_map *isl_map_transitive_closure(
 974                 __isl_take isl_map *map, int *exact);
 975
 976 Compute the transitive closure of C<map>.
 977 The result may be an overapproximation.  If the result is known to be exact,
 978 then C<*exact> is set to C<1>.
 979 The current implementation only produces exact results for particular
 980 cases of piecewise translations (i.e., piecewise uniform dependences).
 981
 982 =back
 983
 984 =head2 Binary Operations
 985
 986 The two arguments of a binary operation not only need to live
 987 in the same C<isl_ctx>, they currently also need to have
 988 the same (number of) parameters.
 989
 990 =head3 Basic Operations
 991
 992 =over
 993
 994 =item * Intersection
 995
 996         __isl_give isl_basic_set *isl_basic_set_intersect(
 997                 __isl_take isl_basic_set *bset1,
 998                 __isl_take isl_basic_set *bset2);
 999         __isl_give isl_set *isl_set_intersect(
1000                 __isl_take isl_set *set1,
1001                 __isl_take isl_set *set2);
1002         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
1003                 __isl_take isl_basic_map *bmap,
1004                 __isl_take isl_basic_set *bset);
1005         __isl_give isl_basic_map *isl_basic_map_intersect_range(
1006                 __isl_take isl_basic_map *bmap,
1007                 __isl_take isl_basic_set *bset);
1008         __isl_give isl_basic_map *isl_basic_map_intersect(
1009                 __isl_take isl_basic_map *bmap1,
1010                 __isl_take isl_basic_map *bmap2);
1011         __isl_give isl_map *isl_map_intersect_domain(
1012                 __isl_take isl_map *map,
1013                 __isl_take isl_set *set);
1014         __isl_give isl_map *isl_map_intersect_range(
1015                 __isl_take isl_map *map,
1016                 __isl_take isl_set *set);
1017         __isl_give isl_map *isl_map_intersect(
1018                 __isl_take isl_map *map1,
1019                 __isl_take isl_map *map2);
1020
1021 =item * Union
1022
1023         __isl_give isl_set *isl_basic_set_union(
1024                 __isl_take isl_basic_set *bset1,
1025                 __isl_take isl_basic_set *bset2);
1026         __isl_give isl_map *isl_basic_map_union(
1027                 __isl_take isl_basic_map *bmap1,
1028                 __isl_take isl_basic_map *bmap2);
1029         __isl_give isl_set *isl_set_union(
1030                 __isl_take isl_set *set1,
1031                 __isl_take isl_set *set2);
1032         __isl_give isl_map *isl_map_union(
1033                 __isl_take isl_map *map1,
1034                 __isl_take isl_map *map2);
1035
1036 =item * Set difference
1037
1038         __isl_give isl_set *isl_set_subtract(
1039                 __isl_take isl_set *set1,
1040                 __isl_take isl_set *set2);
1041         __isl_give isl_map *isl_map_subtract(
1042                 __isl_take isl_map *map1,
1043                 __isl_take isl_map *map2);
1044
1045 =item * Application
1046
1047         __isl_give isl_basic_set *isl_basic_set_apply(
1048                 __isl_take isl_basic_set *bset,
1049                 __isl_take isl_basic_map *bmap);
1050         __isl_give isl_set *isl_set_apply(
1051                 __isl_take isl_set *set,
1052                 __isl_take isl_map *map);
1053         __isl_give isl_basic_map *isl_basic_map_apply_domain(
1054                 __isl_take isl_basic_map *bmap1,
1055                 __isl_take isl_basic_map *bmap2);
1056         __isl_give isl_basic_map *isl_basic_map_apply_range(
1057                 __isl_take isl_basic_map *bmap1,
1058                 __isl_take isl_basic_map *bmap2);
1059         __isl_give isl_map *isl_map_apply_domain(
1060                 __isl_take isl_map *map1,
1061                 __isl_take isl_map *map2);
1062         __isl_give isl_map *isl_map_apply_range(
1063                 __isl_take isl_map *map1,
1064                 __isl_take isl_map *map2);
1065
1066 =back
1067
1068 =head3 Lexicographic Optimization
1069
1070 Given a (basic) set C<set> (or C<bset>) and a zero-dimensional domain C<dom>,
1071 the following functions
1072 compute a set that contains the lexicographic minimum or maximum
1073 of the elements in C<set> (or C<bset>) for those values of the parameters
1074 that satisfy C<dom>.
1075 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
1076 that contains the parameter values in C<dom> for which C<set> (or C<bset>)
1077 has no elements.
1078 In other words, the union of the parameter values
1079 for which the result is non-empty and of C<*empty>
1080 is equal to C<dom>.
1081
1082         __isl_give isl_set *isl_basic_set_partial_lexmin(
1083                 __isl_take isl_basic_set *bset,
1084                 __isl_take isl_basic_set *dom,
1085                 __isl_give isl_set **empty);
1086         __isl_give isl_set *isl_basic_set_partial_lexmax(
1087                 __isl_take isl_basic_set *bset,
1088                 __isl_take isl_basic_set *dom,
1089                 __isl_give isl_set **empty);
1090         __isl_give isl_set *isl_set_partial_lexmin(
1091                 __isl_take isl_set *set, __isl_take isl_set *dom,
1092                 __isl_give isl_set **empty);
1093         __isl_give isl_set *isl_set_partial_lexmax(
1094                 __isl_take isl_set *set, __isl_take isl_set *dom,
1095                 __isl_give isl_set **empty);
1096
1097 Given a (basic) set C<set> (or C<bset>), the following functions simply
1098 return a set containing the lexicographic minimum or maximum
1099 of the elements in C<set> (or C<bset>).
1100
1101         __isl_give isl_set *isl_basic_set_lexmin(
1102                 __isl_take isl_basic_set *bset);
1103         __isl_give isl_set *isl_basic_set_lexmax(
1104                 __isl_take isl_basic_set *bset);
1105         __isl_give isl_set *isl_set_lexmin(
1106                 __isl_take isl_set *set);
1107         __isl_give isl_set *isl_set_lexmax(
1108                 __isl_take isl_set *set);
1109
1110 Given a (basic) relation C<map> (or C<bmap>) and a domain C<dom>,
1111 the following functions
1112 compute a relation that maps each element of C<dom>
1113 to the single lexicographic minimum or maximum
1114 of the elements that are associated to that same
1115 element in C<map> (or C<bmap>).
1116 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
1117 that contains the elements in C<dom> that do not map
1118 to any elements in C<map> (or C<bmap>).
1119 In other words, the union of the domain of the result and of C<*empty>
1120 is equal to C<dom>.
1121
1122         __isl_give isl_map *isl_basic_map_partial_lexmax(
1123                 __isl_take isl_basic_map *bmap,
1124                 __isl_take isl_basic_set *dom,
1125                 __isl_give isl_set **empty);
1126         __isl_give isl_map *isl_basic_map_partial_lexmin(
1127                 __isl_take isl_basic_map *bmap,
1128                 __isl_take isl_basic_set *dom,
1129                 __isl_give isl_set **empty);
1130         __isl_give isl_map *isl_map_partial_lexmax(
1131                 __isl_take isl_map *map, __isl_take isl_set *dom,
1132                 __isl_give isl_set **empty);
1133         __isl_give isl_map *isl_map_partial_lexmin(
1134                 __isl_take isl_map *map, __isl_take isl_set *dom,
1135                 __isl_give isl_set **empty);
1136
1137 Given a (basic) map C<map> (or C<bmap>), the following functions simply
1138 return a map mapping each element in the domain of
1139 C<map> (or C<bmap>) to the lexicographic minimum or maximum
1140 of all elements associated to that element.
1141
1142         __isl_give isl_map *isl_basic_map_lexmin(
1143                 __isl_take isl_basic_map *bmap);
1144         __isl_give isl_map *isl_basic_map_lexmax(
1145                 __isl_take isl_basic_map *bmap);
1146         __isl_give isl_map *isl_map_lexmin(
1147                 __isl_take isl_map *map);
1148         __isl_give isl_map *isl_map_lexmax(
1149                 __isl_take isl_map *map);
1150
1151 =head2 Points
1152
1153 Points are elements of a set.  They can be used to construct
1154 simple sets (boxes) or they can be used to represent the
1155 individual elements of a set.
1156 The zero point (the origin) can be created using
1157
1158         __isl_give isl_point *isl_point_zero(__isl_take isl_dim *dim);
1159
1160 The coordinates of a point can be inspected, set and changed
1161 using
1162
1163         void isl_point_get_coordinate(__isl_keep isl_point *pnt,
1164                 enum isl_dim_type type, int pos, isl_int *v);
1165         __isl_give isl_point *isl_point_set_coordinate(
1166                 __isl_take isl_point *pnt,
1167                 enum isl_dim_type type, int pos, isl_int v);
1168
1169         __isl_give isl_point *isl_point_add_ui(
1170                 __isl_take isl_point *pnt,
1171                 enum isl_dim_type type, int pos, unsigned val);
1172         __isl_give isl_point *isl_point_sub_ui(
1173                 __isl_take isl_point *pnt,
1174                 enum isl_dim_type type, int pos, unsigned val);
1175
1176 Points can be copied or freed using
1177
1178         __isl_give isl_point *isl_point_copy(
1179                 __isl_keep isl_point *pnt);
1180         void isl_point_free(__isl_take isl_point *pnt);
1181
1182 A singleton set can be created from a point using
1183
1184         __isl_give isl_set *isl_set_from_point(
1185                 __isl_take isl_point *pnt);
1186
1187 and a box can be created from two opposite extremal points using
1188
1189         __isl_give isl_set *isl_set_box_from_points(
1190                 __isl_take isl_point *pnt1,
1191                 __isl_take isl_point *pnt2);
1192
1193 All elements of a B<bounded> set can be enumerated using
1194 the following function.
1195
1196         int isl_set_foreach_point(__isl_keep isl_set *set,
1197                 int (*fn)(__isl_take isl_point *pnt, void *user),
1198                 void *user);
1199
1200 The function C<fn> is called for each integer point in
1201 C<set> with as second argument the last argument of
1202 the C<isl_set_foreach_point> call.  The function C<fn>
1203 should return C<0> on success and C<-1> on failure.
1204 In the latter case, C<isl_set_foreach_point> will stop
1205 enumerating and return C<-1> as well.
1206 If the enumeration is performed successfully and to completion,
1207 then C<isl_set_foreach_point> returns C<0>.
1208
1209 To obtain a single point of a set, use
1210
1211         __isl_give isl_point *isl_set_sample_point(
1212                 __isl_take isl_set *set);
1213
1214 If C<set> does not contain any (integer) points, then the
1215 resulting point will be ``void'', a property that can be
1216 tested using
1217
1218         int isl_point_is_void(__isl_keep isl_point *pnt);
1219
1220 =head2 Piecewise Quasipolynomials
1221
1222 A piecewise quasipolynomial is a particular kind of function that maps
1223 a parametric point to a rational value.
1224 More specifically, a quasipolynomial is a polynomial expression in greatest
1225 integer parts of affine expressions of parameters and variables.
1226 A piecewise quasipolynomial is a subdivision of a given parametric
1227 domain into disjoint cells with a quasipolynomial associated to
1228 each cell.  The value of the piecewise quasipolynomial at a given
1229 point is the value of the quasipolynomial associated to the cell
1230 that contains the point.  Outside of the union of cells,
1231 the value is assumed to be zero.
1232 For example, the piecewise quasipolynomial
1233
1234         [n] -> { [x] -> ((1 + n) - x) : x <= n and x >= 0 }
1235
1236 maps C<x> to C<1 + n - x> for values of C<x> between C<0> and C<n>.
1237 Piecewise quasipolynomials are mainly used by the C<barvinok>
1238 library for representing the number of elements in a parametric set or map.
1239 For example, the piecewise quasipolynomial above represents
1240 the number of point in the map
1241
1242         [n] -> { [x] -> [y] : x,y >= 0 and 0 <= x + y <= n }
1243
1244 =head3 Printing (Piecewise) Quasipolynomials
1245
1246 Quasipolynomials and piecewise quasipolynomials can be printed
1247 using the following functions.
1248
1249         __isl_give isl_printer *isl_printer_print_qpolynomial(
1250                 __isl_take isl_printer *p,
1251                 __isl_keep isl_qpolynomial *qp);
1252
1253         __isl_give isl_printer *isl_printer_print_pw_qpolynomial(
1254                 __isl_take isl_printer *p,
1255                 __isl_keep isl_pw_qpolynomial *pwqp);
1256
1257 The output format of the printer
1258 needs to be set to either C<ISL_FORMAT_ISL> or C<ISL_FORMAT_C>.
1259
1260 =head3 Creating New (Piecewise) Quasipolynomials
1261
1262 Some simple quasipolynomials can be created using the following functions.
1263 More complicated quasipolynomials can be created by applying
1264 operations such as addition and multiplication
1265 on the resulting quasipolynomials
1266
1267         __isl_give isl_qpolynomial *isl_qpolynomial_zero(
1268                 __isl_take isl_dim *dim);
1269         __isl_give isl_qpolynomial *isl_qpolynomial_infty(
1270                 __isl_take isl_dim *dim);
1271         __isl_give isl_qpolynomial *isl_qpolynomial_neginfty(
1272                 __isl_take isl_dim *dim);
1273         __isl_give isl_qpolynomial *isl_qpolynomial_nan(
1274                 __isl_take isl_dim *dim);
1275         __isl_give isl_qpolynomial *isl_qpolynomial_rat_cst(
1276                 __isl_take isl_dim *dim,
1277                 const isl_int n, const isl_int d);
1278         __isl_give isl_qpolynomial *isl_qpolynomial_div(
1279                 __isl_take isl_div *div);
1280         __isl_give isl_qpolynomial *isl_qpolynomial_var(
1281                 __isl_take isl_dim *dim,
1282                 enum isl_dim_type type, unsigned pos);
1283
1284 The zero piecewise quasipolynomial or a piecewise quasipolynomial
1285 with a single cell can be created using the following functions.
1286 Multiple of these single cell piecewise quasipolynomials can
1287 be combined to create more complicated piecewise quasipolynomials.
1288
1289         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_zero(
1290                 __isl_take isl_dim *dim);
1291         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_alloc(
1292                 __isl_take isl_set *set,
1293                 __isl_take isl_qpolynomial *qp);
1294
1295 Quasipolynomials can be copied and freed again using the following
1296 functions.
1297
1298         __isl_give isl_qpolynomial *isl_qpolynomial_copy(
1299                 __isl_keep isl_qpolynomial *qp);
1300         void isl_qpolynomial_free(__isl_take isl_qpolynomial *qp);
1301
1302         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_copy(
1303                 __isl_keep isl_pw_qpolynomial *pwqp);
1304         void isl_pw_qpolynomial_free(
1305                 __isl_take isl_pw_qpolynomial *pwqp);
1306
1307 =head3 Inspecting (Piecewise) Quasipolynomials
1308
1309 To iterate over the cells in a piecewise quasipolynomial,
1310 use either of the following two functions
1311
1312         int isl_pw_qpolynomial_foreach_piece(
1313                 __isl_keep isl_pw_qpolynomial *pwqp,
1314                 int (*fn)(__isl_take isl_set *set,
1315                           __isl_take isl_qpolynomial *qp,
1316                           void *user), void *user);
1317         int isl_pw_qpolynomial_foreach_lifted_piece(
1318                 __isl_keep isl_pw_qpolynomial *pwqp,
1319                 int (*fn)(__isl_take isl_set *set,
1320                           __isl_take isl_qpolynomial *qp,
1321                           void *user), void *user);
1322
1323 As usual, the function C<fn> should return C<0> on success
1324 and C<-1> on failure.  The difference between
1325 C<isl_pw_qpolynomial_foreach_piece> and
1326 C<isl_pw_qpolynomial_foreach_lifted_piece> is that
1327 C<isl_pw_qpolynomial_foreach_lifted_piece> will first
1328 compute unique representations for all existentially quantified
1329 variables and then turn these existentially quantified variables
1330 into extra set variables, adapting the associated quasipolynomial
1331 accordingly.  This means that the C<set> passed to C<fn>
1332 will not have any existentially quantified variables, but that
1333 the dimensions of the sets may be different for different
1334 invocations of C<fn>.
1335
1336 To iterate over all terms in a quasipolynomial,
1337 use
1338
1339         int isl_qpolynomial_foreach_term(
1340                 __isl_keep isl_qpolynomial *qp,
1341                 int (*fn)(__isl_take isl_term *term,
1342                           void *user), void *user);
1343
1344 The terms themselves can be inspected and freed using
1345 these functions
1346
1347         unsigned isl_term_dim(__isl_keep isl_term *term,
1348                 enum isl_dim_type type);
1349         void isl_term_get_num(__isl_keep isl_term *term,
1350                 isl_int *n);
1351         void isl_term_get_den(__isl_keep isl_term *term,
1352                 isl_int *d);
1353         int isl_term_get_exp(__isl_keep isl_term *term,
1354                 enum isl_dim_type type, unsigned pos);
1355         __isl_give isl_div *isl_term_get_div(
1356                 __isl_keep isl_term *term, unsigned pos);
1357         void isl_term_free(__isl_take isl_term *term);
1358
1359 Each term is a product of parameters, set variables and
1360 integer divisions.  The function C<isl_term_get_exp>
1361 returns the exponent of a given dimensions in the given term.
1362 The C<isl_int>s in the arguments of C<isl_term_get_num>
1363 and C<isl_term_get_den> need to have been initialized
1364 using C<isl_int_init> before calling these functions.
1365
1366 =head3 Properties of (Piecewise) Quasipolynomials
1367
1368 To check whether a quasipolynomial is actually a constant,
1369 use the following function.
1370
1371         int isl_qpolynomial_is_cst(__isl_keep isl_qpolynomial *qp,
1372                 isl_int *n, isl_int *d);
1373
1374 If C<qp> is a constant and if C<n> and C<d> are not C<NULL>
1375 then the numerator and denominator of the constant
1376 are returned in C<*n> and C<*d>, respectively.
1377
1378 =head3 Operations on (Piecewise) Quasipolynomials
1379
1380         __isl_give isl_qpolynomial *isl_qpolynomial_neg(
1381                 __isl_take isl_qpolynomial *qp);
1382         __isl_give isl_qpolynomial *isl_qpolynomial_add(
1383                 __isl_take isl_qpolynomial *qp1,
1384                 __isl_take isl_qpolynomial *qp2);
1385         __isl_give isl_qpolynomial *isl_qpolynomial_sub(
1386                 __isl_take isl_qpolynomial *qp1,
1387                 __isl_take isl_qpolynomial *qp2);
1388         __isl_give isl_qpolynomial *isl_qpolynomial_mul(
1389                 __isl_take isl_qpolynomial *qp1,
1390                 __isl_take isl_qpolynomial *qp2);
1391
1392         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add(
1393                 __isl_take isl_pw_qpolynomial *pwqp1,
1394                 __isl_take isl_pw_qpolynomial *pwqp2);
1395         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_sub(
1396                 __isl_take isl_pw_qpolynomial *pwqp1,
1397                 __isl_take isl_pw_qpolynomial *pwqp2);
1398         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_add_disjoint(
1399                 __isl_take isl_pw_qpolynomial *pwqp1,
1400                 __isl_take isl_pw_qpolynomial *pwqp2);
1401         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_neg(
1402                 __isl_take isl_pw_qpolynomial *pwqp);
1403         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_mul(
1404                 __isl_take isl_pw_qpolynomial *pwqp1,
1405                 __isl_take isl_pw_qpolynomial *pwqp2);
1406
1407         __isl_give isl_qpolynomial *isl_pw_qpolynomial_eval(
1408                 __isl_take isl_pw_qpolynomial *pwqp,
1409                 __isl_take isl_point *pnt);
1410
1411         __isl_give isl_set *isl_pw_qpolynomial_domain(
1412                 __isl_take isl_pw_qpolynomial *pwqp);
1413         __isl_give isl_pw_qpolynomial *isl_pw_qpolynomial_intersect_domain(
1414                 __isl_take isl_pw_qpolynomial *pwpq,
1415                 __isl_take isl_set *set);
1416
1417 =head2 Dependence Analysis
1418
1419 C<isl> contains specialized functionality for performing
1420 array dataflow analysis.  That is, given a I<sink> access relation
1421 and a collection of possible I<source> access relations,
1422 C<isl> can compute relations that describe
1423 for each iteration of the sink access, which iteration
1424 of which of the source access relations was the last
1425 to access the same data element before the given iteration
1426 of the sink access.
1427 To compute standard flow dependences, the sink should be
1428 a read, while the sources should be writes.
1429
1430         #include <isl_flow.h>
1431
1432         __isl_give isl_access_info *isl_access_info_alloc(
1433                 __isl_take isl_map *sink,
1434                 void *sink_user, isl_access_level_before fn,
1435                 int max_source);
1436         __isl_give isl_access_info *isl_access_info_add_source(
1437                 __isl_take isl_access_info *acc,
1438                 __isl_take isl_map *source, void *source_user);
1439
1440         __isl_give isl_flow *isl_access_info_compute_flow(
1441                 __isl_take isl_access_info *acc);
1442
1443         int isl_flow_foreach(__isl_keep isl_flow *deps,
1444                 int (*fn)(__isl_take isl_map *dep, void *dep_user,
1445                           void *user),
1446                 void *user);
1447         __isl_give isl_set *isl_flow_get_no_source(
1448                 __isl_keep isl_flow *deps);
1449         void isl_flow_free(__isl_take isl_flow *deps);
1450
1451 The function C<isl_access_info_compute_flow> performs the actual
1452 dependence analysis.  The other functions are used to construct
1453 the input for this function or to read off the output.
1454
1455 The input is collected in an C<isl_access_info>, which can
1456 be created through a call to C<isl_access_info_alloc>.
1457 The arguments to this functions are the sink access relation
1458 C<sink>, a token C<sink_user> used to identify the sink
1459 access to the user, a callback function for specifying the
1460 relative order of source and sink accesses, and the number
1461 of source access relations that will be added.
1462 The callback function has type C<int (*)(void *first, void *second)>.
1463 The function is called with two user supplied tokens identifying
1464 either a source or the sink and it should return the shared nesting
1465 level and the relative order of the two accesses.
1466 In particular, let I<n> be the number of loops shared by
1467 the two accesses.  If C<first> precedes C<second> textually,
1468 then the function should return I<2 * n + 1>; otherwise,
1469 it should return I<2 * n>.
1470 The sources can be added to the C<isl_access_info> by performing
1471 (at most) C<max_source> calls to C<isl_access_info_add_source>.
1472 The C<source_user> token is again used to identify
1473 the source access.  The range of the source access relation
1474 C<source> should have the same dimension as the range
1475 of the sink access relation.
1476
1477 The result of the dependence analysis is collected in an
1478 C<isl_flow>.  There may be elements in the domain of
1479 the sink access for which no preceding source access could be
1480 find.  The set of these elements can be obtained through
1481 a call to C<isl_flow_get_no_source>.
1482 In the case of standard flow dependence analysis,
1483 this set corresponds to the reads from uninitialized
1484 array elements.
1485 The actual flow dependences can be extracted using
1486 C<isl_flow_foreach>.  This function will call the user-specified
1487 callback function C<fn> for each B<non-empty> dependence between
1488 a source and the sink.  The callback function is called
1489 with three arguments, the actual flow dependence relation
1490 mapping source iterations to sink iterations, a token
1491 identifying the source and an additional C<void *> with value
1492 equal to the third argument of the C<isl_flow_foreach> call.
1493
1494 After finishing with an C<isl_flow>, the user should call
1495 C<isl_flow_free> to free all associated memory.
1496
1497 =head1 Applications
1498
1499 Although C<isl> is mainly meant to be used as a library,
1500 it also contains some basic applications that use some
1501 of the functionality of C<isl>.
1502 The input may be specified in either the L<isl format>
1503 or the L<PolyLib format>.
1504
1505 =head2 C<isl_polyhedron_sample>
1506
1507 C<isl_polyhedron_sample> takes a polyhedron as input and prints
1508 an integer element of the polyhedron, if there is any.
1509 The first column in the output is the denominator and is always
1510 equal to 1.  If the polyhedron contains no integer points,
1511 then a vector of length zero is printed.
1512
1513 =head2 C<isl_pip>
1514
1515 C<isl_pip> takes the same input as the C<example> program
1516 from the C<piplib> distribution, i.e., a set of constraints
1517 on the parameters, a line contains only -1 and finally a set
1518 of constraints on a parametric polyhedron.
1519 The coefficients of the parameters appear in the last columns
1520 (but before the final constant column).
1521 The output is the lexicographic minimum of the parametric polyhedron.
1522 As C<isl> currently does not have its own output format, the output
1523 is just a dump of the internal state.
1524
1525 =head2 C<isl_polyhedron_minimize>
1526
1527 C<isl_polyhedron_minimize> computes the minimum of some linear
1528 or affine objective function over the integer points in a polyhedron.
1529 If an affine objective function
1530 is given, then the constant should appear in the last column.
1531
1532 =head2 C<isl_polytope_scan>
1533
1534 Given a polytope, C<isl_polytope_scan> prints
1535 all integer points in the polytope.
1536
1537 =head1 C<isl-polylib>
1538
1539 The C<isl-polylib> library provides the following functions for converting
1540 between C<isl> objects and C<PolyLib> objects.
1541 The library is distributed separately for licensing reasons.
1542
1543         #include <isl_set_polylib.h>
1544         __isl_give isl_basic_set *isl_basic_set_new_from_polylib(
1545                 Polyhedron *P, __isl_take isl_dim *dim);
1546         Polyhedron *isl_basic_set_to_polylib(
1547                 __isl_keep isl_basic_set *bset);
1548         __isl_give isl_set *isl_set_new_from_polylib(Polyhedron *D,
1549                 __isl_take isl_dim *dim);
1550         Polyhedron *isl_set_to_polylib(__isl_keep isl_set *set);
1551
1552         #include <isl_map_polylib.h>
1553         __isl_give isl_basic_map *isl_basic_map_new_from_polylib(
1554                 Polyhedron *P, __isl_take isl_dim *dim);
1555         __isl_give isl_map *isl_map_new_from_polylib(Polyhedron *D,
1556                 __isl_take isl_dim *dim);
1557         Polyhedron *isl_basic_map_to_polylib(
1558                 __isl_keep isl_basic_map *bmap);
1559         Polyhedron *isl_map_to_polylib(__isl_keep isl_map *map);