From 5ad6b3b1bbd4d1c8d0e7cf38bc6dc1d29a978381 Mon Sep 17 00:00:00 2001
From: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Date: Sat, 16 Nov 2024 21:02:52 +0200
Subject: ipa: libipa: vector: Add sum() function

Add a function to calculate the sum of a vector. It will be useful for
algorithms.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Milan Zamazal <mzamazal@redhat.com>
---
 src/ipa/libipa/vector.cpp | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'src/ipa/libipa/vector.cpp')

diff --git a/src/ipa/libipa/vector.cpp b/src/ipa/libipa/vector.cpp
index d29c1642..8019f8cf 100644
--- a/src/ipa/libipa/vector.cpp
+++ b/src/ipa/libipa/vector.cpp
@@ -289,6 +289,18 @@ namespace ipa {
  * \return The length of the vector
  */
 
+/**
+ * \fn Vector::sum() const
+ * \brief Calculate the sum of all the vector elements
+ * \tparam R The type of the sum
+ *
+ * The type R of the sum defaults to the type T of the elements, but can be set
+ * explicitly to use a different type in case the type T would risk
+ * overflowing.
+ *
+ * \return The sum of all the vector elements
+ */
+
 /**
  * \fn Vector<T, Rows> operator*(const Matrix<T, Rows, Cols> &m, const Vector<T, Cols> &v)
  * \brief Multiply a matrix by a vector
-- 
cgit v1.2.1