std::span(C++20)

namespace std {
  template <class ElementType, size_t Extent = dynamic_extent>
  class span;


  // viewコンセプトを有効化する
  template<class ElementType, size_t Extent>
  inline constexpr bool ranges::enable_view<span<ElementType, Extent>> = true;

  // borrowed_rangeコンセプトを有効化する
  template<class ElementType, size_t Extent>
  inline constexpr bool ranges::enable_borrowed_range<span<ElementType, Extent>> = true;
}

概要

std::spanは、シーケンスの所有権を保持せず、部分シーケンスを参照するクラスである。

このクラスは、std::vectorや配列といったコンテナから一部の連続的な要素を抽出し、それらの要素にのみなんらかの処理を適用する、という目的に使用できる。

文字列操作に特化したクラスとしてstd::basic_string_viewが定義されているが、こちらはメモリ連続性をもつあらゆるコンテナに適用できる。

このクラスは、トリビアルコピー可能である（C++23）

メモリ連続性

このクラスの対象は、メモリの連続性を持つシーケンスである。例として、以下は対象のシーケンスである：

• 組み込み配列
• 要素を指すポインタと要素数の組
• 先頭要素を指すポインタと、末尾要素の次を指すポインタの組
• std::array
• std::vector

メモリ連続性をもつクラスは、非メンバ関数data()によってポインタを取得でき、非メンバ関数size()によって要素数を取得できること。それらの関数は、ADLによって呼び出される。

静的な要素数と、動的な要素数

std::spanは、静的な要素数をもつ場合と、動的な要素数をもつ場合の両方をサポートする。それはテンプレートパラメータExtentによって表される。動的な要素数をもつ場合は、Extentとしてstd::dynamic_extentを指定する。動的な要素数は、std::vectorを参照したり、ポインタと要素数の組を扱ったり、参照範囲を動的に変更したりする場合に必要となる。

静的な要素数をもつ場合、メンバ定数extentに要素数が保持されるため、メンバ変数として要素数を保持する必要がなく、領域を節約する最適化を行える。

テンプレートパラメータ制約

• ElementTypeは、抽象型ではない完全オブジェクト型であること

備考

• std::spanが参照する範囲[s.data(), s.data() + s.size())に含まれるポインタを無効にする操作を行った場合、std::spanオブジェクトのメンバ関数から返されるその範囲のポインタ、イテレータ、*this以外の参照が無効になる

メンバ関数

構築・破棄

サブシーケンスの参照

領域

要素アクセス

イテレータ

メンバ定数

メンバ型

非メンバ関数

オブジェクトのバイト表現

推論補助

例

基本的な使い方

#include <iostream>
#include <span>
#include <vector>
#include <utility>

// メモリ連続性をもつあらゆる範囲を出力する関数。
// std::spanオブジェクトはコピーで受け取るのが基本的な使い方
template <class T, std::size_t Extent>
void print(std::span<T, Extent> s)
{
  const char* delimiter = "";

  std::cout << '{';
  for (const T& x : s) {
    std::cout << std::exchange(delimiter, ",") << x;
  }
  std::cout << '}' << std::endl;
}

int main()
{
  std::vector<int> v = {1, 2, 3, 4, 5};
  int ar[] = {1, 2, 3, 4, 5};

  // spanに変換してコンテナ全体を出力
  print(std::span{v});

  // コンテナの一部の要素を出力
  print(std::span{v}.subspan(1, 3));

  // ポインタと要素数を指定した範囲を参照して、
  // 範囲for文を使用する
  print(std::span<int>{ar, 3});
}

出力

{1,2,3,4,5}
{2,3,4}
{1,2,3}

データのヘッダ情報とボディ情報をコピーなしで分割する

#include <iostream>
#include <span>
#include <vector>
#include <utility>

template <class T>
void process_header(std::span<T> s)
{
  const char* delimiter = "";

  std::cout << "[header] : ";
  for (int x : s) {
    std::cout << std::exchange(delimiter, ",") << x;
  }
  std::cout << std::endl;
}

template <class T>
void process_body(std::span<T> s)
{
  const char* delimiter = "";

  std::cout << "[body] : ";
  for (int x : s) {
    std::cout << std::exchange(delimiter, ",") << x;
  }
  std::cout << std::endl;
}

template <class T>
void f(std::span<T> s)
{
  std::size_t header_size = 3;
  process_header(s.first(header_size));
  process_body(s.last(s.size() - header_size));
}

int main()
{
  std::vector<int> data = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
  f(std::span{data});
}

出力

[header] : 1,2,3
[body] : 4,5,6,7,8,9,10

バージョン

言語

• C++20

処理系

• Clang: 9.0
• GCC: 10.1
• Visual C++: 2019 Update 6

参照

• P0122R7 <span> (n4740でwording changeあり)
  • N4740 2018年03月 Jacksonville会議
• P1085R2 Should span be regular?
• P1227R2 Signed ssize() functions, unsigned size() functions
• P1024R3 Usability enhancements for std::span
• LWG Issue 3102 Clarify span iterator and const_iterator behavior
• LWG Issue 3144. span does not have a const_pointer typedef
• LWG Issue 3203. span element access invalidation
• P1872R0 span should have size_type, not index_type
• P2051R0 C++ Standard Library Issues to be moved in Prague
  • const_iterator, const_reverse_iterator, cbegin(), cend(), crbegin(), crend()を削除
• P2116R0 Remove tuple-like protocol support from fixed-extent span
• P0896R4 The One Ranges Proposal (was Merging the Ranges TS)
• P2325R3 Views should not be required to be default constructible
• Require span & basic_string_view to be Trivially Copyable
  • C++23から、トリビアルコピー可能が保証される。
• P2278R4 cbegin should always return a constant iterator