Range-v3
Range algorithms, views, and actions for the Standard Library
Range

Description

Core range functionality.

Classes

struct  ranges::at_fn
 Checked indexed range access. More...
 
struct  ranges::back_fn
 
struct  ranges::dangling
 
struct  ranges::front_fn
 
struct  ranges::index_fn
 Unchecked indexed range access. More...
 
struct  ranges::range_cardinality< Rng, Void >
 

Typedefs

using ranges::bidirectional_range_tag = ::concepts::tag< bidirectional_range_concept, forward_range_tag >
 
template<typename I , typename S >
using ranges::common_iterator_t = detail::if_then_t< std::is_same< I, S >::value, I, detail::common_iterator_impl_t< I, S > >
 
using ranges::common_range_tag = ::concepts::tag< common_range_concept, range_tag >
 
template<typename T >
using ranges::common_range_tag_of = ::concepts::tag_of< meta::list< common_range_concept, range_concept >, T >
 
using ranges::contiguous_range_tag = ::concepts::tag< contiguous_range_concept, random_access_range_tag >
 
using ranges::forward_range_tag = ::concepts::tag< forward_range_concept, input_range_tag >
 
using ranges::input_range_tag = ::concepts::tag< input_range_concept, range_tag >
 
using ranges::random_access_range_tag = ::concepts::tag< random_access_range_concept, bidirectional_range_tag >
 
template<typename Rng >
using ranges::range_common_iterator_t = common_iterator_t< iterator_t< Rng >, sentinel_t< Rng > >
 
template<typename Rng >
using ranges::range_common_reference_t = iter_common_reference_t< iterator_t< Rng > >
 
template<typename Rng >
using ranges::range_difference_t = iter_difference_t< iterator_t< Rng > >
 
template<typename Rng >
using ranges::range_reference_t = iter_reference_t< iterator_t< Rng > >
 
template<typename Rng >
using ranges::range_rvalue_reference_t = iter_rvalue_reference_t< iterator_t< Rng > >
 
template<typename Rng >
using ranges::range_size_t = decltype(ranges::size(std::declval< Rng & >()))
 
using ranges::range_tag = ::concepts::tag< range_concept >
 
template<typename T >
using ranges::range_tag_of = ::concepts::tag_of< meta::list< contiguous_range_concept, random_access_range_concept, bidirectional_range_concept, forward_range_concept, input_range_concept, range_concept >, T >
 
template<typename Rng >
using ranges::range_value_t = iter_value_t< iterator_t< Rng > >
 
using ranges::sized_range_tag = ::concepts::tag< sized_range_concept, range_tag >
 
template<typename T >
using ranges::sized_range_tag_of = ::concepts::tag_of< meta::list< sized_range_concept, range_concept >, T >
 

