A toolkit for working with phylogenetic data.
v0.24.0
tree/common_tree/operators.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_TREE_COMMON_TREE_OPERATORS_H_
2 #define GENESIS_TREE_COMMON_TREE_OPERATORS_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 namespace genesis {
35 namespace tree {
36 
37 // =================================================================================================
38 // Forward Declarations
39 // =================================================================================================
40 
41 class Tree;
42 
43 class CommonNodeData;
44 class CommonEdgeData;
45 
46 using CommonTree = Tree;
47 
48 // =================================================================================================
49 // Comparison and Conversion
50 // =================================================================================================
51 
57  Tree const& lhs,
58  Tree const& rhs,
59  bool compare_node_names = true,
60  bool compare_branch_lengths = true
61 );
62 
73 CommonTree convert_to_common_tree( Tree const& source_tree );
74 
75 } // namespace tree
76 } // namespace genesis
77 
78 #endif // include guard
Tree CommonTree
Alias for a Tree with data types CommonNodeData and CommonEdgeData.
bool equal_common_trees(Tree const &lhs, Tree const &rhs, bool compare_node_names, bool compare_branch_lengths)
Compare two CommonTrees, that is, check whether they have identical topology, node names...
Container namespace for all symbols of genesis in order to keep them separate when used as a library...
CommonTree convert_to_common_tree(Tree const &source_tree)
Convert a Tree to a CommonTree with CommonNodeData and CommonEdgeData.