A library for working with phylogenetic and population genetic data.
v0.27.0
placement/formats/serializer.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_PLACEMENT_FORMATS_SERIALIZER_H_
2 #define GENESIS_PLACEMENT_FORMATS_SERIALIZER_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 #include <string>
35 #include <vector>
36 
37 namespace genesis {
38 namespace placement {
39 
40 // =================================================================================================
41 // Forward Declarations
42 // =================================================================================================
43 
44 class Sample;
45 class SampleSet;
46 
47 // =================================================================================================
48 // SampleSerializer
49 // =================================================================================================
50 
55 {
56 public:
57 
58  static void save( Sample const& map, std::string const& file_name );
59 
60  static Sample load( std::string const& file_name );
61  static SampleSet load( std::vector<std::string> const& file_names );
62  static void load( std::vector<std::string> const& file_names, SampleSet& sample_set );
63 
64  static unsigned char version;
65 
66 };
67 
68 } // namespace placement
69 } // namespace genesis
70 
71 #endif // include guard
genesis::placement::SampleSet
Store a set of Samples with associated names.
Definition: sample_set.hpp:54
genesis::placement::Sample
Manage a set of Pqueries along with the PlacementTree where the PqueryPlacements are placed on.
Definition: sample.hpp:68
genesis::placement::SampleSerializer::version
static unsigned char version
Version of this serialization helper. Is written to the stream and read again to make sure that diffe...
Definition: placement/formats/serializer.hpp:64
genesis::placement::SampleSerializer
Definition: placement/formats/serializer.hpp:54
genesis::placement::SampleSerializer::load
static Sample load(std::string const &file_name)
Loads a Sample from a binary file that was written by using save().
Definition: serializer.cpp:122
genesis::placement::SampleSerializer::save
static void save(Sample const &map, std::string const &file_name)
Saves the Sample to a binary file that can later be read by using load().
Definition: serializer.cpp:66
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