标准库标头 <optional>

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

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

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

标准库标头

注：修订记号中的反斜杠 '/' 意味着此标头被弃用和/或被移除。

语言支持
<cstddef> <cstdlib> <version> (C++20) <limits> <climits>	<cfloat> <cstdint> (C++11) <stdfloat> (C++23) <new> <typeinfo>	<source_location> (C++20) <exception> <initializer_list> (C++11) <compare> (C++20)	<coroutine> (C++20) <csignal> <csetjmp> <cstdarg>
概念
<concepts> (C++20)
诊断
<stdexcept> <stacktrace> (C++23)	<cassert>	<cerrno>	<system_error> (C++11)
内存管理
<memory>	<memory_resource> (C++17)	<scoped_allocator> (C++11)
元编程
<type_traits> (C++11)	<ratio> (C++11)
通用工具
<utility> <tuple> (C++11) <optional> (C++17) <variant> (C++17)	<any> (C++17) <expected> (C++23) <bitset>	<functional> <typeindex> (C++11) <execution> (C++17)	<charconv> (C++17) <format> (C++20) <bit> (C++20)
字符串
<string_view> (C++17) <string>	<cctype> <cwctype>	<cstring> <cwchar>	<cuchar> (C++11)
容器
<array> (C++11) <deque> <forward_list> (C++11) <list>	<vector> <map> <set> <unordered_map> (C++11)	<unordered_set> (C++11) <queue> <stack> <flat_map> (C++23)	<flat_set> (C++23) <span> (C++20) <mdspan> (C++23)
迭代器
<iterator>
范围
<ranges> (C++20)	<generator> (C++23)
算法
<algorithm>	<execution>
数值
<cfenv> (C++11) <complex>	<random> (C++11) <valarray>	<cmath>	<numbers> (C++20)
日期时间
<chrono> (C++11)	<ctime>
本地化
<locale>	<clocale>	<codecvt> (C++11/17)
输入/输出
<iosfwd> <iostream> <ios> <streambuf>	<istream> <ostream> <iomanip> <print> (C++23)	<sstream> <spanstream> (C++23) <fstream> <syncstream> (C++20)	<filesystem> (C++17) <cstdio> <cinttypes> (C++11) <strstream> (C++98/)
正则表达式
<regex>
并发支持
<stop_token> (C++20) <thread> (C++11) <atomic> (C++11)	<stdatomic.h> (C++23) <mutex> (C++11) <shared_mutex> (C++14)	<condition_variable> (C++11)   <semaphore> (C++20) <latch> (C++20)	<barrier> (C++20) <future> (C++11)
C 兼容
<cstdbool> (C++11/17/20)   <ccomplex> (C++11/17/20)	<ctgmath> (C++11/17/20)	<cstdalign> (C++11/17/20)	<ciso646> (C++20 前)

 

包含
<compare> (C++20)	三路比较运算符支持
类
optional (C++17)	可能或可能不保有一个对象的包装器 (类模板)
bad_optional_access (C++17)	指示进行了到不含值的 optional 的有检查访问的异常 (类)
std::hash<std::optional> (C++17)	std::optional 的散列支持 (类模板特化)
nullopt_t (C++17)	带未初始化状态的 optional 类型的指示器 (类)
前置声明
在标头 <functional> 定义
hash (C++11)	散列函数对象 (类模板)
常量
nullopt (C++17)	nullopt_t 类型对象 (常量)
函数
比较
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++17)(C++17)(C++17)(C++17)(C++17)(C++17)(C++20)	比较 optional 对象 (函数模板)
特化的算法
std::swap(std::optional) (C++17)	特化 std::swap 算法 (函数模板)
make_optional (C++17)	创建一个 optional 对象 (函数模板)

概要

#include <compare>
 
namespace std {
  // 类模板 optional
  template<class T>
    class optional;
 
  // 无值状态指示器
  struct nullopt_t{/* 见描述 */};
  inline constexpr nullopt_t nullopt(/* 未指明 */);
 
  // 类 bad_optional_access
  class bad_optional_access;
 
  // 关系运算符
  template<class T, class U>
    constexpr bool operator==(const optional<T>&, const optional<U>&);
  template<class T, class U>
    constexpr bool operator!=(const optional<T>&, const optional<U>&);
  template<class T, class U>
    constexpr bool operator<(const optional<T>&, const optional<U>&);
  template<class T, class U>
    constexpr bool operator>(const optional<T>&, const optional<U>&);
  template<class T, class U>
    constexpr bool operator<=(const optional<T>&, const optional<U>&);
  template<class T, class U>
    constexpr bool operator>=(const optional<T>&, const optional<U>&);
  template<class T, three_way_comparable_with<T> U>
    constexpr compare_three_way_result_t<T,U>
      operator<=>(const optional<T>&, const optional<U>&);
 
