A library for working with phylogenetic and population genetic data.
v0.27.0
operations.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_MATH_HISTOGRAM_OPERATIONS_H_
2 #define GENESIS_UTILS_MATH_HISTOGRAM_OPERATIONS_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2017 Lucas Czech
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 namespace genesis {
35 namespace utils {
36 
37 // =================================================================================================
38 // Forward Declarations
39 // =================================================================================================
40 
41 class Histogram;
42 
43 // =================================================================================================
44 // Histogram Operations
45 // =================================================================================================
46 
47 void offset (Histogram& h, double value);
48 
49 void scale (Histogram& h, double factor);
50 
51 void normalize (Histogram& h, double total = 1.0);
52 
53 } // namespace utils
54 } // namespace genesis
55 
56 #endif // include guard
genesis::utils::scale
void scale(Histogram &h, double factor)
Definition: operations.cpp:54
genesis::utils::offset
void offset(Histogram &h, double value)
Definition: operations.cpp:47
genesis
Container namespace for all symbols of genesis in order to keep them separate when used as a library.
Definition: placement/formats/edge_color.cpp:42
genesis::utils::normalize
void normalize(Histogram &h, double total)
Definition: operations.cpp:61