diff options
| author | Jabier Arraiza <jabier.arraiza@marker.es> | 2017-07-01 23:31:49 +0000 |
|---|---|---|
| committer | Jabier Arraiza <jabier.arraiza@marker.es> | 2017-07-01 23:31:49 +0000 |
| commit | 03bb87a0175289274132a0240628936fbccf6ca5 (patch) | |
| tree | 979519e873c0ceff7a6a8b0f53252a4a5ece1143 /src/libvpsc/doc | |
| parent | Improving CR feedback. thanks! (diff) | |
| parent | When running without installing, extensions will spawn correct Inkscape (diff) | |
| download | inkscape-03bb87a0175289274132a0240628936fbccf6ca5.tar.gz inkscape-03bb87a0175289274132a0240628936fbccf6ca5.zip | |
Merge https://gitlab.com/inkscape/inkscape into selectable-knots
Diffstat (limited to 'src/libvpsc/doc')
| -rw-r--r-- | src/libvpsc/doc/description.doc | 36 |
1 files changed, 36 insertions, 0 deletions
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 +<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://marvl.infotech.monash.edu/~mwybrow/">Michael Wybrow</a> and +<a href="http://marvl.infotech.monash.edu/~dwyer/">Tim Dwyer</a>, +members of <a href="http://marvl.infotech.monash.edu/">MArVL: the Monash Adaptive Visualisation 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. + + +*/ + + |