A library for working with phylogenetic and population genetic data.
v0.27.0
placement/function/manipulation.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_PLACEMENT_FUNCTION_MANIPULATION_H_
2 #define GENESIS_PLACEMENT_FUNCTION_MANIPULATION_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2018 Lucas Czech, Pierre Barbera 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 
35 
36 namespace genesis {
37 namespace placement {
38 
39 // =================================================================================================
40 // Forward Declarations
41 // =================================================================================================
42 
43 class Sample;
44 
45 // =================================================================================================
46 // Rooting
47 // =================================================================================================
48 
64 void make_rooted( Sample& sample, PlacementTreeEdge& target_edge );
65 
66 } // namespace tree
67 } // namespace placement
68 
69 #endif // include guard
genesis::placement::make_rooted
void make_rooted(Sample &sample, PlacementTreeEdge &target_edge)
Root the underlying PlacementTree of a Sample at a specified TreeEdge.
Definition: placement/function/manipulation.cpp:51
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::PlacementTreeEdge
tree::TreeEdge PlacementTreeEdge
Alias for tree::TreeEdge used in a PlacementTree. See PlacementEdgeData for the data stored on the ed...
Definition: jplace_reader.hpp:57
sample.hpp