A toolkit for working with phylogenetic data.
v0.20.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
block.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_FORMATS_NEXUS_BLOCK_H_
2 #define GENESIS_UTILS_FORMATS_NEXUS_BLOCK_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 <iosfwd>
36 
37 namespace genesis {
38 namespace utils {
39 
40 // =================================================================================================
41 // Nexus Block
42 // =================================================================================================
43 
48 {
49  // -----------------------------------------------------
50  // Constructor and Rule of Five
51  // -----------------------------------------------------
52 
53 public:
54 
55  NexusBlock() = default;
56  virtual ~NexusBlock() = default;
57 
58  NexusBlock( NexusBlock const& ) = default;
59  NexusBlock( NexusBlock&& ) = default;
60 
61  NexusBlock& operator= ( NexusBlock const& ) = default;
62  NexusBlock& operator= ( NexusBlock&& ) = default;
63 
64  // -----------------------------------------------------
65  // Virtual Functions
66  // -----------------------------------------------------
67 
68 public:
69 
70  virtual std::string block_name() const = 0;
71  virtual void to_stream( std::ostream& os ) const = 0;
72 
73 };
74 
75 // =================================================================================================
76 // Operators
77 // =================================================================================================
78 
79 // std::ostream& operator<< ( std::ostream& os, NexusBlock const& block )
80 inline std::ostream& operator<< ( std::ostream& os, NexusBlock const& block )
81 {
82  block.to_stream( os );
83  return os;
84 }
85 
86 } // namespace utils
87 } // namespace genesis
88 
89 #endif // include guard
virtual ~NexusBlock()=default
virtual std::string block_name() const =0
virtual void to_stream(std::ostream &os) const =0
std::ostream & operator<<(std::ostream &os, const Matrix< T > &matrix)
Print the elements of a Matrix to a stream, using operator << for each element.
NexusBlock & operator=(NexusBlock const &)=default