seqan3::detail::fm_index_validator Struct Reference

Class used to validate the requirements on the input text of the fm_index. More...

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

Static Public Member Functions
template<semialphabet alphabet_t, text_layout text_layout_mode_, std::ranges::range text_t>
static void	validate (text_t &&text)
	Validates the fm_index template parameters and text.

Detailed Description

Class used to validate the requirements on the input text of the fm_index.

Member Function Documentation

validate()

template<semialphabet alphabet_t, text_layout text_layout_mode_, std::ranges::range text_t>

static void seqan3::detail::fm_index_validator::validate ( text_t &&  text )

inlinestatic

Validates the fm_index template parameters and text.

Template Parameters

alphabet_t	The alphabet type of the fm_index; must model seqan3::semialphabet.
text_layout_mode_	The text layout of the fm_index (single/collection).
text_t	The text type used to construct the fm_index.

Parameters

[in]

text

The text used to construct the fm_index.

Exceptions

std::invalid_argument

if text is empty.

Checks if the given types are compatible and the text is not empty.

---

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

• fm_index.hpp