README

   1 barvinok is a library for counting the number of integer points
   2 in parametric and non-parametric polytopes as well as projections
   3 of such sets.
   4 For parametric polytopes the count is represented by either
   5 an explicit function or a generating function.
   6 The first comes in the shape of a piece-wise step-polynomial.
   7 This is a generalization of both Ehrhart quasi-polynomials
   8 and vector partition functions.
   9 The second is a generalization of an Ehrhart series.
  10
  11 This library shares some functionality with LattE
  12 (http://www.math.ucdavis.edu/~latte/)
  13 and uses PolyLib (included) PIP (included) and NTL (http://shoup.net/ntl/).
  14
  15 Additionally, the following packages can optionally be used
  16 - Omega (http://www.cs.umd.edu/projects/omega/ or
  17     http://www.liacs.nl/~sverdool/gitweb.cgi?p=omega.git;a=summary)
  18 - GLPK (http://www.gnu.org/software/glpk/)
  19 - GiNaC (http://www.ginac.de/) (needed for the bernstein library)
  20
  21 NTL needs to have been compiled with GMP support.
  22 That is, you have to specify
  23     NTL_GMP_LIP=on
  24
  25 Suppose you want to put everything in /opt,
  26 Then you configure/compile NTL using
  27
  28 ./configure --prefix=/opt
  29 make
  30 make install
  31
  32 For NTL,
  33
  34 cd src
  35 ./configure NTL_GMP_LIP=on PREFIX=/opt GMP_PREFIX=/path/to/gmp
  36 make
  37 make install
  38
  39 For Omega,
  40
  41 vi -c '/DESTDIR=/|s/=.*$/=\/opt/|wq' Makefile.config
  42 make libomega.a libcode_gen.a
  43 make install
  44
  45 Configure this library using
  46
  47 ./configure --prefix=/opt --with-libgmp=/path/to/gmp  --with-ntl=/opt
  48
  49 If you want shared libraries, then configure with the --enable-shared option.
  50 Note that this doesn't work on some systems because we link in libntl, which
  51 is only available as a static library.
  52 Also note that if you have previously installed a shared library of an older
  53 version of barvinok, and you do not install one for this version, then the
  54 linker may pick up the old shared library rather than the new static library.
  55
  56 Then
  57
  58 make
  59 make check
  60 make install
  61
  62 If you want to put any one of these packages in the default location
  63 (typically /usr/local), then the prefix argument can be omitted.
  64 For more information on other arguments,
  65
  66 ./configure --help
  67
  68 The input format of barvinok_enumerate is the same as that
  69 of testehrhart from the PolyLib distribution.
  70 See the PolyLib manual, barvinok_enumerate.c or the
  71 examples in tests/ehrhart/ .
  72
  73 Note that the fractional representation is subject to change.
  74
  75 The library supports three specialization algorithms.
  76 The first performs a direct specialization using a random vector.
  77 The second performs a "depth-first" incremental specialization.
  78 The third performs a "breadth-first" incremental specialization.
  79
  80 The first is usually the fastest, but can fail if the random
  81 vector happens to be chosen incorrectly.
  82 The incremental algorithms should never fail, but can be slower,
  83 in some cases by quite a bit.  The breadth-first version should
  84 be faster than the depth-first version, especially on polytopes
  85 of moderate dimension with a lot of "structure", but can require
  86 more memory.
  87
  88 Sven Verdoolaege <skimo@kotnet.org>