A toolkit for working with phylogenetic data.
v0.18.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
nhd.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_PLACEMENT_FUNCTION_NHD_H_
2 #define GENESIS_PLACEMENT_FUNCTION_NHD_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 #include <cstddef>
35 
36 namespace genesis {
37 
38 // =================================================================================================
39 // Forward Declarations
40 // =================================================================================================
41 
42 namespace placement {
43 
44  class Sample;
45  class SampleSet;
46 
47 }
48 
49 namespace utils {
50 
51  template<typename T>
52  class Matrix;
53 
54 }
55 
56 namespace placement {
57 
58 // =================================================================================================
59 // Node Histogram Distance
60 // =================================================================================================
61 
62 
67  Sample const& sample_a,
68  Sample const& sample_b,
69  size_t const histogram_bins = 25,
70  bool use_negative_axis = true
71 );
72 
78 utils::Matrix<double> node_histogram_distance (
79  SampleSet const& sample_set,
80  size_t const histogram_bins = 25,
81  bool use_negative_axis = true
82 );
83 
84 } // namespace placement
85 } // namespace genesis
86 
87 #endif // include guard
double node_histogram_distance(Sample const &sample_a, Sample const &sample_b, size_t const histogram_bins, bool use_negative_axis)
Calculate the Node Histogram Distance of two Samples.
Definition: nhd.cpp:324