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>), a bundled version (C<bundled>)
 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>, C<build>
 121 or C<bundled>.  Note that C<bundled> only works if you have obtained
 122 C<isl> and its submodules from the git repository.
 123
 124 =item C<--with-piplib-prefix>
 125
 126 Installation prefix for C<system> C<piplib> (architecture-independent files).
 127
 128 =item C<--with-piplib-exec-prefix>
 129
 130 Installation prefix for C<system> C<piplib> (architecture-dependent files).
 131
 132 =item C<--with-piplib-builddir>
 133
 134 Location where C<build> C<piplib> was built.
 135
 136 =back
 137
 138 =item 3 Compile
 139
 140         make
 141
 142 =item 4 Install (optional)
 143
 144         make install
 145
 146 =back
 147
 148 =head1 Library
 149
 150 =head2 Initialization
 151
 152 All manipulations of integer sets and relations occur within
 153 the context of an C<isl_ctx>.
 154 A given C<isl_ctx> can only be used within a single thread.
 155 All arguments of a function are required to have been allocated
 156 within the same context.
 157 There are currently no functions available for moving an object
 158 from one C<isl_ctx> to another C<isl_ctx>.  This means that
 159 there is currently no way of safely moving an object from one
 160 thread to another, unless the whole C<isl_ctx> is moved.
 161
 162 An C<isl_ctx> can be allocated using C<isl_ctx_alloc> and
 163 freed using C<isl_ctx_free>.
 164 All objects allocated within an C<isl_ctx> should be freed
 165 before the C<isl_ctx> itself is freed.
 166
 167         isl_ctx *isl_ctx_alloc();
 168         void isl_ctx_free(isl_ctx *ctx);
 169
 170 =head2 Integers
 171
 172 All operations on integers, mainly the coefficients
 173 of the constraints describing the sets and relations,
 174 are performed in exact integer arithmetic using C<GMP>.
 175 However, to allow future versions of C<isl> to optionally
 176 support fixed integer arithmetic, all calls to C<GMP>
 177 are wrapped inside C<isl> specific macros.
 178 The basic type is C<isl_int> and the following operations
 179 are available on this type.
 180
 181 =over
 182
 183 =item isl_int_init(i)
 184
 185 =item isl_int_clear(i)
 186
 187 =item isl_int_set(r,i)
 188
 189 =item isl_int_set_si(r,i)
 190
 191 =item isl_int_abs(r,i)
 192
 193 =item isl_int_neg(r,i)
 194
 195 =item isl_int_swap(i,j)
 196
 197 =item isl_int_swap_or_set(i,j)
 198
 199 =item isl_int_add_ui(r,i,j)
 200
 201 =item isl_int_sub_ui(r,i,j)
 202
 203 =item isl_int_add(r,i,j)
 204
 205 =item isl_int_sub(r,i,j)
 206
 207 =item isl_int_mul(r,i,j)
 208
 209 =item isl_int_mul_ui(r,i,j)
 210
 211 =item isl_int_addmul(r,i,j)
 212
 213 =item isl_int_submul(r,i,j)
 214
 215 =item isl_int_gcd(r,i,j)
 216
 217 =item isl_int_lcm(r,i,j)
 218
 219 =item isl_int_divexact(r,i,j)
 220
 221 =item isl_int_cdiv_q(r,i,j)
 222
 223 =item isl_int_fdiv_q(r,i,j)
 224
 225 =item isl_int_fdiv_r(r,i,j)
 226
 227 =item isl_int_fdiv_q_ui(r,i,j)
 228
 229 =item isl_int_read(r,s)
 230
 231 =item isl_int_print(out,i,width)
 232
 233 =item isl_int_sgn(i)
 234
 235 =item isl_int_cmp(i,j)
 236
 237 =item isl_int_cmp_si(i,si)
 238
 239 =item isl_int_eq(i,j)
 240
 241 =item isl_int_ne(i,j)
 242
 243 =item isl_int_lt(i,j)
 244
 245 =item isl_int_le(i,j)
 246
 247 =item isl_int_gt(i,j)
 248
 249 =item isl_int_ge(i,j)
 250
 251 =item isl_int_abs_eq(i,j)
 252
 253 =item isl_int_abs_ne(i,j)
 254
 255 =item isl_int_abs_lt(i,j)
 256
 257 =item isl_int_abs_gt(i,j)
 258
 259 =item isl_int_abs_ge(i,j)
 260
 261 =item isl_int_is_zero(i)
 262
 263 =item isl_int_is_one(i)
 264
 265 =item isl_int_is_negone(i)
 266
 267 =item isl_int_is_pos(i)
 268
 269 =item isl_int_is_neg(i)
 270
 271 =item isl_int_is_nonpos(i)
 272
 273 =item isl_int_is_nonneg(i)
 274
 275 =item isl_int_is_divisible_by(i,j)
 276
 277 =back
 278
 279 =head2 Sets and Relations
 280
 281 C<isl> uses four types of objects for representing sets and relations,
 282 C<isl_basic_set>, C<isl_basic_map>, C<isl_set> and C<isl_map>.
 283 C<isl_basic_set> and C<isl_basic_map> represent sets and relations that
 284 can be described as a conjunction of affine constraints, while
 285 C<isl_set> and C<isl_map> represent unions of
 286 C<isl_basic_set>s and C<isl_basic_map>s, respectively.
 287 The difference between sets and relations (maps) is that sets have
 288 one set of variables, while relations have two sets of variables,
 289 input variables and output variables.
 290
 291 =head2 Memory Management
 292
 293 Since a high-level operation on sets and/or relations usually involves
 294 several substeps and since the user is usually not interested in
 295 the intermediate results, most functions that return a new object
 296 will also release all the objects passed as arguments.
 297 If the user still wants to use one or more of these arguments
 298 after the function call, she should pass along a copy of the
 299 object rather than the object itself.
 300 The user is then responsible for make sure that the original
 301 object gets used somewhere else or is explicitly freed.
 302
 303 The arguments and return values of all documents functions are
 304 annotated to make clear which arguments are released and which
 305 arguments are preserved.  In particular, the following annotations
 306 are used
 307
 308 =over
 309
 310 =item C<__isl_give>
 311
 312 C<__isl_give> means that a new object is returned.
 313 The user should make sure that the returned pointer is
 314 used exactly once as a value for an C<__isl_take> argument.
 315 In between, it can be used as a value for as many
 316 C<__isl_keep> arguments as the user likes.
 317 There is one exception, and that is the case where the
 318 pointer returned is C<NULL>.  Is this case, the user
 319 is free to use it as an C<__isl_take> argument or not.
 320
 321 =item C<__isl_take>
 322
 323 C<__isl_take> means that the object the argument points to
 324 is taken over by the function and may no longer be used
 325 by the user as an argument to any other function.
 326 The pointer value must be one returned by a function
 327 returning an C<__isl_give> pointer.
 328 If the user passes in a C<NULL> value, then this will
 329 be treated as an error in the sense that the function will
 330 not perform its usual operation.  However, it will still
 331 make sure that all the the other C<__isl_take> arguments
 332 are released.
 333
 334 =item C<__isl_keep>
 335
 336 C<__isl_keep> means that the function will only use the object
 337 temporarily.  After the function has finished, the user
 338 can still use it as an argument to other functions.
 339 A C<NULL> value will be treated in the same way as
 340 a C<NULL> value for an C<__isl_take> argument.
 341
 342 =back
 343
 344 =head2 Dimension Specifications
 345
 346 Whenever a new set or relation is created from scratch,
 347 its dimension needs to be specified using an C<isl_dim>.
 348
 349         #include <isl_dim.h>
 350         __isl_give isl_dim *isl_dim_alloc(isl_ctx *ctx,
 351                 unsigned nparam, unsigned n_in, unsigned n_out);
 352         __isl_give isl_dim *isl_dim_set_alloc(isl_ctx *ctx,
 353                 unsigned nparam, unsigned dim);
 354         __isl_give isl_dim *isl_dim_copy(__isl_keep isl_dim *dim);
 355         void isl_dim_free(__isl_take isl_dim *dim);
 356         unsigned isl_dim_size(__isl_keep isl_dim *dim,
 357                 enum isl_dim_type type);
 358
 359 The dimension specification used for creating a set
 360 needs to be created using C<isl_dim_set_alloc>, while
 361 that for creating a relation
 362 needs to be created using C<isl_dim_alloc>.
 363 C<isl_dim_size> can be used
 364 to find out the number of dimensions of each type in
 365 a dimension specification, where type may be
 366 C<isl_dim_param>, C<isl_dim_in> (only for relations),
 367 C<isl_dim_out> (only for relations), C<isl_dim_set>
 368 (only for sets) or C<isl_dim_all>.
 369
 370 =head2 Input and Output
 371
 372 Proper input and output functions are still in development.
 373 However, some functions are provided to read and write
 374 to foreign file formats.
 375
 376 =head3 Input
 377
 378         #include <isl_set.h>
 379         __isl_give isl_basic_set *isl_basic_set_read_from_file(
 380                 isl_ctx *ctx, FILE *input, unsigned nparam);
 381         __isl_give isl_basic_set *isl_basic_set_read_from_str(
 382                 isl_ctx *ctx, const char *str, unsigned nparam);
 383         __isl_give isl_set *isl_set_read_from_file(isl_ctx *ctx,
 384                 FILE *input, unsigned nparam);
 385
 386         #include <isl_map.h>
 387         __isl_give isl_basic_map *isl_basic_map_read_from_file(
 388                 isl_ctx *ctx, FILE *input, unsigned nparam);
 389         __isl_give isl_basic_map *isl_basic_map_read_from_str(
 390                 isl_ctx *ctx, const char *str, unsigned nparam);
 391
 392 The input may be either in C<PolyLib> format or in an
 393 C<Omega>-like format.
 394 C<nparam> specifies how many of the final columns in
 395 the C<PolyLib> format correspond to parameters.  It should
 396 be zero when C<Omega>-like input is expected.
 397
 398 =head3 Output
 399
 400         #include <isl_set.h>
 401         void isl_basic_set_print(__isl_keep isl_basic_set *bset,
 402                 FILE *out, int indent,
 403                 const char *prefix, const char *suffix,
 404                 unsigned output_format);
 405         void isl_set_print(__isl_keep struct isl_set *set,
 406                 FILE *out, int indent, unsigned output_format);
 407
 408 C<input_format> must be C<ISL_FORMAT_POLYLIB>.
 409 Each line in the output is indented by C<indent> spaces,
 410 prefixed by C<prefix> and suffixed by C<suffix>.
 411 The coefficients of the existentially quantified variables
 412 appear between those of the set variables and those
 413 of the parameters.
 414
 415 =head3 Dumping the internal state
 416
 417 For lack of proper output functions, the following functions
 418 can be used to dump the internal state of a set or relation.
 419 The user should not depend on the output format of these functions.
 420
 421         void isl_basic_set_dump(__isl_keep isl_basic_set *bset,
 422                 FILE *out, int indent);
 423         void isl_basic_map_dump(__isl_keep isl_basic_map *bmap,
 424                 FILE *out, int indent);
 425         void isl_set_dump(__isl_keep isl_set *set,
 426                 FILE *out, int indent);
 427         void isl_map_dump(__isl_keep isl_map *map,
 428                 FILE *out, int indent);
 429
 430 =head2 Creating New Sets and Relations
 431
 432 C<isl> has functions for creating some standard sets and relations.
 433
 434 =over
 435
 436 =item * Empty sets and relations
 437
 438         __isl_give isl_basic_set *isl_basic_set_empty(
 439                 __isl_take isl_dim *dim);
 440         __isl_give isl_basic_map *isl_basic_map_empty(
 441                 __isl_take isl_dim *dim);
 442         __isl_give isl_set *isl_set_empty(
 443                 __isl_take isl_dim *dim);
 444         __isl_give isl_map *isl_map_empty(
 445                 __isl_take isl_dim *dim);
 446
 447 =item * Universe sets and relations
 448
 449         __isl_give isl_basic_set *isl_basic_set_universe(
 450                 __isl_take isl_dim *dim);
 451         __isl_give isl_basic_map *isl_basic_map_universe(
 452                 __isl_take isl_dim *dim);
 453         __isl_give isl_set *isl_set_universe(
 454                 __isl_take isl_dim *dim);
 455         __isl_give isl_map *isl_map_universe(
 456                 __isl_take isl_dim *dim);
 457
 458 =item * Identity relations
 459
 460         __isl_give isl_basic_map *isl_basic_map_identity(
 461                 __isl_take isl_dim *set_dim);
 462         __isl_give isl_map *isl_map_identity(
 463                 __isl_take isl_dim *set_dim);
 464
 465 These functions take a dimension specification for a B<set>
 466 and return an identity relation between two such sets.
 467
 468 =item * Lexicographic order
 469
 470         __isl_give isl_map *isl_map_lex_lt(
 471                 __isl_take isl_dim *set_dim);
 472         __isl_give isl_map *isl_map_lex_le(
 473                 __isl_take isl_dim *set_dim);
 474         __isl_give isl_map *isl_map_lex_gt(
 475                 __isl_take isl_dim *set_dim);
 476         __isl_give isl_map *isl_map_lex_ge(
 477                 __isl_take isl_dim *set_dim);
 478
 479 These functions take a dimension specification for a B<set>
 480 and return relations that express that the elements in the domain
 481 are lexicograhically less
 482 (C<isl_map_lex_lt>), less or equal (C<isl_map_lex_le>),
 483 greater (C<isl_map_lex_gt>) or greater or equal (C<isl_map_lex_ge>)
 484 than the elements in the range.
 485
 486 =back
 487
 488 A basic set or relation can be converted to a set or relation
 489 using the following functions.
 490
 491         __isl_give isl_set *isl_set_from_basic_set(
 492                 __isl_take isl_basic_set *bset);
 493         __isl_give isl_map *isl_map_from_basic_map(
 494                 __isl_take isl_basic_map *bmap);
 495
 496 Sets and relations can be copied and freed again using the following
 497 functions.
 498
 499         __isl_give isl_basic_set *isl_basic_set_copy(
 500                 __isl_keep isl_basic_set *bset);
 501         __isl_give isl_set *isl_set_copy(__isl_keep isl_set *set);
 502         __isl_give isl_basic_map *isl_basic_map_copy(
 503                 __isl_keep isl_basic_map *bmap);
 504         __isl_give isl_map *isl_map_copy(__isl_keep isl_map *map);
 505         void isl_basic_set_free(__isl_take isl_basic_set *bset);
 506         void isl_set_free(__isl_take isl_set *set);
 507         void isl_basic_map_free(__isl_take isl_basic_map *bmap);
 508         void isl_map_free(__isl_take isl_map *map);
 509
 510 Other sets and relations can be constructed by starting
 511 from a universe set or relation, adding equality and/or
 512 inequality constraints and then projecting out the
 513 existentially quantified variables, if any.
 514 Constraints can be constructed, manipulated and
 515 added to basic sets and relations using the following functions.
 516
 517         #include <isl_constraint.h>
 518         __isl_give isl_constraint *isl_equality_alloc(
 519                 __isl_take isl_dim *dim);
 520         __isl_give isl_constraint *isl_inequality_alloc(
 521                 __isl_take isl_dim *dim);
 522         void isl_constraint_set_constant(
 523                 __isl_keep isl_constraint *constraint, isl_int v);
 524         void isl_constraint_set_coefficient(
 525                 __isl_keep isl_constraint *constraint,
 526                 enum isl_dim_type type, int pos, isl_int v);
 527         __isl_give isl_basic_map *isl_basic_map_add_constraint(
 528                 __isl_take isl_basic_map *bmap,
 529                 __isl_take isl_constraint *constraint);
 530         __isl_give isl_basic_set *isl_basic_set_add_constraint(
 531                 __isl_take isl_basic_set *bset,
 532                 __isl_take isl_constraint *constraint);
 533
 534 For example, to create a set containing the even integers
 535 between 10 and 42, you would use the following code.
 536
 537         isl_int v;
 538         struct isl_dim *dim;
 539         struct isl_constraint *c;
 540         struct isl_basic_set *bset;
 541
 542         isl_int_init(v);
 543         dim = isl_dim_set_alloc(ctx, 0, 2);
 544         bset = isl_basic_set_universe(isl_dim_copy(dim));
 545
 546         c = isl_equality_alloc(isl_dim_copy(dim));
 547         isl_int_set_si(v, -1);
 548         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 549         isl_int_set_si(v, 2);
 550         isl_constraint_set_coefficient(c, isl_dim_set, 1, v);
 551         bset = isl_basic_set_add_constraint(bset, c);
 552
 553         c = isl_inequality_alloc(isl_dim_copy(dim));
 554         isl_int_set_si(v, -10);
 555         isl_constraint_set_constant(c, v);
 556         isl_int_set_si(v, 1);
 557         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 558         bset = isl_basic_set_add_constraint(bset, c);
 559
 560         c = isl_inequality_alloc(dim);
 561         isl_int_set_si(v, 42);
 562         isl_constraint_set_constant(c, v);
 563         isl_int_set_si(v, -1);
 564         isl_constraint_set_coefficient(c, isl_dim_set, 0, v);
 565         bset = isl_basic_set_add_constraint(bset, c);
 566
 567         bset = isl_basic_set_project_out(bset, isl_dim_set, 1, 1);
 568
 569         isl_int_clear(v);
 570
 571 =head2 Properties
 572
 573 =head3 Unary Properties
 574
 575 =over
 576
 577 =item Emptiness
 578
 579 The following functions test whether the given set or relation
 580 contains any integer points.  The ``fast'' variants do not perform
 581 any computations, but simply check if the given set or relation
 582 is already known to be empty.
 583
 584         int isl_basic_set_fast_is_empty(__isl_keep isl_basic_set *bset);
 585         int isl_basic_set_is_empty(__isl_keep isl_basic_set *bset);
 586         int isl_set_is_empty(__isl_keep isl_set *set);
 587         int isl_basic_map_fast_is_empty(__isl_keep isl_basic_map *bmap);
 588         int isl_basic_map_is_empty(__isl_keep isl_basic_map *bmap);
 589         int isl_map_fast_is_empty(__isl_keep isl_map *map);
 590         int isl_map_is_empty(__isl_keep isl_map *map);
 591
 592 =item * Universality
 593
 594         int isl_basic_set_is_universe(__isl_keep isl_basic_set *bset);
 595         int isl_basic_map_is_universe(__isl_keep isl_basic_map *bmap);
 596
 597 =back
 598
 599 =head3 Binary Properties
 600
 601 =over
 602
 603 =item * Equality
 604
 605         int isl_set_fast_is_equal(__isl_keep isl_set *set1,
 606                 __isl_keep isl_set *set2);
 607         int isl_set_is_equal(__isl_keep isl_set *set1,
 608                 __isl_keep isl_set *set2);
 609         int isl_map_is_equal(__isl_keep isl_map *map1,
 610                 __isl_keep isl_map *map2);
 611         int isl_map_fast_is_equal(__isl_keep isl_map *map1,
 612                 __isl_keep isl_map *map2);
 613         int isl_basic_map_is_equal(
 614                 __isl_keep isl_basic_map *bmap1,
 615                 __isl_keep isl_basic_map *bmap2);
 616
 617 =item * Disjointness
 618
 619         int isl_set_fast_is_disjoint(__isl_keep isl_set *set1,
 620                 __isl_keep isl_set *set2);
 621
 622 =item * Subset
 623
 624         int isl_set_is_subset(__isl_keep isl_set *set1,
 625                 __isl_keep isl_set *set2);
 626         int isl_set_is_strict_subset(
 627                 __isl_keep isl_set *set1,
 628                 __isl_keep isl_set *set2);
 629         int isl_basic_map_is_subset(
 630                 __isl_keep isl_basic_map *bmap1,
 631                 __isl_keep isl_basic_map *bmap2);
 632         int isl_basic_map_is_strict_subset(
 633                 __isl_keep isl_basic_map *bmap1,
 634                 __isl_keep isl_basic_map *bmap2);
 635         int isl_map_is_subset(
 636                 __isl_keep isl_map *map1,
 637                 __isl_keep isl_map *map2);
 638         int isl_map_is_strict_subset(
 639                 __isl_keep isl_map *map1,
 640                 __isl_keep isl_map *map2);
 641
 642 =back
 643
 644 =head2 Unary Operations
 645
 646 =over
 647
 648 =item * Projection
 649
 650         __isl_give isl_basic_set *isl_basic_set_project_out(
 651                 __isl_take isl_basic_set *bset,
 652                 enum isl_dim_type type, unsigned first, unsigned n);
 653         __isl_give isl_set *isl_set_project_out(__isl_take isl_set *set,
 654                 enum isl_dim_type type, unsigned first, unsigned n);
 655         __isl_give isl_basic_set *isl_basic_map_domain(
 656                 __isl_take isl_basic_map *bmap);
 657         __isl_give isl_basic_set *isl_basic_map_range(
 658                 __isl_take isl_basic_map *bmap);
 659         __isl_give isl_set *isl_map_domain(
 660                 __isl_take isl_map *bmap);
 661         __isl_give isl_set *isl_map_range(
 662                 __isl_take isl_map *map);
 663
 664 C<isl_basic_set_project_out> currently only supports projecting
 665 out the final C<isl_dim_set> dimensions.
 666
 667 =item * Coalescing
 668
 669 Simplify the representation of a set or relation by trying
 670 to combine pairs of basic sets or relations into a single
 671 basic set or relation.
 672
 673         __isl_give isl_set *isl_set_coalesce(__isl_take isl_set *set);
 674         __isl_give isl_map *isl_map_coalesce(__isl_take isl_map *map);
 675
 676 =item * Convex hull
 677
 678         __isl_give isl_basic_set *isl_set_convex_hull(
 679                 __isl_take isl_set *set);
 680         __isl_give isl_basic_map *isl_map_convex_hull(
 681                 __isl_take isl_map *map);
 682
 683 If the input set or relation has any existentially quantified
 684 variables, then the result of these operations is currently undefined.
 685
 686 =item * Affine hull
 687
 688         __isl_give isl_basic_set *isl_basic_set_affine_hull(
 689                 __isl_take isl_basic_set *bset);
 690         __isl_give isl_basic_set *isl_set_affine_hull(
 691                 __isl_take isl_set *set);
 692         __isl_give isl_basic_map *isl_basic_map_affine_hull(
 693                 __isl_take isl_basic_map *bmap);
 694         __isl_give isl_basic_map *isl_map_affine_hull(
 695                 __isl_take isl_map *map);
 696
 697 =back
 698
 699 =head2 Binary Operations
 700
 701 The two arguments of a binary operation not only need to live
 702 in the same C<isl_ctx>, they currently also need to have
 703 the same (number of) parameters.
 704
 705 =head3 Basic Operations
 706
 707 =over
 708
 709 =item * Intersection
 710
 711         __isl_give isl_basic_set *isl_basic_set_intersect(
 712                 __isl_take isl_basic_set *bset1,
 713                 __isl_take isl_basic_set *bset2);
 714         __isl_give isl_set *isl_set_intersect(
 715                 __isl_take isl_set *set1,
 716                 __isl_take isl_set *set2);
 717         __isl_give isl_basic_map *isl_basic_map_intersect_domain(
 718                 __isl_take isl_basic_map *bmap,
 719                 __isl_take isl_basic_set *bset);
 720         __isl_give isl_basic_map *isl_basic_map_intersect_range(
 721                 __isl_take isl_basic_map *bmap,
 722                 __isl_take isl_basic_set *bset);
 723         __isl_give isl_basic_map *isl_basic_map_intersect(
 724                 __isl_take isl_basic_map *bmap1,
 725                 __isl_take isl_basic_map *bmap2);
 726         __isl_give isl_map *isl_map_intersect_domain(
 727                 __isl_take isl_map *map,
 728                 __isl_take isl_set *set);
 729         __isl_give isl_map *isl_map_intersect_range(
 730                 __isl_take isl_map *map,
 731                 __isl_take isl_set *set);
 732         __isl_give isl_map *isl_map_intersect(
 733                 __isl_take isl_map *map1,
 734                 __isl_take isl_map *map2);
 735
 736 =item * Union
 737
 738         __isl_give isl_set *isl_basic_set_union(
 739                 __isl_take isl_basic_set *bset1,
 740                 __isl_take isl_basic_set *bset2);
 741         __isl_give isl_map *isl_basic_map_union(
 742                 __isl_take isl_basic_map *bmap1,
 743                 __isl_take isl_basic_map *bmap2);
 744         __isl_give isl_set *isl_set_union(
 745                 __isl_take isl_set *set1,
 746                 __isl_take isl_set *set2);
 747         __isl_give isl_map *isl_map_union(
 748                 __isl_take isl_map *map1,
 749                 __isl_take isl_map *map2);
 750
 751 =item * Set difference
 752
 753         __isl_give isl_set *isl_set_subtract(
 754                 __isl_take isl_set *set1,
 755                 __isl_take isl_set *set2);
 756         __isl_give isl_map *isl_map_subtract(
 757                 __isl_take isl_map *map1,
 758                 __isl_take isl_map *map2);
 759
 760 =item * Application
 761
 762         __isl_give isl_basic_set *isl_basic_set_apply(
 763                 __isl_take isl_basic_set *bset,
 764                 __isl_take isl_basic_map *bmap);
 765         __isl_give isl_set *isl_set_apply(
 766                 __isl_take isl_set *set,
 767                 __isl_take isl_map *map);
 768         __isl_give isl_basic_map *isl_basic_map_apply_domain(
 769                 __isl_take isl_basic_map *bmap1,
 770                 __isl_take isl_basic_map *bmap2);
 771         __isl_give isl_basic_map *isl_basic_map_apply_range(
 772                 __isl_take isl_basic_map *bmap1,
 773                 __isl_take isl_basic_map *bmap2);
 774         __isl_give isl_map *isl_map_apply_domain(
 775                 __isl_take isl_map *map1,
 776                 __isl_take isl_map *map2);
 777         __isl_give isl_map *isl_map_apply_range(
 778                 __isl_take isl_map *map1,
 779                 __isl_take isl_map *map2);
 780
 781 =back
 782
 783 =head3 Lexicographic Optimization
 784
 785 Given a basic set C<bset> and a zero-dimensional domain C<dom>,
 786 the following functions
 787 compute a set that contains the lexicographic minimum or maximum
 788 of the elements in C<bset> for those values of the parameters
 789 that satisfy C<dom>.
 790 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
 791 that contains the parameter values in C<dom> for which C<bset>
 792 has no elements.
 793 In other words, the union of the parameter values
 794 for which the result is non-empty and of C<*empty>
 795 is equal to C<dom>.
 796
 797         __isl_give isl_set *isl_basic_set_partial_lexmin(
 798                 __isl_take isl_basic_set *bset,
 799                 __isl_take isl_basic_set *dom,
 800                 __isl_give isl_set **empty);
 801         __isl_give isl_set *isl_basic_set_partial_lexmax(
 802                 __isl_take isl_basic_set *bset,
 803                 __isl_take isl_basic_set *dom,
 804                 __isl_give isl_set **empty);
 805
 806 Given a basic set C<bset>, the following functions simply
 807 return a set containing the lexicographic minimum or maximum
 808 of the elements in C<bset>.
 809
 810         __isl_give isl_set *isl_basic_set_lexmin(
 811                 __isl_take isl_basic_set *bset);
 812         __isl_give isl_set *isl_basic_set_lexmax(
 813                 __isl_take isl_basic_set *bset);
 814
 815 Given a basic relation C<bmap> and a domain C<dom>,
 816 the following functions
 817 compute a relation that maps each element of C<dom>
 818 to the single lexicographic minimum or maximum
 819 of the elements that are associated to that same
 820 element in C<bmap>.
 821 If C<empty> is not C<NULL>, then C<*empty> is assigned a set
 822 that contains the elements in C<dom> that do not map
 823 to any elements in C<bmap>.
 824 In other words, the union of the domain of the result and of C<*empty>
 825 is equal to C<dom>.
 826
 827         __isl_give isl_map *isl_basic_map_partial_lexmax(
 828                 __isl_take isl_basic_map *bmap,
 829                 __isl_take isl_basic_set *dom,
 830                 __isl_give isl_set **empty);
 831         __isl_give isl_map *isl_basic_map_partial_lexmin(
 832                 __isl_take isl_basic_map *bmap,
 833                 __isl_take isl_basic_set *dom,
 834                 __isl_give isl_set **empty);
 835
 836 Given a basic map C<bmap>, the following functions simply
 837 return a map mapping each element in the domain of
 838 C<bmap> to the lexicographic minimum or maximum
 839 of all elements associated to that element.
 840
 841         __isl_give isl_map *isl_basic_map_lexmin(
 842                 __isl_take isl_basic_map *bmap);
 843         __isl_give isl_map *isl_basic_map_lexmax(
 844                 __isl_take isl_basic_map *bmap);
 845
 846 =head1 Applications
 847
 848 Although C<isl> is mainly meant to be used as a library,
 849 it also contains some basic applications that use some
 850 of the functionality of C<isl>.
 851 Since C<isl> does not have its own input format yet, these
 852 applications currently take input in C<PolyLib> style.
 853 That is, a line with the number of rows and columns,
 854 where the number of rows is equal to the number of constraints
 855 and the number of columns is equal to two plus the number of variables,
 856 followed by the actual rows.
 857 In each row, the first column indicates whether the constraint
 858 is an equality (C<0>) or inequality (C<1>).  The final column
 859 corresponds to the constant term.
 860
 861 =head2 C<isl_polyhedron_sample>
 862
 863 C<isl_polyhedron_sample>
 864 takes a polyhedron in C<PolyLib> format as input and prints
 865 an integer element of the polyhedron, if there is any.
 866 The first column in the output is the denominator and is always
 867 equal to 1.  If the polyhedron contains no integer points,
 868 then a vector of length zero is printed.
 869
 870 =head2 C<isl_pip>
 871
 872 C<isl_pip> takes the same input as the C<example> program
 873 from the C<piplib> distribution, i.e., a set of constraints
 874 on the parameters in C<PolyLib> format,
 875 a line contains only -1 and finally a set
 876 of constraints on a parametric polyhedron, again in C<PolyLib> format.
 877 The coefficients of the parameters appear in the last columns
 878 (but before the final constant column).
 879 The output is the lexicographic minimum of the parametric polyhedron.
 880 As C<isl> currently does not have its own output format, the output
 881 is just a dump of the internal state.
 882
 883 =head2 C<isl_polyhedron_minimize>
 884
 885 C<isl_polyhedron_minimize> computes the minimum of some linear
 886 or affine objective function over the integer points in a polyhedron.
 887 The input is in C<PolyLib> format.  If an affine objective function
 888 is given, then the constant should appear in the last column.
 889
 890 =head2 C<isl_polytope_scan>
 891
 892 Given a polytope in C<PolyLib> format, C<isl_polytope_scan> prints
 893 all integer points in the polytope.
 894
 895 =head1 C<isl-polylib>
 896
 897 The C<isl-polylib> library provides the following functions for converting
 898 between C<isl> objects and C<PolyLib> objects.
 899 The library is distributed separately for licensing reasons.
 900
 901         #include <isl_set_polylib.h>
 902         __isl_give isl_basic_set *isl_basic_set_new_from_polylib(
 903                 Polyhedron *P, __isl_take isl_dim *dim);
 904         Polyhedron *isl_basic_set_to_polylib(
 905                 __isl_keep isl_basic_set *bset);
 906         __isl_give isl_set *isl_set_new_from_polylib(Polyhedron *D,
 907                 __isl_take isl_dim *dim);
 908         Polyhedron *isl_set_to_polylib(__isl_keep isl_set *set);
 909
 910         #include <isl_map_polylib.h>
 911         __isl_give isl_basic_map *isl_basic_map_new_from_polylib(
 912                 Polyhedron *P, __isl_take isl_dim *dim);
 913         __isl_give isl_map *isl_map_new_from_polylib(Polyhedron *D,
 914                 __isl_take isl_dim *dim);
 915         Polyhedron *isl_basic_map_to_polylib(
 916                 __isl_keep isl_basic_map *bmap);
 917         Polyhedron *isl_map_to_polylib(__isl_keep isl_map *map);