mirror of
https://github.com/TartanLlama/optional.git
synced 2025-08-03 11:54:26 +02:00
Update docs
This commit is contained in:
346
docs/index.md
346
docs/index.md
@@ -1,113 +1,117 @@
|
||||
# Header file `optional.hpp`<a id="optional.hpp"></a>
|
||||
|
||||
<pre><code class="language-cpp">#define <a href='doc_optional.md#optional.hpp'>TL_OPTIONAL_HPP</a>
|
||||
<pre><code class="language-cpp">#define <a href='doc_optional.html#optional.hpp'>TL_OPTIONAL_HPP</a>
|
||||
|
||||
#define <a href='doc_optional.md#optional.hpp'>TL_OPTIONAL_VERSION_MAJOR</a>
|
||||
#define <a href='doc_optional.html#optional.hpp'>TL_OPTIONAL_VERSION_MAJOR</a>
|
||||
|
||||
#define <a href='doc_optional.md#optional.hpp'>TL_OPTIONAL_VERSION_MINOR</a>
|
||||
#define <a href='doc_optional.html#optional.hpp'>TL_OPTIONAL_VERSION_MINOR</a>
|
||||
|
||||
#define <a href='doc_optional.md#optional.hpp'>IS_TRIVIALLY_COPY_CONSTRUCTIBLE</a>(T)
|
||||
#define <a href='doc_optional.html#optional.hpp'>IS_TRIVIALLY_COPY_CONSTRUCTIBLE</a>(T)
|
||||
|
||||
#define <a href='doc_optional.md#optional.hpp'>IS_TRIVIALLY_COPY_ASSIGNABLE</a>(T)
|
||||
#define <a href='doc_optional.html#optional.hpp'>IS_TRIVIALLY_COPY_ASSIGNABLE</a>(T)
|
||||
|
||||
#define <a href='doc_optional.md#optional.hpp'>IS_TRIVIALLY_DESTRUCTIBLE</a>(T)
|
||||
#define <a href='doc_optional.html#optional.hpp'>IS_TRIVIALLY_DESTRUCTIBLE</a>(T)
|
||||
|
||||
#define <a href='doc_optional.md#optional.hpp'>TL_OPTIONAL_CXX14</a>
|
||||
#define <a href='doc_optional.html#optional.hpp'>TL_OPTIONAL_CXX14</a>
|
||||
|
||||
namespace <a href='doc_optional.md#optional.hpp'>tl</a>
|
||||
#define <a href='doc_optional.html#optional.hpp'>TL_MONOSTATE_INPLACE_MUTEX</a>
|
||||
|
||||
#define <a href='doc_optional.html#optional.hpp'>TL_TRAITS_MUTEX</a>
|
||||
|
||||
namespace <a href='doc_optional.html#optional.hpp'>tl</a>
|
||||
{
|
||||
class <a href='doc_optional.md#tl::monostate'>monostate</a>;
|
||||
class <a href='doc_optional.html#tl::monostate'>monostate</a>;
|
||||
|
||||
struct <a href='doc_optional.md#tl::in_place_t'>in_place_t</a>;
|
||||
struct <a href='doc_optional.html#tl::in_place_t'>in_place_t</a>;
|
||||
|
||||
constexpr <a href='doc_optional.md#tl::in_place_t'>in_place_t{}</a> <a href='doc_optional.md#tl::in_place'>in_place</a>;
|
||||
constexpr <a href='doc_optional.html#tl::in_place_t'>in_place_t{}</a> <a href='doc_optional.html#tl::in_place'>in_place</a>;
|
||||
|
||||
struct <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>;
|
||||
struct <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>;
|
||||
|
||||
static constexpr nullopt_t nullopt;
|
||||
|
||||
class <a href='doc_optional.md#optional.hpp'>bad_optional_access</a>;
|
||||
class <a href='doc_optional.html#optional.hpp'>bad_optional_access</a>;
|
||||
|
||||
template <class T>
|
||||
class <a href='doc_optional.md#tl::optional-T-'>optional</a>;
|
||||
class <a href='doc_optional.html#tl::optional-T-'>optional</a>;
|
||||
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator==</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator==</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator!=</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator!=</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator<</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator<</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator></a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator></a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator<=</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator<=</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator>=</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constoptional-U-&)'>operator>=</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator==</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator==</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator==</a>(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator==</a>(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator!=</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator!=</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator!=</a>(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator!=</a>(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator<</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>&, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator<</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>&, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator<</a>(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator<</a>(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator<=</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator<=</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator<=</a>(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>&) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator<=</a>(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>&) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator></a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator></a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator></a>(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>&) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator></a>(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>&) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator>=</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>&, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator>=</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>&, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
template <class T>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator>=</a>(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,tl::nullopt_t)'>operator>=</a>(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator==</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator==</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator==</a>(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator==</a>(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator!=</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator!=</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator!=</a>(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator!=</a>(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator<</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator<</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator<</a>(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator<</a>(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator<=</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator<=</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator<=</a>(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator<=</a>(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator></a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator></a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator></a>(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator></a>(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator>=</a>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator>=</a>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
template <class T, class U>
|
||||
constexpr bool <a href='doc_optional.md#tl::operator==(constoptional-T-&,constU&)'>operator>=</a>(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool <a href='doc_optional.html#tl::operator==(constoptional-T-&,constU&)'>operator>=</a>(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
|
||||
template <class T>
|
||||
void swap(optional<T> &lhs, optional<T> &rhs);
|
||||
void swap(optional<T> &lhs, optional<T>
|
||||
|
||||
template <class T>
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional<detail::decay_t<T>></a> <a href='doc_optional.md#optional.hpp'>make_optional</a>(T&& v);
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional<detail::decay_t<T>></a> <a href='doc_optional.html#optional.hpp'>make_optional</a>(T&& v);
|
||||
|
||||
template <class T, class ... Args>
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional<T></a> <a href='doc_optional.md#optional.hpp'>make_optional</a>(Args&&... args);
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional<T></a> <a href='doc_optional.html#optional.hpp'>make_optional</a>(Args&&... args);
|
||||
|
||||
template <class T, class U, class ... Args>
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional<T></a> <a href='doc_optional.md#optional.hpp'>make_optional</a>(<a href='http://en.cppreference.com/mwiki/index.php?title=Special%3ASearch&search=std::initializer_list%3cU%3e'>std::initializer_list<U></a> il, Args&&... args);
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional<T></a> <a href='doc_optional.html#optional.hpp'>make_optional</a>(<a href='http://en.cppreference.com/mwiki/index.php?title=Special%3ASearch&search=std::initializer_list%3cU%3e'>std::initializer_list<U></a> il, Args&&... args);
|
||||
}
|
||||
|
||||
namespace <a href='doc_optional.md#optional.hpp'>std</a>
|
||||
namespace <a href='doc_optional.html#optional.hpp'>std</a>
|
||||
{
|
||||
}</code></pre>
|
||||
|
||||
@@ -123,14 +127,14 @@ Used to represent an optional with no data; essentially a bool
|
||||
|
||||
<pre><code class="language-cpp">struct in_place_t
|
||||
{
|
||||
<a href='doc_optional.md#tl::in_place_t'>in_place_t</a>() = default;
|
||||
<a href='doc_optional.html#tl::in_place_t'>in_place_t</a>() = default;
|
||||
};</code></pre>
|
||||
|
||||
A tag type to tell optional to construct its value in-place
|
||||
|
||||
## Variable `tl::in_place`<a id="tl::in_place"></a>
|
||||
|
||||
<pre><code class="language-cpp">constexpr <a href='doc_optional.md#tl::in_place_t'>in_place_t{}</a> in_place;</code></pre>
|
||||
<pre><code class="language-cpp">constexpr <a href='doc_optional.html#tl::in_place_t'>in_place_t{}</a> in_place;</code></pre>
|
||||
|
||||
A tag to tell optional to construct its value in-place
|
||||
|
||||
@@ -138,9 +142,9 @@ A tag to tell optional to construct its value in-place
|
||||
|
||||
<pre><code class="language-cpp">struct nullopt_t
|
||||
{
|
||||
struct <a href='doc_optional.md#tl::nullopt_t'>do_not_use</a>;
|
||||
struct <a href='doc_optional.html#tl::nullopt_t'>do_not_use</a>;
|
||||
|
||||
constexpr <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>(<a href='doc_optional.md#tl::nullopt_t'>do_not_use</a>, <a href='doc_optional.md#tl::nullopt_t'>do_not_use</a>) noexcept;
|
||||
constexpr <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>(<a href='doc_optional.html#tl::nullopt_t'>do_not_use</a>, <a href='doc_optional.html#tl::nullopt_t'>do_not_use</a>) noexcept;
|
||||
};</code></pre>
|
||||
|
||||
A tag type to represent an empty optional
|
||||
@@ -172,62 +176,62 @@ public:
|
||||
template <class F>
|
||||
constexpr auto and_then(F &&f) const &&;
|
||||
|
||||
template <class F> auto map(F &&f) &;
|
||||
template <class F> auto map(F &&f) &&;
|
||||
template <class F> auto map(F &&f) const&;
|
||||
template <class F> auto map(F &&f) const&&;
|
||||
template <class F> constexpr auto map(F &&f) &;
|
||||
template <class F> constexpr auto map(F &&f) &&;
|
||||
template <class F> constexpr auto map(F &&f) const&;
|
||||
template <class F> constexpr auto map(F &&f) const&&;
|
||||
|
||||
template <class F> optional<T> or_else (F &&f) &;
|
||||
template <class F> optional<T> or_else (F &&f) &&;
|
||||
template <class F> optional<T> or_else (F &&f) const &;
|
||||
|
||||
template <class F, class U>
|
||||
U <a href='doc_optional.md#tl::optional-T-::map_or(F&&,U&&)&'>map_or</a>(F&& f, U&& u) &;
|
||||
U <a href='doc_optional.html#tl::optional-T-::map_or(F&&,U&&)&'>map_or</a>(F&& f, U&& u) &;
|
||||
template <class F, class U>
|
||||
U <a href='doc_optional.md#tl::optional-T-::map_or(F&&,U&&)&'>map_or</a>(F&& f, U&& u) &&;
|
||||
U <a href='doc_optional.html#tl::optional-T-::map_or(F&&,U&&)&'>map_or</a>(F&& f, U&& u) &&;
|
||||
template <class F, class U>
|
||||
U <a href='doc_optional.md#tl::optional-T-::map_or(F&&,U&&)&'>map_or</a>(F&& f, U&& u) const &;
|
||||
U <a href='doc_optional.html#tl::optional-T-::map_or(F&&,U&&)&'>map_or</a>(F&& f, U&& u) const &;
|
||||
template <class F, class U>
|
||||
U <a href='doc_optional.md#tl::optional-T-::map_or(F&&,U&&)&'>map_or</a>(F&& f, U&& u) const &&;
|
||||
U <a href='doc_optional.html#tl::optional-T-::map_or(F&&,U&&)&'>map_or</a>(F&& f, U&& u) const &&;
|
||||
|
||||
template <class F, class U>
|
||||
auto map_or_else(F &&f, U &&u) &;
|
||||
template <class F, class U>
|
||||
auto map_or_else(F &&f, U &&u) &&;
|
||||
auto map_or_else(F &&f, U &&u)
|
||||
template <class F, class U>
|
||||
auto map_or_else(F &&f, U &&u) const &;
|
||||
auto map_or_else(F &&f, U &&u)
|
||||
template <class F, class U>
|
||||
auto map_or_else(F &&f, U &&u) const &&;
|
||||
auto map_or_else(F &&f, U &&u)
|
||||
|
||||
template <class U>
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional<typename std::decay<U>::type></a> <a href='doc_optional.md#tl::optional-T-::conjunction(U&&)const'>conjunction</a>(U&& u) const;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional<typename std::decay<U>::type></a> <a href='doc_optional.html#tl::optional-T-::conjunction(U&&)const'>conjunction</a>(U&& u) const;
|
||||
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) &;
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) const &;
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) &&;
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) const &&;
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) &;
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) const &;
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) &&;
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) const &&;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) &;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) const &;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) &&;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) const &&;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) &;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) const &;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) &&;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::disjunction(constoptional-T-&)&'>disjunction</a>(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) const &&;
|
||||
|
||||
<a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::take()&'>take</a>() &;
|
||||
<a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::take()&'>take</a>() const &;
|
||||
<a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::take()&'>take</a>() &&;
|
||||
<a href='doc_optional.md#tl::optional-T-'>optional</a> <a href='doc_optional.md#tl::optional-T-::take()&'>take</a>() const &&;
|
||||
<a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::take()&'>take</a>() &;
|
||||
<a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::take()&'>take</a>() const &;
|
||||
<a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::take()&'>take</a>() &&;
|
||||
<a href='doc_optional.html#tl::optional-T-'>optional</a> <a href='doc_optional.html#tl::optional-T-::take()&'>take</a>() const &&;
|
||||
|
||||
using <a href='doc_optional.md#tl::optional-T-'>value_type</a> = T;
|
||||
using <a href='doc_optional.html#tl::optional-T-'>value_type</a> = T;
|
||||
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-::optional()'>optional</a>() noexcept = default;
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-::optional()'>optional</a>(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-::optional()'>optional</a>() noexcept = default;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-::optional()'>optional</a>(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-::optional(constoptional-T-&)'>optional</a>(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) = default;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-::optional(constoptional-T-&)'>optional</a>(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) = default;
|
||||
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-::optional(optional-T-&&)'>optional</a>(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) = default;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-::optional(optional-T-&&)'>optional</a>(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) = default;
|
||||
|
||||
template <class... Args> constexpr explicit optional(in_place_t, Args&&... args);
|
||||
template <class... Args> constexpr explicit
|
||||
template <class U, class... Args>
|
||||
constexpr explicit optional(in_place_t, std::initializer_list<U>&, Args&&... args);
|
||||
constexpr explicit
|
||||
|
||||
template <class U=T> constexpr optional(U &&u);
|
||||
|
||||
@@ -235,13 +239,13 @@ public:
|
||||
|
||||
template <class U> optional(optional<U> &&rhs);
|
||||
|
||||
<a href='doc_optional.md#tl::optional-T-::~optional()'>~optional</a>() = default;
|
||||
<a href='doc_optional.html#tl::optional-T-::~optional()'>~optional</a>() = default;
|
||||
|
||||
<a href='doc_optional.md#tl::optional-T-'>optional</a>& <a href='doc_optional.md#tl::optional-T-::operator=(tl::nullopt_t)'>operator=</a>(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
<a href='doc_optional.html#tl::optional-T-'>optional</a>& <a href='doc_optional.html#tl::optional-T-::operator=(tl::nullopt_t)'>operator=</a>(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
|
||||
<a href='doc_optional.md#tl::optional-T-'>optional</a>& <a href='doc_optional.md#tl::optional-T-::operator=(constoptional-T-&)'>operator=</a>(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) = default;
|
||||
<a href='doc_optional.html#tl::optional-T-'>optional</a>& <a href='doc_optional.html#tl::optional-T-::operator=(constoptional-T-&)'>operator=</a>(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) = default;
|
||||
|
||||
<a href='doc_optional.md#tl::optional-T-'>optional</a>& <a href='doc_optional.md#tl::optional-T-::operator=(optional-T-&&)'>operator=</a>(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) = default;
|
||||
<a href='doc_optional.html#tl::optional-T-'>optional</a>& <a href='doc_optional.html#tl::optional-T-::operator=(optional-T-&&)'>operator=</a>(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) = default;
|
||||
|
||||
optional &operator=(U &&u);
|
||||
|
||||
@@ -250,11 +254,12 @@ public:
|
||||
optional &operator=(optional<U> && rhs);
|
||||
|
||||
template <class ... Args>
|
||||
T& <a href='doc_optional.md#tl::optional-T-::emplace(Args&&...)'>emplace</a>(Args&&... args);
|
||||
template <class U, class... Args>
|
||||
T& emplace(std::initializer_list<U> il, Args &&... args);
|
||||
T& <a href='doc_optional.html#tl::optional-T-::emplace(Args&&...)'>emplace</a>(Args&&... args);
|
||||
|
||||
void <a href='doc_optional.md#tl::optional-T-::swap(optional-T-&)'>swap</a>(<a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) noexcept(std::is_nothrow_move_constructible<T>::value&&detail::is_nothrow_swappable<T>::value);
|
||||
template <class U, class... Args>
|
||||
T&
|
||||
|
||||
void <a href='doc_optional.html#tl::optional-T-::swap(optional-T-&)'>swap</a>(<a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) noexcept(std::is_nothrow_move_constructible<T>::value&&detail::is_nothrow_swappable<T>::value);
|
||||
|
||||
constexpr const T *operator->() const;
|
||||
constexpr T *operator->();
|
||||
@@ -262,18 +267,18 @@ public:
|
||||
constexpr T &operator*();
|
||||
constexpr const T &operator*() const;
|
||||
|
||||
constexpr bool <a href='doc_optional.md#tl::optional-T-::has_value()const'>has_value</a>() const noexcept;
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-::has_value()const'>operator bool</a>() const noexcept;
|
||||
constexpr bool <a href='doc_optional.html#tl::optional-T-::has_value()const'>has_value</a>() const noexcept;
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-::has_value()const'>operator bool</a>() const noexcept;
|
||||
|
||||
constexpr T& <a href='doc_optional.md#tl::optional-T-::value()&'>value</a>() &;
|
||||
constexpr T& <a href='doc_optional.html#tl::optional-T-::value()&'>value</a>() &;
|
||||
constexpr const T &value() const;
|
||||
|
||||
template <class U>
|
||||
constexpr T <a href='doc_optional.md#tl::optional-T-::value_or(U&&)const&'>value_or</a>(U&& u) const &;
|
||||
constexpr T <a href='doc_optional.html#tl::optional-T-::value_or(U&&)const&'>value_or</a>(U&& u) const &;
|
||||
template <class U>
|
||||
constexpr T <a href='doc_optional.md#tl::optional-T-::value_or(U&&)const&'>value_or</a>(U&& u) &&;
|
||||
constexpr T <a href='doc_optional.html#tl::optional-T-::value_or(U&&)const&'>value_or</a>(U&& u) &&;
|
||||
|
||||
void <a href='doc_optional.md#tl::optional-T-::reset()'>reset</a>() noexcept;
|
||||
void <a href='doc_optional.html#tl::optional-T-::reset()'>reset</a>() noexcept;
|
||||
};</code></pre>
|
||||
|
||||
An optional object is an object that contains the storage for another object and manages the lifetime of this contained object, if any. The contained object may be initialized after the optional object has been initialized, and may be destroyed before the optional object has been destroyed. The initialization state of the contained object is tracked by the optional object.
|
||||
@@ -292,19 +297,17 @@ An optional object is an object that contains the storage for another object and
|
||||
(4) template <class F>
|
||||
constexpr auto and_then(F &&f) const &&;</code></pre>
|
||||
|
||||
Carries out some operation which returns an optional on the stored object if there is one.
|
||||
|
||||
*Requires*: `std::invoke(std::forward<F>(f), value())` returns a `std::optional<U>` for some `U`. \\returns Let `U` be the result of `std::invoke(std::forward<F>(f), value())`. Returns a `std::optional<U>`. The return value is empty if `*this` is empty, otherwise the return value of `std::invoke(std::forward<F>(f), value())` is returned.
|
||||
Carries out some operation which returns an optional on the stored object if there is one. \\requires `std::invoke(std::forward<F>(f), value())` returns a `std::optional<U>` for some `U`. \\returns Let `U` be the result of `std::invoke(std::forward<F>(f), value())`. Returns a `std::optional<U>`. The return value is empty if `*this` is empty, otherwise the return value of `std::invoke(std::forward<F>(f), value())` is returned.
|
||||
|
||||
### Function template `tl::optional::map`<a id="tl::optional-T-::map(F&&)&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class F> auto map(F &&f) &;
|
||||
<pre><code class="language-cpp">(1) template <class F> constexpr auto map(F &&f) &;
|
||||
|
||||
(2) template <class F> auto map(F &&f) &&;
|
||||
(2) template <class F> constexpr auto map(F &&f) &&;
|
||||
|
||||
(3) template <class F> auto map(F &&f) const&;
|
||||
(3) template <class F> constexpr auto map(F &&f) const&;
|
||||
|
||||
(4) template <class F> auto map(F &&f) const&&;</code></pre>
|
||||
(4) template <class F> constexpr auto map(F &&f) const&&;</code></pre>
|
||||
|
||||
Carries out some operation on the stored object if there is one.
|
||||
|
||||
@@ -346,13 +349,13 @@ If there is a value stored, then `f` is called with `**this` and the value is re
|
||||
auto map_or_else(F &&f, U &&u) &;
|
||||
|
||||
(2) template <class F, class U>
|
||||
auto map_or_else(F &&f, U &&u) &&;
|
||||
auto map_or_else(F &&f, U &&u)
|
||||
|
||||
(3) template <class F, class U>
|
||||
auto map_or_else(F &&f, U &&u) const &;
|
||||
auto map_or_else(F &&f, U &&u)
|
||||
|
||||
(4) template <class F, class U>
|
||||
auto map_or_else(F &&f, U &&u) const &&;</code></pre>
|
||||
auto map_or_else(F &&f, U &&u)</code></pre>
|
||||
|
||||
Maps the stored value with `f` if there is one, otherwise calls `u` and returns the result.
|
||||
|
||||
@@ -361,39 +364,39 @@ If there is a value stored, then `f` is called with `**this` and the value is re
|
||||
### Function template `tl::optional::conjunction`<a id="tl::optional-T-::conjunction(U&&)const"></a>
|
||||
|
||||
<pre><code class="language-cpp">template <class U>
|
||||
constexpr <a href='doc_optional.md#tl::optional-T-'>optional<typename std::decay<U>::type></a> conjunction(U&& u) const;</code></pre>
|
||||
constexpr <a href='doc_optional.html#tl::optional-T-'>optional<typename std::decay<U>::type></a> conjunction(U&& u) const;</code></pre>
|
||||
|
||||
*Returns*: `u` if `*this` has a value, otherwise an empty optional.
|
||||
|
||||
### Function `tl::optional::disjunction`<a id="tl::optional-T-::disjunction(constoptional-T-&)&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> disjunction(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) &;
|
||||
<pre><code class="language-cpp">(1) constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> disjunction(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) &;
|
||||
|
||||
(2) constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> disjunction(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) const &;
|
||||
(2) constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> disjunction(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) const &;
|
||||
|
||||
(3) constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> disjunction(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) &&;
|
||||
(3) constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> disjunction(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) &&;
|
||||
|
||||
(4) constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> disjunction(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) const &&;
|
||||
(4) constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> disjunction(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) const &&;
|
||||
|
||||
(5) constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> disjunction(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) &;
|
||||
(5) constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> disjunction(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) &;
|
||||
|
||||
(6) constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> disjunction(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) const &;
|
||||
(6) constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> disjunction(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) const &;
|
||||
|
||||
(7) constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> disjunction(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) &&;
|
||||
(7) constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> disjunction(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) &&;
|
||||
|
||||
(8) constexpr <a href='doc_optional.md#tl::optional-T-'>optional</a> disjunction(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) const &&;</code></pre>
|
||||
(8) constexpr <a href='doc_optional.html#tl::optional-T-'>optional</a> disjunction(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) const &&;</code></pre>
|
||||
|
||||
*Returns*: `rhs` if `*this` is empty, otherwise the current value.
|
||||
|
||||
### Function `tl::optional::take`<a id="tl::optional-T-::take()&"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) <a href='doc_optional.md#tl::optional-T-'>optional</a> take() &;
|
||||
<pre><code class="language-cpp">(1) <a href='doc_optional.html#tl::optional-T-'>optional</a> take() &;
|
||||
|
||||
(2) <a href='doc_optional.md#tl::optional-T-'>optional</a> take() const &;
|
||||
(2) <a href='doc_optional.html#tl::optional-T-'>optional</a> take() const &;
|
||||
|
||||
(3) <a href='doc_optional.md#tl::optional-T-'>optional</a> take() &&;
|
||||
(3) <a href='doc_optional.html#tl::optional-T-'>optional</a> take() &&;
|
||||
|
||||
(4) <a href='doc_optional.md#tl::optional-T-'>optional</a> take() const &&;</code></pre>
|
||||
(4) <a href='doc_optional.html#tl::optional-T-'>optional</a> take() const &&;</code></pre>
|
||||
|
||||
Takes the value out of the optional, leaving it empty
|
||||
|
||||
@@ -401,13 +404,13 @@ Takes the value out of the optional, leaving it empty
|
||||
|
||||
<pre><code class="language-cpp">(1) constexpr optional() noexcept = default;
|
||||
|
||||
(2) constexpr optional(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;</code></pre>
|
||||
(2) constexpr optional(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;</code></pre>
|
||||
|
||||
Constructs an optional that does not contain a value.
|
||||
|
||||
### Constructor `tl::optional::optional`<a id="tl::optional-T-::optional(constoptional-T-&)"></a>
|
||||
|
||||
<pre><code class="language-cpp">constexpr optional(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) = default;</code></pre>
|
||||
<pre><code class="language-cpp">constexpr optional(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) = default;</code></pre>
|
||||
|
||||
Copy constructor
|
||||
|
||||
@@ -415,7 +418,7 @@ If `rhs` contains a value, the stored value is direct-initialized with it. Other
|
||||
|
||||
### Constructor `tl::optional::optional`<a id="tl::optional-T-::optional(optional-T-&&)"></a>
|
||||
|
||||
<pre><code class="language-cpp">constexpr optional(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) = default;</code></pre>
|
||||
<pre><code class="language-cpp">constexpr optional(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) = default;</code></pre>
|
||||
|
||||
Move constructor
|
||||
|
||||
@@ -423,13 +426,15 @@ If `rhs` contains a value, the stored value is direct-initialized with it. Other
|
||||
|
||||
### Function template `tl::optional::optional`<a id="tl::optional-T-::optional(detail::enable_if_t-std::is_constructible-T,Args...-::value,in_place_t-,Args&&...)"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class... Args> constexpr explicit optional(in_place_t, Args&&... args);
|
||||
<pre><code class="language-cpp">(1) template <class... Args> constexpr explicit
|
||||
|
||||
(2) template <class U, class... Args>
|
||||
constexpr explicit optional(in_place_t, std::initializer_list<U>&, Args&&... args);</code></pre>
|
||||
constexpr explicit</code></pre>
|
||||
|
||||
Constructs the stored value in-place using the given arguments.
|
||||
|
||||
optional(in\_place\_t, Args&&... args);
|
||||
|
||||
### Function template `tl::optional::optional`<a id="tl::optional-T-::optional(U&&)"></a>
|
||||
|
||||
<pre><code class="language-cpp">template <class U=T> constexpr optional(U &&u);</code></pre>
|
||||
@@ -456,7 +461,7 @@ Destroys the stored value if there is one.
|
||||
|
||||
### Assignment operator `tl::optional::operator=`<a id="tl::optional-T-::operator=(tl::nullopt_t)"></a>
|
||||
|
||||
<pre><code class="language-cpp"><a href='doc_optional.md#tl::optional-T-'>optional</a>& operator=(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;</code></pre>
|
||||
<pre><code class="language-cpp"><a href='doc_optional.html#tl::optional-T-'>optional</a>& operator=(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;</code></pre>
|
||||
|
||||
Assignment to empty.
|
||||
|
||||
@@ -464,7 +469,7 @@ Destroys the current value if there is one.
|
||||
|
||||
### Assignment operator `tl::optional::operator=`<a id="tl::optional-T-::operator=(constoptional-T-&)"></a>
|
||||
|
||||
<pre><code class="language-cpp"><a href='doc_optional.md#tl::optional-T-'>optional</a>& operator=(const <a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) = default;</code></pre>
|
||||
<pre><code class="language-cpp"><a href='doc_optional.html#tl::optional-T-'>optional</a>& operator=(const <a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) = default;</code></pre>
|
||||
|
||||
Copy assignment.
|
||||
|
||||
@@ -472,7 +477,7 @@ Copies the value from `rhs` if there is one. Otherwise resets the stored value i
|
||||
|
||||
### Assignment operator `tl::optional::operator=`<a id="tl::optional-T-::operator=(optional-T-&&)"></a>
|
||||
|
||||
<pre><code class="language-cpp"><a href='doc_optional.md#tl::optional-T-'>optional</a>& operator=(<a href='doc_optional.md#tl::optional-T-'>optional</a>&& rhs) = default;</code></pre>
|
||||
<pre><code class="language-cpp"><a href='doc_optional.html#tl::optional-T-'>optional</a>& operator=(<a href='doc_optional.html#tl::optional-T-'>optional</a>&& rhs) = default;</code></pre>
|
||||
|
||||
Move assignment.
|
||||
|
||||
@@ -502,17 +507,21 @@ Moves the value from `rhs` if there is one. Otherwise resets the stored value in
|
||||
|
||||
### Function template `tl::optional::emplace`<a id="tl::optional-T-::emplace(Args&&...)"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class ... Args>
|
||||
T& emplace(Args&&... args);
|
||||
<pre><code class="language-cpp">template <class ... Args>
|
||||
T& emplace(Args&&... args);</code></pre>
|
||||
|
||||
(2) template <class U, class... Args>
|
||||
T& emplace(std::initializer_list<U> il, Args &&... args);</code></pre>
|
||||
Constructs the value in-place, destroying the current one if there is one. \\group emplace
|
||||
|
||||
Constructs the value in-place, destroying the current one if there is one.
|
||||
### Function template `tl::optional::emplace`<a id="tl::optional-T-::emplace(std::initializer_list-U-,Args&&...)"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class U, class... Args>
|
||||
T&</code></pre>
|
||||
|
||||
emplace(std::initializer\_list\<U\> il, Args &&... args);
|
||||
|
||||
### Function `tl::optional::swap`<a id="tl::optional-T-::swap(optional-T-&)"></a>
|
||||
|
||||
<pre><code class="language-cpp">void swap(<a href='doc_optional.md#tl::optional-T-'>optional</a>& rhs) noexcept(std::is_nothrow_move_constructible<T>::value&&detail::is_nothrow_swappable<T>::value);</code></pre>
|
||||
<pre><code class="language-cpp">void swap(<a href='doc_optional.html#tl::optional-T-'>optional</a>& rhs) noexcept(std::is_nothrow_move_constructible<T>::value&&detail::is_nothrow_swappable<T>::value);</code></pre>
|
||||
|
||||
Swaps this optional with the other.
|
||||
|
||||
@@ -577,22 +586,22 @@ Destroys the stored value if one exists, making the optional empty
|
||||
## Comparison operator `tl::operator==`<a id="tl::operator==(constoptional-T-&,constoptional-U-&)"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class T, class U>
|
||||
constexpr bool operator==(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool operator==(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
|
||||
(2) template <class T, class U>
|
||||
constexpr bool operator!=(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool operator!=(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
|
||||
(3) template <class T, class U>
|
||||
constexpr bool operator<(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool operator<(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
|
||||
(4) template <class T, class U>
|
||||
constexpr bool operator>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool operator>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
|
||||
(5) template <class T, class U>
|
||||
constexpr bool operator<=(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);
|
||||
constexpr bool operator<=(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);
|
||||
|
||||
(6) template <class T, class U>
|
||||
constexpr bool operator>=(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<U></a>& rhs);</code></pre>
|
||||
constexpr bool operator>=(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<U></a>& rhs);</code></pre>
|
||||
|
||||
Compares two optional objects
|
||||
|
||||
@@ -601,40 +610,40 @@ If both optionals contain a value, they are compared with `T`s relational operat
|
||||
## Comparison operator `tl::operator==`<a id="tl::operator==(constoptional-T-&,tl::nullopt_t)"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class T>
|
||||
constexpr bool operator==(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool operator==(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
|
||||
(2) template <class T>
|
||||
constexpr bool operator==(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
constexpr bool operator==(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
|
||||
(3) template <class T>
|
||||
constexpr bool operator!=(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool operator!=(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
|
||||
(4) template <class T>
|
||||
constexpr bool operator!=(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
constexpr bool operator!=(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
|
||||
(5) template <class T>
|
||||
constexpr bool operator<(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>&, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool operator<(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>&, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
|
||||
(6) template <class T>
|
||||
constexpr bool operator<(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
constexpr bool operator<(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs) noexcept;
|
||||
|
||||
(7) template <class T>
|
||||
constexpr bool operator<=(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool operator<=(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
|
||||
(8) template <class T>
|
||||
constexpr bool operator<=(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>&) noexcept;
|
||||
constexpr bool operator<=(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>&) noexcept;
|
||||
|
||||
(9) template <class T>
|
||||
constexpr bool operator>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool operator>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
|
||||
(10) template <class T>
|
||||
constexpr bool operator>(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>&) noexcept;
|
||||
constexpr bool operator>(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>&) noexcept;
|
||||
|
||||
(11) template <class T>
|
||||
constexpr bool operator>=(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>&, <a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
constexpr bool operator>=(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>&, <a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>) noexcept;
|
||||
|
||||
(12) template <class T>
|
||||
constexpr bool operator>=(<a href='doc_optional.md#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs) noexcept;</code></pre>
|
||||
constexpr bool operator>=(<a href='doc_optional.html#tl::nullopt_t'>nullopt_t</a>, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs) noexcept;</code></pre>
|
||||
|
||||
Compares an optional to a `nullopt`
|
||||
|
||||
@@ -643,43 +652,50 @@ Equivalent to comparing the optional to an empty optional
|
||||
## Comparison operator `tl::operator==`<a id="tl::operator==(constoptional-T-&,constU&)"></a>
|
||||
|
||||
<pre><code class="language-cpp">(1) template <class T, class U>
|
||||
constexpr bool operator==(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool operator==(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
|
||||
(2) template <class T, class U>
|
||||
constexpr bool operator==(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool operator==(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
|
||||
(3) template <class T, class U>
|
||||
constexpr bool operator!=(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool operator!=(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
|
||||
(4) template <class T, class U>
|
||||
constexpr bool operator!=(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool operator!=(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
|
||||
(5) template <class T, class U>
|
||||
constexpr bool operator<(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool operator<(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
|
||||
(6) template <class T, class U>
|
||||
constexpr bool operator<(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool operator<(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
|
||||
(7) template <class T, class U>
|
||||
constexpr bool operator<=(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool operator<=(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
|
||||
(8) template <class T, class U>
|
||||
constexpr bool operator<=(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool operator<=(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
|
||||
(9) template <class T, class U>
|
||||
constexpr bool operator>(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool operator>(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
|
||||
(10) template <class T, class U>
|
||||
constexpr bool operator>(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);
|
||||
constexpr bool operator>(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);
|
||||
|
||||
(11) template <class T, class U>
|
||||
constexpr bool operator>=(const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
constexpr bool operator>=(const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& lhs, const U& rhs);
|
||||
|
||||
(12) template <class T, class U>
|
||||
constexpr bool operator>=(const U& lhs, const <a href='doc_optional.md#tl::optional-T-'>optional<T></a>& rhs);</code></pre>
|
||||
constexpr bool operator>=(const U& lhs, const <a href='doc_optional.html#tl::optional-T-'>optional<T></a>& rhs);</code></pre>
|
||||
|
||||
Compares the optional with a value.
|
||||
|
||||
If the optional has a value, it is compared with the other value using `T`s relational operators. Otherwise, the optional is considered less than the value.
|
||||
|
||||
## Function template `tl::swap`<a id="tl::swap(optional-T-&,optional-T-&)"></a>
|
||||
|
||||
<pre><code class="language-cpp">template <class T>
|
||||
void swap(optional<T> &lhs, optional<T></code></pre>
|
||||
|
||||
\&rhs);
|
||||
|
||||
-----
|
||||
|
Reference in New Issue
Block a user