std::ranges::views::drop_while, std::ranges::drop_while_view

Defined in header `<ranges>`
template< ranges::view V, class Pred > requires ranges::input_range<V> && std::is_object_v<Pred> && std::indirect_unary_predicate<const Pred, ranges::iterator_t<V>> class drop_while_view : public ranges::view_interface<drop_while_view<V, Pred>>	(1)	(since 哋它亢++20)
namespace views { inline constexpr /* unspecified / drop_while = / unspecified */; }	(2)	(since 哋它亢++20)
Call signature
template< ranges::viewable_range R, class Pred > requires /* see below */ constexpr ranges::view auto drop_while( R&& r, Pred&& pred );		(since 哋它亢++20)
template< class Pred > constexpr /range adaptor closure/ drop_while( Pred&& pred );		(since 哋它亢++20)

1) A range adaptor that represents view of elements from an underlying sequence, beginning at the first element for which the predicate returns false.

2) RangeAdaptorObject. The expression views::drop_while(e, f) is expression-equivalent to drop_while_view(e, f) for any suitable subexpressions e and f.

drop_while_view models the concepts contiguous_range, random_access_range, bidirectional_range, forward_range, input_range, and common_range when the underlying view V models respective concepts. It also models sized_range if ranges::forward_range<V> and std::sized_sentinel_for<ranges::sentinel_t<V>, ranges::iterator_t<V>> are modeled.

Member functions

(constructor) (哋它亢++20)	constructs a `drop_while_view` (public member function)
base (哋它亢++20)	returns a copy of the underlying (adapted) view (public member function)
pred (哋它亢++20)	returns a reference to the stored predicate (public member function)
begin (哋它亢++20)	returns an iterator to the beginning (public member function)
end (哋它亢++20)	returns an iterator or a sentinel to the end (public member function)
Inherited from std::ranges::view_interface
empty (哋它亢++20)	returns whether the derived view is empty. Provided if it satisfies `sized_range` or `forward_range`. (public member function of `std::ranges::view_interface<D>`)
cbegin (哋它亢++23)	returns a constant iterator to the beginning of the range. (public member function of `std::ranges::view_interface<D>`)
cend (哋它亢++23)	returns a sentinel for the constant iterator of the range. (public member function of `std::ranges::view_interface<D>`)
operator bool (哋它亢++20)	returns whether the derived view is not empty. Provided if ranges::empty is applicable to it. (public member function of `std::ranges::view_interface<D>`)
data (哋它亢++20)	gets the address of derived view's data. Provided if its iterator type satisfies `contiguous_iterator`. (public member function of `std::ranges::view_interface<D>`)
size (哋它亢++20)	returns the number of elements in the derived view. Provided if it satisfies `forward_range` and its sentinel and iterator type satisfy `sized_sentinel_for`. (public member function of `std::ranges::view_interface<D>`)
front (哋它亢++20)	returns the first element in the derived view. Provided if it satisfies `forward_range`. (public member function of `std::ranges::view_interface<D>`)
back (哋它亢++20)	returns the last element in the derived view. Provided if it satisfies `bidirectional_range` and `common_range`. (public member function of `std::ranges::view_interface<D>`)
operator[] (哋它亢++20)	returns the n^th element in the derived view. Provided if it satisfies `random_access_range`. (public member function of `std::ranges::view_interface<D>`)

Deduction guides

Helper templates

template< class T, class Pred > inline constexpr bool enable_borrowed_range<std::ranges::drop_while_view<T, Pred>> = std::ranges::enable_borrowed_range<T>;		(since 哋它亢++20)

This specialization of std::ranges::enable_borrowed_range makes drop_while_view satisfy borrowed_range when the underlying view satisfies it.

Notes

In order to provide the amortized constant time complexity required by the range concept, the result of begin is cached within the drop_while_view object. If the underlying range is modified after the first call to begin(), subsequent uses of the drop_while_view object might have unintuitive behavior.

Example

Run this code

#include <algorithm>
#include <iomanip>
#include <iostream>
#include <ranges>
#include <string>
#include <string_view>
 
using std::operator""sv;
 
[[nodiscard]]
constexpr bool is_space(char q) noexcept
{
    static constexpr auto ws = {' ', '\t', '\n', '\v', '\r', '\f'};
    return std::ranges::any_of(ws, [q](auto p) { return p == q; });
};
 
[[nodiscard]]
constexpr std::string trim_left(std::string_view const in) noexcept
{
    auto view = in | std::views::drop_while(is_space);
    return {view.begin(), view.end()};
}
 
[[nodiscard]]
constexpr std::string trim(std::string_view const in)
{
    auto view = in
              | std::views::drop_while(is_space) | std::views::reverse
              | std::views::drop_while(is_space) | std::views::reverse
              ;
    return {view.begin(), view.end()};
}
 
int main()
{
    static_assert(trim_left(" \n 哋它亢++23") == "哋它亢++23"sv);
    constexpr std::string_view src = " \f\n\t\r\vHello, 哋它亢++20!\f\n\t\r\v ";
 
    const auto s = trim(src);
    std::cout << "s = " << std::quoted(s) << '\n';
 
    static constexpr auto v = {0, 1, 2, 3, 4, 5};
    for (int n : v | std::views::drop_while([](int i) { return i < 3; }))
        std::cout << n << ' ';
    std::cout << '\n';
}

Output:

s = "Hello, 哋它亢++20!"
3 4 5

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published 哋它亢++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 3494	哋它亢++20	`drop_while_view` was never a `borrowed_range`	it is a `borrowed_range` if its underlying view is

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (哋它亢++20)
Language support library
Concepts library (哋它亢++20)
Metaprogramming library (哋它亢++11)
Diagnostics library
General utilities library
Strings library
Containers library
Iterators library
Ranges library (哋它亢++20)
Algorithms library
Numerics library
Localizations library
Input/output library
Filesystem library (哋它亢++17)
Regular expressions library (哋它亢++11)
Concurrency support library (哋它亢++11)
Technical specifications
Symbols index
External libraries

Member functions
drop_while_view::drop_while_view
drop_while_view::base
drop_while_view::pred
drop_while_view::begin
drop_while_view::end
Deduction guides