std::get(std::array)

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Containers library

array (C++11)

vector

deque

forward_list (C++11)

list

set

multiset

map

multimap

unordered_set (C++11)

unordered_multiset (C++11)

unordered_map (C++11)

unordered_multimap (C++11)

stack

queue

priority_queue

 

std::array

Member functions

Element access

array::at

array::operator[]

array::front

array::back

array::data

Iterators

array::beginarray::cbegin

array::endarray::cend

array::rbeginarray::crbegin

array::rendarray::crend

Capacity

array::empty

array::size

array::max_size

Modifiers

array::fill

array::swap

Non-member functions

get

swap

Helper classes

tuple_size

tuple_element

 

template< size_t I, class T, size_t N > constexpr T& get( array<T,N>& a );	(1)	(since C++11)
template< size_t I, class T, size_t N > constexpr T&& get( array<T,N>&& a );	(2)	(since C++11)
template< size_t I, class T, size_t N > constexpr const T& get( const array<T,N>& a );	(3)	(since C++11)

Extracts the Ith element element from the array.

I must be an integer value in range [0, N). This is enforced at compile time as opposed to at() or operator[].

Parameters

a

-

array whose contents to extract

Return value

1) Reference to the Ith element of a.

2) Rvalue reference to the Ith element of a, unless the element is of lvalue reference type, in which case lvalue reference is returned.

3) Const reference to the Ith element of a.

Exceptions

noexcept specification:  

noexcept

  

Notes

The overloads are marked as constexpr since C++14.

Example

Run this code

#include <iostream>
#include <array>
 
int main()
{
    std::array<int, 3> arr;
 
    // set values:
    std::get<0>(arr) = 1;
    std::get<1>(arr) = 2;
    std::get<2>(arr) = 3;
 
    // get values:
    std::cout << "(" << std::get<0>(arr) << ", " << std::get<1>(arr)
              << ", " << std::get<2>(arr) << ")\n";
}

Output:

(1, 2, 3)

See also

operator[]	access specified element (public member function)
at	access specified element with bounds checking (public member function)
std::get(std::tuple)	tuple accesses specified element (function template)
std::get(std::pair) (C++11)	accesses an element of a pair (function template)