std::ranges::out_value_result

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

受约束算法

本菜单中的所有名字均属于命名空间 std::ranges

不修改序列的操作

all_ofany_ofnone_of for_each for_each_n    countcount_if adjacent_find mismatch equal lexicographical_compare    containscontains_subrange (C++23)(C++23) findfind_iffind_if_not find_lastfind_last_iffind_last_if_not (C++23)(C++23)(C++23)   find_end find_first_of search search_n starts_with (C++23) ends_with (C++23)

修改序列的操作

copycopy_if copy_n copy_backward    move move_backward shift_leftshift_right (C++23)(C++23)   fill fill_n generate generate_n    transform swap_ranges    shuffle sample removeremove_if replacereplace_if reverse rotate remove_copyremove_copy_if    unique replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy

划分操作

is_partitioned    partition_point    partition    partition_copy    stable_partition

排序操作

is_sorted is_sorted_until     sort stable_sort         partial_sort       nth_element partial_sort_copy

二分搜索操作（在有序范围上）

lower_bound         upper_bound         binary_search      equal_range

集合操作（在有序范围上）

merge inplace_merge       set_difference set_intersection    set_union          includes set_symmetric_difference

堆操作

is_heap is_heap_until       make_heap           sort_heap push_heap pop_heap

最小/最大操作

max max_element         min min_element         minmax minmax_element     clamp

排列操作

is_permutation      next_permutation    prev_permutation

折叠操作

fold_left (C++23) fold_left_first (C++23)   fold_right (C++23) fold_right_last (C++23)   fold_left_with_iter (C++23) fold_left_first_with_iter (C++23)

数值操作 iota (C++23)             随机数生成 generate_random (C++26)

未初始化存储上的操作

construct_at    destroy destroy_n destroy_at uninitialized_copy    uninitialized_move uninitialized_fill uninitialized_copy_n    uninitialized_move_n uninitialized_fill_n uninitialized_default_construct uninitialized_default_construct_n uninitialized_value_construct uninitialized_value_construct_n

返回类型

in_fun_result in_in_result in_found_result    in_out_result in_in_out_result    in_out_out_result    min_max_result out_value_result (C++23) in_value_result (C++23)

 

受约束算法的返回类型

返回类型

ranges::in_found_result

ranges::in_fun_result

ranges::in_in_out_result

ranges::in_in_result

ranges::in_out_out_result

ranges::in_out_result

ranges::in_value_result (C++23)

ranges::min_max_result

ranges::out_value_result (C++23)

 

在标头 <algorithm> 定义
template< class O, class T > struct out_value_result;		(C++23 起)

ranges::out_value_result 是类模板，提供了将迭代器和值作为一个单元存储的方法。

除了下面显示的成员外，此类模板没有其他基类或数据成员，从而它适用于结构化绑定。

此类模板的所有特殊成员函数均为隐式声明，这使得所有特化都为聚合类，并传播数据成员上相应的操作的平凡性、潜在抛出性及 constexpr 性质。

模板形参

O, T

-

ranges::out_value_result 储存的对象的类型。

数据成员

成员名字	定义
out	O 类型的值（假定为迭代器）。 (公开成员对象)
value	T 类型的值（假定为存储的值）。 (公开成员对象)

这些成员都被声明为带有 [[no_unique_address]] 属性。

成员函数

std::ranges::out_value_result::operator out_value_result<O2, T2>

template<class O2, class T2> requires convertible_to<const O&, O2> && convertible_to<const T&, T2> constexpr operator out_value_result<O2, T2>() const &;	(1)
template<class O2, class T2> requires convertible_to<O, O2> && convertible_to<T, T2> constexpr operator out_value_result<O2, T2>() &&;	(2)

通过从 *this 的对应成员构造结果的每个数据成员，将 *this 转换为结果。

1) 等价于 return {out, value};。

2) 等价于 return {std::move(out), std::move(value)};。

标准库

这些标准库函数使用 ranges::out_value_result 作为返回值类型：

算法函数
ranges::iota (C++23)	从初始值开始连续递增填充范围 (算法函数对象)

概要

namespace std::ranges
{
    template<class O, class T>
    struct out_value_result
    {
        [[no_unique_address]] O out;
        [[no_unique_address]] T value;
 
        template<class O2, class T2>
        requires convertible_to<const O&, O2> && convertible_to<const T&, T2>
        constexpr operator out_value_result<O2, T2>() const &
        {
            return {out, value};
        }
 
        template<class O2, class T2>
        requires convertible_to<O, O2> && convertible_to<T, T2>
        constexpr operator out_value_result<O2, T2>() &&
        {
            return {std::move(out), std::move(value)};
        }
    };
}

注解

每个使用这一族返回类型的标准库算法都声明了新的别名类型，例如 using merge_result = in_in_out_result<I1, I2, O>;。

这些别名的名称由算法名添加 “_result”组成。故 std::ranges::merge 的返回类型命名为 std::ranges::merge_result。

不同于 std::pair 和 std::tuple，此类模板的拥有名字有意义的数据成员。

示例

运行此代码

#include <algorithm>
#include <array>
#include <cassert>
#include <numeric>
#include <ranges>
 
int main()
{
    std::array<int, 4> a {};
    constexpr std::array expected {2, 3, 4, 5};
    const auto result = std::ranges::iota(a, 2);
    assert(std::ranges::distance(a.cbegin(), result.out) == 4);
    assert(result.value == 6);
    assert(a == expected);
}

参阅

pair	实现二元组，即一对值 (类模板)
tuple (C++11)	实现固定大小的容器，可保有类型相异的元素 (类模板)