A library for working with phylogenetic and population genetic data.
v0.32.0
VariantGaplessInputStream::Iterator Class Reference

#include <genesis/population/stream/variant_gapless_input_stream.hpp>

Detailed Description

Iterator over loci of the input source.

Definition at line 116 of file variant_gapless_input_stream.hpp.

Public Member Functions

 Iterator ()=default
 
 Iterator (self_type &&)=default
 
 Iterator (self_type const &)=default
 
 ~Iterator ()=default
 
GenomeLocus const & locus () const
 Return the current locus where the iteration is at. More...
 
 operator bool () const
 
bool operator!= (self_type const &it) const
 
const Variantoperator* () const
 
self_typeoperator++ ()
 
const Variantoperator-> () const
 
Iteratoroperator= (self_type &&)=default
 
Iteratoroperator= (self_type const &)=default
 
bool operator== (self_type const &it) const
 Compare two iterators for equality. More...
 

Public Types

using iterator_category = std::input_iterator_tag
 
using pointer = value_type const *
 
using reference = value_type const &
 
using self_type = VariantGaplessInputStream::Iterator
 
using value_type = Variant
 

Public Attributes

friend VariantGaplessInputStream
 

Constructor & Destructor Documentation

◆ Iterator() [1/3]

Iterator ( )
default

◆ ~Iterator()

~Iterator ( )
default

◆ Iterator() [2/3]

Iterator ( self_type const &  )
default

◆ Iterator() [3/3]

Iterator ( self_type &&  )
default

Member Function Documentation

◆ locus()

GenomeLocus const& locus ( ) const
inline

Return the current locus where the iteration is at.

Definition at line 177 of file variant_gapless_input_stream.hpp.

◆ operator bool()

operator bool ( ) const
inline

Definition at line 199 of file variant_gapless_input_stream.hpp.

◆ operator!=()

bool operator!= ( self_type const &  it) const
inline

Definition at line 217 of file variant_gapless_input_stream.hpp.

◆ operator*()

const Variant& operator* ( ) const
inline

Definition at line 164 of file variant_gapless_input_stream.hpp.

◆ operator++()

self_type& operator++ ( )
inline

Definition at line 186 of file variant_gapless_input_stream.hpp.

◆ operator->()

const Variant* operator-> ( ) const
inline

Definition at line 154 of file variant_gapless_input_stream.hpp.

◆ operator=() [1/2]

Iterator& operator= ( self_type &&  )
default

◆ operator=() [2/2]

Iterator& operator= ( self_type const &  )
default

◆ operator==()

bool operator== ( self_type const &  it) const
inline

Compare two iterators for equality.

Any two iterators that are created by calling begin() on the same LambdaStream instance will compare equal, as long as neither of them is past-the-end. A valid (not past-the-end) iterator and an end() iterator will not compare equal, no matter from which LambdaStream they were created.

Definition at line 212 of file variant_gapless_input_stream.hpp.

Member Typedef Documentation

◆ iterator_category

using iterator_category = std::input_iterator_tag

Definition at line 128 of file variant_gapless_input_stream.hpp.

◆ pointer

using pointer = value_type const*

Definition at line 126 of file variant_gapless_input_stream.hpp.

◆ reference

using reference = value_type const&

Definition at line 127 of file variant_gapless_input_stream.hpp.

◆ self_type

◆ value_type

Definition at line 125 of file variant_gapless_input_stream.hpp.

Member Data Documentation

◆ VariantGaplessInputStream


The documentation for this class was generated from the following files: