summaryrefslogtreecommitdiffstats
path: root/libraries/munkres/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/munkres/README')
-rw-r--r--libraries/munkres/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/libraries/munkres/README b/libraries/munkres/README
new file mode 100644
index 0000000000..bd6def1299
--- /dev/null
+++ b/libraries/munkres/README
@@ -0,0 +1,12 @@
+The Munkres module provides an implementation of the Munkres algorithm
+(also called the Hungarian algorithm or the Kuhn-Munkres algorithm).
+The algorithm models an assignment problem as an NxM cost matrix,
+where each element represents the cost of assigning the i-th worker to
+j-th job, and it figures out the least-cost solution, choosing a
+single item from each row and column in the matrix, such that no row
+and no column are used more than once.
+
+If you want to build this for use with Python 3.x (needs the
+optional dependency python3) pass the script PYTHON3=yes, like
+
+ PYTHON3=yes ./munkres.SlackBuild