A library for working with phylogenetic and population genetic data.
v0.27.0
placement/function/tree.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_PLACEMENT_FUNCTION_TREE_H_
2 #define GENESIS_PLACEMENT_FUNCTION_TREE_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 <string>
35 
36 namespace genesis {
37 
38 // =================================================================================================
39 // Forward Declarations
40 // =================================================================================================
41 
42 namespace tree{
43  class Tree;
44 }
45 
46 namespace placement {
47 
48 class Sample;
49 
50 // =================================================================================================
51 // Placement Tree Functions
52 // =================================================================================================
53 
143 tree::Tree labelled_tree(
144  Sample const& sample,
145  bool fully_resolve = false,
146  std::string const& name_prefix = ""
147 );
148 
164 tree::Tree labelled_tree(
165  Sample const& sample,
166  tree::Tree const& tree,
167  bool fully_resolve = false,
168  std::string const& name_prefix = ""
169 );
170 
171 } // namespace placement
172 } // namespace genesis
173 
174 #endif // include guard
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::placement::labelled_tree
tree::Tree labelled_tree(Sample const &sample, bool const fully_resolve, std::string const &name_prefix)
Produce a Tree where the most probable PqueryPlacement of each Pquery in a Sample is turned into an E...
Definition: placement/function/tree.cpp:55