Remove redundant return type from doxygen return commands

Author: Q-Minh

python/elasticity/potentials.py

@@ -135,7 +135,7 @@ def codegen(fpsi, energy_name: str):
          * @param F Deformation gradient
          * @param mu First Lame coefficient
          * @param lambda Second Lame coefficient
-         * @return ScalarType Energy
+         * @return Energy
          */
         template <math::linalg::mini::CReadableVectorizedMatrix TMatrix>
         PBAT_HOST_DEVICE
@@ -152,7 +152,7 @@ def codegen(fpsi, energy_name: str):
          * @param F Deformation gradient
          * @param mu First Lame coefficient
          * @param lambda Second Lame coefficient
-         * @return ScalarType Energy gradient
+         * @return Energy gradient
          */
         template <math::linalg::mini::CReadableVectorizedMatrix TMatrix>
         PBAT_HOST_DEVICE
@@ -169,7 +169,7 @@ def codegen(fpsi, energy_name: str):
          * @param F Deformation gradient
          * @param mu First Lame coefficient
          * @param lambda Second Lame coefficient
-         * @return ScalarType Energy hessian
+         * @return Energy hessian
          */
         template <math::linalg::mini::CReadableVectorizedMatrix TMatrix>
         PBAT_HOST_DEVICE
@@ -187,7 +187,7 @@ def codegen(fpsi, energy_name: str):
          * @param mu First Lame coefficient
          * @param lambda Second Lame coefficient
          * @param gF Gradient w.r.t. F
-         * @return ScalarType Energy and its gradient
+         * @return Energy and its gradient
          */
         template <
             math::linalg::mini::CReadableVectorizedMatrix TMatrix, 
@@ -210,7 +210,7 @@ def codegen(fpsi, energy_name: str):
          * @param lambda Second Lame coefficient
          * @param gF Gradient w.r.t. F
          * @param HF Hessian w.r.t. F
-         * @return ScalarType Energy and its gradient and hessian
+         * @return Energy and its gradient and hessian
          */
         template <
             math::linalg::mini::CReadableVectorizedMatrix TMatrix,

source/pbat/common/ArgSort.h

