std::begin, std::cbegin

 

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

 

Iterator-Bibliothek

Iterator-Konzepte
indirectly_readable (C++20) indirectly_writable (C++20) weakly_incrementable (C++20) incrementable (C++20) is-integer-like is-signed-integer-like (C++20)(C++20)	sentinel_for (C++20) sized_sentinel_for (C++20) input_iterator (C++20) output_iterator (C++20) input_or_output_iterator (C++20)	forward_iterator (C++20) bidirectional_iterator (C++20) random_access_iterator (C++20) contiguous_iterator (C++20)
Iterator-Primitive
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	iter_value_titer_difference_titer_reference_titer_const_reference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++20)(C++23)(C++20)(C++20)	iterator (veraltet in C++17) iterator_traits incrementable_traits (C++20) indirectly_readable_traits (C++20)
Algorithmus-Konzepte und Hilfsprogramme
Indirekte aufrufbare Konzepte
indirectly_unary_invocableindirectly_regular_unary_invocable (C++20)(C++20)	indirect_unary_predicate (C++20) indirect_binary_predicate (C++20)	indirect_equivalence_relation (C++20) indirect_strict_weak_order (C++20)
Gemeinsame Algorithmus-Anforderungen
indirectly_movable (C++20) indirectly_movable_storable (C++20) indirectly_copyable (C++20)	indirectly_copyable_storable (C++20)   indirectly_swappable (C++20) indirectly_comparable (C++20)	permutable (C++20) mergeable (C++20) sortable (C++20)
Dienstprogramme
indirect_result_t (C++20)	projected (C++20)	projected_value_t (C++26)
Iterator-Adapter
reverse_iterator make_reverse_iterator (C++14) move_iterator (C++11) make_move_iterator (C++11) default_sentinel_tdefault_sentinel (C++20)(C++20) unreachable_sentinel_tunreachable_sentinel (C++20)(C++20)	front_insert_iterator back_insert_iterator inserter insert_iterator front_inserter back_inserter move_sentinel (C++20)	common_iterator (C++20) counted_iterator (C++20) basic_const_iterator (C++23) const_iterator (C++23) const_sentinel (C++23) make_const_iterator (C++23) make_const_sentinel (C++23)
Stream-Iteratoren istream_iterator    ostream_iterator istreambuf_iterator ostreambuf_iterator	Iterator-Anpassungspunkte ranges::iter_move (C++20) ranges::iter_swap (C++20)
Iterator-Operationen advance distance prev (C++11)   next (C++11) ranges::advance (C++20) ranges::distance (C++20) ranges::prev (C++20) ranges::next (C++20)	Bereichszugriff begincbegin (C++11)(C++14) rbegincrbegin (C++14)(C++14)   endcend (C++11)(C++14) rendcrend (C++14)(C++14)   sizessize (C++17)(C++20) empty (C++17) data (C++17)

 

Definiert in der Header-Datei <array>
Definiert in Header <deque>
Definiert in Header <flat_map>
Definiert in Header <flat_set>
Definiert in Header <forward_list>
Definiert in Header <inplace_vector>
Definiert in Header <iterator>
Definiert in Header <list>
Definiert in Header <map>
Definiert in Header <regex>
Definiert in Header <set>
Definiert in Header <span>
Definiert in Header <string>
Definiert in Header <string_view>
Definiert in Header <unordered_map>
Definiert in Header <unordered_set>
Definiert in Header <vector>
template< class C > auto begin( C& c ) -> decltype(c.begin());	(1)	(seit C++11) (constexpr seit C++17)
template< class C > auto begin( const C& c ) -> decltype(c.begin());	(2)	(seit C++11) (constexpr seit C++17)
template< class T, std::size_t N > T* begin( T (&array)[N] );	(3)	(seit C++11) (noexcept seit C++14) (constexpr seit C++14)
template< class C > constexpr auto cbegin( const C& c ) noexcept(/* siehe unten */)     -> decltype(std::begin(c));	(4)	(seit C++14)

