std::ranges::begin

 

C++

Compiler-Unterstützung

Freestanding und gehostet

Sprache

Standardbibliothek

Header der Standardbibliothek

Benannte Anforderungen

Feature-Test-Makros (C++20)

Bibliothek für Sprachunterstützung

Konzepte-Bibliothek (C++20)

Diagnostik-Bibliothek

Speicherverwaltungsbibliothek

Metaprogrammierungsbibliothek (C++11)

Allgemeine Dienstprogramme-Bibliothek

Container-Bibliothek

Iterator-Bibliothek

Ranges-Bibliothek (C++20)

Algorithmen-Bibliothek

Bibliothek für Zeichenketten

Textverarbeitungsbibliothek

Numerik-Bibliothek

Datums- und Zeitbibliothek

Ein-/Ausgabe-Bibliothek

Dateisystembibliothek (C++17)

Unterstützung für nebenläufige Programmierung (C++11)

Ausführungssteuerungsbibliothek (C++26)

Technische Spezifikationen

Symbolverzeichnis

Externe Bibliotheken

 

Bereichsbibliothek

Bereichszugriff begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

Range-Konvertierungen std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

Behandlung von hängenden Iteratoren dangling borrowed_iterator_t borrowed_subrange_t

Range-Primitive
range_size_trange_difference_trange_value_t elements_of (C++23)	iterator_tconst_iterator_tsentinel_tconst_sentinel_t (C++23)(C++23)	range_reference_trange_const_reference_trange_rvalue_reference_trange_common_reference_t (C++23)

Range-Konzepte
range borrowed_range    common_range	sized_range viewable_range    view	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	approximately_sized_range (C++26) constant_range (C++23)

Ansichten
view_interface	subrange

Range-Fabriken
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

Range-Adaptoren
views::all_tviews::all as_rvalue_viewviews::as_rvalue (C++23)(C++23)   filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while common_viewviews::common views::counted to_input_viewviews::to_input (C++26)(C++26)	ref_view drop_viewviews::drop drop_while_viewviews::drop_while lazy_split_viewviews::lazy_split split_viewviews::split join_viewviews::join join_with_viewviews::join_with (C++23)(C++23)   concat_viewviews::concat (C++26)(C++26) cache_latest_viewviews::cache_latest (C++26)(C++26)	owning_view reverse_viewviews::reverse as_const_viewviews::as_const (C++23)(C++23) elements_viewviews::elements keys_viewviews::keys values_viewviews::values enumerate_viewviews::enumerate (C++23)(C++23) zip_viewviews::zip (C++23)(C++23) zip_transform_viewviews::zip_transform (C++23)(C++23)	adjacent_viewviews::adjacent (C++23)(C++23) views::pairwise (C++23) adjacent_transform_viewviews::adjacent_transform (C++23)(C++23) views::pairwise_transform (C++23) chunk_viewviews::chunk (C++23)(C++23) slide_viewviews::slide (C++23)(C++23) chunk_by_viewviews::chunk_by (C++23)(C++23) stride_viewviews::stride (C++23)(C++23) cartesian_product_viewviews::cartesian_product (C++23)(C++23)

Range generators std::generator (C++23)

Range-Adaptor-Closure-Objekte range_adaptor_closure (C++23)

Range-Adaptor-Objekte

Hilfselemente
copyable-box movable-box (bis C++23)  (C++23)	simple-view non-propagating-cache

 

Definiert in der Header-Datei <ranges>
Definiert in Header <iterator>
inline namespace /* nicht spezifiziert */ {     inline constexpr /* unbekannt */ begin = /* unbekannt */; }		(seit C++20) (Customization-Point-Objekt)
Aufruf-Signatur
template< class T >     requires /* siehe unten */ constexpr std::input_or_output_iterator auto begin( T&& t );		(seit C++20)

Gibt einen Iterator zum ersten Element des Arguments zurück.

Wenn das Argument ein lvalue ist oder ranges::enable_borrowed_range<std::remove_cv_t<T>> true ist, dann ist ein Aufruf von ranges::begin ausdrucksäquivalent zu

1. t + 0, wenn t einen Array-Typ hat.
   • Wenn std::remove_all_extents_t<std::remove_reference_t<T>> unvollständig ist, dann ist der Aufruf von ranges::begin ill-formed (fehlerhaft formuliert), keine Diagnose erforderlich.
