seqan3::detail::minimiser_hash_fn Struct Reference

seqan3::views::minimiser_hash's range adaptor object type (non-closure). More...

#include <seqan3/search/views/minimiser_hash.hpp>

Public Member Functions
constexpr auto	operator() (shape const &shape, window_size const window_size) const
	Store the shape and the window size and return a range adaptor closure object.
constexpr auto	operator() (shape const &shape, window_size const window_size, seed const seed) const
	Store the shape, the window size and the seed and return a range adaptor closure object.
template<std::ranges::range urng_t>
constexpr auto	operator() (urng_t &&urange, shape const &shape, window_size const window_size, seed const seed=seqan3::seed{0x8F3F73B5CF1C9ADE}) const
	Call the view's constructor with the underlying view, a seqan3::shape and a window size as argument.

Detailed Description

seqan3::views::minimiser_hash's range adaptor object type (non-closure).

Member Function Documentation

operator()() [1/3]

constexpr auto seqan3::detail::minimiser_hash_fn::operator() ( shape const &  shape, window_size const  window_size  ) const

inlineconstexpr

Store the shape and the window size and return a range adaptor closure object.

Parameters

[in]	shape	The seqan3::shape to use for hashing.
[in]	window_size	The windows size to use.

Exceptions

std::invalid_argument

if the size of the shape is greater than the window_size.

Returns

A range of converted elements.

operator()() [2/3]

constexpr auto seqan3::detail::minimiser_hash_fn::operator() ( shape const &  shape, window_size const  window_size, seed const  seed  ) const

inlineconstexpr

Store the shape, the window size and the seed and return a range adaptor closure object.

Parameters

[in]	shape	The seqan3::shape to use for hashing.
[in]	window_size	The size of the window.
[in]	seed	The seed to use.

Exceptions

std::invalid_argument

if the size of the shape is greater than the window_size.

Returns

A range of converted elements.

operator()() [3/3]

template<std::ranges::range urng_t>

constexpr auto seqan3::detail::minimiser_hash_fn::operator() ( urng_t &&  urange, shape const &  shape, window_size const  window_size, seed const  seed = seqan3::seed{0x8F3F73B5CF1C9ADE}  ) const

inlineconstexpr

Call the view's constructor with the underlying view, a seqan3::shape and a window size as argument.

Parameters

[in]	urange	The input range to process. Must model std::ranges::viewable_range and the reference type of the range must model seqan3::semialphabet.
[in]	shape	The seqan3::shape to use for hashing.
[in]	window_size	The size of the window.
[in]	seed	The seed to use.

Exceptions

std::invalid_argument

if the size of the shape is greater than the window_size.

Returns

A range of converted elements.

---

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

• minimiser_hash.hpp