finishing the container classes, combining read.otu and read.list commands. some...

[mothur.git] / rabundvector.hpp

diff --git a/rabundvector.hpp b/rabundvector.hpp
index a0807e5126b62969c967a49e96cb11299302f21c..327b29b5dc8fa881ca8f8f543c1f5f293974cda8 100644 (file)
--- a/rabundvector.hpp
+++ b/rabundvector.hpp
@@ -3,6 +3,15 @@
 
 #include "datavector.hpp"
 
+/* This class is a child to datavector.  It represents OTU information at a certain distance. 
+       A rabundvector can be converted into and ordervector, listvector or sabundvector.
+       Each member of the internal container "data" represents an individual OTU.
+       So data[0] = 6, because there are six member in that OTU.
+       example: listvector             =       a,b,c,d,e,f             g,h,i           j,k             l               m  
+                        rabundvector   =       6                               3                       2               1               1
+                        sabundvector   =       2               1               1               0               0               1
+                        ordervector    =       1       1       1       1       1       1       2       2       2       3       3       4       5 */
+
 class RAbundVector : public DataVector {
        
 public: