Spec-Zone.ru › C++

std::ranges::views::zip, std::ranges::zip_view

Определено в заголовке <ranges>
template< ranges::input_range... Views >
    requires (ranges::view<Views> && ...) && (sizeof...(Views) > 0)
class zip_view
    : public ranges::view_interface<zip_view<Views...>>
(1) (с C++23)
namespace views {
    inline constexpr /*unspecified*/ zip = /*unspecified*/;
}
(2) (с C++23)
Подпись вызова
template< ranges::viewable_range... Rs >
    requires /* see below */
constexpr auto zip( Rs&&... rs );
(с C++23)
1) zip_view — это адаптер диапазонов, который принимает один или несколько view, и создаёт view, чьим i-ым элементом является значение типа, подобного кортежу, состоящее из i-ых элементов всех представлений. Размер созданного представления — минимальный из размеров всех адаптированных представлений.
2) views::zip — это объект для кастомизации.

При вызове без аргументов views::zip() эквивалентен выражению auto(views::empty<std::tuple<>>).
В противном случае, views::zip(rs...) эквивалентен выражению ranges::zip_view<views::all_t<decltype((rs))>...>(rs...).

zip_view всегда моделирует input_range, и моделирует forward_range, bidirectional_range, random_access_range, или sized_range, если все адаптированные view типы моделируют соответствующий концепт.

zip_view моделирует common_range, если

  • sizeof...(Views) равно 1, и единственный тип адаптированного представления моделирует common_range, или
  • по крайней мере один тип адаптированного представления не моделирует bidirectional_range, и каждый тип адаптированного представления моделирует common_range, или
  • каждый тип адаптированного представления моделирует и random_access_range, и sized_range.

Объекты для кастомизации

Имя views::zip обозначает объект для кастомизации, который является константным объектом-функцией литерального типа semiregular. Для целей пояснения, неквалифицированная версия его типа обозначается как __zip_fn.

Все экземпляры __zip_fn равны. Эффекты вызова разных экземпляров типа __zip_fn с одними и теми же аргументами эквивалентны, независимо от того, является ли выражение, обозначающее экземпляр, lvalue или rvalue, и является ли оно квалифицированным как const или нет (однако, не требуется, чтобы экземпляр с квалификатором volatile был вызываемым). Таким образом, views::zip можно свободно копировать, и его копии можно использовать взаимозаменяемо.

Учитывая набор типов Args..., если std::declval<Args>()... соответствуют требованиям к аргументам для views::zip выше, __zip_fn моделирует

  • std::invocable<__zip_fn, Args...>,
  • std::invocable<const __zip_fn, Args...>,
  • std::invocable<__zip_fn&, Args...>, и
  • std::invocable<const __zip_fn&, Args...>.

В противном случае, никакая операция вызова функции __zip_fn не участвует в разрешении перегрузки.

Члены данных

Объект члена Определение
views_ (private) Кортеж типа std::tuple<Views...>, содержащий все адаптированные объекты представления.
(объект члена только для иллюстрации*)

Члены-функции

(конструктор)
(C++23)
создаёт zip_view
(публичная функция-член)
begin
(C++23)
возвращает итератор начала
(публичная функция-член)
end
(C++23)
возвращает итератор или страж конца
(публичная функция-член)
size
(C++23)
возвращает количество элементов. Предоставляется только если каждый базовый (адаптированный) диапазон удовлетворяет sized_range.
(публичная функция-член)
Наследуется от std::ranges::view_interface
empty
(C++20)
возвращает, пусто ли производное представление. Предоставляется, если оно удовлетворяет sized_range или forward_range.
(публичная функция-член std::ranges::view_interface<D> )
cbegin
(C++23)
возвращает постоянный итератор начала диапазона.
(публичная функция-член std::ranges::view_interface<D> )
cend
(C++23)
возвращает страж для постоянного итератора диапазона.
(публичная функция-член std::ranges::view_interface<D> )
operator bool
(C++20)
возвращает, не пусто ли производное представление. Предоставляется, если для него применимо ranges::empty.
(публичная функция-член std::ranges::view_interface<D> )
front
(C++20)
возвращает первый элемент производного представления. Предоставляется, если оно удовлетворяет forward_range.
(публичная функция-член std::ranges::view_interface<D> )
back
(C++20)
возвращает последний элемент производного представления. Предоставляется, если оно удовлетворяет bidirectional_range и common_range.
(публичная функция-член std::ranges::view_interface<D> )
operator[]
(C++20)
возвращает nth элемент производного представления. Предоставляется, если оно удовлетворяет random_access_range.
(публичная функция-член std::ranges::view_interface<D> )

Правила вывода типов

Вложенные классы

итератор
(C++23)
тип итератора
(только для иллюстрации — шаблон класса-члена*)
маркер
(C++23)
тип маркера, используемый, когда zip_view не является common_range
(только для иллюстрации — шаблон класса-члена*)

Вспомогательные шаблоны

template< class... Views >
inline constexpr bool enable_borrowed_range<ranges::zip_view<Views...>> =
    (ranges::enable_borrowed_range<Views> && ...);
(с C++23)

Эта специализация ranges::enable_borrowed_range обеспечивает, чтобы zip_view удовлетворял borrowed_range, когда каждый базовый вид его удовлетворяет.

Примечания

Макрокоманда проверки наличия функции Значение Стандарт Функция
__cpp_lib_ranges_zip 202110L (C++23) std::ranges::zip_view,

std::ranges::zip_transform_view,
std::ranges::adjacent_view,
std::ranges::adjacent_transform_view

Пример

#include <array>
#include <iostream>
#include <list>
#include <ranges>
#include <string>
#include <tuple>
#include <vector>
 
void print(auto const rem, auto const& range)
{
    for (std::cout << rem; auto const& elem : range)
        std::cout << elem << ' ';
    std::cout << '\n';
}
 
int main()
{
    auto x = std::vector{1, 2, 3, 4};
    auto y = std::list<std::string>{"α", "β", "γ", "δ", "ε"};
    auto z = std::array{'A', 'B', 'C', 'D', 'E', 'F'};
 
    print("Source views:", "");
    print("x: ", x);
    print("y: ", y);
    print("z: ", z);
 
    print("\nzip(x,y,z):", "");
 
    for (std::tuple<int&, std::string&, char&> elem : std::views::zip(x, y, z))
    {
        std::cout << std::get<0>(elem) << ' '
                  << std::get<1>(elem) << ' '
                  << std::get<2>(elem) << '\n';
 
        std::get<char&>(elem) += ('a' - 'A'); // modifies the element of z
    }
 
    print("\nAfter modification, z: ", z);
}

Вывод:

Source views:
x: 1 2 3 4
y: α β γ δ ε
z: A B C D E F
 
zip(x,y,z):
1 α A
2 β B
3 γ C
4 δ D
 
After modification, z: a b c d E F

См. также

ranges::zip_transform_viewviews::zip_transform
(C++23)
view, состоящий из кортежей результатов применения функции преобразования к соответствующим элементам адаптированных видов
(шаблон класса) (объект точечной настройки)
ranges::elements_viewviews::elements
(C++20)
принимает view, состоящий из tuple-like значений и числа N и создает view N-го элемента каждого кортежа
(шаблон класса) (объект адаптера диапазонов)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/ranges/zip_view

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API