@@ -26,7 +26,7 @@ namespace common {
  * @tparam FLess Callable with signature `bool(TIndex, TIndex)`
  * @param n Number of elements
  * @param less Less-than comparison function object
- * @return Eigen::Vector<TIndex, Eigen::Dynamic>
+ * @return `|n|` array of indices that would sort the input array
  */
 template <std::integral TIndex, class FLess>
 auto ArgSort(TIndex n, FLess less) -> Eigen::Vector<TIndex, Eigen::Dynamic>

source/pbat/common/Hash.h

@@ -37,7 +37,7 @@ void HashCombineAccumulate(std::size_t& seed, T const& val)
  *
  * @tparam Types Hashable types
  * @param args Arguments to hash
- * @return std::size_t Hash value
+ * @return Hash value
  */
 template <typename... Types>
 std::size_t HashCombine(const Types&... args)
@@ -61,7 +61,7 @@ struct hash<pair<pbat::Index, pbat::Index>>
     /**
      * @brief Hash function for pair of Index
      * @param inds Pair of indices
-     * @return std::size_t Hash value
+     * @return Hash value
      */
     [[maybe_unused]] std::size_t operator()(pair<pbat::Index, pbat::Index> const& inds) const
     {
@@ -78,7 +78,7 @@ struct hash<tuple<pbat::Index, pbat::Index>>
     /**
      * @brief Hash function for 2-tuple of Index
      * @param inds 2-tuple of indices
-     * @return std::size_t Hash value
+     * @return Hash value
      */
     [[maybe_unused]] std::size_t operator()(tuple<pbat::Index, pbat::Index> const& inds) const
     {
@@ -95,7 +95,7 @@ struct hash<tuple<pbat::Index, pbat::Index, pbat::Index>>
     /**
      * @brief Hash function for 3-tuple of Index
      * @param inds 3-tuple of indices
-     * @return std::size_t Hash value
+     * @return Hash value
      */
     [[maybe_unused]] std::size_t
     operator()(tuple<pbat::Index, pbat::Index, pbat::Index> const& inds) const
@@ -113,7 +113,7 @@ struct hash<pbat::IndexVector<2>>
     /**
      * @brief Hash function for pbat::IndexVector<2>
      * @param inds Index vector
-     * @return std::size_t Hash value
+     * @return Hash value
      */
     [[maybe_unused]] std::size_t operator()(pbat::IndexVector<2> const& inds) const
     {
@@ -130,7 +130,7 @@ struct hash<pbat::IndexVector<3>>
     /**
      * @brief Hash function for pbat::IndexVector<3>
      * @param inds Index vector
-     * @return std::size_t Hash value
+     * @return Hash value
      */
     [[maybe_unused]] std::size_t operator()(pbat::IndexVector<3> const& inds) const
     {

source/pbat/common/Indexing.h

@@ -28,7 +28,7 @@ namespace common {
  * @tparam R Integer range type
  * @tparam TIndex Type of the integers
  * @param sizes Range of integers
- * @return Eigen::Vector<TIndex, Eigen::Dynamic> Cumulative sum of the range
+ * @return Cumulative sum of the range
  */
 template <CIndexRange R, std::integral TIndex = std::ranges::range_value_t<R>>
 auto CumSum(R&& sizes) -> Eigen::Vector<TIndex, Eigen::Dynamic>
@@ -51,7 +51,7 @@ auto CumSum(R&& sizes) -> Eigen::Vector<TIndex, Eigen::Dynamic>
  * @param begin Range begin
  * @param end Range end (exclusive)
  * @param ncounts Upper bound on values in range
- * @return Eigen::Vector<TIndex, Eigen::Dynamic> Counts of each integer in the range
+ * @return Counts of each integer in the range
  */
 template <std::integral TIndex>
 auto Counts(auto begin, auto end, TIndex ncounts) -> Eigen::Vector<TIndex, Eigen::Dynamic>
@@ -70,7 +70,7 @@ auto Counts(auto begin, auto end, TIndex ncounts) -> Eigen::Vector<TIndex, Eigen
  * @tparam TIndex Integer type of the range
  * @param begin Start of the range (inclusive)
  * @param end End of the range (exclusive)
- * @return Eigen::Vector<TIndex, Eigen::Dynamic> Shuffled range of integers
+ * @return Shuffled range of integers
  */
 template <std::integral TIndex>
 auto Shuffle(TIndex begin, TIndex end) -> Eigen::Vector<TIndex, Eigen::Dynamic>
@@ -94,7 +94,7 @@ auto Shuffle(TIndex begin, TIndex end) -> Eigen::Vector<TIndex, Eigen::Dynamic>
  * @param begin Start of the range (inclusive)
  * @param end End of the range (exclusive)
  * @param f Predicate function to filter the range
- * @return Eigen::Vector<TIndex, Eigen::Dynamic> Filtered range of integers
+ * @return Filtered range of integers
  */
 template <
     std::integral TIndexB,
@@ -122,7 +122,7 @@ auto Filter(TIndexB begin, TIndexE end, Func&& f) -> Eigen::Vector<TIndex, Eigen
  * @tparam TIndex Integer type of the repetition vector
  * @param x Values to repeat
  * @param r Repetition vector
- * @return Eigen::Vector<TScalar, Eigen::Dynamic> Vector with repeated elements
+ * @return Vector with repeated elements
  */
 template <
     class TDerivedX,

source/pbat/common/Queue.h

@@ -31,8 +31,8 @@ class Queue
     PBAT_HOST_DEVICE Queue() : queue{}, begin{0}, end{0}, n{0} {}
     /**
      * @brief Add element to the queue
-     *
      * @param value Element to add
+     * @pre The queue is not full
      */
     PBAT_HOST_DEVICE void Push(T value)
     {
@@ -42,12 +42,13 @@ class Queue
     }
     /**
      * @brief Get the next element in the queue
-     *
-     * @return const& T Next element in the queue
+     * @return Next element in the queue
+     * @pre The queue is not empty
      */
     PBAT_HOST_DEVICE T const& Top() const { return queue[begin]; }
     /**
      * @brief Remove the next element in the queue
+     * @pre The queue is not empty
      */
     PBAT_HOST_DEVICE void Pop()
     {
@@ -57,19 +58,19 @@ class Queue
     /**
      * @brief Check if the queue is full
      *
-     * @return bool True if the queue is full
+     * @return True if the queue is full
      */
     PBAT_HOST_DEVICE bool IsFull() const { return n == Capacity(); }
     /**
      * @brief Check if the queue is empty
      *
-     * @return bool True if the queue is empty
+     * @return True if the queue is empty
      */
     PBAT_HOST_DEVICE bool IsEmpty() const { return n == 0; }
     /**
      * @brief Get the number of elements in the queue
      *
-     * @return auto Number of elements in the queue
+     * @return Number of elements in the queue
      */
     PBAT_HOST_DEVICE auto Size() const { return n; }
     /**
@@ -79,7 +80,7 @@ class Queue
     /**
      * @brief Get the maximum number of elements in the queue
      *
-     * @return constexpr auto Maximum number of elements in the queue
+     * @return Maximum number of elements in the queue
      */
     PBAT_HOST_DEVICE constexpr auto Capacity() const { return kCapacity; }
 

source/pbat/common/Stack.h

@@ -38,19 +38,19 @@ class Stack
     /**
      * @brief Remove the top element from the stack
      *
-     * @return T Top element of the stack
+     * @return Top element of the stack
      */
     PBAT_HOST_DEVICE T Pop() { return stack[--size]; }
     /**
      * @brief Get the top element of the stack
      *
-     * @return const& T Top element of the stack
+     * @return Top element of the stack
      */
     PBAT_HOST_DEVICE T const& Top() const { return stack[size - 1]; }
     /**
      * @brief Get the number of elements in the stack
      *
-     * @return auto Number of elements in the stack
+     * @return Number of elements in the stack
      */
     PBAT_HOST_DEVICE auto Size() const { return size; }
     /**
@@ -73,30 +73,30 @@ class Stack
      * @brief Access element at index i
      *
      * @note No bounds checking
-     * @pre i < size and i >= 0
+     * @pre `i < size` and `i >= 0`
      * @param i Index of the element
-     * @return T& Reference to the element at index i
+     * @return Reference to the element at index i
      */
     PBAT_HOST_DEVICE T& operator[](auto i) { return stack[i]; }
     /**
      * @brief Read-only access element at index i
      *
      * @note No bounds checking
-     * @pre i < size and i >= 0
+     * @pre `i < size` and `i >= 0`
      * @param i Index of the element
-     * @return const& T Reference to the element at index i
+     * @return Reference to the element at index i
      */
     PBAT_HOST_DEVICE T const& operator[](auto i) const { return stack[i]; }
     /**
      * @brief Pointer to the beginning of the stack
      *
-     * @return T* Pointer to the beginning of the stack
+     * @return Pointer to the beginning of the stack
      */
     PBAT_HOST_DEVICE T* begin() { return stack; }
     /**
      * @brief Pointer to the end of the stack
      *
-     * @return T* Pointer to the end of the stack
+     * @return Pointer to the end of the stack
      */
     PBAT_HOST_DEVICE T* end() { return stack + size; }
 

source/pbat/fem/Gradient.h

@@ -49,7 +49,7 @@ namespace fem {
  * \f]
  *
  * where \f$ g \f$ is the number of evaluation points.
- * 
+ *
  * @note Link to my higher-level FEM crash course doc.
  *
  * @tparam TMesh
@@ -93,20 +93,18 @@ struct Gradient
 
     /**
      * @brief Transforms this matrix-free Gradient operator into sparse compressed format.
-     * @return CSCMatrix Sparse compressed column matrix representation of the Gradient operator
+     * @return Sparse compressed column matrix representation of the Gradient operator
      */
     CSCMatrix ToMatrix() const;
 
     /**
-     * @brief
-     *
-     * @return Index
+     * @brief Returns the number columns
+     * @return Number of columns
      */
     Index InputDimensions() const { return mesh.X.cols(); }
     /**
-     * @brief
-     *
-     * @return Index
+     * @brief Returns the number of rows
+     * @return Number of rows
      */
     Index OutputDimensions() const { return kDims * eg.size(); }
 
@@ -118,8 +116,8 @@ struct Gradient
     MeshType const& mesh; ///< The finite element mesh
 
     Eigen::Ref<IndexVectorX const>
-        eg; ///< |# quad.pts.|x1 array of element indices corresponding to quadrature points
-    Eigen::Ref<MatrixX const> GNeg; ///< |# element nodes|x|# dims * # quad.pts. * # elements|
+        eg; ///< `|# quad.pts.|x1` array of element indices corresponding to quadrature points
+    Eigen::Ref<MatrixX const> GNeg; ///< `|# element nodes|x|# dims * # quad.pts. * # elements|`
                                     ///< matrix of element shape function gradients at quadrature
                                     ///< points. See ShapeFunctionGradients().
 };

source/pbat/fem/HyperElasticPotential.h

@@ -196,36 +196,36 @@ struct HyperElasticPotential
     /**
      * @brief Transforms this matrix-free hessian matrix representation into sparse compressed
      * column format.
-     * @return CSCMatrix Sparse compressed column matrix representation of the hessian operator
+     * @return Sparse compressed column matrix representation of the hessian operator
      */
     CSCMatrix ToMatrix() const;
 
     /**
      * @brief Transforms this per quadrature point gradient representation into the global gradient.
-     * @return VectorX Global gradient
+     * @return Global gradient
      */
     VectorX ToVector() const;
 
     /**
      * @brief Computes the total elastic potential
-     * @return Scalar Total elastic potential
+     * @return Total elastic potential
      */
     Scalar Eval() const;
 
     /**
-     * @brief Number of input dimensions
+     * @brief Number of columns
      *
      * Effectively the number of nodes in the system
      *
-     * @return Index
+     * @return Number of columns
      */
     Index InputDimensions() const;
     /**
-     * @brief Number of output dimensions
+     * @brief Number of rows
      *
      * Effectively the number of nodes in the system
      *
-     * @return Index
+     * @return Number of rows
      */
     Index OutputDimensions() const;
     /**