Namespaces
Variants
Views
Actions

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

From cppreference.com
m (Exceptions: Make the condition easier to read.)
m (Exceptions: fmt)
Line 51: Line 51:
  
 
===Exceptions===
 
===Exceptions===
{{lc|std::out_of_range}} if {{c|pos >= size()}}.
+
{{lc|std::out_of_range}} if {{c|1=pos >= size()}}.
  
 
===Complexity===
 
===Complexity===

Revision as of 06:38, 1 October 2023

reference       at( size_type pos );
(1) (since {std})
const_reference at( size_type pos ) const;
(2) (since {std})

Returns a reference to the element at specified location pos, with bounds checking.

If pos is not within the range of the container, an exception of type std::out_of_range is thrown.

Contents

Parameters

pos - position of the element to return

Return value

Reference to the requested element.

Exceptions

std::out_of_range if pos >= size().

Complexity

Constant.

Example

#include <iostream>
#include <>
#include <stdexcept>
 
[[gnu::noinline]] unsigned int runtime_six() // Emulate runtime input
{
    return 6u;
}
 
int main()
{
    std::<int> data = {1, 2, 4, 5, 5, 6};
 
    // Set element 1
    data.at(1) = 88;
 
    // Read element 2
    std::cout << "Element at index 2 has value " << data.at(2) << '\n';
 
    std::cout << "data size = " << data.size() << '\n';
 
    try
    {
        // Set element 6, where the index is determined at runtime
        data.at(runtime_six()) = 666;
    }
    catch (std::out_of_range const& exc)
    {
        std::cout << exc.what() << '\n';
    }
 
    // Print final values
    std::cout << "data:";
    for (int elem : data)
        std::cout << ' ' << elem;
    std::cout << '\n';
}

Possible output:

Element at index 2 has value 4
data size = 6
std::out_of_range: pos >= size()
data: 1 88 4 5 5 6

See also

access specified element
(public member function of std::{{{1}}}) [edit]