A library for working with phylogenetic and population genetic data.
v0.32.0
WindowView< D >::Iterator Class Reference

#include <genesis/population/window/window_view.hpp>

Detailed Description

template<class D>
class genesis::population::WindowView< D >::Iterator

Definition at line 100 of file window_view.hpp.

Public Member Functions

 Iterator ()=default
 Default constructor for empty (past-the-end) data. More...
 
 Iterator (self_type &&)=default
 
 Iterator (self_type const &)=default
 
 Iterator (WindowView const *parent)
 Constructor for data iteration. More...
 
 ~Iterator ()=default
 
bool operator!= (self_type const &other) const
 
value_typeoperator* ()
 
const value_typeoperator* () const
 
self_typeoperator++ ()
 
value_typeoperator-> ()
 
const value_typeoperator-> () const
 
Iteratoroperator= (self_type &&)=default
 
Iteratoroperator= (self_type const &)=default
 
bool operator== (self_type const &other) const
 Compare two iterators for equality. More...
 

Public Types

using const_reference = value_type const &
 
using Data = D
 
using difference_type = std::ptrdiff_t
 
using iterator_category = std::input_iterator_tag
 
using pointer = value_type const *
 
using reference = value_type &
 
using self_type = WindowView< Data >::Iterator
 
using value_type = Data
 

Constructor & Destructor Documentation

◆ Iterator() [1/4]

Iterator ( )
default

Default constructor for empty (past-the-end) data.

◆ Iterator() [2/4]

Iterator ( WindowView const *  parent)
inline

Constructor for data iteration.

Definition at line 126 of file window_view.hpp.

◆ ~Iterator()

~Iterator ( )
default

◆ Iterator() [3/4]

Iterator ( self_type const &  )
default

◆ Iterator() [4/4]

Iterator ( self_type &&  )
default

Member Function Documentation

◆ operator!=()

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

Definition at line 217 of file window_view.hpp.

◆ operator*() [1/2]

value_type& operator* ( )
inline

Definition at line 176 of file window_view.hpp.

◆ operator*() [2/2]

const value_type& operator* ( ) const
inline

Definition at line 169 of file window_view.hpp.

◆ operator++()

self_type& operator++ ( )
inline

Definition at line 187 of file window_view.hpp.

◆ operator->() [1/2]

value_type* operator-> ( )
inline

Definition at line 162 of file window_view.hpp.

◆ operator->() [2/2]

const value_type* operator-> ( ) const
inline

Definition at line 155 of file window_view.hpp.

◆ operator=() [1/2]

Iterator& operator= ( self_type &&  )
default

◆ operator=() [2/2]

Iterator& operator= ( self_type const &  )
default

◆ operator==()

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

Compare two iterators for equality.

Any two iterators that are copies of each other without having moved 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. Two past-the-end iterators compare equal.

Definition at line 210 of file window_view.hpp.

Member Typedef Documentation

◆ const_reference

using const_reference = value_type const&

Definition at line 114 of file window_view.hpp.

◆ Data

using Data = D

Definition at line 108 of file window_view.hpp.

◆ difference_type

using difference_type = std::ptrdiff_t

Definition at line 115 of file window_view.hpp.

◆ iterator_category

using iterator_category = std::input_iterator_tag

Definition at line 116 of file window_view.hpp.

◆ pointer

using pointer = value_type const*

Definition at line 112 of file window_view.hpp.

◆ reference

Definition at line 113 of file window_view.hpp.

◆ self_type

Definition at line 109 of file window_view.hpp.

◆ value_type

using value_type = Data

Definition at line 111 of file window_view.hpp.


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