From fd733201b82f39655488a286c89142f321ef9dc9 Mon Sep 17 00:00:00 2001 From: Sylvain Chiron Date: Sat, 1 Jul 2017 13:36:41 +0200 Subject: Updated libs from the Adaptagrams project: libavoid, libcola and libvspc; changed the code to match the new API Signed-off-by: Sylvain Chiron --- src/libvpsc/doc/description.doc | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 src/libvpsc/doc/description.doc (limited to 'src/libvpsc/doc') diff --git a/src/libvpsc/doc/description.doc b/src/libvpsc/doc/description.doc new file mode 100644 index 000000000..46a21b093 --- /dev/null +++ b/src/libvpsc/doc/description.doc @@ -0,0 +1,36 @@ +/*! + +\if LIBVPSC_DOC +@mainpage libvpsc: Variable Placement with Separation Constraints solver +\endif +\if ADAPTAGRAMS_DOC +@page libvpsc libvpsc — Overview +\endif + + +libvpsc is a cross-platform C++ library for solving for the Variable Placement with Separation Constraints problem. This is a quadratic programming problem in which the squared differences between a placement vector and some ideal placement are minimised subject to a set of separation constraints. This is very useful in a number of layout problems. + +libvpsc is part of the +Adaptagrams project. +There are no official releases yet, though the code is stable and +available from the Adaptagrams +github +repository. + +The API is documented using Doxygen. The documentation you are currently +reading can be obtained by running doxygen in the cola directory. + +libcola is written and maintained by +Michael Wybrow and +Tim Dwyer, +members of MArVL: the Monash Adaptive Visualisation Lab at Monash University, Australia. + +The algorithms used for VPSC are described in the following papers. If you use libcola, please cite the relevant paper. +- Tim Dwyer, Kim Marriott, and Peter J. Stuckey. Fast node overlap removal.\n + In Proceedings 13th International Symposium on Graph Drawing (GD '05),\n + volume 3843 of LNCS, pages 153-164. Springer, 2006. + + +*/ + + -- cgit v1.2.3