SeqAn3  3.0.2
The Modern C++ library for sequence analysis.
seqan3::bi_fm_index_cursor< index_t > Class Template Reference

The SeqAn Bidirectional FM Index Cursor. More...

#include <seqan3/search/fm_index/bi_fm_index_cursor.hpp>

+ Inheritance diagram for seqan3::bi_fm_index_cursor< index_t >:

Public Types

using index_type = index_t
 Type of the index.
 
Text types
using size_type = typename index_type::size_type
 Type for representing positions in the indexed text.
 
Cursor types
using fwd_cursor = fm_index_cursor< fm_index< typename index_type::alphabet_type, index_type::text_layout_mode, typename index_type::sdsl_index_type > >
 Type for the unidirectional cursor on the original text.
 
using rev_cursor = fm_index_cursor< fm_index< typename index_type::alphabet_type, index_type::text_layout_mode, typename index_type::sdsl_index_type > >
 Type for the unidirectional cursor on the reversed text.
 

Public Member Functions

size_type count () const noexcept
 Counts the number of occurrences of the searched query in the text. More...
 
bool cycle_back () noexcept
 Tries to replace the rightmost character of the query by the next lexicographically larger character such that the query is found in the text. More...
 
bool cycle_front () noexcept
 Tries to replace the leftmost character of the query by the next lexicographically larger character such that the query is found in the text. More...
 
bool extend_left () noexcept
 Tries to extend the query by the smallest possible character to the left such that the query is found in the text. More...
 
template<typename char_t >
bool extend_left (char_t const c) noexcept
 Tries to extend the query by the character c to the left. More...
 
template<std::ranges::range seq_t>
bool extend_left (seq_t &&seq) noexcept
 Tries to extend the query by seq to the left. More...
 
bool extend_right () noexcept
 Tries to extend the query by the smallest possible character to the right such that the query is found in the text. More...
 
template<typename char_t >
bool extend_right (char_t const c) noexcept
 Tries to extend the query by the character c to the right. More...
 
template<std::ranges::range seq_t>
bool extend_right (seq_t &&seq) noexcept
 Tries to extend the query by seq to the right. More...
 
size_type last_rank () noexcept
 Outputs the rightmost respectively leftmost rank depending on whether extend_right() or extend_left() has been called last. More...
 
auto lazy_locate () const
 Locates the occurrences of the searched query in the text on demand, i.e. a ranges::view is returned and every position is located once it is accessed. More...
 
auto lazy_locate () const
 
std::vector< size_typelocate () const
 Locates the occurrences of the searched query in the text. More...
 
std::vector< std::pair< size_type, size_type > > locate () const
 
bool operator!= (bi_fm_index_cursor const &rhs) const noexcept
 Compares two cursors. More...
 
bool operator== (bi_fm_index_cursor const &rhs) const noexcept
 Compares two cursors. More...
 
template<std::ranges::range text_t>
auto path_label (text_t &&text) const noexcept
 Returns the searched query. More...
 
template<std::ranges::range text_t>
auto path_label (text_t &&text) const noexcept
 
size_type query_length () const noexcept
 Returns the depth of the cursor node in the implicit suffix tree, i.e. the length of the sequence searched. More...
 
fwd_cursor to_fwd_cursor () const noexcept
 Returns a unidirectional seqan3::fm_index_cursor on the original text. path_label() on the returned unidirectional index cursor will be equal to path_label() on the bidirectional index cursor. cycle_back() and last_char() will be undefined behavior if the last extension on the bidirectional FM index has been to the left. The behavior will be well-defined after the first extension to the right on the unidirectional index. More...
 
rev_cursor to_rev_cursor () const noexcept
 Returns a unidirectional seqan3::fm_index_cursor on the reversed text. path_label() on the returned unidirectional index cursor will be equal to reversing path_label() on the bidirectional index cursor. Note that because of the text being reversed, extend_right() resp. cycle_back() correspond to extend_left() resp. cycle_front() on the bidirectional index cursor. Furthermore cycle_back() and last_char() will be undefined behavior if the last extension on the bidirectional FM index has been to the left. The behavior will be well-defined after the first extension to the right on the unidirectional index. More...
 