2. Andernfalls decay-copy(t.begin())(bis C++23)auto(t.begin())(seit C++23), wenn dieser Ausdruck gültig ist und sein Typ std::input_or_output_iterator modelliert.
3. Andernfalls decay-copy(begin(t))(bis C++23)auto(begin(t))(seit C++23), wenn T ein Klassen- oder Enumerationstyp ist, dieser Ausdruck gültig ist und sein Typ std::input_or_output_iterator modelliert, wobei die Bedeutung von begin wie durch argumentabhängige Suche allein etabliert wird.

In allen anderen Fällen ist ein Aufruf von ranges::begin ill-formed, was zu Substitutionsfehler führen kann, wenn der Aufruf im unmittelbaren Kontext einer Template-Instanziierung erscheint.

Customization Point Objects

Der Name ranges::begin bezeichnet ein Customization Point Object, ein konstantes Funktionsobjekt eines literalen semiregular Klassentyps. Zu Ausübungszwecken wird die cv-unqualifizierte Version seines Typs als __begin_fn bezeichnet.

Alle Instanzen von __begin_fn sind gleich. Die Effekte des Aufrufs verschiedener Instanzen des Typs __begin_fn mit denselben Argumenten sind äquivalent, unabhängig davon, ob der Ausdruck, der die Instanz bezeichnet, ein lvalue oder rvalue ist und ob er const-qualifiziert ist oder nicht (eine volatile-qualifizierte Instanz muss jedoch nicht aufrufbar sein). Daher kann ranges::begin frei kopiert und seine Kopien können austauschbar verwendet werden.

Gegeben sei eine Menge von Typen Args.... Wenn std::declval<Args>()... die obigen Anforderungen für Argumente von ranges::begin erfüllt, modelliert __begin_fn

• std::invocable<__begin_fn, Args...>,
• std::invocable<const __begin_fn, Args...>,
• std::invocable<__begin_fn&, Args...>, und
• std::invocable<const __begin_fn&, Args...>.
  

Andernfalls nimmt kein Funktionsaufrufoperator von __begin_fn an der Überladungsauflösung teil.

Anmerkungen

Wenn das Argument ein rvalue ist (d.h. T ist ein Objekttyp) und ranges::enable_borrowed_range<std::remove_cv_t<T>> false ist, ist der Aufruf von ranges::begin ill-formed, was ebenfalls zu einem Substitutionsfehler führt.

Der Rückgabetyp modelliert in allen Fällen std::input_or_output_iterator.

Der C++20-Standard verlangt, dass bei einem zugrunde liegenden begin-Funktionsaufruf, der ein prvalue zurückgibt, der Rückgabewert aus dem materialisierten temporären Objekt move-konstruiert wird. Alle Implementierungen geben den prvalue stattdessen direkt zurück. Die Anforderung wird durch den Post-C++20-Vorschlag P0849R8 korrigiert, um mit den Implementierungen übereinzustimmen.

Beispiel

Führen Sie diesen Code aus

#include <cassert>
#include <ranges>
#include <vector>
 
int main() 
{
    std::vector v{3, 1, 4};
    auto vi = std::ranges::begin(v);
    auto vci = std::ranges::cbegin(v);
    assert(*vi == 3 and *vi == *vci);
    ++vi;
    ++vci; // OK: vci is modifiable object
    *vi = 42; // OK: vi points to mutable element
    // *vci = 13; // Error: vci points to immutable element
 
    int a[]{-5, 10, 15};
    auto ai = std::ranges::begin(a); // works with C-arrays as well
    assert(*ai == -5);
    *ai = 42; // OK
}

Fehlerberichte

Die folgenden Verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.

DR	angewendet auf	Verhalten wie veröffentlicht	Korrigiertes Verhalten
P2602R2	C++20	Es gibt Mechanismen, um bestimmte Nicht-Member begins, die durch ADL gefunden werden, zu verbieten.	solche Mechanismen wurden entfernt.

Siehe auch

ranges::cbegin (C++20)	gibt einen Iterator zum Anfang eines schreibgeschützten Ranges zurück (Customization Point Objekt)
begincbegin (C++11)(C++14)	gibt einen Iterator zum Anfang eines Containers oder Arrays zurück (Funktionsvorlage)