std::integer_sequence

来自cppreference.com
< cpp‎ | utility
 
 
工具库
通用工具
格式化库 (C++20)
(C++11)
integer_sequence
(C++14)
关系运算符 (C++20 中弃用)
整数比较函数
(C++20)(C++20)(C++20)
(C++20)
swap 与类型运算
(C++14)
(C++11)
(C++11)
(C++11)
(C++17)
常用词汇类型
(C++11)
(C++17)
(C++17)
(C++17)
(C++11)
(C++17)

初等字符串转换
(C++17)
(C++17)
栈踪
 
定义于头文件 <utility>
template< class T, T... Ints >
struct integer_sequence;
(C++14 起)

类模板 std::integer_sequence 表示一个编译时的整数序列。在用作函数模板的实参时,能推导参数包 Ints 并将它用于包展开。

模板形参

T - 用于序列元素的整数类型
...Ints - 表示序列的非类型形参包

成员类型

成员类型 定义
value_type T

成员函数

size
[静态]
返回 Ints 中的元素数
(公开静态成员函数)

std::integer_sequence::size

static constexpr std::size_t size() noexcept;

返回 Ints 中的元素数。等价于 sizeof...(Ints)

参数

(无)

返回值

Ints 中的元素数。

辅助模板

为帮助 Tstd::size_t 的常用情况,定义辅助别名模板 std::index_sequence

template<std::size_t... Ints>
using index_sequence = std::integer_sequence<std::size_t, Ints...>;

分别定义辅助别名模板 std::make_integer_sequencestd::make_index_sequence 以简化以 0, 1, 2, ..., N-1Ints 创建 std::integer_sequencestd::index_sequence 类型:

template<class T, T N>
using make_integer_sequence = std::integer_sequence<T, /* a sequence 0, 1, 2, ..., N-1 */ >;
template<std::size_t N>
using make_index_sequence = std::make_integer_sequence<std::size_t, N>;

N 为负则程序为谬构。若 N 为零,则指示类型为 integer_sequence<T>

定义辅助类模板 std::index_sequence_for ,以转换任何类型参数包为同长度的下标序列:

template<class... T>
using index_sequence_for = std::make_index_sequence<sizeof...(T)>;

示例

注意:另一示例见 std::apply 中可能的实现

#include <tuple>
#include <iostream>
#include <array>
#include <utility>
 
// 调试辅助
template<typename T, T... ints>
void print_sequence(std::integer_sequence<T, ints...> int_seq)
{
    std::cout << "The sequence of size " << int_seq.size() << ": ";
    ((std::cout << ints << ' '),...);
    std::cout << '\n';
}
 
// 转换数组为 tuple
template<typename Array, std::size_t... I>
auto a2t_impl(const Array& a, std::index_sequence<I...>)
{
    return std::make_tuple(a[I]...);
}
 
template<typename T, std::size_t N, typename Indices = std::make_index_sequence<N>>
auto a2t(const std::array<T, N>& a)
{
    return a2t_impl(a, Indices{});
}
 
// 漂亮地打印 tuple
 
template<class Ch, class Tr, class Tuple, std::size_t... Is>
void print_tuple_impl(std::basic_ostream<Ch,Tr>& os,
                      const Tuple& t,
                      std::index_sequence<Is...>)
{
    ((os << (Is == 0? "" : ", ") << std::get<Is>(t)), ...);
}
 
template<class Ch, class Tr, class... Args>
auto& operator<<(std::basic_ostream<Ch, Tr>& os, const std::tuple<Args...>& t)
{
    os << "(";
    print_tuple_impl(os, t, std::index_sequence_for<Args...>{});
    return os << ")";
}
 
int main()
{
    print_sequence(std::integer_sequence<unsigned, 9, 2, 5, 1, 9, 1, 6>{});
    print_sequence(std::make_integer_sequence<int, 20>{});
    print_sequence(std::make_index_sequence<10>{});
    print_sequence(std::index_sequence_for<float, std::iostream, char>{});
 
    std::array<int, 4> array = {1,2,3,4};
 
    // 转换 array 为 tuple
    auto tuple = a2t(array);
    static_assert(std::is_same<decltype(tuple),
                               std::tuple<int, int, int, int>>::value, "");
 
    // 打印到 cout
    std::cout << tuple << '\n';
}

输出:

The sequence of size 7: 9 2 5 1 9 1 6 
The sequence of size 20: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 
The sequence of size 10: 0 1 2 3 4 5 6 7 8 9 
The sequence of size 3: 0 1 2 
(1, 2, 3, 4)