Constructors, destructor and assignment
 bi_fm_index_cursor () noexcept=default
 Default constructor. Accessing member functions on a default constructed object is undefined behavior. More...
 
 bi_fm_index_cursor (bi_fm_index_cursor const &) noexcept=default
 Defaulted.
 
bi_fm_index_cursoroperator= (bi_fm_index_cursor const &) noexcept=default
 Defaulted.
 
 bi_fm_index_cursor (bi_fm_index_cursor &&) noexcept=default
 Defaulted.
 
bi_fm_index_cursoroperator= (bi_fm_index_cursor &&) noexcept=default
 Defaulted.
 
 ~bi_fm_index_cursor ()=default
 Defaulted.
 
 bi_fm_index_cursor (index_t const &_index) noexcept
 Construct from given index.
 

Detailed Description

template<typename index_t>
class seqan3::bi_fm_index_cursor< index_t >

The SeqAn Bidirectional FM Index Cursor.

Template Parameters
index_tThe type of the underlying index; must model seqan3::bi_fm_index_specialisation.

The cursor's interface provides searching a string both from left to right as well as from right to left in the indexed text. It extends the interface of the unidirectional seqan3::fm_index_cursor. All methods modifying the cursor (e.g. extending by a character with extend_right()) return a bool value whether the operation was successful or not. In case of an unsuccessful operation the cursor remains unmodified, i.e. an cursor can never be in an invalid state except default constructed cursors that are always invalid.

The asymptotic running times for using the cursor depend on the SDSL index configuration. To determine the exact running times, you have to additionally look up the running times of the used traits (configuration).

Constructor & Destructor Documentation

◆ bi_fm_index_cursor()

template<typename index_t >
seqan3::bi_fm_index_cursor< index_t >::bi_fm_index_cursor ( )
defaultnoexcept

Default constructor. Accessing member functions on a default constructed object is undefined behavior.

Defaulted.

Member Function Documentation

◆ count()

template<typename index_t >
size_type seqan3::bi_fm_index_cursor< index_t >::count ( ) const
inlinenoexcept

Counts the number of occurrences of the searched query in the text.

Returns
Number of occurrences of the searched query in the text.

Complexity

Constant.

Exceptions

No-throw guarantee.

◆ cycle_back()

template<typename index_t >
bool seqan3::bi_fm_index_cursor< index_t >::cycle_back ( )
inlinenoexcept

Tries to replace the rightmost character of the query by the next lexicographically larger character such that the query is found in the text.

Returns
true if there exists a query in the text where the rightmost character of the query is lexicographically larger than the current rightmost character of the query.

Example:

#include <vector>
int main()
{
using seqan3::operator""_dna4;
seqan3::debug_stream << "Example cycle_back() and cycle_front()\n";
std::vector<seqan3::dna4> genome{"GAATTAATGAAC"_dna4};
seqan3::bi_fm_index index{genome}; // build the bidirectional index
auto cur = index.begin(); // create a cursor
// cur.cycle_back(); // cycle_back / cycle_front on begin() is undefined behaviour!
cur.extend_right("AAC"_dna4); // search the sequence "AAC"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "AAC"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 1
// cur.cycle_front(); // undefined behaviour! only cycle_back() is allowed after extend_right()
cur.cycle_back(); // search the sequence "AAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "AAT"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 3
cur.extend_left('G'_dna4); // search the sequence "GAAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "GAAC"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 2
// cur.cycle_back(); // undefined behaviour! only cycle_front() is allowed after extend_left()
cur.cycle_front(); // search the sequence "TAAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "TAAT"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 3
cur.cycle_front(); // search the sequence "TAAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "TAAT"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 3
}

