describe.hpp

Go to the documentation of this file.

/*************************************************************************
 *
 *  Project
 *                         _____ _____  __  __ _____
 *                        / ____|  __ \|  \/  |  __ \
 *  ___  _ __   ___ _ __ | |  __| |__) | \  / | |__) |
 * / _ \| '_ \ / _ \ '_ \| | |_ |  ___/| |\/| |  ___/
 *| (_) | |_) |  __/ | | | |__| | |    | |  | | |
 * \___/| .__/ \___|_| |_|\_____|_|    |_|  |_|_|
 *      | |
 *      |_|
 *
 * Copyright (C) Akiel Aries, <akiel@akiel.org>, et al.
 *
 * This software is licensed as described in the file LICENSE, which
 * you should have received as part of this distribution. The terms
 * among other details are referenced in the official documentation
 * seen here : https://akielaries.github.io/openGPMP/ along with
 * important files seen in this project.
 *
 * You may opt to use, copy, modify, merge, publish, distribute
 * and/or sell copies of the Software, and permit persons to whom
 * the Software is furnished to do so, under the terms of the
 * LICENSE file. As this is an Open Source effort, all implementations
 * must be of the same methodology.
 *
 *
 *
 * This software is distributed on an AS IS basis, WITHOUT
 * WARRANTY OF ANY KIND, either express or implied.
 *
 ************************************************************************/
#ifndef DESCRIBE_HPP
#define DESCRIBE_HPP
 
#include <vector>
 
namespace gpmp {
namespace stats {
 
class Describe {
  public:
    static double u_stat(const std::vector<double> &sample1,
                         const std::vector<double> &sample2);
 
    static double mean_arith(const std::vector<double> &data);
 
    double mean_geo(const std::vector<double> &data);
 
    double mean_cubic(const std::vector<double> &data, double p);
 
    double mean_geo_pow(const std::vector<double> &data, double p);
 
    double mean_harmonic(const std::vector<double> &data);
 
    double mean_heronian(const std::vector<double> &data);
 
    double mean_heinz(const std::vector<double> &data);
 
    double mean_lehmer(const std::vector<double> &data, double p);
 
    double Median(std::vector<double> data);
    double avg_abs_dev(const std::vector<double> &data);
 
    double var_coeff(const std::vector<double> &data);
 
    double iq_range(const std::vector<double> &data);
    double percentile(const std::vector<double> &data, double percentile);
    double range(const std::vector<double> &data);
 
    static double stdev(const std::vector<double> &data, double mean);
    static double variance(const std::vector<double> &data, double mean);
 
    double clt(const std::vector<double> &data, int numSamples);
 
    double kurtosis(const std::vector<double> &data, double mean);
    double lmoment1(const std::vector<double> &data, double mean);
 
    double lmoment2(const std::vector<double> &data, double mean);
    double
    skewness(const std::vector<double> &data, double mean, double stddev);
 
    std::vector<size_t> rank_data(const std::vector<double> &data);
 
    double partial_corr(const std::vector<double> &x,
                        const std::vector<double> &y,
                        const std::vector<double> &z);
    double ppmc(const std::vector<double> &x, const std::vector<double> &y);
 
    double kendalls_tau(const std::vector<double> &x,
                        const std::vector<double> &y);
    double spearmans_rho(const std::vector<double> &x,
                         const std::vector<double> &y);
};
 
} // namespace stats
} // namespace gpmp
 
#endif