public member function
<list>

std::list::front

      reference front();
const_reference front() const;
Access first element
Returns a reference to the first element in the list container.

Unlike member list::begin, which returns an iterator to this same element, this function returns a direct reference.

Calling this function on an empty container causes undefined behavior.

Parameters

none

Return value

A reference to the first element in the list container.

If the list object is const-qualified, the function returns a const_reference. Otherwise, it returns a reference.

Member types reference and const_reference are the reference types to the elements of the container (see list member types).

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
// list::front
#include <iostream>
#include <list>

int main ()
{
  std::list<int> mylist;

  mylist.push_back(77);
  mylist.push_back(22);

  // now front equals 77, and back 22

  mylist.front() -= mylist.back();

  std::cout << "mylist.front() is now " << mylist.front() << '\n';

  return 0;
}


Output:
mylist.front() is now 55

Complexity

Constant.

Iterator validity

No changes.

Data races

The container is accessed (neither the const nor the non-const versions modify the container).
The first element is potentially accessed or modified by the caller. Concurrently accessing or modifying other elements is safe.

Exception safety

If the container is not empty, the function never throws exceptions (no-throw guarantee).
Otherwise, it causes undefined behavior.

See also

list::back
Access last element (public member function )
list::begin
Return iterator to beginning (public member function )
list::push_front
Insert element at beginning (public member function )
list::pop_front
Delete first element (public member function )

C++