]> git.donarmstrong.com Git - mothur.git/blobdiff - calculator.h
added logfile feature
[mothur.git] / calculator.h
index 5dc081296748412a8e61e883d11ac60d70cfd864..ffc92b929f75fe7164301f94f969e384ad9d907a 100644 (file)
@@ -41,43 +41,43 @@ protected:
 /**************************************************************************************************/
 /*This Class holds all of the methods that manipulate vectors.
 These methods are used in the other classes.
-This class must be included if any of the other classes are to be used.*/
+This class must be included if any of the other classes are to be used. */
 
 class VecCalc
 {
        // The methods seen in the order here is how they are ordered throughout the class.
        public:
                VecCalc(){};
-               void printElements(vector<double>); //This prints the values of the vector on one line with a space between each value.
-               void printElements(vector<string>); //This prints the values of the vector on one line with a space between each value.
-               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.
-               double mean(vector<double>); //This returns the mean value of the vector.
-               double stError(vector<double>); //This returns the standard error of the vector.
+               //void printElements(vector<double>); //This prints the values of the vector on one line with a space between each value.
+               //void printElements(vector<string>); //This prints the values of the vector on one line with a space between each value.
+               //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.
+               //double mean(vector<double>); //This returns the mean value of the vector.
+               //double stError(vector<double>); //This returns the standard error of the vector.
                int sumElements(vector<int>, int);
                int sumElements(vector<int>);
                double sumElements(vector<double>); //This returns the sum of all the values in the vector.
                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.  
-               double findMax(vector<double>); //This returns the maximum value in the vector.
+               //double findMax(vector<double>); //This returns the maximum value in the vector.
                int numNZ(vector<int>); //This returns the number of non-zero values in the vector.
                double numNZ(vector<double>); //This returns the number of non-zero values in the vector.
-               double numPos(vector<double>); //This returns the number of positive values in the vector.
-               double findMaxDiff(vector<double>, vector<double>); //This returns the absolute value of the maximum difference between the two vectors.
-               double findDStat(vector<double>, vector<double>, double); //This returns the D-Statistic of the two vectors with the given total number of species.
-               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.
-               vector<double> add(vector<double>, double); //This adds the given number to every element in the given vector and returns the new vector.
-               vector<double> multiply(vector<double>, double); //This multiplies every element in the given vector by the given number and returns the new vector.
-               vector<double> power(vector<double>, double); //This raises every element in the given vector to the given number and returns the new vector.
-               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.
-               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.
-               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.
-               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.
-               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.
-               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.
-               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.
-               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.
-               vector<double> quicksort(vector<double>); //This sorts the given vector from highest to lowest and returns the sorted vector.
-               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.
-               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.
+               //double numPos(vector<double>); //This returns the number of positive values in the vector.
+               //double findMaxDiff(vector<double>, vector<double>); //This returns the absolute value of the maximum difference between the two vectors.
+               //double findDStat(vector<double>, vector<double>, double); //This returns the D-Statistic of the two vectors with the given total number of species.
+               //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.
+               //vector<double> add(vector<double>, double); //This adds the given number to every element in the given vector and returns the new vector.
+               //vector<double> multiply(vector<double>, double); //This multiplies every element in the given vector by the given number and returns the new vector.
+               //vector<double> power(vector<double>, double); //This raises every element in the given vector to the given number and returns the new vector.
+               //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.
+               //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.
+               //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.
+               //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.
+               //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.
+               ///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.
+               //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.
+               //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.
+               //vector<double> quicksort(vector<double>); //This sorts the given vector from highest to lowest and returns the sorted vector.
+               //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.
+               //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.
 };
 
 /**************************************************************************************************/
@@ -85,7 +85,7 @@ class VecCalc
 /*This Class is similar to the GeometricSeries.h class. It calculates
 the broken stick distribution of the table and prints the D-Statistic 
 and the confidence limits for the Kolmogorov-Smirnov 1-Sample test
-with a 95% confidence level.*/
+with a 95% confidence level.
 
 class BrokenStick
 {
@@ -104,7 +104,7 @@ It prints the D-Statistic and the critical values for the Kolmogorov-Smirnov
                void doGeomTest(vector<double>);
 };*/
 
-/**************************************************************************************************/
+/**************************************************************************************************
 //This Class calculates the jackknifed estimate of the data and
 //prints it and the confidence limits at a chosen confidence level.
 
@@ -113,10 +113,10 @@ class Jackknifing
        public:
                void doJK(vector<double>, double);
 };
-/**************************************************************************************************/
+/**************************************************************************************************
 /*This Class stores calculates the Kolmogorov-Smirnov 2-Sample test between two samples.
 It prints the D-Statistic and the critical value for the test at 
-the 90% and 95% confidence interval.*/
+the 90% and 95% confidence interval.
 
 class KS2SampleTest
 {
@@ -124,14 +124,14 @@ class KS2SampleTest
                void doKSTest(vector<double>, vector<double>);
 };
 
-/**************************************************************************************************/
+/**************************************************************************************************
 //This Class calculates and prints the Q-Statistic for the data.
 class QStatistic
 {
        public:
                void doQStat(vector<double>);
 };
-/**************************************************************************************************/
+/**************************************************************************************************
 class SSBPDiversityIndices
 {
        public:
@@ -148,7 +148,7 @@ class TDTable
                double getConfLimit(int,int);
 };
 
-/**************************************************************************************************/
+/**************************************************************************************************
 //This Class stores the table of the confidence limits of the One-Sample Kolmogorov-Smirnov Test.
 class KOSTable
 {