Complexity

$O(\Sigma) * O(T_{BACKWARD\_SEARCH})$

It scans linearly over the alphabet starting from the rightmost character until it finds the query with a larger rightmost character.

Exceptions

No-throw guarantee.

◆ cycle_front()

template<typename index_t >
bool seqan3::bi_fm_index_cursor< index_t >::cycle_front ( )
inlinenoexcept

Tries to replace the leftmost character of the query by the next lexicographically larger character such that the query is found in the text.

Returns
true if there exists a query in the text where the leftmost character of the query is lexicographically larger than the current leftmost character of the query.

Example:

#include <vector>
int main()
{
using seqan3::operator""_dna4;
seqan3::debug_stream << "Example cycle_back() and cycle_front()\n";
std::vector<seqan3::dna4> genome{"GAATTAATGAAC"_dna4};
seqan3::bi_fm_index index{genome}; // build the bidirectional index
auto cur = index.begin(); // create a cursor
// cur.cycle_back(); // cycle_back / cycle_front on begin() is undefined behaviour!
cur.extend_right("AAC"_dna4); // search the sequence "AAC"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "AAC"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 1
// cur.cycle_front(); // undefined behaviour! only cycle_back() is allowed after extend_right()
cur.cycle_back(); // search the sequence "AAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "AAT"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 3
cur.extend_left('G'_dna4); // search the sequence "GAAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "GAAC"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 2
// cur.cycle_back(); // undefined behaviour! only cycle_front() is allowed after extend_left()
cur.cycle_front(); // search the sequence "TAAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "TAAT"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 3
cur.cycle_front(); // search the sequence "TAAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "TAAT"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 3
}

Complexity

$O(\Sigma) * O(T_{BACKWARD\_SEARCH})$

It scans linearly over the alphabet starting from the leftmost character until it finds the query with a larger leftmost character.

Exceptions

No-throw guarantee.

◆ extend_left() [1/3]

template<typename index_t >
bool seqan3::bi_fm_index_cursor< index_t >::extend_left ( )
inlinenoexcept

Tries to extend the query by the smallest possible character to the left such that the query is found in the text.

Returns
true if the cursor could extend the query successfully.

Complexity

$O(\Sigma) * O(T_{BACKWARD\_SEARCH})$

It scans linearly over the alphabet until it finds the smallest character that is represented by an edge.

Exceptions

No-throw guarantee.

◆ extend_left() [2/3]

template<typename index_t >
template<typename char_t >
bool seqan3::bi_fm_index_cursor< index_t >::extend_left ( char_t const  c)
inlinenoexcept

Tries to extend the query by the character c to the left.

Template Parameters
char_tType of the character needs to be convertible to the character type char_type of the index.
Parameters
[in]cCharacter to extend the query with to the left.
Returns
true if the cursor could extend the query successfully.

Complexity

$O(T_{BACKWARD\_SEARCH})$

Exceptions

No-throw guarantee.

◆ extend_left() [3/3]

template<typename index_t >
template<std::ranges::range seq_t>
bool seqan3::bi_fm_index_cursor< index_t >::extend_left ( seq_t &&  seq)
inlinenoexcept

Tries to extend the query by seq to the left.

Template Parameters
seq_tThe type of range of the sequence to search; must model std::ranges::bidirectional_range.
Parameters
[in]seqSequence to extend the query with to the left (starting from right to left, see example).
Returns
true if the cursor could extend the query successfully.

If extending fails in the middle of the sequence, all previous computations are rewound to restore the cursor's state before calling this method.

Example:

#include <vector>
int main()
{
using seqan3::operator""_dna4;
seqan3::debug_stream << "Example extend_left(seq)\n";
std::vector<seqan3::dna4> genome{"GAATTAATGAAC"_dna4};
seqan3::bi_fm_index index{genome}; // build the bidirectional index
auto cur = index.begin(); // create a cursor
cur.extend_right("AAC"_dna4); // search the sequence "AAC"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "AAC"
cur.extend_left("ATG"_dna4); // extend the query to "ATGAAC"
// The rightmost character of "ATG" is extended to the left first.
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "ATGAAT"
}

