C++

Reference

<forward_list>

forward_list

public member function
<forward_list>

std::forward_list::end

 iterator end() noexcept;const_iterator end() const noexcept;
Return iterator to end
Returns an iterator referring to the past-the-end element in the forward_list container.

The past-the-end element is the theoretical element that would follow the last element in the forward_list. It does not point to any element, and thus shall not be dereferenced.

Because the ranges used by functions of the standard library do not include the element pointed by their closing iterator, this function is often used in combination with forward_list::begin to specify a range including all the elements in the container.

If the container is empty, this function returns the same as forward_list::begin.

Parameters

none

Return Value

An iterator to the element past the end of the sequence.

If the forward_list object is const-qualified, the function returns a const_iterator. Otherwise, it returns an iterator.

Member types iterator and const_iterator are forward iterator types (pointing to an element and to a const element, respectively).

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
// forward_list::end example #include <iostream> #include <forward_list> int main () { std::forward_list<int> mylist = { 10, 20, 30, 40 }; std::cout << "mylist contains:"; for ( auto it = mylist.begin(); it != mylist.end(); ++it ) std::cout << ' ' << *it; std::cout << '\n'; return 0; }

Output:
mylist contains: 10 20 30 40


Complexity

Constant.

Iterator validity

No changes.

Data races

The container is accessed (neither the const nor the non-const versions modify the container).
No contained elements are accessed by the call, but the iterator returned can be used to access or modify elements. Concurrently accessing or modifying different elements is safe.

Exception safety

No-throw guarantee: this member function never throws exceptions.
The copy construction or assignment of the returned iterator is also guaranteed to never throw.

See also

forward_list::cend
Return const_iterator to end (public member function)
forward_list::begin
Return iterator to beginning (public member type)