From: Costa Shulyupin <constantine.shulyupin@gmail.com>
Date: Wed, 5 Oct 2022 15:45:18 +0000 (+0300)
Subject: vpsc: doxygen comment
X-Git-Tag: 6.0.2~9^2~1
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=11cbd22d4efc839e84e851ea403f5509c48e373f;p=graphviz

vpsc: doxygen comment
---

diff --git a/lib/vpsc/solve_VPSC.cpp b/lib/vpsc/solve_VPSC.cpp
index e0ce311e9..46b4986af 100644
--- a/lib/vpsc/solve_VPSC.cpp
+++ b/lib/vpsc/solve_VPSC.cpp
@@ -393,4 +393,19 @@ bool VPSC::blockGraphIsCyclic() {
 	}
 	return false;
 }
-
+/**
+ * @dir lib/vpsc
+ * @brief library for solving the
+ *        %Variable Placement with Separation Constraints problem
+ *        for lib/neatogen
+ *
+ * This is a quadratic programming problem in which the squared differences
+ * between a placement vector and some ideal placement are minimized subject
+ * to a set of separation constraints. This is very useful in a number of layout problems.
+ *
+ * References:
+ * - https://www.adaptagrams.org/documentation/libvpsc.html
+ * - Tim Dwyer, Kim Marriott, and Peter J. Stuckey. Fast node overlap removal.
+ *   In Proceedings 13th International Symposium on Graph Drawing (GD '05),
+ *   volume 3843 of LNCS, pages 153-164. Springer, 2006.
+ */