  // 与 nullopt 比较
  template<class T> constexpr bool operator==(const optional<T>&, nullopt_t) noexcept;
  template<class T>
    constexpr strong_ordering operator<=>(const optional<T>&, nullopt_t) noexcept;
 
  // 与 T 比较
  template<class T, class U> constexpr bool operator==(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator==(const T&, const optional<U>&);
  template<class T, class U> constexpr bool operator!=(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator!=(const T&, const optional<U>&);
  template<class T, class U> constexpr bool operator<(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator<(const T&, const optional<U>&);
  template<class T, class U> constexpr bool operator>(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator>(const T&, const optional<U>&);
  template<class T, class U> constexpr bool operator<=(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator<=(const T&, const optional<U>&);
  template<class T, class U> constexpr bool operator>=(const optional<T>&, const U&);
  template<class T, class U> constexpr bool operator>=(const T&, const optional<U>&);
  template<class T, three_way_comparable_with<T> U>
    constexpr compare_three_way_result_t<T,U>
      operator<=>(const optional<T>&, const U&);
 
  // 特化的算法
  template<class T>
    constexpr void swap(optional<T>&, optional<T>&) noexcept(/* 见描述 */);
 
  template<class T>
    constexpr optional</* 见描述 */> make_optional(T&&);
  template<class T, class... Args>
    constexpr optional<T> make_optional(Args&&... args);
  template<class T, class U, class... Args>
    constexpr optional<T> make_optional(initializer_list<U> il, Args&&... args);
 
  // 散列支持
  template<class T> struct hash;
  template<class T> struct hash<optional<T>>;
}

类模板 std::optional

namespace std {
  template<class T>
  class optional {
  public:
    using value_type = T;
 
    // 构造函数
    constexpr optional() noexcept;
    constexpr optional(nullopt_t) noexcept;
    constexpr optional(const optional&);
    constexpr optional(optional&&) noexcept(/* 见描述 */);
    template<class... Args>
      constexpr explicit optional(in_place_t, Args&&...);
    template<class U, class... Args>
      constexpr explicit optional(in_place_t, initializer_list<U>, Args&&...);
    template<class U = T>
      constexpr explicit(/* 见描述 */) optional(U&&);
    template<class U>
      constexpr explicit(/* 见描述 */) optional(const optional<U>&);
    template<class U>
      constexpr explicit(/* 见描述 */) optional(optional<U>&&);
 
    // 析构函数
    constexpr ~optional();
 
    // 赋值
    constexpr optional& operator=(nullopt_t) noexcept;
    constexpr optional& operator=(const optional&);
    constexpr optional& operator=(optional&&) noexcept(/* 见描述 */);
    template<class U = T> constexpr optional& operator=(U&&);
    template<class U> constexpr optional& operator=(const optional<U>&);
    template<class U> constexpr optional& operator=(optional<U>&&);
    template<class... Args> constexpr T& emplace(Args&&...);
    template<class U, class... Args> constexpr T& emplace(initializer_list<U>, Args&&...);
 
    // 交换
    constexpr void swap(optional&) noexcept(/* 见描述 */);
 
    // 观察器
    constexpr const T* operator->() const noexcept;
    constexpr T* operator->() noexcept;
    constexpr const T& operator*() const& noexcept;
    constexpr T& operator*() & noexcept;
    constexpr T&& operator*() && noexcept;
    constexpr const T&& operator*() const&& noexcept;
    constexpr explicit operator bool() const noexcept;
    constexpr bool has_value() const noexcept;
    constexpr const T& value() const&;
    constexpr T& value() &;
    constexpr T&& value() &&;
    constexpr const T&& value() const&&;
    template<class U> constexpr T value_or(U&&) const&;
    template<class U> constexpr T value_or(U&&) &&;
 
    // 单子操作
    template <class F> constexpr auto and_then(F&& f) &;
    template <class F> constexpr auto and_then(F&& f) &&;
    template <class F> constexpr auto and_then(F&& f) const&;
    template <class F> constexpr auto and_then(F&& f) const&&;
    template <class F> constexpr auto transform(F&& f) &;
    template <class F> constexpr auto transform(F&& f) &&;
    template <class F> constexpr auto transform(F&& f) const&;
    template <class F> constexpr auto transform(F&& f) const&&;
    template <class F> constexpr optional or_else(F&& f) &&;
    template <class F> constexpr optional or_else(F&& f) const&;
 
    // 修改器
    constexpr void reset() noexcept;
 
  private:
    T *val;         // 仅用于阐释
  };
 
  template<class T>
    optional(T) -> optional<T>;
}