add missing documentation

Author: white238

src/smith/numerics/functional/tuple.hpp

@@ -59,6 +59,7 @@ struct tuple<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> {
 
 namespace detail {
 
+/// @brief Return element @p i from a 10- or 11-element tuple.
 template <int i, typename Tuple>
 MFEM_HOST_DEVICE constexpr auto& tuple_get_extended(Tuple& values)
 {
@@ -98,6 +99,7 @@ MFEM_HOST_DEVICE constexpr auto& tuple_get_extended(Tuple& values)
   MFEM_UNREACHABLE();
 }
 
+/// @brief Return const element @p i from a 10- or 11-element tuple.
 template <int i, typename Tuple>
 MFEM_HOST_DEVICE constexpr const auto& tuple_get_extended(const Tuple& values)
 {
@@ -139,6 +141,7 @@ MFEM_HOST_DEVICE constexpr const auto& tuple_get_extended(const Tuple& values)
 
 }  // namespace detail
 
+/// @brief Return mutable element @p i from a 10-element tuple.
 template <int i, typename T0, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7,
           typename T8, typename T9>
 MFEM_HOST_DEVICE constexpr auto& get(tuple<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9>& values)
@@ -147,6 +150,7 @@ MFEM_HOST_DEVICE constexpr auto& get(tuple<T0, T1, T2, T3, T4, T5, T6, T7, T8, T
   return detail::tuple_get_extended<i>(values);
 }
 
+/// @brief Return mutable element @p i from an 11-element tuple.
 template <int i, typename T0, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7,
           typename T8, typename T9, typename T10>
 MFEM_HOST_DEVICE constexpr auto& get(tuple<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>& values)
@@ -155,6 +159,7 @@ MFEM_HOST_DEVICE constexpr auto& get(tuple<T0, T1, T2, T3, T4, T5, T6, T7, T8, T
   return detail::tuple_get_extended<i>(values);
 }
 
+/// @brief Return const element @p i from a 10-element tuple.
 template <int i, typename T0, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7,
           typename T8, typename T9>
 MFEM_HOST_DEVICE constexpr const auto& get(const tuple<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9>& values)
@@ -163,6 +168,7 @@ MFEM_HOST_DEVICE constexpr const auto& get(const tuple<T0, T1, T2, T3, T4, T5, T
   return detail::tuple_get_extended<i>(values);
 }
 
+/// @brief Return const element @p i from an 11-element tuple.
 template <int i, typename T0, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7,
           typename T8, typename T9, typename T10>
 MFEM_HOST_DEVICE constexpr const auto& get(const tuple<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>& values)
@@ -171,6 +177,25 @@ MFEM_HOST_DEVICE constexpr const auto& get(const tuple<T0, T1, T2, T3, T4, T5, T
   return detail::tuple_get_extended<i>(values);
 }
 
+/**
+ * @brief a function intended to be used for extracting the ith type from a tuple.
+ *
+ * @note type<i>(my_tuple) returns a value, whereas get<i>(my_tuple) returns a reference
+ *
+ * @tparam i the index of the tuple to query
+ * @tparam T0 The first type stored in the tuple
+ * @tparam T1 The second type stored in the tuple
+ * @tparam T2 The third type stored in the tuple
+ * @tparam T3 The fourth type stored in the tuple
+ * @tparam T4 The fifth type stored in the tuple
+ * @tparam T5 The sixth type stored in the tuple
+ * @tparam T6 The seventh type stored in the tuple
+ * @tparam T7 The eighth type stored in the tuple
+ * @tparam T8 The ninth type stored in the tuple
+ * @tparam T9 The tenth type stored in the tuple
+ * @param values the tuple of values
+ * @return a copy of the ith entry of the input
+ */
 template <int i, typename T0, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7,
           typename T8, typename T9>
 MFEM_HOST_DEVICE constexpr auto type(const tuple<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9>& values)
@@ -179,6 +204,26 @@ MFEM_HOST_DEVICE constexpr auto type(const tuple<T0, T1, T2, T3, T4, T5, T6, T7,
   return detail::tuple_get_extended<i>(values);
 }
 
+/**
+ * @brief a function intended to be used for extracting the ith type from a tuple.
+ *
+ * @note type<i>(my_tuple) returns a value, whereas get<i>(my_tuple) returns a reference
+ *
+ * @tparam i the index of the tuple to query
+ * @tparam T0 The first type stored in the tuple
+ * @tparam T1 The second type stored in the tuple
+ * @tparam T2 The third type stored in the tuple
+ * @tparam T3 The fourth type stored in the tuple
+ * @tparam T4 The fifth type stored in the tuple
+ * @tparam T5 The sixth type stored in the tuple
+ * @tparam T6 The seventh type stored in the tuple
+ * @tparam T7 The eighth type stored in the tuple
+ * @tparam T8 The ninth type stored in the tuple
+ * @tparam T9 The tenth type stored in the tuple
+ * @tparam T10 The eleventh type stored in the tuple
+ * @param values the tuple of values
+ * @return a copy of the ith entry of the input
+ */
 template <int i, typename T0, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7,
           typename T8, typename T9, typename T10>
 MFEM_HOST_DEVICE constexpr auto type(const tuple<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>& values)
@@ -191,29 +236,32 @@ MFEM_HOST_DEVICE constexpr auto type(const tuple<T0, T1, T2, T3, T4, T5, T6, T7,
 
 namespace smith {
 
-/**
- * @brief Alias for the CUDA-capable MFEM tuple implementation used by Smith.
- *
- * Keep Smith's public tuple spelling available while sharing the implementation
- * with MFEM's future namespace.
- */
+/// @brief Expose MFEM tuple in the Smith namespace.
 template <typename... T>
 using tuple = mfem::future::tuple<T...>;
 
+/// @brief Expose MFEM tuple application in the Smith namespace.
 using mfem::future::apply;
+/// @brief Expose MFEM tuple element access in the Smith namespace.
 using mfem::future::get;
+/// @brief Expose MFEM tuple construction in the Smith namespace.
 using mfem::future::make_tuple;
+/// @brief Expose MFEM tuple type selection in the Smith namespace.
 using mfem::future::type;
 
+/// @brief Alias for the MFEM tuple size trait.
 template <class... Types>
 using tuple_size = mfem::future::tuple_size<Types...>;
 
+/// @brief Alias for the MFEM tuple element trait.
 template <size_t I, class T>
 using tuple_element = mfem::future::tuple_element<I, T>;
 
+/// @brief Alias for the MFEM tuple detection trait.
 template <typename T>
 using is_tuple = mfem::future::is_tuple<T>;
 
+/// @brief Alias for the MFEM nested tuple detection trait.
 template <typename T>
 using is_tuple_of_tuples = mfem::future::is_tuple_of_tuples<T>;