SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
seqan3::bin_index Struct Reference

A strong type that represents the bin index for the seqan3::interleaved_bloom_filter. More...

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

+ Inheritance diagram for seqan3::bin_index:

Additional Inherited Members

- Public Types inherited from seqan3::detail::strong_type< size_t, bin_index, detail::strong_type_skill::convert >
using value_type = size_t
 The underlying value type.
 
- Public Member Functions inherited from seqan3::detail::strong_type< size_t, bin_index, detail::strong_type_skill::convert >
constexpr strong_type () noexcept=default
 Defaulted.
 
constexpr strong_type (strong_type const &) noexcept=default
 Defaulted.
 
constexpr strong_type (strong_type &&) noexcept=default
 Defaulted.
 
constexpr strong_type (size_t _value)
 Construction from underlying value type.
 
constexpr strong_typeoperator= (strong_type const &) noexcept=default
 Defaulted.
 
constexpr strong_typeoperator= (strong_type &&) noexcept=default
 Defaulted.
 
 ~strong_type () noexcept=default
 Defaulted.
 
constexpr size_t & get () &noexcept
 Returns the underlying value.
 
constexpr size_t const & get () const &noexcept
 Returns the underlying value.
 
constexpr size_t && get () &&noexcept
 Returns the underlying value as rvalue.
 
constexpr size_t const && get () const &&noexcept
 Returns the underlying value as rvalue.
 
constexpr bin_index operator+ (strong_type const &other)
 Adds addition operator to the strong type.
 
constexpr bin_index operator- (strong_type const &other)
 Adds subtraction operator to the strong type.
 
constexpr bin_index operator* (strong_type const &other)
 Adds multiplication operator to the strong type.
 
constexpr bin_index operator/ (strong_type const &other)
 Adds division operator to the strong type.
 
constexpr bin_index operator% (strong_type const &other)
 Adds modulo operator to the strong type.
 
constexpr bin_index operator& (strong_type const &other)
 Adds bitwise and operator to the strong type.
 
constexpr bin_index operator| (strong_type const &other)
 Adds bitwise or operator to the strong type.
 
constexpr bin_index operator^ (strong_type const &other)
 Adds bitwise xor operator to the strong type.
 
constexpr bin_index operator~ ()
 Adds bitwise not operator to the strong type.
 
constexpr bin_index operator<< (strong_type const &other)
 Adds bitwise left shift operator to the strong type.
 
constexpr bin_index operator<< (integral_t const shift)
 Adds bitwise left shift operator to the strong type.
 
constexpr bin_index operator>> (strong_type const &other)
 Adds bitwise right shift operator to the strong type.
 
constexpr bin_index operator>> (integral_t const shift)
 Adds bitwise right shift operator to the strong type.
 
constexpr bool operator&& (strong_type const &other)
 Adds logical and operator to the strong type.
 
constexpr bool operator|| (strong_type const &other)
 Adds logical or operator to the strong type.
 
constexpr bool operator! ()
 Adds logical not operator to the strong type.
 
constexpr bin_indexoperator++ ()
 Adds pre-increment operator to the strong type.
 
constexpr bin_index operator++ (int)
 Adds post-increment operator to the strong type.
 
constexpr bin_indexoperator-- ()
 Adds pre-decrement operator to the strong type.
 
constexpr bin_index operator-- (int)
 Adds post-decrement operator to the strong type.
 
constexpr bool operator== (strong_type const &rhs) const
 Return whether this instance is equal to rhs.
 
constexpr bool operator!= (strong_type const &rhs) const
 Return whether this instance is not equal to rhs.
 
constexpr operator size_t () const
 Adds explicit conversion to it's underlying type.
 
- Static Public Attributes inherited from seqan3::detail::strong_type< size_t, bin_index, detail::strong_type_skill::convert >
static constexpr strong_type_skill skills
 The selected skills for this type.
 

Detailed Description

A strong type that represents the bin index for the seqan3::interleaved_bloom_filter.


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