summaryrefslogtreecommitdiffstats
path: root/src/3rdparty/adaptagrams/libvpsc/doc/description.doc
blob: ee66b35817460e9df83a0e6d45c880ae09a9b8dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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 
<a href="http://www.adaptagrams.org/">Adaptagrams project</a>. 
There are no official releases yet, though the code is stable and 
available from the Adaptagrams 
<a href="https://github.com/mjwybrow/adaptagrams">GitHub 
repository</a>.

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 
<a href="http://users.monash.edu/~mwybrow/">Michael Wybrow</a> and
<a href="http://ialab.it.monash.edu/~dwyer/">Tim Dwyer</a>,
members of <a href="http://ialab.it.monash.edu/">Immersive Analytics Lab</a> 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.


*/