search/fm_index/concept.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <concepts>
#include <type_traits>
 
#include <sdsl/suffix_arrays.hpp>
 
#include <seqan3/core/platform.hpp>
 
namespace seqan3::detail
{
 
// ============================================================================
//  sdsl_index
// ============================================================================
 
template <typename t>
concept sdsl_index = requires (t sdsl_index) {
    typename t::size_type;
 
    { sdsl_index.size() } -> std::same_as<typename t::size_type>;
    { sdsl_index[0] }; // suffix array access
    { sdsl_index.comp2char[0] } -> std::same_as<uint8_t>;
    { sdsl_index.char2comp[0] } -> std::same_as<uint8_t>;
    { sdsl_index.sigma };
    { sdsl_index.C[0] };
 
    requires requires (t sdsl_index,
                       typename t::char_type const c,
                       typename t::size_type const lb,
                       typename t::size_type const rb,
                       sdsl::int_vector<8> const text) {
        { sdsl_index.bwt.rank(lb, c) };
        { sdsl_index.wavelet_tree.lex_count(lb, rb, c) };
        { sdsl::construct_im(sdsl_index, text, 0) };
    };
};
 
} // namespace seqan3::detail
 
namespace seqan3
{
enum text_layout : bool
{
    single,
    collection
};
 
} // namespace seqan3