From 5f23dc3d59bcae592d7df887a5610136f22c358a Mon Sep 17 00:00:00 2001 From: iguer Date: Wed, 24 Aug 2016 12:14:50 +0200 Subject: [PATCH] release of version 0.2 --- CHANGES.md | 15 +++++++++++++++ README.md | 28 ++++++++++++++++++++++------ opam | 2 +- src/version.ml | 2 +- 4 files changed, 39 insertions(+), 8 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 34252be..61cb4e3 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,18 @@ +(!!! = may break code that uses previous versions) + + +verion 0.2, August 24, 2016 +=============================== + +* add support for linear optimization (!!!). An minimal example is given + in tests/standalone_minimal_maximization.ml + +* some bugfixes when assuming inconsistent bounds + +* improve build and testing + + + first public 0.1, July 11, 2016 =============================== diff --git a/README.md b/README.md index aba14a6..7c1d482 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # ocplib-simplex A library implementing a simplex algorithm, in a functional style, for -solving systems of linear inequalities +solving systems of linear inequalities and optimizing linear objective +functions ## Overview @@ -9,8 +10,8 @@ solving systems of linear inequalities `ocplib-simplex` is a (fully) functional OCaml implementation of the simplex algorithm for solving systems of linear inequalities. The implementation is incremental and backtrackable. It is able to extract -unsat-cores for unsatisfiable problems. Linear optimization is -currently not supported. +unsat-cores for unsatisfiable problems. Versions `> 0.1` also support +linear optimization ## Dependencies @@ -21,7 +22,12 @@ You can use `make opam-deps` to install dependencies in the current switch. ## Build and Install Instructions -Use the following instructions: +The easiest way to install ocplib-simplex is to use OPAM: + + $ opam install ocplib-simplex + +If you want to install ocplib-simplex from sources, use the following +instructions: $ autoconf (if configure is not present) $ ./configure @@ -33,9 +39,11 @@ to compile and install `ocplib-simplex` on your system. You can uninstall the library with `make uninstall`. -## Minimal Example +## Minimal Examples -See the file `tests/standalone_minimal.ml`. +Solving a system of linear inequalities: see the file `tests/standalone_minimal.ml` + +Linear optimization: see the file `tests/standalone_minimal_maximization.ml` ## Contributing @@ -43,6 +51,14 @@ See the file `tests/standalone_minimal.ml`. Don't hesitate to report encountered bugs on this Git repo's issues tracker. +## TODO + +- the code is not (well) documented, + +- some parts of the code need factorization/simplification, + +- some invariants (check unsat-core, linear optimization) are missing. + ## Licensing diff --git a/opam b/opam index 5a1705c..76f255a 100644 --- a/opam +++ b/opam @@ -1,6 +1,6 @@ opam-version: "1.2" name: "ocplib-simplex" -version: "0.1+" +version: "0.2" authors: "Mohamed Iguernlala " maintainer: "Mohamed Iguernlala " diff --git a/src/version.ml b/src/version.ml index 0d2964a..4c70500 100644 --- a/src/version.ml +++ b/src/version.ml @@ -4,4 +4,4 @@ (* Copyright (C) --- OCamlPro --- See README.md for information and licensing *) (******************************************************************************) -let version="0.1" +let version="0.2"