A toolkit for working with phylogenetic data.
v0.24.0
deref_iterator.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_CONTAINERS_DEREF_ITERATOR_H_
2 #define GENESIS_UTILS_CONTAINERS_DEREF_ITERATOR_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2018 Lucas Czech and HITS gGmbH
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 <cstddef>
35 
36 namespace genesis {
37 namespace utils {
38 
39 // =================================================================================================
40 // Dereference Iterator
41 // =================================================================================================
42 
59 template <class BaseIterator>
60 class DereferenceIterator : public BaseIterator
61 {
62 public:
63 
64  using value_type = typename BaseIterator::value_type::element_type;
65  using difference_type = typename BaseIterator::difference_type;
66 
67  using pointer = value_type *;
68  using reference = value_type &;
69 
70  DereferenceIterator( BaseIterator const& other )
71  : BaseIterator( other )
72  {}
73 
75  {
76  return *(this->BaseIterator::operator*());
77  }
78 
80  {
81  return this->BaseIterator::operator*().get();
82  }
83 
85  {
86  return *( this->BaseIterator::operator[]( n ));
87  }
88 };
89 
90 } // namespace utils
91 } // namespace genesis
92 
93 #endif // include guard
Iterator class that exposes elements in a container of pointers.
Container namespace for all symbols of genesis in order to keep them separate when used as a library...
reference operator[](difference_type n) const
DereferenceIterator(BaseIterator const &other)
typename BaseIterator::value_type::element_type value_type
typename BaseIterator::difference_type difference_type