SeqAn3
kmer_hash.hpp
Go to the documentation of this file.
1 // ============================================================================
2 // SeqAn - The Library for Sequence Analysis
3 // ============================================================================
4 //
5 // Copyright (c) 2006-2018, Knut Reinert & Freie Universitaet Berlin
6 // Copyright (c) 2016-2018, Knut Reinert & MPI Molekulare Genetik
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are met:
11 //
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // * Neither the name of Knut Reinert or the FU Berlin nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 // ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
25 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 // OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31 // DAMAGE.
32 //
33 // ============================================================================
34 
40 #pragma once
41 
42 #include <range/v3/view/sliding.hpp>
43 
47 #include <seqan3/std/view/all.hpp>
49 
50 namespace seqan3::detail
51 {
52 // ============================================================================
53 // kmer_hash_fn (adaptor definition)
54 // ============================================================================
55 
57 class kmer_hash_fn : public pipable_adaptor_base<kmer_hash_fn>
58 {
59 private:
61  using base_t = pipable_adaptor_base<kmer_hash_fn>;
62 
64  friend base_t;
65 
72  template <std::ranges::ViewableRange urng_t>
74  requires semi_alphabet_concept<reference_t<urng_t>>
76  static auto impl(urng_t && urange, size_t const k)
77  {
78  return std::forward<urng_t>(urange) | ranges::view::sliding(k) | view::transform(
79  [] (auto const in)
80  {
81  std::hash<decltype(in)> h{};
82  return h(in);
83  });
84  }
85 
86 public:
88  using base_t::base_t;
89 };
90 
91 } // namespace seqan3::detail
92 
93 namespace seqan3::view
94 {
132  inline auto constexpr kmer_hash = detail::kmer_hash_fn{};
133 } // namespace seqan3::view
constexpr auto transform
A range adaptor that takes a invocable and returns a view of the elements with the invocable applied...
Definition: transform.hpp:95
auto constexpr kmer_hash
A view that calls std::hash on each substring of length k in the input range.
Definition: kmer_hash.hpp:132
Auxiliary header for the view submodule .
The SeqAn3 namespace for views.
Definition: aligned_sequence_concept.hpp:288
Provides seqan3::view::transform.
Core alphabet concept and free function/metafunction wrappers.
Provides various metafunctions used by the range module.
Meta-include for standard library views.