std::experimental::ranges::distance

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Technical specifications

Filesystem library (filesystem TS)

Library fundamentals (library fundamentals TS)

Library fundamentals 2 (library fundamentals 2 TS)

Extensions for parallelism (parallelism TS)

Extensions for parallelism 2 (parallelism TS v2)

Extensions for concurrency (concurrency TS)

Concepts (concepts TS)

Ranges (ranges TS)

Special mathematical functions (special math TR)

 

Ranges

Concepts

General utilities

Iterators

Ranges

Algorithms

 

Iterators library

Iterator concepts
Readable Writable WeaklyIncrementable Incrementable	Iterator Sentinel SizedSentinel	InputIterator ForwardIterator BidirectionalIterator RandomAccessIterator	OutputIterator
Indirect callable concepts
IndirectUnaryInvocableIndirectRegularUnaryInvocable	IndirectUnaryPredicate	IndirectRelation	IndirectStrictWeakOrder
Common algorithm requirements
IndirectlyMovable IndirectlyMovableStorable	IndirectlyCopyable IndirectlyCopyableStorable	IndirectlySwappable IndirectlyComparable	Permutable Mergeable Sortable
Concept utilities
indirect_result_of	projected
Iterator utilities and operations
iter_move iter_swap	advance distance	next prev
Iterator traits
difference_type value_type reference_trvalue_reference_titer_common_reference_t iterator_category	input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tag	ranges::iterator_traits std::iterator_traits<InputIterator>std::iterator_traits<OutputIterator>
Iterator adaptors
reverse_iterator move_iterator move_sentinel	back_insert_iterator front_insert_iterator insert_iterator	common_iterator counted_iterator default_sentinel	danglingsafe_iterator_t unreachable
Stream iterators
istream_iterator	ostream_iterator	istreambuf_iterator	ostreambuf_iterator

 

Defined in header <experimental/ranges/iterator>
namespace {     constexpr /* unspecified */ distance = /* unspecified */; }		(ranges TS) (customization point object)
Call signature
template< Iterator I, Sentinel<I> S > constexpr ranges::difference_type_t<I> distance(I first, S last);	(1)
template< Range R > constexpr ranges::difference_type_t<ranges::iterator_t<R>> distance(R&& r);	(2)
template< SizedRange R > constexpr ranges::difference_type_t<ranges::iterator_t<R>> distance(R&& r);	(3)

Returns the distance between first and last, or between the beginning and the end of the range r.

1) If SizedSentinel<S, I> is satisfied, equivalent to return last - first;. Otherwise, returns the number of increments needed to get from first to last. If [first, last) does not denote a range, then I and S must be the same type and must model SizedSentinel, and [last, first) must denote a range. Otherwise, the behavior is undefined.

2) Equivalent to return ranges::distance(ranges::begin(r), ranges::end(r));

3) Equivalent to return ranges::size(r);

Instantiating overloads (2-3) may be ill-formed if the header <experimental/ranges/range> is not included before the point of instantiation.

Customization point objects

The name ranges::distance denotes a customization point object, which is a function object of a literal Semiregular class type (denoted, for exposition purposes, as DistanceT). All instances of DistanceT are equal. Thus, ranges::distance can be copied freely and its copies can be used interchangeably.

Given a set of types Args..., if std::declval<Args>()... meet the requirements for arguments to ranges::distance above, DistanceT will satisfy ranges::Invocable<const DistanceT, Args...>. Otherwise, no function call operator of DistanceT participates in overload resolution.

In every translation unit in which ranges::distance is defined, it refers to the same instance of the customization point object. (This means that it can be used freely in things like inline functions and function templates without violating the one-definition rule.)

Return value

The distance between first and last, or between the beginning and the end of the range r.

See also

distance	returns the distance between two iterators (function template)
advance	advances an iterator by given distance (function template)
next	increment an iterator (function template)
prev	decrement an iterator (function template)
size	obtains the size of a range whose size can be calculated in constant time (customization point object)