C++

Reference

<array>

array

public member function
<array>

std::array::end

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

The past-the-end element is the theoretical element that would follow the last element in the array. 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 array::begin to specify a range including all the elements in the container.

In zero-sized arrays, this function returns the same as array::begin.

Parameters

none

Return Value

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

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

Member types iterator and const_iterator are random access 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
 
// array::end example
#include <iostream>
#include <array>

int main ()
{
  std::array<int,5> myarray = { 5, 19, 77, 34, 99 };

  std::cout << "myarray contains:";
  for ( auto it = myarray.begin(); it != myarray.end(); ++it )
    std::cout << ' ' << *it;

  std::cout << '\n';

  return 0;
}

Output:
myarray contains: 5 19 77 34 99


Complexity

Constant.

Iterator validity

No changes.

Data races

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

array::cend
Return const_iterator to end (public member function)
array::back
Access last element (public member function)
array::begin
Return iterator to beginning (public member function)
array::rbegin
Return reverse iterator to reverse beginning (public member function)
array::rend
Return reverse iterator to reverse end (public member function)