Complexity

$|seq| * O(T_{BACKWARD\_SEARCH})$

Exceptions

No-throw guarantee.

◆ extend_right() [1/3]

template<typename index_t >
bool seqan3::bi_fm_index_cursor< index_t >::extend_right ( )
inlinenoexcept

Tries to extend the query by the smallest possible character to the right such that the query is found in the text.

Returns
true if the cursor could extend the query successfully.

Complexity

$O(\Sigma) * O(T_{BACKWARD\_SEARCH})$

It scans linearly over the alphabet until it finds the smallest character that is represented by an edge.

Exceptions

No-throw guarantee.

◆ extend_right() [2/3]

template<typename index_t >
template<typename char_t >
bool seqan3::bi_fm_index_cursor< index_t >::extend_right ( char_t const  c)
inlinenoexcept

Tries to extend the query by the character c to the right.

Template Parameters
char_tType of the character; needs to be convertible to the character type char_type of the index.
Parameters
[in]cCharacter to extend the query with to the right.
Returns
true if the cursor could extend the query successfully.

Complexity

$O(T_{BACKWARD\_SEARCH})$

Exceptions

No-throw guarantee.

◆ extend_right() [3/3]

template<typename index_t >
template<std::ranges::range seq_t>
bool seqan3::bi_fm_index_cursor< index_t >::extend_right ( seq_t &&  seq)
inlinenoexcept

Tries to extend the query by seq to the right.

Template Parameters
seq_tThe type of range of the sequence to search; must model std::ranges::forward_range.
Parameters
[in]seqSequence to extend the query with to the right.
Returns
true if the cursor could extend the query successfully.

If extending fails in the middle of the sequence, all previous computations are rewound to restore the cursor's state before calling this method.

Complexity

$|seq| * O(T_{BACKWARD\_SEARCH})$

Exceptions

No-throw guarantee.

◆ last_rank()

template<typename index_t >
size_type seqan3::bi_fm_index_cursor< index_t >::last_rank ( )
inlinenoexcept

Outputs the rightmost respectively leftmost rank depending on whether extend_right() or extend_left() has been called last.

Returns
Rightmost or leftmost rank.

Example:

#include <vector>
int main()
{
using seqan3::operator""_dna4;
seqan3::debug_stream << "Example cycle_back() and cycle_front()\n";
std::vector<seqan3::dna4> genome{"GAATTAATGAAC"_dna4};
seqan3::bi_fm_index index{genome}; // build the bidirectional index
auto cur = index.begin(); // create a cursor
// cur.cycle_back(); // cycle_back / cycle_front on begin() is undefined behaviour!
cur.extend_right("AAC"_dna4); // search the sequence "AAC"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "AAC"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 1
// cur.cycle_front(); // undefined behaviour! only cycle_back() is allowed after extend_right()
cur.cycle_back(); // search the sequence "AAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "AAT"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 3
cur.extend_left('G'_dna4); // search the sequence "GAAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "GAAC"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 2
// cur.cycle_back(); // undefined behaviour! only cycle_front() is allowed after extend_left()
cur.cycle_front(); // search the sequence "TAAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "TAAT"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 3
cur.cycle_front(); // search the sequence "TAAT"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "TAAT"
seqan3::debug_stream << cur.last_rank() << '\n'; // outputs 3
}

Complexity

Constant.

Exceptions

No-throw guarantee.

◆ lazy_locate() [1/2]

template<typename index_t >
auto seqan3::bi_fm_index_cursor< index_t >::lazy_locate ( ) const
inline

Locates the occurrences of the searched query in the text on demand, i.e. a ranges::view is returned and every position is located once it is accessed.

