A toolkit for working with phylogenetic data.
v0.20.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
functions/taxopath.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_TAXONOMY_FUNCTIONS_TAXOPATH_H_
2 #define GENESIS_TAXONOMY_FUNCTIONS_TAXOPATH_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 namespace genesis {
35 namespace taxonomy {
36 
37 // =================================================================================================
38 // Forwad Declarations
39 // =================================================================================================
40 
41 class Taxon;
42 class Taxonomy;
43 class Taxopath;
44 
45 // =================================================================================================
46 // Taxopath
47 // =================================================================================================
48 
49 Taxon& add_from_taxopath(
50  Taxonomy& taxonomy,
51  Taxopath const& taxopath,
52  bool expect_parents = false
53 );
54 
55 Taxon const* find_taxon_by_taxopath( Taxonomy const& tax, Taxopath const& taxopath );
56 Taxon* find_taxon_by_taxopath( Taxonomy& tax, Taxopath const& taxopath );
57 
58 } // namespace taxonomy
59 } // namespace genesis
60 
61 #endif // include guard
Taxon const * find_taxon_by_taxopath(Taxonomy const &tax, Taxopath const &taxopath)
Find a Taxon in a Taxonomy, given its Taxopath.
Taxon & add_from_taxopath(Taxonomy &taxonomy, Taxopath const &taxopath, bool expect_parents)
Add a Taxon to a Taxonomy, using the taxonomic elements of a Taxopath.