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

[mothur.git] / sharedsabundvector.h

diff --git a/sharedsabundvector.h b/sharedsabundvector.h
index 7010968f53ce641bd9f6396e4213ecb2dd5fb361..60b9364e471a0df8b295b23ea62b66e8a37bca47 100644 (file)
--- a/sharedsabundvector.h
+++ b/sharedsabundvector.h
@@ -7,7 +7,7 @@
  *  Dotur
  *
  *  Created by Sarah Westcott on 12/10/08.
- *  Copyright 2008 __MyCompanyName__. All rights reserved.
+ *  Copyright 2008 Schloss Lab UMASS Amherst. All rights reserved.
  *
  */
 
@@ -19,6 +19,12 @@
 #include "sharedordervector.h"
 #include "sharedrabundvector.h"
 
+/* This class is a child to datavector.  It represents OTU information at a certain distance. 
+       It is similiar to an sabundvector except each member of data knows which group it belongs to.
+       Each member of the internal container "data" is a struct of type individual. 
+       An individual which knows the OTU from which it came, 
+       the group it is in and its abundance.  */
+
 using namespace std;
 
 class SharedSAbundVector : public DataVector {
@@ -35,10 +41,10 @@ public:
        string getGroup();
        void setGroup(string);  
        
-       void set(int, int, string);     
+       void set(int, int, string);      //OTU, abundance, group
        individual get(int);
        int getAbundance(int);
-       void push_back(int, int, string);
+       void push_back(int, int, string);       //abundance, OTU, group
        void pop_back();
        void resize(int);
        int size();
@@ -47,9 +53,10 @@ public:
                
        RAbundVector getRAbundVector(); 
        SAbundVector getSAbundVector();
-       SharedSAbundVector getSharedSAbundVector();
-       SharedRAbundVector getSharedVector();
        OrderVector getOrderVector(map<string,int>*);
+       SharedSAbundVector getSharedSAbundVector();
+       SharedRAbundVector getSharedRAbundVector();
+       SharedOrderVector getSharedOrderVector();
        
 private:
        vector<individual> data;