SeqAn3
fm_index_iterator.hpp
Go to the documentation of this file.
1 // ============================================================================
2 // SeqAn - The Library for Sequence Analysis
3 // ============================================================================
4 //
5 // Copyright (c) 2006-2018, Knut Reinert & Freie Universitaet Berlin
6 // Copyright (c) 2016-2018, Knut Reinert & MPI Molekulare Genetik
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are met:
11 //
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // * Neither the name of Knut Reinert or the FU Berlin nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 // ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
25 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 // OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31 // DAMAGE.
32 //
33 // ============================================================================
34 
40 #pragma once
41 
42 #include <type_traits>
43 
44 #include <seqan3/core/platform.hpp>
45 
46 namespace seqan3::detail
47 {
48 
57 template <typename index_t>
58 struct fm_index_iterator_node
59 {
61  using size_type = typename index_t::size_type;
65  using sdsl_char_type = typename index_t::sdsl_char_type;
66 
68  size_type lb;
70  size_type rb;
72  size_type depth;
74  sdsl_char_type last_char;
75 
77  bool operator==(fm_index_iterator_node const & rhs) const
78  {
79  // NOTE: last_char is implementation specific for cycle_back().
80  // lb, rb and depth already determine the node in the suffix tree.
81  // Thus there is no need to compare last_char.
82  return std::tie(lb, rb, depth) == std::tie(rhs.lb, rhs.rb, rhs.depth);
83  }
84 
86  bool operator!=(fm_index_iterator_node const & rhs) const
87  {
88  return !(*this == rhs);
89  }
90 };
91 
92 // std::tuple get_suffix_array_range(fm_index_iterator<index_t> const & it)
93 // {
94 // return {node.lb, node.rb};
95 // }
96 //
97 // std::tuple get_suffix_array_range(bi_fm_index_iterator<index_t> const & it)
98 // {
99 // return {node.lb, node.rb};
100 // }
101 
103 
105 
106 }
Contains platform and dependency checks.
Definition: aligned_sequence_concept.hpp:288
Provides C++20 additions to the type_traits header.