|
| 1 | +// SPDX-FileCopyrightText: 2006-2025 Knut Reinert & Freie Universität Berlin |
| 2 | +// SPDX-FileCopyrightText: 2016-2025 Knut Reinert & MPI für molekulare Genetik |
| 3 | +// SPDX-License-Identifier: BSD-3-Clause |
| 4 | + |
| 5 | +/*!\file |
| 6 | + * \author Enrico Seiler <enrico.seiler AT fu-berlin.de> |
| 7 | + * \brief Provides strong types for the (Interleaved) Bloom Filter. |
| 8 | + */ |
| 9 | + |
| 10 | +#pragma once |
| 11 | + |
| 12 | +#include <seqan3/core/detail/strong_type.hpp> |
| 13 | + |
| 14 | +//Todo: When removing search/dream_index/interleaved_bloom_filter.hpp, the contents of this header can be moved |
| 15 | +// into utility/bloom_filter/bloom_filter.hpp |
| 16 | +// Also remove \ingroup search_dream_index when doing this |
| 17 | + |
| 18 | +namespace seqan3 |
| 19 | +{ |
| 20 | + |
| 21 | +//!\brief Determines if the Interleaved Bloom Filter is compressed. |
| 22 | +//!\ingroup search_dream_index |
| 23 | +//!\ingroup utility_bloom_filter |
| 24 | +enum data_layout : bool |
| 25 | +{ |
| 26 | + uncompressed, //!< The Interleaved Bloom Filter is uncompressed. |
| 27 | + compressed //!< The Interleaved Bloom Filter is compressed. |
| 28 | +}; |
| 29 | + |
| 30 | +//!\brief A strong type that represents the number of bins for the seqan3::interleaved_bloom_filter. |
| 31 | +//!\ingroup search_dream_index |
| 32 | +//!\ingroup utility_bloom_filter |
| 33 | +struct bin_count : public detail::strong_type<size_t, bin_count, detail::strong_type_skill::convert> |
| 34 | +{ |
| 35 | + using detail::strong_type<size_t, bin_count, detail::strong_type_skill::convert>::strong_type; |
| 36 | +}; |
| 37 | + |
| 38 | +//!\brief A strong type that represents the number of bits for each bin in the seqan3::interleaved_bloom_filter. |
| 39 | +//!\ingroup search_dream_index |
| 40 | +//!\ingroup utility_bloom_filter |
| 41 | +struct bin_size : public detail::strong_type<size_t, bin_size, detail::strong_type_skill::convert> |
| 42 | +{ |
| 43 | + using detail::strong_type<size_t, bin_size, detail::strong_type_skill::convert>::strong_type; |
| 44 | +}; |
| 45 | + |
| 46 | +//!\brief A strong type that represents the number of hash functions for the seqan3::interleaved_bloom_filter. |
| 47 | +//!\ingroup search_dream_index |
| 48 | +//!\ingroup utility_bloom_filter |
| 49 | +struct hash_function_count : public detail::strong_type<size_t, hash_function_count, detail::strong_type_skill::convert> |
| 50 | +{ |
| 51 | + using detail::strong_type<size_t, hash_function_count, detail::strong_type_skill::convert>::strong_type; |
| 52 | +}; |
| 53 | + |
| 54 | +//!\brief A strong type that represents the bin index for the seqan3::interleaved_bloom_filter. |
| 55 | +//!\ingroup search_dream_index |
| 56 | +//!\ingroup utility_bloom_filter |
| 57 | +struct bin_index : public detail::strong_type<size_t, bin_index, detail::strong_type_skill::convert> |
| 58 | +{ |
| 59 | + using detail::strong_type<size_t, bin_index, detail::strong_type_skill::convert>::strong_type; |
| 60 | +}; |
| 61 | + |
| 62 | +} // namespace seqan3 |
0 commit comments