Add scalar addition and subtraction operators to all matrix classes (#1990)

Jürgen Knödlseder
1 parent ef231310
Showing 13 changed files with 252 additions and 33 deletions
include/GMatrix.hpp
include/GMatrixSparse.hpp
include/GMatrixSymmetric.hpp
pyext/GMatrix.i
pyext/GMatrixSparse.i
pyext/GMatrixSymmetric.i
src/linalg/GMatrix.cpp
src/linalg/GMatrixSparse.cpp
src/linalg/GMatrixSymmetric.cpp
test/Makefile.am
test/test_GMatrix.cpp
test/test_GMatrixSparse.cpp
test/test_GMatrixSymmetric.cpp
 /***************************************************************************
  *                      GMatrix.hpp - General matrix class                 *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2006-2014 by Juergen Knoedlseder                         *
+ *  copyright (C) 2006-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -213,11 +213,10 @@ GMatrix GMatrix::operator+(const GMatrix&amp; matrix) const
 /***********************************************************************//**
  * @brief Binary matrix scalar addition
  *
- * @param[in] double Scalar.
- * @return Result of matrix addition.
+ * @param[in] scalar Scalar.
+ * @return Matrix with @p scalar added.
  *
- * Returns the sum of the matrix with another matrix were all entries have 
- * the value of scalar. The method makes use of the unary addition operator.
+ * Returns a matrix where a @p scalar has been added to each matrix element.
  ***************************************************************************/
 inline
 GMatrix GMatrix::operator+(const double& scalar) const
@@ -249,11 +248,11 @@ GMatrix GMatrix::operator-(const GMatrix&amp; matrix) const
 /***********************************************************************//**
  * @brief Binary matrix scalar subtraction
  *
- * @param[in] double Scalar.
- * @return Result of matrix subtraction.
+ * @param[in] scalar Scalar.
+ * @return Matrix with @p scalar subtracted.
  *
- * Returns the difference of the matrix with another matrix were all entries have 
- * the value of scalar. The method makes use of the unary subtraction operator.
+ * Returns a matrix where a @p scalar has been subtracted from each matrix
+ * element.
  ***************************************************************************/
 inline
 GMatrix GMatrix::operator-(const double& scalar) const
 /***************************************************************************
  *                  GMatrixSparse.hpp - Sparse matrix class                *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2006-2014 by Juergen Knoedlseder                         *
+ *  copyright (C) 2006-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -221,11 +221,15 @@ public:
     virtual GMatrixSparse& operator=(const GMatrixSparse& matrix);
     virtual GMatrixSparse& operator=(const double& value);
     virtual GMatrixSparse  operator+(const GMatrixSparse& matrix) const;
+    virtual GMatrixSparse  operator+(const double& scalar) const;
     virtual GMatrixSparse  operator-(const GMatrixSparse& matrix) const;
+    virtual GMatrixSparse  operator-(const double& scalar) const;
     virtual GMatrixSparse  operator*(const GMatrixSparse& matrix) const;
     virtual GMatrixSparse  operator-(void) const;
     virtual GMatrixSparse& operator+=(const GMatrixSparse& matrix);
+    virtual GMatrixSparse& operator+=(const double& scalar);
     virtual GMatrixSparse& operator-=(const GMatrixSparse& matrix);
+    virtual GMatrixSparse& operator-=(const double& scalar);
     virtual GMatrixSparse& operator*=(const GMatrixSparse& matrix);
     virtual GMatrixSparse& operator*=(const double& scalar);
     virtual GMatrixSparse& operator/=(const double& scalar);
@@ -359,6 +363,23 @@ GMatrixSparse GMatrixSparse::operator+(const GMatrixSparse&amp; matrix) const
 /***********************************************************************//**
+ * @brief Binary matrix scalar addition
+ *
+ * @param[in] scalar Scalar.
+ * @return Matrix with @p scalar added.
+ *
+ * Returns a matrix where a @p scalar has been added to each matrix element.
+ ***************************************************************************/
+inline
+GMatrixSparse GMatrixSparse::operator+(const double& scalar) const
+{
+    GMatrixSparse result = *this;
+    result += scalar;
+    return result;
+}
+
+
+/***********************************************************************//**
  * @brief Binary matrix subtraction
  *
  * @param[in] matrix Matrix.
@@ -377,6 +398,24 @@ GMatrixSparse GMatrixSparse::operator-(const GMatrixSparse&amp; matrix) const
 /***********************************************************************//**
+ * @brief Binary matrix scalar subtraction
+ *
+ * @param[in] scalar Scalar.
+ * @return Matrix with @p scalar subtracted.
+ *
+ * Returns a matrix where a @p scalar has been subtracted from each matrix
+ * element.
+ ***************************************************************************/
+inline
+GMatrixSparse GMatrixSparse::operator-(const double& scalar) const
+{
+    GMatrixSparse result = *this;
+    result -= scalar;
+    return result;
+}
+
+
+/***********************************************************************//**
  * @brief Binary matrix multiplication
  *
  * @param[in] matrix Matrix.
 /***************************************************************************
  *                GMatrixSymmetric.hpp - Symmetric matrix class            *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2006-2014 by Juergen Knoedlseder                         *
+ *  copyright (C) 2006-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -88,11 +88,15 @@ public:
     virtual GMatrixSymmetric& operator=(const GMatrixSymmetric& matrix);
     virtual GMatrixSymmetric& operator=(const double& value);
     virtual GMatrixSymmetric  operator+(const GMatrixSymmetric& matrix) const;
+    virtual GMatrixSymmetric  operator+(const double& scalar) const;
     virtual GMatrixSymmetric  operator-(const GMatrixSymmetric& matrix) const;
+    virtual GMatrixSymmetric  operator-(const double& scalar) const;
     virtual GMatrix           operator*(const GMatrixSymmetric& matrix) const;
     virtual GMatrixSymmetric  operator-(void) const;
     virtual GMatrixSymmetric& operator+=(const GMatrixSymmetric& matrix);
+    virtual GMatrixSymmetric& operator+=(const double& scalar);
     virtual GMatrixSymmetric& operator-=(const GMatrixSymmetric& matrix);
+    virtual GMatrixSymmetric& operator-=(const double& scalar);
     virtual GMatrixSymmetric& operator*=(const double& scaler);
     virtual GMatrixSymmetric& operator/=(const double& scalar);
@@ -214,6 +218,23 @@ GMatrixSymmetric GMatrixSymmetric::operator+(const GMatrixSymmetric&amp; matrix) con
 /***********************************************************************//**
+ * @brief Binary matrix scalar addition
+ *
+ * @param[in] scalar Scalar.
+ * @return Matrix with @p scalar added.
+ *
+ * Returns a matrix where a @p scalar has been added to each matrix element.
+ ***************************************************************************/
+inline
+GMatrixSymmetric GMatrixSymmetric::operator+(const double& scalar) const
+{
+    GMatrixSymmetric result = *this;
+    result += scalar;
+    return result;
+}
+
+
+/***********************************************************************//**
  * @brief Binary matrix subtraction
  *
  * @param[in] matrix Matrix.
@@ -232,6 +253,24 @@ GMatrixSymmetric GMatrixSymmetric::operator-(const GMatrixSymmetric&amp; matrix) con
 /***********************************************************************//**
+ * @brief Binary matrix scalar subtraction
+ *
+ * @param[in] scalar Scalar.
+ * @return Matrix with @p scalar subtracted.
+ *
+ * Returns a matrix where a @p scalar has been subtracted from each matrix
+ * element.
+ ***************************************************************************/
+inline
+GMatrixSymmetric GMatrixSymmetric::operator-(const double& scalar) const
+{
+    GMatrixSymmetric result = *this;
+    result -= scalar;
+    return result;
+}
+
+
+/***********************************************************************//**
  * @brief Scale matrix elements
  *
  * @param[in] scalar Scale factor.
 /***************************************************************************
  *                   GMatrix.i - General Matrix class                      *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2008-2016 by Juergen Knoedlseder                         *
+ *  copyright (C) 2008-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -53,12 +53,12 @@ public:
     virtual GMatrix       operator+(const GMatrix& matrix) const;
     virtual GMatrix       operator-(const GMatrix& matrix) const;
     virtual GMatrix       operator-(void) const;
-    virtual GMatrix       operator+(const double scalar) const;
-    virtual GMatrix       operator-(const double scalar) const;
+    virtual GMatrix       operator+(const double& scalar) const;
+    virtual GMatrix       operator-(const double& scalar) const;
     virtual GMatrix&      operator+=(const GMatrix& matrix);
-    virtual GMatrix&      operator+=(const double scalar);
+    virtual GMatrix&      operator+=(const double& scalar);
     virtual GMatrix&      operator-=(const GMatrix& matrix);
-    virtual GMatrix&      operator-=(const double scalar);
+    virtual GMatrix&      operator-=(const double& scalar);
     virtual GMatrix&      operator*=(const GMatrix& matrix);
     virtual GMatrix&      operator*=(const double& scalar);
 /***************************************************************************
  *                   GMatrixSparse.i - Sparse matrix class                 *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2008-2016 by Juergen Knoedlseder                         *
+ *  copyright (C) 2008-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -55,10 +55,14 @@ public:
     // Other operators
     virtual GMatrixSparse  operator+(const GMatrixSparse& matrix) const;
+    virtual GMatrixSparse  operator+(const double& scalar) const;
     virtual GMatrixSparse  operator-(const GMatrixSparse& matrix) const;
+    virtual GMatrixSparse  operator-(const double& scalar) const;
     virtual GMatrixSparse  operator-(void) const;
     virtual GMatrixSparse& operator+=(const GMatrixSparse& matrix);
+    virtual GMatrixSparse& operator+=(const double& scalar);
     virtual GMatrixSparse& operator-=(const GMatrixSparse& matrix);
+    virtual GMatrixSparse& operator-=(const double& scalar);
     virtual GMatrixSparse& operator*=(const GMatrixSparse& matrix);
     virtual GMatrixSparse& operator*=(const double& scalar);
 /***************************************************************************
  *              GMatrixSymmetric.i - Symmetric matrix class                *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2008-2016 by Juergen Knoedlseder                         *
+ *  copyright (C) 2008-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -50,10 +50,14 @@ public:
     // Other operators
     virtual GMatrixSymmetric  operator+(const GMatrixSymmetric& matrix) const;
+    virtual GMatrixSymmetric  operator+(const double& scalar) const;
     virtual GMatrixSymmetric  operator-(const GMatrixSymmetric& matrix) const;
+    virtual GMatrixSymmetric  operator-(const double& scalar) const;
     virtual GMatrixSymmetric  operator-(void) const;
     virtual GMatrixSymmetric& operator+=(const GMatrixSymmetric& matrix);
+    virtual GMatrixSymmetric& operator+=(const double& scalar);
     virtual GMatrixSymmetric& operator-=(const GMatrixSymmetric& matrix);
+    virtual GMatrixSymmetric& operator-=(const double& scalar);
     virtual GMatrixSymmetric& operator*=(const double& scaler);
     // Implemented pure virtual base class methods
 /***************************************************************************
  *                    GMatrix.cpp - General matrix class                   *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2006-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2006-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -364,9 +364,9 @@ GMatrix&amp; GMatrix::operator+=(const GMatrix&amp; matrix)
 /***********************************************************************//**
  * @brief Unary matrix scalar addition operator
  *
- * @param[in] double Scalar.
+ * @param[in] scaler Scalar.
  *
- * This method adds a given scalar to each matrix element.
+ * Adds a @p scalar to each matrix element.
  ***************************************************************************/
 GMatrix& GMatrix::operator+=(const double& scalar)
 {
@@ -416,9 +416,9 @@ GMatrix&amp; GMatrix::operator-=(const GMatrix&amp; matrix)
 /***********************************************************************//**
  * @brief Unary matrix scalar subtraction operator
  *
- * @param[in] double Scalar.
+ * @param[in] scalar Scalar.
  *
- * This method subtracts a given scalar from each matrix element.
+ * Subtracts a @p scalar from each matrix element.
  ***************************************************************************/
 GMatrix& GMatrix::operator-=(const double& scalar)
 {
 /***************************************************************************
  *                   GMatrixSparse.cpp - Sparse matrix class               *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2006-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2006-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -572,6 +572,27 @@ GMatrixSparse&amp; GMatrixSparse::operator+=(const GMatrixSparse&amp; matrix)
 /***********************************************************************//**
+ * @brief Unary matrix scalar addition operator
+ *
+ * @param[in] scaler Scalar.
+ *
+ * Adds a @p scalar to each matrix element.
+ ***************************************************************************/
+GMatrixSparse& GMatrixSparse::operator+=(const double& scalar)
+{
+    // Perform inplace matrix addition using vectors
+    for (int col = 0; col < m_cols; ++col) {
+        GVector vector = column(col);
+        vector += scalar;
+        column(col, vector);
+    }
+
+    // Return result
+    return *this;
+}
+
+
+/***********************************************************************//**
  * @brief Unary matrix subtraction operator
  *
  * @param[in] matrix Matrix.
@@ -607,6 +628,27 @@ GMatrixSparse&amp; GMatrixSparse::operator-=(const GMatrixSparse&amp; matrix)
 /***********************************************************************//**
+ * @brief Unary matrix scalar subtraction operator
+ *
+ * @param[in] scalar Scalar.
+ *
+ * Subtracts a @p scalar from each matrix element.
+ ***************************************************************************/
+GMatrixSparse& GMatrixSparse::operator-=(const double& scalar)
+{
+    // Perform inplace matrix subtraction
+    for (int col = 0; col < m_cols; ++col) {
+        GVector vector = column(col);
+        vector -= scalar;
+        column(col, vector);
+    }
+
+    // Return result
+    return *this;
+}
+
+
+/***********************************************************************//**
  * @brief Unary matrix multiplication operator
  *
  * @param[in] matrix Matrix.
 /***************************************************************************
  *                GMatrixSymmetric.cpp - Symmetric matrix class            *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2006-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2006-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -412,6 +412,26 @@ GMatrixSymmetric&amp; GMatrixSymmetric::operator+=(const GMatrixSymmetric&amp; matrix)
 /***********************************************************************//**
+ * @brief Unary matrix scalar addition operator
+ *
+ * @param[in] scaler Scalar.
+ *
+ * Adds a @p scalar to each matrix element.
+ ***************************************************************************/
+GMatrixSymmetric& GMatrixSymmetric::operator+=(const double& scalar)
+{
+    // Add all matrix elements
+    double* dst = m_data;
+    for (int i = 0; i < m_elements; ++i) {
+        *dst++ += scalar;
+    }
+
+    // Return result
+    return *this;
+}
+
+
+/***********************************************************************//**
  * @brief Unary matrix subtraction operator
  *
  * @param[in] matrix Matrix.
@@ -443,6 +463,26 @@ GMatrixSymmetric&amp; GMatrixSymmetric::operator-=(const GMatrixSymmetric&amp; matrix)
 }
+/***********************************************************************//**
+ * @brief Unary matrix scalar subtraction operator
+ *
+ * @param[in] scalar Scalar.
+ *
+ * Subtracts a @p scalar from each matrix element.
+ ***************************************************************************/
+GMatrixSymmetric& GMatrixSymmetric::operator-=(const double& scalar)
+{
+    // Add all matrix elements
+    double* dst = m_data;
+    for (int i = 0; i < m_elements; ++i) {
+        *dst++ -= scalar;
+    }
+
+    // Return result
+    return *this;
+}
+
+
 /*==========================================================================
  =                                                                         =
  =                              Public methods                             =
@@ -205,6 +205,7 @@ all-local:
 # Files to be removed in build directory
 clean-local:
 	rm -rf $(top_builddir)/test/*.fits
+	rm -rf $(top_builddir)/test/*.csv
 	rm -rf $(top_builddir)/test/*.log
 	rm -rf $(top_builddir)/test/*.html
 	rm -rf $(top_builddir)/test/*.xml
 /***************************************************************************
  *             test_GMatrix.cpp - Test generic matrix class                *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2006-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2006-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -540,8 +540,8 @@ void TestGMatrix::matrix_arithmetics(void)
                 "Unexpected result matrix:\n"+test.print());
 	// GMatrix += 3.0
-        test = m_test;
-        test += 3.0;
+    test = m_test;
+    test += 3.0;
     test_assert(check_matrix(m_test), "Test source matrix");
     test_assert(check_matrix(test, 1.0, 3.0), "Test GMatrix + 3.0",
                 "Unexpected result matrix:\n"+test.print());
@@ -553,13 +553,12 @@ void TestGMatrix::matrix_arithmetics(void)
                 "Unexpected result matrix:\n"+test.print());
 	// GMatrix -= 3.0
-        test = m_test;
-        test -= 3.0;
+    test = m_test;
+    test -= 3.0;
     test_assert(check_matrix(m_test), "Test source matrix");
     test_assert(check_matrix(test, 1.0, -3.0), "Test GMatrix -= 3.0",
                 "Unexpected result matrix:\n"+test.print());
-    
     // Test invalid matrix addition
     test_try("Test invalid matrix addition");
     try {
 /***************************************************************************
  *            test_GMatrixSparse.cpp - Test sparse matrix class            *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2006-2016 by Juergen Knoedlseder                         *
+ *  copyright (C) 2006-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -861,6 +861,32 @@ void TestGMatrixSparse::matrix_arithmetics(void)
     test_assert(check_matrix(test, 1.0/3.0, 0.0), "Test GMatrixSparse / 3.0",
                 "Unexpected result matrix:\n"+test.print());
+	// GMatrixSparse + 3.0
+	test = m_test + 3.0;
+    test_assert(check_matrix(m_test), "Test source matrix");
+    test_assert(check_matrix(test, 1.0, 3.0), "Test GMatrixSparse + 3.0",
+                "Unexpected result matrix:\n"+test.print());
+
+	// GMatrixSparse += 3.0
+    test = m_test;
+    test += 3.0;
+    test_assert(check_matrix(m_test), "Test source matrix");
+    test_assert(check_matrix(test, 1.0, 3.0), "Test GMatrixSparse + 3.0",
+                "Unexpected result matrix:\n"+test.print());
+    
+	// GMatrixSparse - 5.0
+	test = m_test - 5.0;
+    test_assert(check_matrix(m_test), "Test source matrix");
+    test_assert(check_matrix(test, 1.0, -5.0), "Test GMatrixSparse -= 5.0",
+                "Unexpected result matrix:\n"+test.print());
+
+	// GMatrixSparse -= 3.0
+    test = m_test;
+    test -= 3.0;
+    test_assert(check_matrix(m_test), "Test source matrix");
+    test_assert(check_matrix(test, 1.0, -3.0), "Test GMatrixSparse -= 3.0",
+                "Unexpected result matrix:\n"+test.print());
+
     // Test invalid matrix addition
     test_try("Test invalid matrix addition");
     try {
 /***************************************************************************
  *          test_GMatrixSymmetric.cpp - Test symmetric matrix class        *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2006-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2006-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -537,6 +537,32 @@ void TestGMatrixSymmetric::matrix_arithmetics(void)
     test_assert(check_matrix(test, 1.0/3.0, 0.0), "Test GMatrixSymmetric / 3.0",
                 test.print());
+	// GMatrixSymmetric + 3.0
+	test = m_test + 3.0;
+    test_assert(check_matrix(m_test), "Test source matrix");
+    test_assert(check_matrix(test, 1.0, 3.0), "Test GMatrixSymmetric + 3.0",
+                "Unexpected result matrix:\n"+test.print());
+
+	// GMatrixSymmetric += 3.0
+    test = m_test;
+    test += 3.0;
+    test_assert(check_matrix(m_test), "Test source matrix");
+    test_assert(check_matrix(test, 1.0, 3.0), "Test GMatrixSymmetric + 3.0",
+                "Unexpected result matrix:\n"+test.print());
+    
+	// GMatrixSymmetric - 5.0
+	test = m_test - 5.0;
+    test_assert(check_matrix(m_test), "Test source matrix");
+    test_assert(check_matrix(test, 1.0, -5.0), "Test GMatrixSymmetric -= 5.0",
+                "Unexpected result matrix:\n"+test.print());
+
+	// GMatrixSymmetric -= 3.0
+    test = m_test;
+    test -= 3.0;
+    test_assert(check_matrix(m_test), "Test source matrix");
+    test_assert(check_matrix(test, 1.0, -3.0), "Test GMatrixSymmetric -= 3.0",
+                "Unexpected result matrix:\n"+test.print());
+
     // Test invalid matrix addition
     test_try("Test invalid matrix addition");
     try {