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), NTL (http://shoup.net/ntl/).
  14 If you have cloned the git repository, you need to run
  15         git submodule init
  16         git submodule update
  17         sh autogen.sh
  18 to get the submodules and create the configure scripts.
  19
  20 Additionally, the following packages can optionally be used
  21 - Omega+ (http://chunchen.info/omega/)
  22 - GLPK (http://www.gnu.org/software/glpk/)
  23
  24 NTL needs to have been compiled with GMP support.
  25 That is, you have to specify
  26     NTL_GMP_LIP=on
  27
  28 Suppose you want to install everything in /opt,
  29 Then you configure/compile NTL using
  30
  31 cd src
  32 ./configure NTL_GMP_LIP=on PREFIX=/opt GMP_PREFIX=/path/to/gmp
  33 make
  34 make install
  35
  36 Configure this library using
  37
  38 ./configure --prefix=/opt --with-gmp-prefix=/path/to/gmp  --with-ntl=/opt
  39
  40 If you want shared libraries, then configure with the
  41 --enable-shared-barvinok option.
  42 Note that this doesn't work on some systems because we link in libntl, which
  43 is only available as a static library.
  44 Also note that if you have previously installed a shared library of an older
  45 version of barvinok, and you do not install one for this version, then the
  46 linker may pick up the old shared library rather than the new static library.
  47
  48 If you want to compile and use the included pet library, then
  49 you need the following packages:
  50 - libyaml (http://pyyaml.org/wiki/LibYAML)
  51 - LLVM/clang (http://clang.llvm.org/get_started.html)
  52 Additionally, you need to configure with the --with-pet=bundled option.
  53 See pet/README for more information.
  54
  55 Then
  56
  57 make
  58 make check
  59 make install
  60
  61 If you want to put any one of these packages in the default location
  62 (typically /usr/local), then the prefix argument can be omitted.
  63 For more information on other arguments,
  64
  65 ./configure --help
  66
  67 The input format of barvinok_enumerate is the same as that
  68 of testehrhart from the PolyLib distribution.
  69 See the PolyLib manual, barvinok_enumerate.c or the
  70 examples in tests/ehrhart/ .
  71
  72 Note that the fractional representation is subject to change.
  73
  74 The library supports three specialization algorithms.
  75 The first performs a direct specialization using a random vector.
  76 The second performs a "depth-first" incremental specialization.
  77 The third performs a "breadth-first" incremental specialization.
  78
  79 The first is usually the fastest, but can fail if the random
  80 vector happens to be chosen incorrectly.
  81 The incremental algorithms should never fail, but can be slower,
  82 in some cases by quite a bit.  The breadth-first version should
  83 be faster than the depth-first version, especially on polytopes
  84 of moderate dimension with a lot of "structure", but can require
  85 more memory.
  86
  87 Sven Verdoolaege <skimo@kotnet.org>