seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent::binning_bitvector Class Reference

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

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

Public Member Functions
size_t	size () const noexcept
	Returns the number of elements.
Constructors, destructor and assignment
	binning_bitvector ()=default
	Defaulted.
	binning_bitvector (binning_bitvector const &)=default
	Defaulted.
binning_bitvector &	operator= (binning_bitvector const &)=default
	Defaulted.
	binning_bitvector (binning_bitvector &&)=default
	Defaulted.
binning_bitvector &	operator= (binning_bitvector &&)=default
	Defaulted.
	~binning_bitvector ()=default
	Defaulted.
	binning_bitvector (size_t const size)
	Construct with given size.
Iterators
auto	begin () noexcept
	Returns an iterator to the first element of the container.
auto	begin () const noexcept
	Returns an iterator to the first element of the container. More...
auto	end () noexcept
	Returns an iterator to the element following the last element of the container.
auto	end () const noexcept
	Returns an iterator to the element following the last element of the container. More...
Access
auto	operator[] (size_t const i) noexcept
	Return the i-th element.
auto	operator[] (size_t const i) const noexcept
	Return the i-th element. More...
constexpr data_type &	raw_data () noexcept
	Provides direct, unsafe access to the underlying data structure. More...
constexpr data_type const &	raw_data () const noexcept
	Provides direct, unsafe access to the underlying data structure. More...

Friends
template<std::integral value_t>
class	counting_vector
class	membership_agent
Comparison operators
bool	operator== (binning_bitvector const &lhs, binning_bitvector const &rhs) noexcept
	Test for equality.
bool	operator!= (binning_bitvector const &lhs, binning_bitvector const &rhs) noexcept
	Test for inequality.
SEQAN3_DEPRECATED_310 friend bool	operator== (binning_bitvector const &lhs, sdsl::bit_vector const &rhs) noexcept
	Test for equality. More...
SEQAN3_DEPRECATED_310 friend bool	operator== (sdsl::bit_vector const &lhs, binning_bitvector const &rhs) noexcept
	Test for equality. More...
SEQAN3_DEPRECATED_310 friend bool	operator!= (binning_bitvector const &lhs, sdsl::bit_vector const &rhs) noexcept
	Test for inequality. More...
SEQAN3_DEPRECATED_310 friend bool	operator!= (sdsl::bit_vector const &lhs, binning_bitvector const &rhs) noexcept
	Test for inequality. More...

Detailed Description

template<data_layout data_layout_mode_ = data_layout::uncompressed>
class seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent::binning_bitvector

A bitvector representing the result of a call to bulk_contains of the seqan3::interleaved_bloom_filter.

Member Function Documentation

begin()

template<data_layout data_layout_mode_ = data_layout::uncompressed>

auto seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent::binning_bitvector::begin ( ) const

inlinenoexcept

Returns an iterator to the first element of the container.

end()

template<data_layout data_layout_mode_ = data_layout::uncompressed>

auto seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent::binning_bitvector::end ( ) const

inlinenoexcept

Returns an iterator to the element following the last element of the container.

operator[]()

template<data_layout data_layout_mode_ = data_layout::uncompressed>

auto seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent::binning_bitvector::operator[] ( size_t const  i ) const

inlinenoexcept

Return the i-th element.

raw_data() [1/2]

template<data_layout data_layout_mode_ = data_layout::uncompressed>

constexpr data_type const& seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent::binning_bitvector::raw_data ( ) const

inlineconstexprnoexcept

Provides direct, unsafe access to the underlying data structure.

Returns

A reference to an SDSL bitvector.

This entity is not part of the SeqAn API. Do not rely on it in your applications. The exact representation of the data is implementation defined.

raw_data() [2/2]

template<data_layout data_layout_mode_ = data_layout::uncompressed>

constexpr data_type& seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent::binning_bitvector::raw_data ( )

inlineconstexprnoexcept

Provides direct, unsafe access to the underlying data structure.

Returns

A reference to an SDSL bitvector.

This entity is not part of the SeqAn API. Do not rely on it in your applications. The exact representation of the data is implementation defined.

Friends And Related Function Documentation

operator!= [1/2]

template<data_layout data_layout_mode_ = data_layout::uncompressed>

SEQAN3_DEPRECATED_310 friend bool operator!= ( binning_bitvector const &  lhs, sdsl::bit_vector const &  rhs  )

friend

Test for inequality.

Deprecated:

Use binning_bitvector.raw_data() != rhs

operator!= [2/2]

template<data_layout data_layout_mode_ = data_layout::uncompressed>

SEQAN3_DEPRECATED_310 friend bool operator!= ( sdsl::bit_vector const &  lhs, binning_bitvector const &  rhs  )

friend

Test for inequality.

Deprecated:

Use lhs != binning_bitvector.raw_data()

operator== [1/2]

template<data_layout data_layout_mode_ = data_layout::uncompressed>

SEQAN3_DEPRECATED_310 friend bool operator== ( binning_bitvector const &  lhs, sdsl::bit_vector const &  rhs  )

friend

Test for equality.

Deprecated:

Use binning_bitvector.raw_data() == rhs

operator== [2/2]

template<data_layout data_layout_mode_ = data_layout::uncompressed>

SEQAN3_DEPRECATED_310 friend bool operator== ( sdsl::bit_vector const &  lhs, binning_bitvector const &  rhs  )

friend

Test for equality.

Deprecated:

Use lhs == binning_bitvector.raw_data()

---

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

• seqan3/search/dream_index/interleaved_bloom_filter.hpp