The type returned by seqan3::views::kmer_hash. More...
#include <seqan3/search/views/kmer_hash.hpp>
Classes | |
class | basic_iterator |
Iterator for calculating hash values via a given seqan3::shape. More... | |
Public Member Functions | |
auto | size () |
Returns the size of the range, if the underlying range is a std::ranges::sized_range. More... | |
auto | size () const |
Returns the size of the range, if the underlying range is a std::ranges::sized_range. More... | |
Constructors, destructor and assignment | |
kmer_hash_view ()=default | |
Defaulted. | |
kmer_hash_view (kmer_hash_view const &rhs)=default | |
Defaulted. | |
kmer_hash_view (kmer_hash_view &&rhs)=default | |
Defaulted. | |
kmer_hash_view & | operator= (kmer_hash_view const &rhs)=default |
Defaulted. | |
kmer_hash_view & | operator= (kmer_hash_view &&rhs)=default |
Defaulted. | |
~kmer_hash_view ()=default | |
Defaulted. | |
kmer_hash_view (urng_t urange_, shape const &s_) | |
Construct from a view and a given shape. More... | |
template<typename rng_t > | |
kmer_hash_view (rng_t &&urange_, shape const &s_) | |
Construct from a non-view that can be view-wrapped and a given shape. More... | |
Iterators | |
auto | begin () noexcept |
Returns an iterator to the first element of the range. More... | |
auto | begin () const noexcept |
Returns an iterator to the first element of the range. More... | |
auto | end () noexcept |
Returns an iterator to the element following the last element of the range. More... | |
auto | end () const noexcept |
Returns an iterator to the element following the last element of the range. More... | |
Private Attributes | |
shape | shape_ |
The shape to use. | |
urng_t | urange |
The underlying range. | |
The type returned by seqan3::views::kmer_hash.
urng_t | The type of the underlying ranges, must model std::forward_range, the reference type must model seqan3::semialphabet. |
Note that most members of this class are generated by ranges::view_interface which is not yet documented here.
|
inline |
Construct from a view and a given shape.
std::invalid_argument | if hashes resulting from the shape/alphabet combination cannot be represented in uint64_t , i.e. with shape size and alphabet size . |
|
inline |
Construct from a non-view that can be view-wrapped and a given shape.
std::invalid_argument | if hashes resulting from the shape/alphabet combination cannot be represented in uint64_t , i.e. with shape size and alphabet size . |
|
inlinenoexcept |
Returns an iterator to the first element of the range.
Constant.
No-throw guarantee.
|
inlinenoexcept |
Returns an iterator to the first element of the range.
Constant.
No-throw guarantee.
|
inlinenoexcept |
Returns an iterator to the element following the last element of the range.
This element acts as a placeholder; attempting to dereference it results in undefined behaviour.
Constant.
No-throw guarantee.
|
inlinenoexcept |
Returns an iterator to the element following the last element of the range.
This element acts as a placeholder; attempting to dereference it results in undefined behaviour.
Constant.
No-throw guarantee.
|
inline |
Returns the size of the range, if the underlying range is a std::ranges::sized_range.
|
inline |
Returns the size of the range, if the underlying range is a std::ranges::sized_range.