| // Copyright 2017-2020 The Khronos Group. This work is licensed under a |
| // Creative Commons Attribution 4.0 International License; see |
| // http://creativecommons.org/licenses/by/4.0/ |
| |
| [[tuple-library]] |
| === Tuple Library |
| |
| OpenCL {cpp} standard library implements most of the tuples described in _chapter 20.4 [tuple]_ of {cpp14} standard. |
| |
| The following parts of tuple library are not supported: |
| |
| * allocator related traits ({cpp14} standard, _section 20.4.2.8_) |
| |
| [[header-opencl_tuple-synopsis]] |
| ==== Header <opencl_tuple> Synopsis |
| |
| [source] |
| ---- |
| namespace cl |
| { |
| // class template tuple: |
| template <class... Types> class tuple; |
| |
| // tuple creation functions: |
| const unspecified ignore; |
| template <class... Types> |
| constexpr tuple<VTypes ...> make_tuple(Types&&...); |
| template <class... Types> |
| constexpr tuple<Types&&...> forward_as_tuple(Types&&...) noexcept; |
| template<class... Types> |
| constexpr tuple<Types&...> tie(Types&...) noexcept; |
| template <class... Tuples> |
| constexpr tuple<Ctypes ...> tuple_cat(Tuples&&...); |
| |
| // tuple helper classes: |
| template <class T> class tuple_size; // undefined |
| template <class T> class tuple_size<const T>; |
| template <class T> class tuple_size<volatile T>; |
| template <class T> class tuple_size<const volatile T>; |
| template <class... Types> class tuple_size<tuple<Types...> >; |
| template <size_t I, class T> class tuple_element; // undefined |
| template <size_t I, class T> class tuple_element<I, const T>; |
| template <size_t I, class T> class tuple_element<I, volatile T>; |
| template <size_t I, class T> class tuple_element<I, const volatile T>; |
| template <size_t I, class... Types> class tuple_element<I, tuple<Types...> >; |
| template <size_t I, class T> |
| using tuple_element_t = typename tuple_element<I, T>::type; |
| |
| // element access: |
| template <size_t I, class... Types> |
| constexpr tuple_element_t<I, tuple<Types...>>& |
| get(tuple<Types...>&) noexcept; |
| template <size_t I, class... Types> |
| constexpr tuple_element_t<I, tuple<Types...>>&& |
| get(tuple<Types...>&&) noexcept; |
| template <size_t I, class... Types> |
| constexpr const tuple_element_t<I, tuple<Types...>>& |
| get(const tuple<Types...>&) noexcept; |
| template <class T, class... Types> |
| constexpr T& get(tuple<Types...>& t) noexcept; |
| template <class T, class... Types> |
| constexpr T&& get(tuple<Types...>&& t) noexcept; |
| template <class T, class... Types> |
| constexpr const T& get(const tuple<Types...>& t) noexcept; |
| |
| // relational operators: |
| template<class... TTypes, class... UTypes> |
| constexpr bool operator==(const tuple<TTypes...>&, const tuple<UTypes...>&); |
| template<class... TTypes, class... UTypes> |
| constexpr bool operator<(const tuple<TTypes...>&, const tuple<UTypes...>&); |
| template<class... TTypes, class... UTypes> |
| constexpr bool operator!=(const tuple<TTypes...>&, const tuple<UTypes...>&); |
| template<class... TTypes, class... UTypes> |
| constexpr bool operator>(const tuple<TTypes...>&, const tuple<UTypes...>&); |
| template<class... TTypes, class... UTypes> |
| constexpr bool operator<=(const tuple<TTypes...>&, const tuple<UTypes...>&); |
| template<class... TTypes, class... UTypes> |
| constexpr bool operator>=(const tuple<TTypes...>&, const tuple<UTypes...>&); |
| |
| // specialized algorithms: |
| template <class... Types> |
| void swap(tuple<Types...>& x, tuple<Types...>& y) noexcept(see cpp14 standard); |
| |
| } |
| ---- |
