A toolkit for working with phylogenetic data.
v0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
utils/math/histogram/stats.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_MATH_HISTOGRAM_STATS_H_
2 #define GENESIS_UTILS_MATH_HISTOGRAM_STATS_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2018 Lucas Czech and HITS gGmbH
7 
8  This program is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with this program. If not, see <http://www.gnu.org/licenses/>.
20 
21  Contact:
22  Lucas Czech <lucas.czech@h-its.org>
23  Exelixis Lab, Heidelberg Institute for Theoretical Studies
24  Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
25 */
26 
34 #include <cstddef>
35 
36 namespace genesis {
37 namespace utils {
38 
39 // =================================================================================================
40 // Forward Declarations
41 // =================================================================================================
42 
43 class Histogram;
44 
45 // =================================================================================================
46 // Histogram Statistics
47 // =================================================================================================
48 
49 double min_value(const Histogram& h);
50 
51 double max_value(const Histogram& h);
52 
53 size_t min_bin(const Histogram& h);
54 
55 size_t max_bin(const Histogram& h);
56 
57 double median(const Histogram& h);
58 
66 double mean(const Histogram& h);
67 
75 double sigma(const Histogram& h);
76 
77 double sum(const Histogram& h);
78 
79 } // namespace utils
80 } // namespace genesis
81 
82 #endif // include guard
double min_value(const Histogram &h)
double sigma(const Histogram &h)
Compute the bin-weighted standard deviation.
double median(const Histogram &h)
double sum(const Histogram &h)
double mean(const Histogram &h)
Compute the bin-weighted arithmetic mean.
size_t max_bin(const Histogram &h)
size_t min_bin(const Histogram &h)
double max_value(const Histogram &h)