Namespaces
Variants
Views
Actions

Difference between revisions of "Template:cpp/container/begin"

From cppreference.com
m (Simplify with {{#ifexpr:}})
m (Apply tag {{mark noexcept since c++11}}: cpp/container/vector/begin.)
Line 14: Line 14:
 
}}
 
}}
 
|vector=
 
|vector=
{{dcl rev multi|num=1
+
{{dcl|num=1|notes={{mark noexcept since c++11}}<br>{{mark constexpr since c++20}}|
|until1=c++11|dcl1=
+
 
iterator begin();
 
iterator begin();
|notes2={{mark constexpr since c++20}}|dcl2=
 
iterator begin() noexcept;
 
 
}}
 
}}
{{dcl rev multi|num=2
+
{{dcl|num=2|notes={{mark noexcept since c++11}}<br>{{mark constexpr since c++20}}|
|until1=c++11|dcl1=
+
 
const_iterator begin() const;
 
const_iterator begin() const;
|notes2={{mark constexpr since c++20}}|dcl2=
 
const_iterator begin() const noexcept;
 
 
}}
 
}}
 
{{dcl|num=3|since=c++11|notes={{mark constexpr since c++20}}|
 
{{dcl|num=3|since=c++11|notes={{mark constexpr since c++20}}|

Revision as of 11:06, 15 April 2024

iterator begin() noexcept;
(1) (since {std})
const_iterator begin() const noexcept;
(2) (since {std})
const_iterator cbegin() const noexcept;
(3) (since {std})

Returns an iterator to the first element of the {{{1}}}.

If the {{{1}}} is empty, the returned iterator will be equal to end().

range-begin-end.svg

Contents

Parameters

(none)

Return value

Iterator to the first element.

Complexity

Constant.

Example

#include <algorithm>
#include <iostream>
#include <numeric>
#include <string>
#include <list>
 
int main()
{
    std::list<int> nums{1, 2, 4, 8, 16};
    std::list<std::string> fruits{"orange", "apple", "raspberry"};
    std::list<char> empty;
 
    // Print list.
    std::for_each(nums.begin(), nums.end(), [](const int n) { std::cout << n << ' '; });
    std::cout << '\n';
 
    // Sums all integers in the list nums (if any), printing only the result.
    std::cout << "Sum of nums: "
              << std::accumulate(nums.begin(), nums.end(), 0) << '\n';
 
    // Prints the first fruit in the list fruits, checking if there is any.
    if (!fruits.empty())
        std::cout << "First fruit: " << *fruits.begin() << '\n';
 
    if (empty.begin() == empty.end())
        std::cout << "list 'empty' is indeed empty.\n";
}

Output:

1 2 4 8 16
Sum of nums: 31
First fruit: orange
list 'empty' is indeed empty.

See also

returns an iterator to the end
(public member function of std::{{{1}}}) [edit]
(C++11)(C++14)
returns an iterator to the beginning of a container or array
(function template) [edit]