SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
indexed_sequence_pair_range Interface Reference

A helper concept to check the input of the range based alignment algorithm interface. More...

#include <seqan3/alignment/pairwise/detail/concept.hpp>

Detailed Description

A helper concept to check the input of the range based alignment algorithm interface.

Template Parameters
tThe type to check.

This concept checks if the given type models a std::ranges::forward_range over indexed sequence pairs that are passed to the alignment algorithms. An indexed sequence pair consists of a seqan3::detail::sequence_pair that shall be aligned and an index that is used to identify the aligned sequence pair. The caller can then infer the aligned sequences from the returned seqan3::alignment_result. The layout of this indexed sequence type looks as follows:

  • the first type of the pair must model seqan3::detail::sequence_pair, and
  • the second type of the pair refers to the respective index type, which can be any type but must model std::copy_constructible.

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