Returns
Positions in the text.

Complexity

$count() * O(T_{BACKWARD\_SEARCH} * SAMPLING\_RATE)$

Exceptions

Strong exception guarantee (no data is modified in case an exception is thrown).

◆ lazy_locate() [2/2]

template<typename index_t >
auto seqan3::bi_fm_index_cursor< index_t >::lazy_locate ( ) const
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ locate() [1/2]

template<typename index_t >
std::vector<size_type> seqan3::bi_fm_index_cursor< index_t >::locate ( ) const
inline

Locates the occurrences of the searched query in the text.

Returns
Positions in the text.

Complexity

$count() * O(T_{BACKWARD\_SEARCH} * SAMPLING\_RATE)$

Exceptions

Strong exception guarantee (no data is modified in case an exception is thrown).

◆ locate() [2/2]

template<typename index_t >
std::vector<std::pair<size_type, size_type> > seqan3::bi_fm_index_cursor< index_t >::locate ( ) const
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ operator!=()

template<typename index_t >
bool seqan3::bi_fm_index_cursor< index_t >::operator!= ( bi_fm_index_cursor< index_t > const &  rhs) const
inlinenoexcept

Compares two cursors.

Parameters
[in]rhsOther cursor to compare it to.
Returns
true if the cursors are not equal, false otherwise.

Complexity

Constant.

Exceptions

No-throw guarantee.

◆ operator==()

template<typename index_t >
bool seqan3::bi_fm_index_cursor< index_t >::operator== ( bi_fm_index_cursor< index_t > const &  rhs) const
inlinenoexcept

Compares two cursors.

Parameters
[in]rhsOther cursor to compare it to.
Returns
true if both cursors are equal, false otherwise.

Complexity

Constant.

Exceptions

No-throw guarantee.

◆ path_label() [1/2]

template<typename index_t >
template<std::ranges::range text_t>
auto seqan3::bi_fm_index_cursor< index_t >::path_label ( text_t &&  text) const
inlinenoexcept

Returns the searched query.

Template Parameters
text_tThe type of the text used to build the index; must model std::ranges::input_range.
Parameters
[in]textText that was used to build the index.

Complexity

$O(SAMPLING\_RATE * T_{BACKWARD\_SEARCH}) + query\_length()$

Exceptions

No-throw guarantee.

◆ path_label() [2/2]

template<typename index_t >
template<std::ranges::range text_t>
auto seqan3::bi_fm_index_cursor< index_t >::path_label ( text_t &&  text) const
inlinenoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ query_length()

template<typename index_t >
size_type seqan3::bi_fm_index_cursor< index_t >::query_length ( ) const
inlinenoexcept

Returns the depth of the cursor node in the implicit suffix tree, i.e. the length of the sequence searched.

Returns
Length of searched sequence.

Complexity

Constant.

Exceptions

No-throw guarantee.

◆ to_fwd_cursor()

template<typename index_t >
fwd_cursor seqan3::bi_fm_index_cursor< index_t >::to_fwd_cursor ( ) const
inlinenoexcept

Returns a unidirectional seqan3::fm_index_cursor on the original text. path_label() on the returned unidirectional index cursor will be equal to path_label() on the bidirectional index cursor. cycle_back() and last_char() will be undefined behavior if the last extension on the bidirectional FM index has been to the left. The behavior will be well-defined after the first extension to the right on the unidirectional index.

Returns
Returns a unidirectional seqan3::fm_index_cursor on the index of the original text.

Example:

