std::common_reference

来自cppreference.com
< cpp‎ | types
 
 
元编程库
类型特征
类型类别
(C++11)
(C++14)  
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
类型属性
(C++11)
(C++11)
(C++14)
(C++11)
(C++11)(C++20 前*)
(C++11)(C++20 中弃用)
(C++11)
类型特征常量
元函数
(C++17)
受支持操作
关系与属性查询
类型修改
(C++11)(C++11)(C++11)
类型变换
(C++11)(C++23 中弃用)
(C++11)(C++23 中弃用)
(C++11)
(C++11)
(C++17)

common_reference
(C++20)
(C++11)(C++20 前*)(C++17)
编译时有理数算术
编译时整数序列
 
在标头 <type_traits> 定义
template< class... T >
struct common_reference;
(C++20 起)

确定类型 T... 的公共引用类型,即 T... 中所有类型能转换或绑定到的类型。若这种类型存在(如按照后述规则所确定),则成员 type 指名该类型。否则,无成员 type。若 T... 中的任何类型为(可有 cv 限定的)void 以外的不完整类型,则行为未定义。

当给定引用类型时,common_reference 尝试寻找所提供的所有引用类型都能绑定到的引用类型,但若找不到这种引用类型,则可能返回非引用类型。

  • sizeof...(T) 为零,则无成员 type
  • sizeof...(T) 为一(即 T... 仅含一个类型 T0),则成员 type 指名与 T0 相同的类型。
  • sizeof...(T) 为二(即 T... 含两个类型 T1T2),则:
    • 令类型 ST1T2简单公共引用类型(定义如下)。则当满足以下所有条件时,成员类型 type 指名 S
      • T1T2 都是引用类型
      • S 良构
(C++23 起)
  • 否则,若 std::basic_common_reference<std::remove_cvref_t<T1>, std::remove_cvref_t<T2>, T1Q, T2Q>::type 存在,其中 TiQ 是一元别名模板,满足 TiQ<U>U 带上 Ti 的 cv 及引用限定符,则成员类型 type 指名该类型;
    • 否则,若 decltype(false? val<T1>() : val<T2>()) 是合法类型,其中 val 为函数模板 template<class T> T val();,则成员类型 type 指名该类型;
    • 否则,若 std::common_type_t<T1, T2> 为合法类型,则成员类型 type 指名该类型;
    • 否则,无成员 type
  • sizeof...(T) 大于二(即 T...T1, T2, R... 组成),则若 std::common_reference_t<T1, T2> 存在,且 std::common_reference_t<std::common_reference_t<T1, T2>, R...> 存在,则成员类型 type 指代它。所有其他情况下,无成员类型 type

两个引用类型 T1T2简单公共引用类型定义如下:

  • T1cv1 X &T2cv2 Y &(即都是左值引用类型):则其简单公共引用类型为 decltype(false? std::declval<cv12 X &>() : std::declval<cv12 Y &>()),其中 cv12cv1cv2 的并,若该类型存在且为引用类型;
  • T1T2 均为右值引用类型:若 T1 &T2 & 的简单公共引用类型(按照前一条确定)存在,则令 C 代表该类型的对应右值引用类型。若 std::is_convertible_v<T1, C>std::is_convertible_v<T2, C> 均为 true,则 T1T2 的简单公共引用类型为 C
  • 否则,两个类型之一必须为左值引用类型 A & 而另一个必须为右值引用类型 B &&AB 可为 cv 限定)。令 D 代表 A &B const & 的简单公共引用类型,若它存在。若 D 存在且 std::is_convertible_v<B &&, D>true,则简单公共引用类型为 D
  • 否则,无简单公共引用类型。

对于类似上文所用到的表达式 false ? X : Y 的类型的定义,参见条件运算符

成员类型

名称 定义
type 所有 T... 的公共引用类型

辅助类型

template< class... T >
using common_reference_t = std::common_reference<T...>::type;
template< class T, class U, template<class> class TQual, template<class> class UQual >
struct basic_common_reference {};

类模板 basic_common_reference 是一个定制点,允许用户影响 common_reference 对用户定义类型(常为代理引用)的结果。主模板为空。

特化

std::is_same_v<T, std::decay_t<T>>std::is_same_v<U, std::decay_t<U>> 皆为 true,且它们至少有一个依赖于程序定义类型,则程序可以在前两个形参 TU 上特化 std::basic_common_reference<T, U, TQual, UQual>

若这种特化拥有名为 type 的成员,则限定标识 std::basic_common_reference<T, U, TQual, UQual>::type 必须合法并指名 TQual<T>UQual<U> 都能转换到的类型的公开且无歧义的成员类型。另外,std::basic_common_reference<T, U, TQual, UQual>::typestd::basic_common_reference<U, T, UQual, TQual>::type 必须代表同一类型。

程序不可在第三或第四形参上特化 basic_common_reference,亦不可特化 common_reference 自身。以违背这些规则的方式添加特化的程序拥有未定义行为。

标准库提供下列 basic_common_reference 的特化:

确定两个 pair 的公共引用类型
(类模板特化)
确定 tupletuple-like 类型的公共引用类型
(类模板特化)
确定 reference_wrapper 和非 reference_wrapper 的公共引用类型
(类模板特化)

注解

功能特性测试 标准 功能特性
__cpp_lib_common_reference 202302L (C++23) std::reference_wrapperstd::common_reference_t 是引用类型

示例

#include <concepts>
#include <type_traits>
 
static_assert(
    std::same_as<
        int&,
        std::common_reference_t<
            std::add_lvalue_reference_t<int>,
            std::add_lvalue_reference_t<int>&,
            std::add_lvalue_reference_t<int>&&,
            std::add_lvalue_reference_t<int>const,
            std::add_lvalue_reference_t<int>const&
        >
    >
);
 
int main() {}

参阅

确定一组类型的公共类型
(类模板)
指定两个类型共有一个公共引用类型
(概念)