seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent_type Class Reference

Manages membership queries for the seqan3::interleaved_bloom_filter. More...

#include <seqan3/search/dream_index/interleaved_bloom_filter.hpp>

Classes
class	binning_bitvector
	A bitvector representing the result of a call to bulk_contains of the seqan3::interleaved_bloom_filter. More...

Public Member Functions
Lookup
binning_bitvector const &	bulk_contains (size_t const value) &noexcept
	Determines set membership of a given value.
binning_bitvector const &	bulk_contains (size_t const value) &&noexcept=delete
	Determines set membership of a given value.

Public Attributes
binning_bitvector	result_buffer
	Stores the result of bulk_contains().

Constructors, destructor and assignment
	membership_agent_type ()=default
	Defaulted.
	membership_agent_type (membership_agent_type const &)=default
	Defaulted.
membership_agent_type &	operator= (membership_agent_type const &)=default
	Defaulted.
	membership_agent_type (membership_agent_type &&)=default
	Defaulted.
membership_agent_type &	operator= (membership_agent_type &&)=default
	Defaulted.
	~membership_agent_type ()=default
	Defaulted.

Detailed Description

template<data_layout data_layout_mode_ = data_layout::uncompressed>
class seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent_type

Manages membership queries for the seqan3::interleaved_bloom_filter.

Attention

Calling seqan3::interleaved_bloom_filter::increase_bin_number_to on ibf invalidates the membership_agent.

Example

// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: CC0-1.0
 
#include <seqan3/search/dream_index/interleaved_bloom_filter.hpp>
 
int main()
{
    // Construct an Interleaved Bloom Filter to be used with the membership_agent.
    seqan3::interleaved_bloom_filter ibf{seqan3::bin_count{43u},
                                         seqan3::bin_size{8192u},
                                         seqan3::hash_function_count{3}};
 
    // The membership_agent can now be constructed by calling `membership_agent` on the Interleaved Bloom Filter.
    auto agent = ibf.membership_agent();
 
    // Calling `increase_bin_number_to` invalidates the agent.
    ibf.increase_bin_number_to(seqan3::bin_count{60u});
 
    // So make sure to construct a new membership_agent.
    agent = ibf.membership_agent();
}

Member Function Documentation

bulk_contains() [1/2]

template<data_layout data_layout_mode_ = data_layout::uncompressed>

binning_bitvector const & seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent_type::bulk_contains ( size_t const  value ) &&

deletenoexcept

Determines set membership of a given value.

Parameters

[in]

value

The raw value to process.

Attention

The result of this function must always be bound via reference, e.g. auto &, to prevent copying.

Sequential calls to this function invalidate the previously returned reference.

Example

// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: CC0-1.0
 
#include <seqan3/core/debug_stream.hpp>
#include <seqan3/search/dream_index/interleaved_bloom_filter.hpp>
 
int main()
{
    seqan3::interleaved_bloom_filter ibf{seqan3::bin_count{12u}, seqan3::bin_size{8192u}};
    ibf.emplace(126, seqan3::bin_index{0u});
    ibf.emplace(712, seqan3::bin_index{3u});
    ibf.emplace(237, seqan3::bin_index{9u});
 
    // Query the Interleaved Bloom Filter. Note that there may be false positive results!
    // A `1` at position `i` indicates the (probable) presence of the query in bin `i`.
    // Capture the result by reference to avoid copies.
    auto agent = ibf.membership_agent();
    auto & result = agent.bulk_contains(712);
    seqan3::debug_stream << result << '\n'; // prints [0,0,0,1,0,0,0,0,0,0,0,0]
 
    // Calling `increase_bin_number_to` invalidates the agent.
    ibf.increase_bin_number_to(seqan3::bin_count{60u});
 
    // So make sure to construct a new membership_agent.
    agent = ibf.membership_agent();
}

Thread safety

Concurrent invocations of this function are not thread safe, please create a seqan3::interleaved_bloom_filter::membership_agent_type for each thread.

bulk_contains() [2/2]

template<data_layout data_layout_mode_ = data_layout::uncompressed>

binning_bitvector const & seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent_type::bulk_contains ( size_t const  value ) &

inlinenoexcept

Determines set membership of a given value.

Parameters

[in]

value

The raw value to process.

Attention

The result of this function must always be bound via reference, e.g. auto &, to prevent copying.

Sequential calls to this function invalidate the previously returned reference.

Example

// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: CC0-1.0
 
#include <seqan3/core/debug_stream.hpp>
#include <seqan3/search/dream_index/interleaved_bloom_filter.hpp>
 
int main()
{
    seqan3::interleaved_bloom_filter ibf{seqan3::bin_count{12u}, seqan3::bin_size{8192u}};
    ibf.emplace(126, seqan3::bin_index{0u});
    ibf.emplace(712, seqan3::bin_index{3u});
    ibf.emplace(237, seqan3::bin_index{9u});
 
    // Query the Interleaved Bloom Filter. Note that there may be false positive results!
    // A `1` at position `i` indicates the (probable) presence of the query in bin `i`.
    // Capture the result by reference to avoid copies.
    auto agent = ibf.membership_agent();
    auto & result = agent.bulk_contains(712);
    seqan3::debug_stream << result << '\n'; // prints [0,0,0,1,0,0,0,0,0,0,0,0]
 
    // Calling `increase_bin_number_to` invalidates the agent.
    ibf.increase_bin_number_to(seqan3::bin_count{60u});
 
    // So make sure to construct a new membership_agent.
    agent = ibf.membership_agent();
}

Thread safety

Concurrent invocations of this function are not thread safe, please create a seqan3::interleaved_bloom_filter::membership_agent_type for each thread.

---

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

• interleaved_bloom_filter.hpp