#include <vector>
int main()
{
using seqan3::operator""_dna4;
seqan3::debug_stream << "Example to_fwd_cursor()\n";
std::vector<seqan3::dna4> genome{"GAATTAACGAAC"_dna4};
seqan3::bi_fm_index index{genome}; // build the bidirectional index
auto cur = index.begin(); // create a cursor
cur.extend_left("AAC"_dna4); // search the sequence "AAC"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "AAC"
auto uni_it = cur.to_fwd_cursor(); // unidirectional cursor on the text "GAATTAACGAAC"
seqan3::debug_stream << uni_it.path_label(genome) << '\n'; // outputs "CAA"
// Undefined behaviour! Cannot be called on the forward cursor if the last extension on the bidirectional
// cursor was to the left:
// cur.cycle_back();
// seqan3::debug_stream << cur.last_rank() << '\n';
uni_it.extend_right('G'_dna4); // search the sequence "AACG"
seqan3::debug_stream << uni_it.path_label(genome) << '\n'; // outputs "AACG"
seqan3::debug_stream << uni_it.last_rank() << '\n'; // outputs 2
uni_it.cycle_back(); // returns false since there is no sequence "AACT" in the text.
}

Complexity

Constant.

Exceptions

No-throw guarantee.

◆ to_rev_cursor()

template<typename index_t >
rev_cursor seqan3::bi_fm_index_cursor< index_t >::to_rev_cursor ( ) const
inlinenoexcept

Returns a unidirectional seqan3::fm_index_cursor on the reversed text. path_label() on the returned unidirectional index cursor will be equal to reversing path_label() on the bidirectional index cursor. Note that because of the text being reversed, extend_right() resp. cycle_back() correspond to extend_left() resp. cycle_front() on the bidirectional index cursor. Furthermore cycle_back() and last_char() will be undefined behavior if the last extension on the bidirectional FM index has been to the left. The behavior will be well-defined after the first extension to the right on the unidirectional index.

Returns
Returns a unidirectional seqan3::fm_index_cursor on the index of the reversed text.

Example:

#include <vector>
int main()
{
using seqan3::operator""_dna4;
seqan3::debug_stream << "Example to_rev_cursor()\n";
std::vector<seqan3::dna4> genome{"GAATTAACGAAC"_dna4};
seqan3::bi_fm_index index{genome}; // build the bidirectional index
auto cur = index.begin(); // create a cursor
cur.extend_right("AAC"_dna4); // search the sequence "AAC"
seqan3::debug_stream << cur.path_label(genome) << '\n'; // outputs "AAC"
auto uni_it = cur.to_rev_cursor(); // unidirectional cursor on the text "CAAGCAATTAAG"
seqan3::debug_stream << uni_it.path_label(genome) << '\n'; // outputs "CAA"
// Undefined behaviour! Cannot be called on the reversed cursor if the last extension on the bidirectional
// cursor was to the right:
// cur.cycle_back();
// seqan3::debug_stream << cur.last_rank() << '\n';
uni_it.extend_right('G'_dna4); // search the sequence "CAAG"
seqan3::debug_stream << uni_it.path_label(genome) << '\n'; // outputs "CAAG"
seqan3::debug_stream << uni_it.last_rank() << '\n'; // outputs 2
uni_it.cycle_back(); // search the sequence "CAAT"
}
Attention
When the index is built for text collections, the returned text IDs will be reversed.
#include <vector>
int main()
{
using seqan3::operator""_dna4;
seqan3::debug_stream << "Example to_rev_cursor() on collections\n";
std::vector<std::vector<seqan3::dna4>> genomes{"GAATTAACGAAC"_dna4, "TTTAACTTATC"_dna4};
seqan3::bi_fm_index index{genomes}; // build the bidirectional index
auto cur = index.begin(); // create a cursor
cur.extend_right("AAC"_dna4); // search the sequence "AAC"
seqan3::debug_stream << cur.locate() << '\n'; // outputs [(0,9),(0,5),(1,3)]
auto uni_it = cur.to_rev_cursor(); // unidirectional cursor on the text "CTATTCAATTT|CAAGCAATTAAG"
seqan3::debug_stream << uni_it.locate() << '\n'; // outputs [(1,4),(0,5),(1,0)] for "CAA"
}

Complexity

Constant.

Exceptions

No-throw guarantee.


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