A library for working with phylogenetic and population genetic data.
v0.32.0
variant_window_stream.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_POPULATION_WINDOW_VARIANT_WINDOW_STREAM_H_
2 #define GENESIS_POPULATION_WINDOW_VARIANT_WINDOW_STREAM_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2024 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 <lczech@carnegiescience.edu>
23  Department of Plant Biology, Carnegie Institution For Science
24  260 Panama Street, Stanford, CA 94305, USA
25 */
26 
39 
40 #include <type_traits>
41 
42 namespace genesis {
43 namespace population {
44 
45 // =================================================================================================
46 // Generic Variant Window Stream
47 // =================================================================================================
48 
49 // Quick check to avoid future bugs if we ever change that definition.
50 static_assert(
51  std::is_same<VariantInputStream::value_type, Variant>::value,
52  "VariantInputStream::value_type != Variant"
53 );
54 
61 using VariantWindowStream = BaseWindowStream<
64  Window<VariantInputStream::value_type>
65 >;
66 
82 >;
83 
84 } // namespace population
85 } // namespace genesis
86 
87 #endif // include guard
genesis::population::BaseWindowStream
Base class for streams of Windows over the chromosomes of a genome.
Definition: base_window_stream.hpp:119
base_window_stream.hpp
genesis::population::VariantWindowStream
BaseWindowStream< VariantInputStream::Iterator, VariantInputStream::value_type, Window< VariantInputStream::value_type > > VariantWindowStream
Typedef for a uniform Window stream type.
Definition: variant_window_stream.hpp:65
window_view.hpp
genesis::utils::GenericInputStream< Variant, VariantInputStreamData >::value_type
Variant value_type
Definition: generic_input_stream.hpp:172
genesis::population::WindowView
Proxy view over window-like regions of a genome.
Definition: window_view.hpp:76
window_view_stream.hpp
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
window.hpp
variant_input_stream.hpp
genesis::utils::GenericInputStream< Variant, VariantInputStreamData >::Iterator
friend Iterator
Definition: generic_input_stream.hpp:846