A library for working with phylogenetic and population genetic data.
v0.27.0
gzip_block_ostream.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_IO_GZIP_BLOCK_OSTREAM_H_
2 #define GENESIS_UTILS_IO_GZIP_BLOCK_OSTREAM_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2020 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 
36 
37 #include <fstream>
38 #include <sstream>
39 #include <string>
40 
41 namespace genesis {
42 namespace utils {
43 
44 // ================================================================================================
45 // Gzip Block Output Stream
46 // ================================================================================================
47 
91  : public std::ostream
92 {
93 public:
94 
95  explicit GzipBlockOStream(
96  std::ostream& os,
97  std::size_t block_size = GZIP_DEFAULT_BLOCK_SIZE,
99  std::size_t num_threads = 0
100  );
101 
102  explicit GzipBlockOStream(
103  std::streambuf* sbuf_p,
104  std::size_t block_size = GZIP_DEFAULT_BLOCK_SIZE,
106  std::size_t num_threads = 0
107  );
108 
109  virtual ~GzipBlockOStream();
110 
111  static const std::size_t GZIP_DEFAULT_BLOCK_SIZE = 1ul << 16;
112 };
113 
114 } // namespace utils
115 } // namespace genesis
116 
117 #endif // include guard
genesis::utils::GzipBlockOStream::~GzipBlockOStream
virtual ~GzipBlockOStream()
Definition: gzip_block_ostream.cpp:738
genesis::utils::GzipBlockOStream::GZIP_DEFAULT_BLOCK_SIZE
static const std::size_t GZIP_DEFAULT_BLOCK_SIZE
Definition: gzip_block_ostream.hpp:111
gzip.hpp
genesis::utils::GzipCompressionLevel
GzipCompressionLevel
List of possible compression levels used for GzipOStream.
Definition: gzip_stream.hpp:100
gzip_stream.hpp
genesis::utils::GzipBlockOStream
Output stream that writes blocks of gzip-compressed data to an underlying wrapped stream,...
Definition: gzip_block_ostream.hpp:90
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::utils::GzipCompressionLevel::kDefaultCompression
@ kDefaultCompression
genesis::utils::GzipBlockOStream::GzipBlockOStream
GzipBlockOStream(std::ostream &os, std::size_t block_size=GZIP_DEFAULT_BLOCK_SIZE, GzipCompressionLevel compression_level=GzipCompressionLevel::kDefaultCompression, std::size_t num_threads=0)
Definition: gzip_block_ostream.cpp:706