// ---------------------------------------------------------------------------- // - Open3D: www.open3d.org - // ---------------------------------------------------------------------------- // Copyright (c) 2018-2023 www.open3d.org // SPDX-License-Identifier: MIT // ---------------------------------------------------------------------------- // Copyright (C) 2011 - 2012 Andrzej Krzemienski. // // Use, modification, and distribution is subject to the Boost Software // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at // http://www.boost.org/LICENSE_1_0.txt) // // The idea and interface is based on Boost.Optional library // authored by Fernando Luis Cacciola Carballal // // From https://github.com/akrzemi1/Optional // // C10 // - Move to `c10` namespace. // - Remove macro use in line 478 because the nvcc device compiler cannot handle // it. // - revise constructor logic so that it is consistent with c++ 17 standard // documented here in (8): // https://en.cppreference.com/w/cpp/utility/optional/optional, and could be // able to support initialization of optionals from convertible type U, also // remove two old constructors optional(const T&) and optional(T&&) as it could // be handled by the template case with default template argument. // - `constexpr struct in_place_t {} in_place{}` is moved to // `c10/util/in_place.h`, so that it can also be used in `c10/util/variant.h`. // - Remove special cases for pre-c++14 compilers to make code simpler // // // Open3D // - Namespace change: open3d::utility::optional #pragma once #include #include #include #include #include #include #include #define TR2_OPTIONAL_REQUIRES(...) \ typename std::enable_if<__VA_ARGS__::value, bool>::type = false namespace open3d { namespace utility { struct in_place_t { explicit in_place_t() = default; }; constexpr in_place_t in_place{}; // 20.5.4, optional for object types template class optional; // 20.5.5, optional for lvalue reference types template class optional; // workaround: std utility functions aren't constexpr yet template inline constexpr T&& constexpr_forward( typename std::remove_reference::type& t) noexcept { return static_cast(t); } template inline constexpr T&& constexpr_forward( typename std::remove_reference::type&& t) noexcept { static_assert(!std::is_lvalue_reference::value, "!!"); return static_cast(t); } template inline constexpr typename std::remove_reference::type&& constexpr_move( T&& t) noexcept { return static_cast::type&&>(t); } #if defined NDEBUG #define TR2_OPTIONAL_ASSERTED_EXPRESSION(CHECK, EXPR) (EXPR) #else #define TR2_OPTIONAL_ASSERTED_EXPRESSION(CHECK, EXPR) \ ((CHECK) ? (EXPR) : ([] { assert(!#CHECK); }(), (EXPR))) #endif #if defined(__CUDA_ARCH__) #define TR2_OPTIONAL_HOST_CONSTEXPR #else #define TR2_OPTIONAL_HOST_CONSTEXPR constexpr #endif namespace detail_ { // VS doesn't handle constexpr well, so we need to skip these stuff. #if (defined _MSC_VER) template T* static_addressof(T& ref) { return std::addressof(ref); } #else // static_addressof: a constexpr version of addressof template struct has_overloaded_addressof { template constexpr static bool has_overload(...) { return false; } template ().operator&())> constexpr static bool has_overload(bool) { return true; } constexpr static bool value = has_overload(true); }; template )> constexpr T* static_addressof(T& ref) { return &ref; } template )> T* static_addressof(T& ref) { return std::addressof(ref); } #endif // the call to convert(b) has return type A and converts b to type A iff b // decltype(b) is implicitly convertible to A template constexpr U convert(U v) { return v; } } // namespace detail_ constexpr struct trivial_init_t { } trivial_init{}; // 20.5.7, Disengaged state indicator struct nullopt_t { struct init {}; constexpr explicit nullopt_t(init) {} }; constexpr nullopt_t nullopt{nullopt_t::init()}; // 20.5.8, class bad_optional_access class bad_optional_access : public std::logic_error { public: explicit bad_optional_access(const std::string& what_arg) : logic_error{what_arg} {} explicit bad_optional_access(const char* what_arg) : logic_error{what_arg} {} }; template union storage_t { unsigned char dummy_; T value_; constexpr storage_t(trivial_init_t) noexcept : dummy_(){}; template constexpr storage_t(Args&&... args) : value_(constexpr_forward(args)...) {} ~storage_t() {} }; template union constexpr_storage_t { unsigned char dummy_; T value_; constexpr constexpr_storage_t(trivial_init_t) noexcept : dummy_(){}; template constexpr constexpr_storage_t(Args&&... args) : value_(constexpr_forward(args)...) {} ~constexpr_storage_t() = default; }; template struct optional_base { bool init_; storage_t storage_; constexpr optional_base() noexcept : init_(false), storage_(trivial_init){}; explicit constexpr optional_base(const T& v) : init_(true), storage_(v) {} explicit constexpr optional_base(T&& v) : init_(true), storage_(constexpr_move(v)) {} template explicit optional_base(in_place_t, Args&&... args) : init_(true), storage_(constexpr_forward(args)...) {} template >)> explicit optional_base(in_place_t, std::initializer_list il, Args&&... args) : init_(true), storage_(il, std::forward(args)...) {} ~optional_base() { if (init_) storage_.value_.T::~T(); } }; template struct constexpr_optional_base { bool init_; constexpr_storage_t storage_; constexpr constexpr_optional_base() noexcept : init_(false), storage_(trivial_init){}; explicit constexpr constexpr_optional_base(const T& v) : init_(true), storage_(v) {} explicit constexpr constexpr_optional_base(T&& v) : init_(true), storage_(constexpr_move(v)) {} template explicit constexpr constexpr_optional_base(in_place_t, Args&&... args) : init_(true), storage_(constexpr_forward(args)...) {} template >)> constexpr explicit constexpr_optional_base(in_place_t, std::initializer_list il, Args&&... args) : init_(true), storage_(il, std::forward(args)...) {} ~constexpr_optional_base() = default; }; template using OptionalBase = typename std::conditional< std::is_trivially_destructible::value, // if possible constexpr_optional_base::type>, // use base with trivial destructor optional_base::type>>::type; template class optional : private OptionalBase { template // re-declaration for nvcc on Windows. using OptionalBase = typename std::conditional< std::is_trivially_destructible::value, // if possible constexpr_optional_base::type>, // use base with trivial destructor optional_base::type>>::type; static_assert(!std::is_same::type, nullopt_t>::value, "bad T"); static_assert( !std::is_same::type, in_place_t>::value, "bad T"); constexpr bool initialized() const noexcept { return OptionalBase::init_; } typename std::remove_const::type* dataptr() { return std::addressof(OptionalBase::storage_.value_); } constexpr const T* dataptr() const { return detail_::static_addressof(OptionalBase::storage_.value_); } constexpr const T& contained_val() const& { return OptionalBase::storage_.value_; } constexpr T&& contained_val() && { return std::move(OptionalBase::storage_.value_); } constexpr T& contained_val() & { return OptionalBase::storage_.value_; } void clear() noexcept { if (initialized()) dataptr()->~T(); OptionalBase::init_ = false; } template void initialize(Args&&... args) noexcept( noexcept(T(std::forward(args)...))) { assert(!OptionalBase::init_); ::new (static_cast(dataptr())) T(std::forward(args)...); OptionalBase::init_ = true; } template void initialize(std::initializer_list il, Args&&... args) noexcept( noexcept(T(il, std::forward(args)...))) { assert(!OptionalBase::init_); ::new (static_cast(dataptr())) T(il, std::forward(args)...); OptionalBase::init_ = true; } public: typedef T value_type; // 20.5.5.1, constructors constexpr optional() noexcept : OptionalBase(){}; constexpr optional(nullopt_t) noexcept : OptionalBase(){}; optional(const optional& rhs) : OptionalBase() { if (rhs.initialized()) { ::new (static_cast(dataptr())) T(*rhs); OptionalBase::init_ = true; } } optional(optional&& rhs) noexcept( std::is_nothrow_move_constructible::value) : OptionalBase() { if (rhs.initialized()) { ::new (static_cast(dataptr())) T(std::move(*rhs)); OptionalBase::init_ = true; } } // see https://github.com/akrzemi1/Optional/issues/16 // and https://en.cppreference.com/w/cpp/utility/optional/optional, // in constructor 8, the std::optional spec can allow initialization // of optionals from convertible type U // // 8 - implicit move construct from value template ::value && !std::is_same::type, in_place_t>::value && !std::is_same::type, optional>::value && std::is_convertible)> constexpr optional(U&& u) : OptionalBase(std::forward(u)) {} // 8 - explicit move construct from value template ::value && !std::is_same::type, in_place_t>::value && !std::is_same::type, optional>::value && !std::is_convertible)> explicit constexpr optional(U&& u) : OptionalBase(std::forward(u)) {} template explicit constexpr optional(in_place_t, Args&&... args) : OptionalBase(in_place_t{}, constexpr_forward(args)...) {} template >)> constexpr explicit optional(in_place_t, std::initializer_list il, Args&&... args) : OptionalBase(in_place_t{}, il, constexpr_forward(args)...) {} // 20.5.4.2, Destructor ~optional() = default; // 20.5.4.3, assignment optional& operator=(nullopt_t) noexcept { clear(); return *this; } optional& operator=(const optional& rhs) { if (initialized() == true && rhs.initialized() == false) clear(); else if (initialized() == false && rhs.initialized() == true) initialize(*rhs); else if (initialized() == true && rhs.initialized() == true) contained_val() = *rhs; return *this; } optional& operator=(optional&& rhs) noexcept( std::is_nothrow_move_assignable::value&& std::is_nothrow_move_constructible::value) { if (initialized() == true && rhs.initialized() == false) clear(); else if (initialized() == false && rhs.initialized() == true) initialize(std::move(*rhs)); else if (initialized() == true && rhs.initialized() == true) contained_val() = std::move(*rhs); return *this; } template auto operator=(U&& v) -> typename std::enable_if< std::is_constructible::value && !std::is_same::type, optional>::value && (std::is_scalar::value || std::is_same::type, T>::value) && std::is_assignable::value, optional&>::type { if (initialized()) { contained_val() = std::forward(v); } else { initialize(std::forward(v)); } return *this; } template void emplace(Args&&... args) { clear(); initialize(std::forward(args)...); } template void emplace(std::initializer_list il, Args&&... args) { clear(); initialize(il, std::forward(args)...); } // 20.5.4.4, Swap void swap(optional& rhs) noexcept( std::is_nothrow_move_constructible::value&& noexcept( std::swap(std::declval(), std::declval()))) { if (initialized() == true && rhs.initialized() == false) { rhs.initialize(std::move(**this)); clear(); } else if (initialized() == false && rhs.initialized() == true) { initialize(std::move(*rhs)); rhs.clear(); } else if (initialized() == true && rhs.initialized() == true) { using std::swap; swap(**this, *rhs); } } // 20.5.4.5, Observers explicit constexpr operator bool() const noexcept { return initialized(); } constexpr bool has_value() const noexcept { return initialized(); } TR2_OPTIONAL_HOST_CONSTEXPR T const* operator->() const { return TR2_OPTIONAL_ASSERTED_EXPRESSION(initialized(), dataptr()); } TR2_OPTIONAL_HOST_CONSTEXPR T* operator->() { assert(initialized()); return dataptr(); } TR2_OPTIONAL_HOST_CONSTEXPR T const& operator*() const& { return TR2_OPTIONAL_ASSERTED_EXPRESSION(initialized(), contained_val()); } TR2_OPTIONAL_HOST_CONSTEXPR T& operator*() & { assert(initialized()); return contained_val(); } TR2_OPTIONAL_HOST_CONSTEXPR T&& operator*() && { assert(initialized()); return constexpr_move(contained_val()); } TR2_OPTIONAL_HOST_CONSTEXPR T const& value() const& { return initialized() ? contained_val() : (throw bad_optional_access("bad optional access"), contained_val()); } TR2_OPTIONAL_HOST_CONSTEXPR T& value() & { return initialized() ? contained_val() : (throw bad_optional_access("bad optional access"), contained_val()); } TR2_OPTIONAL_HOST_CONSTEXPR T&& value() && { if (!initialized()) throw bad_optional_access("bad optional access"); return std::move(contained_val()); } template constexpr T value_or(V&& v) const& { return *this ? **this : detail_::convert(constexpr_forward(v)); } template constexpr T value_or(V&& v) && { return *this ? constexpr_move( const_cast&>(*this).contained_val()) : detail_::convert(constexpr_forward(v)); } // 20.6.3.6, modifiers void reset() noexcept { clear(); } }; // XXX: please refrain from using optional, since it is being against with // the optional standard in c++ 17, see the debate and the details here: // http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2012/n3406#rationale.refs // if you need it, consider using optional> or * // pointer // // we leave the implementation here in case we want to reconsider using it in // the future if it becomes a definitely necessary case. template class optional { // add this assert to prevent user from using optional reference as // indicated above static_assert(sizeof(T) == 0, "optional references is ill-formed, \ consider use optional of a std::reference_wrapper of type T to \ hold a reference if you really need to"); static_assert(!std::is_same::value, "bad T"); static_assert(!std::is_same::value, "bad T"); T* ref; public: // 20.5.5.1, construction/destruction constexpr optional() noexcept : ref(nullptr) {} constexpr optional(nullopt_t) noexcept : ref(nullptr) {} template constexpr optional(U& u) noexcept : ref(detail_::static_addressof(u)) {} template optional(U&&) = delete; constexpr optional(const optional& rhs) noexcept : ref(rhs.ref) {} explicit constexpr optional(in_place_t, T& v) noexcept : ref(detail_::static_addressof(v)) {} explicit optional(in_place_t, T&&) = delete; ~optional() = default; // 20.5.5.2, mutation optional& operator=(nullopt_t) noexcept { ref = nullptr; return *this; } // optional& operator=(const optional& rhs) noexcept { // ref = rhs.ref; // return *this; // } // optional& operator=(optional&& rhs) noexcept { // ref = rhs.ref; // return *this; // } template auto operator=(U&& rhs) noexcept -> typename std::enable_if< std::is_same::type, optional>::value, optional&>::type { ref = rhs.ref; return *this; } template auto operator=(U&& rhs) noexcept -> typename std::enable_if< !std::is_same::type, optional>::value, optional&>::type = delete; void emplace(T& v) noexcept { ref = detail_::static_addressof(v); } void emplace(T&&) = delete; void swap(optional& rhs) noexcept { std::swap(ref, rhs.ref); } // 20.5.5.3, observers TR2_OPTIONAL_HOST_CONSTEXPR T* operator->() const { return TR2_OPTIONAL_ASSERTED_EXPRESSION(ref, ref); } TR2_OPTIONAL_HOST_CONSTEXPR T& operator*() const { return TR2_OPTIONAL_ASSERTED_EXPRESSION(ref, *ref); } constexpr T& value() const { return ref ? *ref : (throw bad_optional_access("bad optional access"), *ref); } explicit constexpr operator bool() const noexcept { return ref != nullptr; } constexpr bool has_value() const noexcept { return ref != nullptr; } template constexpr typename std::decay::type value_or(V&& v) const { return *this ? **this : detail_::convert::type>( constexpr_forward(v)); } // x.x.x.x, modifiers void reset() noexcept { ref = nullptr; } }; template class optional { static_assert(sizeof(T) == 0, "optional rvalue references disallowed"); }; // 20.5.8, Relational operators template constexpr bool operator==(const optional& x, const optional& y) { return bool(x) != bool(y) ? false : bool(x) == false ? true : *x == *y; } template constexpr bool operator!=(const optional& x, const optional& y) { return !(x == y); } template constexpr bool operator<(const optional& x, const optional& y) { return (!y) ? false : (!x) ? true : *x < *y; } template constexpr bool operator>(const optional& x, const optional& y) { return (y < x); } template constexpr bool operator<=(const optional& x, const optional& y) { return !(y < x); } template constexpr bool operator>=(const optional& x, const optional& y) { return !(x < y); } // 20.5.9, Comparison with nullopt template constexpr bool operator==(const optional& x, nullopt_t) noexcept { return (!x); } template constexpr bool operator==(nullopt_t, const optional& x) noexcept { return (!x); } template constexpr bool operator!=(const optional& x, nullopt_t) noexcept { return bool(x); } template constexpr bool operator!=(nullopt_t, const optional& x) noexcept { return bool(x); } template constexpr bool operator<(const optional&, nullopt_t) noexcept { return false; } template constexpr bool operator<(nullopt_t, const optional& x) noexcept { return bool(x); } template constexpr bool operator<=(const optional& x, nullopt_t) noexcept { return (!x); } template constexpr bool operator<=(nullopt_t, const optional&) noexcept { return true; } template constexpr bool operator>(const optional& x, nullopt_t) noexcept { return bool(x); } template constexpr bool operator>(nullopt_t, const optional&) noexcept { return false; } template constexpr bool operator>=(const optional&, nullopt_t) noexcept { return true; } template constexpr bool operator>=(nullopt_t, const optional& x) noexcept { return (!x); } // 20.5.10, Comparison with T template constexpr bool operator==(const optional& x, const T& v) { return bool(x) ? *x == v : false; } template constexpr bool operator==(const T& v, const optional& x) { return bool(x) ? v == *x : false; } template constexpr bool operator!=(const optional& x, const T& v) { return bool(x) ? *x != v : true; } template constexpr bool operator!=(const T& v, const optional& x) { return bool(x) ? v != *x : true; } template constexpr bool operator<(const optional& x, const T& v) { return bool(x) ? *x < v : true; } template constexpr bool operator>(const T& v, const optional& x) { return bool(x) ? v > *x : true; } template constexpr bool operator>(const optional& x, const T& v) { return bool(x) ? *x > v : false; } template constexpr bool operator<(const T& v, const optional& x) { return bool(x) ? v < *x : false; } template constexpr bool operator>=(const optional& x, const T& v) { return bool(x) ? *x >= v : false; } template constexpr bool operator<=(const T& v, const optional& x) { return bool(x) ? v <= *x : false; } template constexpr bool operator<=(const optional& x, const T& v) { return bool(x) ? *x <= v : true; } template constexpr bool operator>=(const T& v, const optional& x) { return bool(x) ? v >= *x : true; } // Comparison of optional with T template constexpr bool operator==(const optional& x, const T& v) { return bool(x) ? *x == v : false; } template constexpr bool operator==(const T& v, const optional& x) { return bool(x) ? v == *x : false; } template constexpr bool operator!=(const optional& x, const T& v) { return bool(x) ? *x != v : true; } template constexpr bool operator!=(const T& v, const optional& x) { return bool(x) ? v != *x : true; } template constexpr bool operator<(const optional& x, const T& v) { return bool(x) ? *x < v : true; } template constexpr bool operator>(const T& v, const optional& x) { return bool(x) ? v > *x : true; } template constexpr bool operator>(const optional& x, const T& v) { return bool(x) ? *x > v : false; } template constexpr bool operator<(const T& v, const optional& x) { return bool(x) ? v < *x : false; } template constexpr bool operator>=(const optional& x, const T& v) { return bool(x) ? *x >= v : false; } template constexpr bool operator<=(const T& v, const optional& x) { return bool(x) ? v <= *x : false; } template constexpr bool operator<=(const optional& x, const T& v) { return bool(x) ? *x <= v : true; } template constexpr bool operator>=(const T& v, const optional& x) { return bool(x) ? v >= *x : true; } // Comparison of optional with T template constexpr bool operator==(const optional& x, const T& v) { return bool(x) ? *x == v : false; } template constexpr bool operator==(const T& v, const optional& x) { return bool(x) ? v == *x : false; } template constexpr bool operator!=(const optional& x, const T& v) { return bool(x) ? *x != v : true; } template constexpr bool operator!=(const T& v, const optional& x) { return bool(x) ? v != *x : true; } template constexpr bool operator<(const optional& x, const T& v) { return bool(x) ? *x < v : true; } template constexpr bool operator>(const T& v, const optional& x) { return bool(x) ? v > *x : true; } template constexpr bool operator>(const optional& x, const T& v) { return bool(x) ? *x > v : false; } template constexpr bool operator<(const T& v, const optional& x) { return bool(x) ? v < *x : false; } template constexpr bool operator>=(const optional& x, const T& v) { return bool(x) ? *x >= v : false; } template constexpr bool operator<=(const T& v, const optional& x) { return bool(x) ? v <= *x : false; } template constexpr bool operator<=(const optional& x, const T& v) { return bool(x) ? *x <= v : true; } template constexpr bool operator>=(const T& v, const optional& x) { return bool(x) ? v >= *x : true; } // 20.5.12, Specialized algorithms template void swap(optional& x, optional& y) noexcept(noexcept(x.swap(y))) { x.swap(y); } template constexpr optional::type> make_optional(T&& v) { return optional::type>(constexpr_forward(v)); } template constexpr optional make_optional(std::reference_wrapper v) { return optional(v.get()); } } // namespace utility } // namespace open3d namespace std { template struct hash> { typedef typename hash::result_type result_type; typedef open3d::utility::optional argument_type; constexpr result_type operator()(argument_type const& arg) const { return arg ? std::hash{}(*arg) : result_type{}; } }; template struct hash> { typedef typename hash::result_type result_type; typedef open3d::utility::optional argument_type; constexpr result_type operator()(argument_type const& arg) const { return arg ? std::hash{}(*arg) : result_type{}; } }; } // namespace std #undef TR2_OPTIONAL_REQUIRES #undef TR2_OPTIONAL_ASSERTED_EXPRESSION #undef TR2_OPTIONAL_HOST_CONSTEXPR