SeqAn3 3.2.0-rc.1
The Modern C++ library for sequence analysis.
persist_view.hpp
Go to the documentation of this file.
1// -----------------------------------------------------------------------------------------------------
2// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin
3// Copyright (c) 2016-2021, Knut Reinert & MPI für molekulare Genetik
4// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
5// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
6// -----------------------------------------------------------------------------------------------------
7
13#pragma once
14
15#include <algorithm>
16#include <concepts>
17#include <seqan3/std/ranges>
18
24
25namespace seqan3::detail
26{
27
28// ============================================================================
29// view_persist
30// ============================================================================
31
43template <std::ranges::input_range urng_t>
44class view_persist : public std::ranges::view_interface<view_persist<urng_t>>
45{
46private:
49
50public:
54 view_persist() noexcept = default;
55 constexpr view_persist(view_persist const & rhs) noexcept = default;
56 constexpr view_persist(view_persist && rhs) noexcept = default;
57 constexpr view_persist & operator=(view_persist const & rhs) noexcept = default;
58 constexpr view_persist & operator=(view_persist && rhs) noexcept = default;
59 ~view_persist() noexcept = default;
60
64 view_persist(urng_t && _urange) : urange{new urng_t{std::move(_urange)}}
65 {}
67
84 auto begin() noexcept
85 {
86 return std::ranges::begin(*urange);
87 }
88
90 auto begin() const noexcept
91 requires const_iterable_range<urng_t>
92 {
93 return std::ranges::cbegin(*urange);
94 }
95
109 auto end() noexcept
110 {
111 return std::ranges::end(*urange);
112 }
113
115 auto end() const noexcept
116 requires const_iterable_range<urng_t>
117 {
118 return std::ranges::cend(*urange);
119 }
121};
122
125template <typename urng_t>
127
128// ============================================================================
129// persist_fn (adaptor definition)
130// ============================================================================
131
133
136class persist_fn : public adaptor_base<persist_fn>
137{
138private:
141
142public:
144 using base_t::base_t;
145
146private:
148 friend base_t;
149
153 template <std::ranges::viewable_range urng_t>
154 static auto impl(urng_t && urange)
155 {
156 return std::views::all(std::forward<urng_t>(urange));
157 }
158
162 template <std::ranges::range urng_t>
163 static auto impl(urng_t && urange)
164 {
165 static_assert(!std::is_lvalue_reference_v<urng_t>, "BUG: lvalue-reference in persist_fn::impl().");
166 return view_persist{std::move(urange)};
167 }
168};
170
171// ============================================================================
172// detail::persist (adaptor instance definition)
173// ============================================================================
174
218inline constexpr auto persist = persist_fn{};
219
220} // namespace seqan3::detail
Provides seqan3::detail::adaptor_base and seqan3::detail::combined_adaptor.
CRTP-base to simplify the definition of range adaptor closure objects and similar types.
Definition: adaptor_base.hpp:77
[adaptor_def]
Definition: persist_view.hpp:137
friend base_t
Befriend the base class so it can call impl().
Definition: persist_view.hpp:148
static auto impl(urng_t &&urange)
For ranges that are viewable, delegate to std::views::all.
Definition: persist_view.hpp:154
The type returned by seqan3::detail::persist.
Definition: persist_view.hpp:45
auto end() noexcept
Returns an iterator to the element following the last element of the range.
Definition: persist_view.hpp:109
view_persist(urng_t &&) -> view_persist< std::remove_reference_t< urng_t > >
Template argument type deduction guide that strips references.
auto end() const noexcept
Returns an iterator to the element following the last element of the range.
Definition: persist_view.hpp:115
auto begin() const noexcept
Returns an iterator to the first element of the container.
Definition: persist_view.hpp:90
std::shared_ptr< urng_t > urange
Shared storage of the underlying range.
Definition: persist_view.hpp:48
auto begin() noexcept
Returns an iterator to the first element of the container.
Definition: persist_view.hpp:84
view_persist() noexcept=default
Defaulted.
Provides various transformation traits used by the range module.
constexpr auto persist
[adaptor_def]
Definition: persist_view.hpp:218
constexpr auto all
Returns a view that includes all elements of the range argument.
Definition: all_view.hpp:204
Specifies requirements of an input range type for which the const version of that type satisfies the ...
Provides various transformation traits for use on iterators.
The internal SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
The <ranges> header from C++20's standard library.
Provides seqan3::detail::transformation_trait_or.
Additional non-standard concepts for ranges.