Gibt einen Iterator zum Anfang des gegebenen Bereichs zurück.

1,2) Gibt c.begin() zurück, was typischerweise ein Iterator zum Anfang der von c repräsentierten Sequenz ist.

1) Wenn C ein Standard-Container ist, wird ein C::iterator-Objekt zurückgegeben.

2) Wenn C ein Standard-Container ist, wird ein C::const_iterator-Objekt zurückgegeben.

3) Gibt einen Zeiger auf den Anfang von array zurück.

4) Gibt std::begin(c) zurück, wobei c immer als const-qualifiziert behandelt wird.

Wenn C ein Standard-Container ist, wird ein C::const_iterator-Objekt zurückgegeben.

Parameter

c	-	Ein Container oder eine View mit einer begin-Memberfunktion
array	-	Ein Array beliebigen Typs

Rückgabewert

1,2) c.begin()

3) array

4) c.begin()

Ausnahmen

4)

noexcept-Spezifikation:  

noexcept(noexcept(std::begin(c)))

Überladungen

Benutzerdefinierte Überladungen von begin können für Klassen und Aufzählungen bereitgestellt werden, die keine geeignete begin()-Memberfunktion bereitstellen, aber dennoch iterierbar sind. Die folgenden Überladungen werden bereits von der Standardbibliothek bereitgestellt

std::begin(std::initializer_list) (C++11)	Überladungen von std::begin (function template)
std::begin(std::valarray) (C++11)	Überladungen von std::begin (function template)
begin(std::filesystem::directory_iterator)end(std::filesystem::directory_iterator) (C++17)	Unterstützung für range-basierte for-Schleifen (Funktion)
begin(std::filesystem::recursive_directory_iterator)end(std::filesystem::recursive_directory_iterator)	Unterstützung für range-basierte for-Schleifen (Funktion)

Ähnlich wie bei der Verwendung von swap (beschrieben in Swappable) ist die typische Verwendung der begin-Funktion im generischen Kontext äquivalent zu using std::begin; begin(arg);, was sowohl die über ADL ausgewählten Überladungen für benutzerdefinierte Typen als auch die Standardbibliotheks-Funktionstemplates im selben Überladungssatz erscheinen lässt.

template<typename Container, typename Function>
void for_each(Container&& cont, Function f)
{
    using std::begin;
    auto it = begin(cont);
    using std::end;
    auto end_it = end(cont);
    while (it != end_it)
    {
        f(*it);
        ++it;
    }
}

Von der argumentabhängigen Suche gefundene Überladungen von begin können verwendet werden, um das Verhalten von std::ranges::begin, std::ranges::cbegin und anderen Customization-Pointer-Objekten, die von std::ranges::begin abhängen, anzupassen.

(seit C++20)

Anmerkungen

Die Nicht-Array-Überladungen spiegeln das Verhalten von C::begin exakt wider. Ihre Auswirkungen können überraschend sein, wenn die Memberfunktion keine sinnvolle Implementierung hat.

std::cbegin wurde zur Vereinheitlichung von Member- und Nicht-Member-Bereichszugriffen eingeführt. Siehe auch LWG issue 2128.

Wenn C eine Shallow-Const-View ist, kann std::cbegin einen mutierbaren Iterator zurückgeben. Ein solches Verhalten ist für einige Benutzer unerwartet. Siehe auch P2276 und P2278.

Beispiel

Führen Sie diesen Code aus

#include <iostream>
#include <iterator>
#include <vector>
 
int main() 
{
    std::vector<int> v = {3, 1, 4};
    auto vi = std::begin(v);
    std::cout << std::showpos << *vi << '\n'; 
 
    int a[] = {-5, 10, 15};
    auto ai = std::begin(a);
    std::cout << *ai << '\n';
}

Ausgabe

+3
-5

Siehe auch

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