[v4,05/17] ipa: libipa: vector: Rename the dot product operator*() to dot()
diff mbox series

Message ID 20241119121928.30939-6-laurent.pinchart@ideasonboard.com
State New
Headers show
Series
  • Improve linear algebra helpers in libipa
Related show

Commit Message

Laurent Pinchart Nov. 19, 2024, 12:19 p.m. UTC 
The Vector class defines a set of arithmetic operators between two
vectors or a vector and a scalar. All the operators perform element-wise
operations, except for the operator*() that computes the dot product.
This is inconsistent and confusing. Replace the operator with a dot()
function.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Milan Zamazal <mzamazal@redhat.com>
---
 src/ipa/libipa/vector.cpp | 14 +++++++-------
 src/ipa/libipa/vector.h   | 16 ++++++++--------
 2 files changed, 15 insertions(+), 15 deletions(-)

Patch
diff mbox series 

diff --git a/src/ipa/libipa/vector.cpp b/src/ipa/libipa/vector.cpp
index a9779fa2b8e2..473e6d8bad01 100644
--- a/src/ipa/libipa/vector.cpp
+++ b/src/ipa/libipa/vector.cpp
@@ -91,13 +91,6 @@  namespace ipa {
  * \return The sum of the two vectors
  */
 
-/**
- * \fn Vector::operator*(const Vector<T, Rows> &other) const
- * \brief Compute the dot product
- * \param[in] other The other vector
- * \return The dot product of the two vectors
- */
-
 /**
  * \fn Vector::operator*(T factor) const
  * \brief Multiply the vector by a scalar
@@ -112,6 +105,13 @@  namespace ipa {
  * \return The vector divided by \a factor
  */
 
+/**
+ * \fn Vector::dot(const Vector<T, Rows> &other) const
+ * \brief Compute the dot product
+ * \param[in] other The other vector
+ * \return The dot product of the two vectors
+ */
+
 /**
  * \fn constexpr T &Vector::x()
  * \brief Convenience function to access the first element of the vector
diff --git a/src/ipa/libipa/vector.h b/src/ipa/libipa/vector.h
index 1022550e6170..b4eb19707063 100644
--- a/src/ipa/libipa/vector.h
+++ b/src/ipa/libipa/vector.h
@@ -86,14 +86,6 @@  public:
 		return ret;
 	}
 
-	constexpr T operator*(const Vector<T, Rows> &other) const
-	{
-		T ret = 0;
-		for (unsigned int i = 0; i < Rows; i++)
-			ret += data_[i] * other[i];
-		return ret;
-	}
-
 	constexpr Vector<T, Rows> operator*(T factor) const
 	{
 		Vector<T, Rows> ret;
@@ -110,6 +102,14 @@  public:
 		return ret;
 	}
 
+	constexpr T dot(const Vector<T, Rows> &other) const
+	{
+		T ret = 0;
+		for (unsigned int i = 0; i < Rows; i++)
+			ret += data_[i] * other[i];
+		return ret;
+	}
+
 #ifndef __DOXYGEN__
 	template<bool Dependent = false, typename = std::enable_if_t<Dependent || Rows >= 1>>
 #endif /* __DOXYGEN__ */