SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
seqan3::detail::fm_index_cursor_node< index_t > Struct Template Reference

Internal representation of the node of an FM index cursor. More...

#include <seqan3/search/fm_index/detail/fm_index_cursor.hpp>

+ Inheritance diagram for seqan3::detail::fm_index_cursor_node< index_t >:

Public Types

using sdsl_char_type = typename index_t::sdsl_char_type
 The type of the reduced alphabet type. (The reduced alphabet might be smaller than the original alphabet in case not all possible characters occur in the indexed text.)
 
using size_type = typename index_t::size_type
 Type for representing positions in the indexed text.
 

Public Member Functions

bool operator!= (fm_index_cursor_node const &rhs) const
 Comparison of two cursor nodes.
 
bool operator== (fm_index_cursor_node const &rhs) const
 Comparison of two cursor nodes.
 
template<cereal_archive archive_t>
void serialize (archive_t &archive)
 Serialisation support function.
 

Public Attributes

size_type depth
 Depth of the node in the suffix tree, i.e. length of the searched query.
 
sdsl_char_type last_char
 Label of the last edge moved down. Needed for cycle_back().
 
size_type lb
 Left suffix array bound.
 
size_type rb
 Right suffix array bound.
 

Detailed Description

template<typename index_t>
struct seqan3::detail::fm_index_cursor_node< index_t >

Internal representation of the node of an FM index cursor.

Template Parameters
index_tThe type of the underlying index.

Member Function Documentation

◆ serialize()

template<typename index_t >
template<cereal_archive archive_t>
void seqan3::detail::fm_index_cursor_node< index_t >::serialize ( archive_t &  archive)
inline

Serialisation support function.

Template Parameters
archive_tType of archive; must satisfy seqan3::cereal_archive.
Parameters
archiveThe archive being serialised from/to.
Attention
These functions are never called directly, see Serialisation for more details.

The documentation for this struct was generated from the following file:
Hide me