[Scipy-svn] r4192 - trunk/scipy/cluster

[scipy-svn at scipy.org]

Author: damian.eads
Date: 2008-04-27 08:16:46 -0500 (Sun, 27 Apr 2008)
New Revision: 4192

Modified:
   trunk/scipy/cluster/vq.py
Log:
Tightened language in vq's module summary docstring.

Modified: trunk/scipy/cluster/vq.py
===================================================================
--- trunk/scipy/cluster/vq.py	2008-04-27 13:06:16 UTC (rev 4191)
+++ trunk/scipy/cluster/vq.py	2008-04-27 13:16:46 UTC (rev 4192)
@@ -45,11 +45,15 @@
     human face, more flesh tone colors would be represented in the
     code book.
 
-    All routines expect the observation vectors to be stored as rows
-    in the obs matrix.  Similarly the centroids corresponding to the
-    codes are stored as rows of the code_book matrix.  The i'th index
-    is the code corresponding to the code_book[i] centroid.
+    All routines expect obs to be a M by N array where the rows are
+    the observation vectors. The codebook is an k by N array where
+    the i'th row is the centroid of code word i. The observation
+    vectors and centroids have the same feature dimension.
 
+ corresponding to
+    the codes are stored as rows of the code_book matrix. The i'th
+    index is the code corresponding to the code_book[i] centroid.
+
     whiten(obs) --
         Normalize a group of observations so each feature has unit
         variance.