A toolkit for working with phylogenetic data.
v0.18.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
cog.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_PLACEMENT_FUNCTION_COG_H_
2 #define GENESIS_PLACEMENT_FUNCTION_COG_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 
35 
36 namespace genesis {
37 namespace placement {
38 
39 // =================================================================================================
40 // Forward Declarations
41 // =================================================================================================
42 
43 class Sample;
44 
45 // =================================================================================================
46 // Center of Gravity
47 // =================================================================================================
48 
72 std::pair<PlacementTreeEdge const*, double> center_of_gravity (
73  Sample const& smp,
74  bool const with_pendant_length = false
75 );
76 
88  Sample const& smp,
89  bool const with_pendant_length = false
90 );
91 
99  Sample const& smp_a,
100  Sample const& smp_b,
101  bool const with_pendant_length = false
102 );
103 
104 } // namespace placement
105 } // namespace genesis
106 
107 #endif // include guard
double center_of_gravity_distance(Sample const &smp_a, Sample const &smp_b, bool const with_pendant_length)
Calculate the distance between the two Centers of Gravity of two Samples.
Definition: cog.cpp:601
double center_of_gravity_variance(Sample const &smp, bool const with_pendant_length)
Calcualte the variance of the PqueryPlacements of a Sample around its Center of Gravity.
Definition: cog.cpp:534
std::pair< PlacementTreeEdge const *, double > center_of_gravity(Sample const &smp, bool const with_pendant_length)
Calculate the Center of Gravity of the placements on a tree.
Definition: cog.cpp:57