calculator.h

   1 #ifndef CALCULATOR_H
   2 #define CALCULATOR_H
   3
   4 using namespace std;
   5
   6 #include "mothur.h"
   7 #include "utilities.hpp"
   8 #include "sabundvector.hpp"
   9 #include "sharedsabundvector.h"
  10 #include "rabundvector.hpp"
  11 #include "uvest.h"
  12
  13 /* The calculator class is the parent class for all the different estimators implemented in mothur except the tree calculators.
  14 It has 2 pure functions EstOutput getValues(SAbundVector*), which works on a single group, and
  15 EstOutput getValues(SharedRAbundVector* shared1, SharedRAbundVector* shared2), which compares 2 groups. */
  16
  17
  18 using namespace std;
  19 typedef vector<double> EstOutput;
  20
  21 /***********************************************************************/
  22
  23 class Calculator {
  24
  25 public:
  26         Calculator(){};
  27         Calculator(string n, int c) : name(n), cols(c) {};
  28         virtual EstOutput getValues(SAbundVector*) = 0;
  29         virtual EstOutput getValues(SharedRAbundVector* shared1, SharedRAbundVector* shared2) = 0;
  30         virtual void print(ostream& f)  { f.setf(ios::fixed, ios::floatfield); f.setf(ios::showpoint);
  31                                                                           f << data[0]; for(int i=1;i<data.size();i++){ f << '\t' << data[i];   }}
  32         virtual string getName()                {       return name;    }
  33         virtual int getCols()           {       return cols;    }
  34 protected:
  35         EstOutput data;
  36         string name;
  37         int cols;
  38
  39 };
  40
  41 /**************************************************************************************************/
  42 /*This Class holds all of the methods that manipulate vectors.
  43 These methods are used in the other classes.
  44 This class must be included if any of the other classes are to be used.*/
  45
  46 class VecCalc
  47 {
  48         // The methods seen in the order here is how they are ordered throughout the class.
  49         public:
  50                 void printElements(vector<double>); //This prints the values of the vector on one line with a space between each value.
  51                 void printElements(vector<string>); //This prints the values of the vector on one line with a space between each value.
  52                 int findString(vector<string>, string);//This returns the index of the given string in the given <string> vector, if the string does not exist in the vector it returns -1.
  53                 double mean(vector<double>); //This returns the mean value of the vector.
  54                 double stError(vector<double>); //This returns the standard error of the vector.
  55                 double sumElements(vector<double>); //This returns the sum of all the values in the vector.
  56                 double sumElements(vector<double>, int); //This returns the sum of all the values in the vector excluding those whose index is before the given index.
  57                 double findMax(vector<double>); //This returns the maximum value in the vector.
  58                 double numNZ(vector<double>); //This returns the number of non-zero values in the vector.
  59                 double numPos(vector<double>); //This returns the number of positive values in the vector.
  60                 double findMaxDiff(vector<double>, vector<double>); //This returns the absolute value of the maximum difference between the two vectors.
  61                 double findDStat(vector<double>, vector<double>, double); //This returns the D-Statistic of the two vectors with the given total number of species.
  62                 vector<int> findQuartiles(vector<double>); //This returns a vector with the first element being the index of the lower quartile of the vector and the second element being the index of the upper quartile of the vector.
  63                 vector<double> add(vector<double>, double); //This adds the given number to every element in the given vector and returns the new vector.
  64                 vector<double> multiply(vector<double>, double); //This multiplies every element in the given vector by the given number and returns the new vector.
  65                 vector<double> power(vector<double>, double); //This raises every element in the given vector to the given number and returns the new vector.
  66                 vector<double> addVecs(vector<double>,vector<double>); //The given vectors must be the same size. This adds the ith element of the first given vector to the ith element of the second given vector and returns the new vector.
  67                 vector<double> multVecs(vector<double>,vector<double>); //The given vectors must be the same size. This multiplies the ith element of the first given vector to the ith element of the second given vector and returns the new vector.
  68                 vector<double> remDup(vector<double>); //This returns a vector that contains 1 of each unique element in the given vector. The order of the elements is not changed.
  69                 vector<double> genCVec(vector<double>); //This returns a cumilative vector of the given vector. The ith element of the returned vector is the sum of all the elements in the given vector up to i.
  70                 vector<double> genRelVec(vector<double>); //This finds the sum of all the elements in the given vector and then divides the ith element in the given vector by that sum and then puts the result into a new vector, which is returned after all of the elements in the given vector have been used.
  71                 vector<double> genDiffVec(vector<double>, vector<double>);//This subtracts the ith element of the second given vector from the ith element of the first given vector and returns the new vector.
  72                 vector<double> genCSVec(vector<double>);//This calculates the number of species that have the same number of individuals as the ith element of the given vector and then returns a cumulative vector.
  73                 vector<double> genTotVec(vector<vector<double> >); //This adds up the ith element of all the columns and puts that value into a new vector. It those this for all the rows and then returns the new vector.
  74                 vector<double> quicksort(vector<double>); //This sorts the given vector from highest to lowest and returns the sorted vector.
  75                 vector<vector<double> > gen2DVec(vector<double>, int, int); //(vector, #rows/columns, 0 if the second parameter was rows, 1 if the second parameter was columns) Transforms a single vector that was formatted like a table into a 2D vector.
  76                 vector<string> getSData(char[]);//This takes a file name as a parameter and reads all of the data in the file into a <string> vector.
  77 };
  78
  79 /**************************************************************************************************/
  80 /*This Class contains methods that return the B Diverstiy of two sets
  81 of data. The four methods are the Whittaker's measure, the Marczewski-Stainhaus distance,
  82 the Sorensen quantitative index, and the Morisita-Horn index.
  83 The main method takes a number of columns of data and performs all 4 methods on each
  84 combination of columns. It prints a table for every method that shows the B Diverstiy for
  85 each combination. It also calculates the overall diversity for Whittaker's measure and
  86 the Marczewski-Steinhaus distance.*/
  87
  88
  89 class BDiversity
  90 {
  91         public:
  92                 void doBD(vector<double>, double);//Main method
  93                 double getWhitt(vector<double>,vector<double>);//Whittacker's measure
  94                 double getMS(vector<double>, vector<double>);//Marczewski-Stainhaus distance
  95                 double getSor(vector<double>, vector<double>);//Sorensen quantitative index
  96                 double getMor(vector<double>, vector<double>);//Morisita-Horn index
  97                 void printD(vector<vector<double> >, int);//This prints a table that represents the given 2D vector, the second paramter specifies which method is to be used (1 for Whitt, 2 for MS, 3 for Sor, and 4 for Mor)
  98 };
  99
 100 /**************************************************************************************************/
 101
 102 /*This Class is similar to the GeometricSeries.h class. It calculates
 103 the broken stick distribution of the table and prints the D-Statistic
 104 and the confidence limits for the Kolmogorov-Smirnov 1-Sample test
 105 with a 95% confidence level.*/
 106
 107 class BrokenStick
 108 {
 109         public:
 110                 void doBStick(vector<double>);
 111 };
 112
 113 /**************************************************************************************************/
 114 /*This Class calculates the geometric series distribution for the data.
 115 It prints the D-Statistic and the critical values for the Kolmogorov-Smirnov
 116 1-sample test at the 95% confidence interval.*/
 117
 118 class GeometricSeries
 119 {
 120         public:
 121                 void doGeomTest(vector<double>);
 122 };
 123
 124 /**************************************************************************************************/
 125 //This Class calculates the jackknifed estimate of the data and
 126 //prints it and the confidence limits at a chosen confidence level.
 127
 128 class Jackknifing
 129 {
 130         public:
 131                 void doJK(vector<double>, double);
 132 };
 133 /**************************************************************************************************/
 134 /*This Class stores calculates the Kolmogorov-Smirnov 2-Sample test between two samples.
 135 It prints the D-Statistic and the critical value for the test at
 136 the 90% and 95% confidence interval.*/
 137
 138 class KS2SampleTest
 139 {
 140         public:
 141                 void doKSTest(vector<double>, vector<double>);
 142 };
 143 /**************************************************************************************************/
 144 /*This Class calculates the Log Series Distribution for the data.
 145 It then generates a D-Statistic and prints the D-Statistic and
 146 the critical values for the Kolmogorov-Smirnov 1 sample test.*/
 147
 148 class LogSD
 149 {
 150         public:
 151                 void doLogSD(vector<double>, vector<double>);
 152 };
 153
 154 /**************************************************************************************************/
 155 //This Class calculates and prints the Q-Statistic for the data.
 156 class QStatistic
 157 {
 158         public:
 159                 void doQStat(vector<double>);
 160 };
 161 /**************************************************************************************************/
 162 class SSBPDiversityIndices
 163 {
 164         public:
 165                 void doSSBP(vector<double>);
 166                 double getShan(vector<double> vec);//The Shannon Index
 167                 double getSimp(vector<double> vec);//The Simpson Index
 168                 double getBP(vector<double> vec);//The Berger-Parker Index
 169 };
 170 /**************************************************************************************************/
 171 //This Class stores the table of the confidence limits of the Student-T distribution.
 172 class TDTable
 173 {
 174         public:
 175                 double getConfLimit(int,int);
 176 };
 177
 178 /**************************************************************************************************/
 179 /*This Class calculates the truncated lognormal for the data.
 180 It then prints the D-Statistic and the critical values for the
 181 Kolmogorov-Smirnov 1-Sample test.*
 182
 183 class TrunLN
 184 {
 185         public:
 186                 void doTrunLN(vector<double>, vector<double>);
 187 };
 188 /**************************************************************************************************/
 189
 190 #endif
 191