Заголовочный файл стандартной библиотеки <tuple> (C++11) — cppreference.com

Материал из cppreference.com

Этот заголовок является частью библиотеки общих утилит.

Включает
<compare> (C++20)	Поддержка оператора трёхстороннего сравнения [править]
Классы
tuple (C++11)	реализует контейнер фиксированного размера, который содержит элементы, возможно, разных типов (шаблон класса) [править]
tuple_size (C++11)	получает количество элементов tuple подобного типа (шаблон класса) [править]
tuple_element (C++11)	получает типы элементов tuple подобного типа (шаблон класса) [править]
std::tuple_size<std::tuple> (C++11)	получает размер `tuple` во время компиляции (специализация шаблона класса) [править]
std::tuple_element<std::tuple> (C++11)	получает тип указанного элемента (специализация шаблона класса) [править]
std::uses_allocator<std::tuple> (C++11)	специализация свойств типа std::uses_allocator (специализация шаблона класса) [править]
Константы
ignore (C++11)	заполнитель для пропуска элемента при распаковке `tuple` с помощью `tie` (константа) [править]
Функции
make_tuple (C++11)	создаёт объект `tuple` типа, определённого типами аргументов (шаблон функции) [править]
tie	создаёт std::tuple левосторонних ссылок или распаковывает кортеж на отдельные объекты (шаблон функции) [править]
forward_as_tuple (C++11)	создаёт `tuple` пересылалаемых ссылок (шаблон функции) [править]
tuple_cat (C++11)	создаёт `tuple`, объединяя любое количество кортежей (шаблон функции) [править]
std::get(std::tuple) (C++11)	доступ к определённому элементу кортежа (шаблон функции) [править]
operator==operator!=operator<operator<=operator>operator>=operator<=> (удалено в C++20)(удалено в C++20)(удалено в C++20)(удалено в C++20)(удалено в C++20)(C++20)	лексикографически сравнивает значения в кортеже (шаблон функции) [править]
std::swap(std::tuple) (C++11)	специализация алгоритма std::swap (шаблон функции) [править]
apply (C++17)	вызывает функцию с кортежем аргументов (шаблон функции) [править]
make_from_tuple (C++17)	создаёт объект с кортежем аргументов (шаблон функции) [править]

Краткое описание

#include <compare>

namespace std {
  // шаблонный класс tuple
  template<class... Types>
    class tuple;

  // функции создания tuple
  inline constexpr /* не определено */ ignore;

  template<class... TTypes>
    constexpr tuple<unwrap_ref_decay_t<TTypes>...> make_tuple(TTypes&&...);

  template<class... TTypes>
    constexpr tuple<TTypes&&...> forward_as_tuple(TTypes&&...) noexcept;

  template<class... TTypes>
    constexpr tuple<TTypes&...> tie(TTypes&...) noexcept;

  template<class... Tuples>
    constexpr tuple<CTypes...> tuple_cat(Tuples&&...);

  // вызов функции с tuple в качестве аргументов
  template<class F, class Tuple>
    constexpr decltype(auto) apply(F&& f, Tuple&& t);

  template<class T, class Tuple>
    constexpr T make_from_tuple(Tuple&& t);

  // вспомогательные классы для tuple
  template<class T> struct tuple_size;                  // не определено
  template<class T> struct tuple_size<const T>;

  template<class... Types> struct tuple_size<tuple<Types...>>;

  template<size_t I, class T> struct tuple_element;     // не определено
  template<size_t I, class T> struct tuple_element<I, const T>;

  template<size_t I, class... Types>
    struct tuple_element<I, tuple<Types...>>;

  template<size_t I, class T>
    using tuple_element_t = typename tuple_element<I, T>::type;

  // доступ к элементам
  template<size_t I, class... Types>
    constexpr tuple_element_t<I, tuple<Types...>>& get(tuple<Types...>&) noexcept;
  template<size_t I, class... Types>
    constexpr tuple_element_t<I, tuple<Types...>>&& get(tuple<Types...>&&) noexcept;
  template<size_t I, class... Types>
    constexpr const tuple_element_t<I, tuple<Types...>>&
      get(const tuple<Types...>&) noexcept;
  template<size_t I, class... Types>
    constexpr const tuple_element_t<I, tuple<Types...>>&&
      get(const tuple<Types...>&&) noexcept;
  template<class T, class... Types>
    constexpr T& get(tuple<Types...>& t) noexcept;
  template<class T, class... Types>
    constexpr T&& get(tuple<Types...>&& t) noexcept;
  template<class T, class... Types>
    constexpr const T& get(const tuple<Types...>& t) noexcept;
  template<class T, class... Types>
    constexpr const T&& get(const tuple<Types...>&& t) noexcept;

  // операторы отношения
  template<class... TTypes, class... UTypes>
    constexpr bool operator==(const tuple<TTypes...>&, const tuple<UTypes...>&);
  template<class... TTypes, class... UTypes>
    constexpr common_comparison_category_t</*synth-three-way-result*/<TTypes, UTypes>...>
      operator<=>(const tuple<TTypes...>&, const tuple<UTypes...>&);

