SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent_type::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_bitvectoroperator= (binning_bitvector const &)=default
 Defaulted.
 
 binning_bitvector (binning_bitvector &&)=default
 Defaulted.
 
binning_bitvectoroperator= (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.
 
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.
 
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.
 
constexpr data_type & raw_data () noexcept
 Provides direct, unsafe access to the underlying data structure.
 
constexpr data_type const & raw_data () const noexcept
 Provides direct, unsafe access to the underlying data structure.
 

Friends

class membership_agent_type
 
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.
 

Detailed Description

template<data_layout data_layout_mode_ = data_layout::uncompressed>
class seqan3::interleaved_bloom_filter< data_layout_mode_ >::membership_agent_type::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_type::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_type::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_type::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_type::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_type::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.


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