Functions

 ranges::CPP_PP_CAT (CPP_PP_DEF_, template(typename C)) META_CONCEPT CPP_PP_CAT(CPP_PP_DEF_
 
 ranges::CPP_PP_CAT (CPP_PP_DEF_, template(typename C, typename I)) META_CONCEPT CPP_PP_CAT(CPP_PP_DEF_
 
 ranges::CPP_PP_CAT (CPP_PP_DEF_, template(typename Rng, typename I, typename S)) META_CONCEPT CPP_PP_CAT(CPP_PP_DEF_
 
 ranges::CPP_PP_CAT (CPP_PP_DEF_, template(typename T)) META_CONCEPT CPP_PP_CAT(CPP_PP_DEF_
 Range concepts below. More...
 
 ranges::CPP_PP_CAT (CPP_PP_DEF_, template(typename T, typename V)) META_CONCEPT CPP_PP_CAT(CPP_PP_DEF_
 
template<template< typename... > class ContT>
auto ranges::to () -> detail::to_container_fn< detail::from_range< ContT >>
 For initializing a container of the specified type with the elements of an Range. More...
 
template<template< typename... > class ContT, typename Rng >
auto ranges::to (Rng &&rng) -> ContT< range_value_t< Rng >> requires range< Rng > &&detail::convertible_to_container< Rng, ContT< range_value_t< Rng >>>
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 

Variables

constexpr at_fn ranges::at {}
 Checked indexed range access. More...
 
constexpr back_fn ranges::back {}
 
constexpr _begin_::fn ranges::begin {}
 
concept ranges::bidirectional_range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( forward_range<T> && bidirectional_range_<T> )( forward_range<T> && bidirectional_range_<T> )
 
constexpr _cbegin_::fn ranges::cbegin {}
 
constexpr _cdata_::fn ranges::cdata {}
 
constexpr _cend_::fn ranges::cend {}
 
concept ranges::common_range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( range<T> && common_range_<T> )( range<T> && common_range_<T> )
 
concept ranges::container = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( semi_container<T> && constructible_from< uncvref_t<T> )( semi_container<T> && constructible_from< uncvref_t<T>, detail::movable_input_iterator<range_value_t<T>>, detail::movable_input_iterator<range_value_t<T>>> )
 
concept ranges::contiguous_range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( random_access_range<T> && contiguous_range_<T> )( random_access_range<T> && contiguous_range_<T> )
 
constexpr _crbegin_::fn ranges::crbegin {}
 
constexpr _crend_::fn ranges::crend {}
 
constexpr _empty_::fn ranges::empty {}
 
template<typename T >
constexpr bool ranges::enable_view
 
constexpr _end_::fn ranges::end {}
 
concept ranges::erasable_range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( requires (Rng &&rng, I first, S last) ( ranges::erase(static_cast<Rng &&>(rng), first, last) ) && range<Rng> )( requires (Rng &&rng, I first, S last) ( ranges::erase(static_cast<Rng &&>(rng), first, last) ) && range<Rng> )
 
concept ranges::forward_range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( input_range<T> && forward_range_<T> )( input_range<T> && forward_range_<T> )
 
constexpr front_fn ranges::front {}
 
constexpr index_fn ranges::index {}
 Unchecked indexed range access. More...
 
concept ranges::input_range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( range<T> && input_range_<T> )( range<T> && input_range_<T> )
 
concept ranges::lvalue_container_like = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( implicitly_convertible_to<detail::is_lvalue_container_like_t<T> )( implicitly_convertible_to<detail::is_lvalue_container_like_t<T>, std::true_type> && forward_range<T> )
 
concept ranges::output_range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( range<T> && output_iterator<iterator_t<T> )( range<T> && output_iterator<iterator_t<T>, V> )
 
concept ranges::random_access_range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( bidirectional_range<T> && random_access_range_<T> )( bidirectional_range<T> && random_access_range_<T> )
 
concept ranges::random_access_reservable = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( reservable<C> && random_access_range<C> )( reservable<C> && random_access_range<C> )
 
concept ranges::range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( range_impl_<T &> )( range_impl_<T &> )
 
constexpr _rbegin_::fn ranges::rbegin {}
 
constexpr _rend_::fn ranges::rend {}
 
concept ranges::reservable = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( requires (C &c, C const &cc, range_size_t<C> s) ( c.reserve(s), cc.capacity(), cc.max_size(), concepts::requires_<same_as<decltype(cc.capacity()), range_size_t<C>>>, concepts::requires_<same_as<decltype(cc.max_size()), range_size_t<C>>> ) && container<C> && sized_range<C> )( requires (C &c, C const &cc, range_size_t<C> s) ( c.reserve(s), cc.capacity(), cc.max_size(), concepts::requires_<same_as<decltype(cc.capacity()), range_size_t<C>>>, concepts::requires_<same_as<decltype(cc.max_size()), range_size_t<C>>> ) && container<C> && sized_range<C> )
 
concept ranges::reservable_with_assign = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( requires (C &c, I i) ( c.assign(i, i) ) && reservable<C> && input_iterator<I> )( requires (C &c, I i) ( c.assign(i, i) ) && reservable<C> && input_iterator<I> )
 
concept ranges::semi_container = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( forward_range<T> && default_constructible<uncvref_t<T>> && movable<uncvref_t<T>> && !view_<T> )( forward_range<T> && default_constructible<uncvref_t<T>> && movable<uncvref_t<T>> && !view_<T> )
 
constexpr _size_::fn ranges::size {}
 
concept ranges::sized_range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( requires (T &t) ( ranges::size(t) ) && range<T> && detail::integer_like_<range_size_t<T>> && !disable_sized_range<uncvref_t<T>> )( requires (T &t) ( ranges::size(t) ) && range<T> && detail::integer_like_<range_size_t<T>> && !disable_sized_range<uncvref_t<T>> )
 
constexpr detail::to_container_fn< detail::from_range< std::vector > > ranges::to_vector {}
 
concept ranges::view_ = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( range<T> && semiregular<T> && enable_view<T> )( range<T> && semiregular<T> && enable_view<T> )
 
concept ranges::viewable_range = CPP_PP_CAT( CPP_PP_DEF_IMPL_IS_PAREN_, 0 )( range<T> && (forwarding_range_<T> || view_<detail::decay_t<T>>) )( range<T> && (forwarding_range_<T> || view_<detail::decay_t<T>>) )
 

Function Documentation

◆ CPP_PP_CAT()

ranges::CPP_PP_CAT ( CPP_PP_DEF_  ,
template(typename T)   
)

#include <range/v3/action/concepts.hpp>

Range concepts below.

View concepts below.

◆ to()

template<template< typename... > class ContT>
auto ranges::to ( ) -> detail::to_container_fn<detail::from_range<ContT>>

#include <range/v3/range/conversion.hpp>

For initializing a container of the specified type with the elements of an Range.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Variable Documentation

◆ at

constexpr at_fn ranges::at {}
constexpr

#include <range/v3/range/operations.hpp>

Checked indexed range access.

See also
at_fn

◆ back

constexpr back_fn ranges::back {}
constexpr

◆ begin

constexpr _begin_::fn ranges::begin {}
constexpr

#include <range/v3/range/access.hpp>

Parameters
r
Returns
r, if r is an array. Otherwise, r.begin() if that expression is well-formed and returns an input_or_output_iterator. Otherwise, begin(r) if that expression returns an input_or_output_iterator.

◆ cbegin

constexpr _cbegin_::fn ranges::cbegin {}
constexpr

#include <range/v3/range/access.hpp>

Parameters
r
Returns
The result of calling ranges::begin with a const-qualified reference to r.

◆ cdata

constexpr _cdata_::fn ranges::cdata {}
constexpr

#include <range/v3/range/primitives.hpp>

Parameters
r
Returns
The result of calling ranges::data with a const-qualified (lvalue or rvalue) reference to r.

◆ cend

constexpr _cend_::fn ranges::cend {}
constexpr

#include <range/v3/range/access.hpp>

Parameters
r
Returns
The result of calling ranges::end with a const-qualified reference to r.

◆ crbegin

constexpr _crbegin_::fn ranges::crbegin {}
constexpr

#include <range/v3/range/access.hpp>

Parameters
r
Returns
The result of calling ranges::rbegin with a const-qualified reference to r.

◆ crend

constexpr _crend_::fn ranges::crend {}
constexpr

#include <range/v3/range/access.hpp>

Parameters
r
Returns
The result of calling ranges::rend with a const-qualified reference to r.

◆ empty

constexpr _empty_::fn ranges::empty {}
constexpr

#include <range/v3/range/primitives.hpp>

Returns
true if and only if range contains no elements.

◆ enable_view

template<typename T >
constexpr bool ranges::enable_view
constexpr

#include <range/v3/range/concepts.hpp>

Initial value:
=
detail::enable_view_impl_(detail::nullptr_<T>(0))

◆ end

constexpr _end_::fn ranges::end {}
constexpr

#include <range/v3/range/access.hpp>

Parameters
r
Returns
r+size(r), if r is an array. Otherwise, r.end() if that expression is well-formed and returns an input_or_output_iterator. Otherwise, end(r) if that expression returns an input_or_output_iterator.

◆ front

constexpr front_fn ranges::front {}
constexpr

◆ index

constexpr index_fn ranges::index {}
constexpr

#include <range/v3/range/operations.hpp>

Unchecked indexed range access.

See also
index_fn

◆ rbegin

constexpr _rbegin_::fn ranges::rbegin {}
constexpr

#include <range/v3/range/access.hpp>

Parameters
r
Returns
make_reverse_iterator(r+size(r)) if r is an array. Otherwise, r.rbegin() if that expression is well-formed and returns an input_or_output_iterator. Otherwise, make_reverse_iterator(ranges::end(r)) if ranges::begin(r) and ranges::end(r) are both well-formed and have the same type that satisfies bidirectional_iterator.

◆ rend

constexpr _rend_::fn ranges::rend {}
constexpr

#include <range/v3/range/access.hpp>

Parameters
r
Returns
make_reverse_iterator(r)) if r is an array. Otherwise, r.rend() if that expression is well-formed and returns a type that satisfies sentinel_for<S, I> where I is the type of ranges::rbegin(r). Otherwise, make_reverse_iterator(ranges::begin(r)) if ranges::begin(r) and ranges::end(r) are both well-formed and have the same type that satisfies bidirectional_iterator.

◆ size

constexpr _size_::fn ranges::size {}
constexpr

#include <range/v3/range/primitives.hpp>

Returns
For a given expression E of type T, ranges::size(E) is equivalent to:
  • +extent_v<T> if T is an array type.
  • Otherwise, +E.size() if it is a valid expression and its type I models integral and disable_sized_range<std::remove_cvref_t<T>> is false.
  • Otherwise, +size(E) if it is a valid expression and its type I models integral with overload resolution performed in a context that includes the declaration:
    template<class T> void size(T&&) = delete;
    and does not include a declaration of ranges::size, and disable_sized_range<std::remove_cvref_t<T>> is false.
  • Otherwise, static_cast<U>(ranges::end(E) - ranges::begin(E)) where U is std::make_unsigned_t<iter_difference_t<iterator_t<T>>> if iter_difference_t<iterator_t<T>> satisfies integral and iter_difference_t<iterator_t<T>> otherwise; except that E is evaluated once, if it is a valid expression and the types I and S of ranges::begin(E) and ranges::end(E) model sized_sentinel_for<S, I> and forward_iterator<I>.
  • Otherwise, ranges::size(E) is ill-formed.
meta::size
meta::size_t< L::size()> size
An integral constant wrapper that is the size of the meta::list L.
Definition: meta.hpp:1664