  // свойства, связанные с аллокатором
  template<class... Types, class Alloc>
    struct uses_allocator<tuple<Types...>, Alloc>;

  // специализированные алгоритмы
  template<class... Types>
    constexpr void
      swap(tuple<Types...>& x, tuple<Types...>& y) noexcept(/* смотрите описание */);

  // вспомогательные классы для tuple
  template<class T>
    inline constexpr size_t tuple_size_v = tuple_size<T>::value;
}

// устарело
namespace std {
  template<class T> class tuple_size<volatile T>;
  template<class T> class tuple_size<const volatile T>;

  template<size_t I, class T> class tuple_element<I, volatile T>;
  template<size_t I, class T> class tuple_element<I, const volatile T>;
}

Шаблонный класс std::tuple

namespace std {
  template<class... Types>
  class tuple {
  public:
    // создание tuple
    constexpr explicit(/* смотрите описание */) tuple();
    constexpr explicit(/* смотрите описание */)
      tuple(const Types&...);         // только если sizeof...(Types) >= 1
    template<class... UTypes>
      constexpr explicit(/* смотрите описание */)
        tuple(UTypes&&...);           // только если sizeof...(Types) >= 1

    tuple(const tuple&) = default;
    tuple(tuple&&) = default;

    template<class... UTypes>
      constexpr explicit(/* смотрите описание */) tuple(const tuple<UTypes...>&);
    template<class... UTypes>
      constexpr explicit(/* смотрите описание */) tuple(tuple<UTypes...>&&);

    template<class U1, class U2>
      constexpr explicit(/* смотрите описание */)
        tuple(const pair<U1, U2>&);   // только если sizeof...(Types) == 2
    template<class U1, class U2>
      constexpr explicit(/* смотрите описание */)
        tuple(pair<U1, U2>&&);        // только если sizeof...(Types) == 2

    // конструкторы, расширенные аллокатором
    template<class Alloc>
      constexpr explicit(/* смотрите описание */)
        tuple(allocator_arg_t, const Alloc& a);
    template<class Alloc>
      constexpr explicit(/* смотрите описание */)
        tuple(allocator_arg_t, const Alloc& a, const Types&...);
    template<class Alloc, class... UTypes>
      constexpr explicit(/* смотрите описание */)
        tuple(allocator_arg_t, const Alloc& a, UTypes&&...);
    template<class Alloc>
      constexpr tuple(allocator_arg_t, const Alloc& a, const tuple&);
    template<class Alloc>
      constexpr tuple(allocator_arg_t, const Alloc& a, tuple&&);
    template<class Alloc, class... UTypes>
      constexpr explicit(/* смотрите описание */)
        tuple(allocator_arg_t, const Alloc& a, const tuple<UTypes...>&);
    template<class Alloc, class... UTypes>
      constexpr explicit(/* смотрите описание */)
        tuple(allocator_arg_t, const Alloc& a, tuple<UTypes...>&&);
    template<class Alloc, class U1, class U2>
      constexpr explicit(/* смотрите описание */)
        tuple(allocator_arg_t, const Alloc& a, const pair<U1, U2>&);
    template<class Alloc, class U1, class U2>
      constexpr explicit(/* смотрите описание */)
        tuple(allocator_arg_t, const Alloc& a, pair<U1, U2>&&);

    // присваивание tuple
    constexpr tuple& operator=(const tuple&);
    constexpr tuple& operator=(tuple&&) noexcept(/* смотрите описание */);

    template<class... UTypes>
      constexpr tuple& operator=(const tuple<UTypes...>&);
    template<class... UTypes>
      constexpr tuple& operator=(tuple<UTypes...>&&);

    template<class U1, class U2>
      constexpr tuple& operator=(const pair<U1, U2>&); // только если sizeof...(Types) == 2
    template<class U1, class U2>
      constexpr tuple& operator=(pair<U1, U2>&&);      // только если sizeof...(Types) == 2

    // обмен tuple
    constexpr void swap(tuple&) noexcept(/* смотрите описание */);
  };

  template<class... UTypes>
    tuple(UTypes...) -> tuple<UTypes...>;
  template<class T1, class T2>
    tuple(pair<T1, T2>) -> tuple<T1, T2>;
  template<class Alloc, class... UTypes>
    tuple(allocator_arg_t, Alloc, UTypes...) -> tuple<UTypes...>;
  template<class Alloc, class T1, class T2>
    tuple(allocator_arg_t, Alloc, pair<T1, T2>) -> tuple<T1, T2>;
  template<class Alloc, class... UTypes>
    tuple(allocator_arg_t, Alloc, tuple<UTypes...>) -> tuple<UTypes...>;
}

Заголовочный файл стандартной библиотеки <tuple> (C++11) — cppreference.com

Включает

Классы

Константы

Функции

Краткое описание

Шаблонный класс std::tuple