Add missing operators and add corresponding Python unit tests.

Jürgen Knödlseder
1 parent e4936932
Showing 5 changed files with 272 additions and 22 deletions
include/GEnergy.hpp
include/GTime.hpp
pyext/GEnergy.i
pyext/GTime.i
test/test_GObservation.py
@@ -48,17 +48,17 @@
 class GEnergy : public GBase {
     // Operator friends
-    friend GEnergy operator+ (const GEnergy &a, const GEnergy &b);
-    friend GEnergy operator- (const GEnergy &a, const GEnergy &b);
-    friend GEnergy operator* (const double &a, const GEnergy &b);
-    friend GEnergy operator* (const GEnergy &a, const double &b);
-    friend GEnergy operator/ (const GEnergy &a, const double &b);
-    friend bool    operator== (const GEnergy &a, const GEnergy &b);
-    friend bool    operator!= (const GEnergy &a, const GEnergy &b);
-    friend bool    operator< (const GEnergy &a, const GEnergy &b);
-    friend bool    operator<= (const GEnergy &a, const GEnergy &b);
-    friend bool    operator> (const GEnergy &a, const GEnergy &b);
-    friend bool    operator>= (const GEnergy &a, const GEnergy &b);
+    friend GEnergy operator+(const GEnergy &a, const GEnergy &b);
+    friend GEnergy operator-(const GEnergy &a, const GEnergy &b);
+    friend GEnergy operator*(const double &a, const GEnergy &b);
+    friend GEnergy operator*(const GEnergy &a, const double &b);
+    friend GEnergy operator/(const GEnergy &a, const double &b);
+    friend bool    operator==(const GEnergy &a, const GEnergy &b);
+    friend bool    operator!=(const GEnergy &a, const GEnergy &b);
+    friend bool    operator<(const GEnergy &a, const GEnergy &b);
+    friend bool    operator<=(const GEnergy &a, const GEnergy &b);
+    friend bool    operator>(const GEnergy &a, const GEnergy &b);
+    friend bool    operator>=(const GEnergy &a, const GEnergy &b);
 public:
     // Constructors and destructors
@@ -71,6 +71,8 @@ public:
     GEnergy& operator=(const GEnergy& eng);
     GEnergy& operator+=(const GEnergy& eng);
     GEnergy& operator-=(const GEnergy& eng);
+    GEnergy& operator*=(const double& scale);
+    GEnergy& operator/=(const double& scale);
     void     operator()(const double& eng, const std::string& unit);
     double   operator()(const std::string& unit) const;
@@ -129,8 +131,11 @@ std::string GEnergy::classname(void) const
 }
-/***************************************************************************
- *                               Inline friends                            *
+/***********************************************************************//**
+ * @brief Energy unary addition operator
+ *
+ * @param[in] eng Energy.
+ * @return Sum of energies.
  ***************************************************************************/
 inline
 GEnergy& GEnergy::operator+=(const GEnergy& eng)
@@ -139,6 +144,14 @@ GEnergy&amp; GEnergy::operator+=(const GEnergy&amp; eng)
     m_has_log10  = false;
     return *this;
 }
+
+
+/***********************************************************************//**
+ * @brief Energy unary differnce operator
+ *
+ * @param[in] eng Energy.
+ * @return Difference of energies.
+ ***************************************************************************/
 inline
 GEnergy& GEnergy::operator-=(const GEnergy& eng)
 {
@@ -146,6 +159,45 @@ GEnergy&amp; GEnergy::operator-=(const GEnergy&amp; eng)
     m_has_log10  = false;
     return *this;
 }
+
+
+/***********************************************************************//**
+ * @brief Energy unary multiplication operator
+ *
+ * @param[in] scale Scale.
+ * @return Energy multiplied with scale.
+ ***************************************************************************/
+inline
+GEnergy& GEnergy::operator*=(const double& scale)
+{
+    m_energy    *= scale;
+    m_has_log10  = false;
+    return *this;
+}
+
+
+/***********************************************************************//**
+ * @brief Energy unary division operator
+ *
+ * @param[in] scale Scale.
+ * @return Energy divided by scale.
+ ***************************************************************************/
+inline
+GEnergy& GEnergy::operator/=(const double& scale)
+{
+    m_energy    /= scale;
+    m_has_log10  = false;
+    return *this;
+}
+
+
+/***********************************************************************//**
+ * @brief Energy addition operator friend
+ *
+ * @param[in] a First energy.
+ * @param[in] b Second energy.
+ * @return Sum of energies.
+ ***************************************************************************/
 inline
 GEnergy operator+(const GEnergy& a, const GEnergy& b)
 {
@@ -153,6 +205,15 @@ GEnergy operator+(const GEnergy&amp; a, const GEnergy&amp; b)
     result.m_energy = a.m_energy + b.m_energy;
     return result;
 }
+
+
+/***********************************************************************//**
+ * @brief Energy subtraction operator friend
+ *
+ * @param[in] a First energy.
+ * @param[in] b Second energy.
+ * @return Difference of energies.
+ ***************************************************************************/
 inline
 GEnergy operator-(const GEnergy& a, const GEnergy& b)
 {
@@ -160,6 +221,15 @@ GEnergy operator-(const GEnergy&amp; a, const GEnergy&amp; b)
     result.m_energy = a.m_energy - b.m_energy;
     return result;
 }
+
+
+/***********************************************************************//**
+ * @brief Energy multiplication operator friend
+ *
+ * @param[in] a Scale.
+ * @param[in] b Energy.
+ * @return Energy multiplied by scale.
+ ***************************************************************************/
 inline
 GEnergy operator*(const double& a, const GEnergy& b)
 {
@@ -167,6 +237,15 @@ GEnergy operator*(const double&amp; a, const GEnergy&amp; b)
     result.m_energy = a * b.m_energy;
     return result;
 }
+
+
+/***********************************************************************//**
+ * @brief Energy multiplication operator friend
+ *
+ * @param[in] a Energy.
+ * @param[in] b Scale.
+ * @return Energy multiplied by scale.
+ ***************************************************************************/
 inline
 GEnergy operator*(const GEnergy& a, const double& b)
 {
@@ -174,6 +253,15 @@ GEnergy operator*(const GEnergy&amp; a, const double&amp; b)
     result.m_energy = b * a.m_energy;
     return result;
 }
+
+
+/***********************************************************************//**
+ * @brief Energy division operator friend
+ *
+ * @param[in] a Energy.
+ * @param[in] b Scale.
+ * @return Energy divided by scale.
+ ***************************************************************************/
 inline
 GEnergy operator/(const GEnergy& a, const double& b)
 {
@@ -181,31 +269,85 @@ GEnergy operator/(const GEnergy&amp; a, const double&amp; b)
     result.m_energy = a.m_energy / b;
     return result;
 }
+
+
+/***********************************************************************//**
+ * @brief Energy equality operator friend
+ *
+ * @param[in] a First energy.
+ * @param[in] b Second energy.
+ * @return True if both energies are equal.
+ ***************************************************************************/
 inline
 bool operator==(const GEnergy &a, const GEnergy &b)
 {
     return (a.m_energy == b.m_energy);
 }
+
+
+/***********************************************************************//**
+ * @brief Energy non-equality operator friend
+ *
+ * @param[in] a First energy.
+ * @param[in] b Second energy.
+ * @return True if both energies are not equal.
+ ***************************************************************************/
 inline
 bool operator!=(const GEnergy &a, const GEnergy &b)
 {
     return (a.m_energy != b.m_energy);
 }
+
+
+/***********************************************************************//**
+ * @brief Energy smaller than operator friend
+ *
+ * @param[in] a First energy.
+ * @param[in] b Second energy.
+ * @return True if first energy is smaller than second energy.
+ ***************************************************************************/
 inline
 bool operator<(const GEnergy &a, const GEnergy &b)
 {
     return (a.m_energy < b.m_energy);
 }
+
+
+/***********************************************************************//**
+ * @brief Energy smaller than or equal to operator friend
+ *
+ * @param[in] a First energy.
+ * @param[in] b Second energy.
+ * @return True if first energy is smaller than or equal to second energy.
+ ***************************************************************************/
 inline
 bool operator<=(const GEnergy &a, const GEnergy &b)
 {
     return (a.m_energy <= b.m_energy);
 }
+
+
+/***********************************************************************//**
+ * @brief Energy larger than operator friend
+ *
+ * @param[in] a First energy.
+ * @param[in] b Second energy.
+ * @return True if first energy is larger than second energy.
+ ***************************************************************************/
 inline
 bool operator>(const GEnergy &a, const GEnergy &b)
 {
     return (a.m_energy > b.m_energy);
 }
+
+
+/***********************************************************************//**
+ * @brief Energy larger than or equal to operator friend
+ *
+ * @param[in] a First energy.
+ * @param[in] b Second energy.
+ * @return True if first energy is larger than or equal to second energy.
+ ***************************************************************************/
 inline
 bool operator>=(const GEnergy &a, const GEnergy &b)
 {
@@ -74,6 +74,10 @@ public:
     // Operators
     GTime& operator=(const GTime& time);
+    GTime& operator+=(const GTime& time);
+    GTime& operator-=(const GTime& time);
+    GTime& operator*=(const double& scale);
+    GTime& operator/=(const double& scale);
     // Methods
     void           clear(void);
@@ -175,6 +179,62 @@ int GTime::days_in_year(const int&amp; year) const
 /***********************************************************************//**
+ * @brief Time unary addition operator
+ *
+ * @param[in] time Time.
+ * @return Sum of times.
+ ***************************************************************************/
+inline
+GTime& GTime::operator+=(const GTime& time)
+{
+    m_time += time.m_time;
+    return *this;
+}
+
+
+/***********************************************************************//**
+ * @brief Time unary subtraction operator
+ *
+ * @param[in] time Time.
+ * @return Difference of times.
+ ***************************************************************************/
+inline
+GTime& GTime::operator-=(const GTime& time)
+{
+    m_time -= time.m_time;
+    return *this;
+}
+
+
+/***********************************************************************//**
+ * @brief Time unary multiplication operator
+ *
+ * @param[in] scale Scale.
+ * @return Time multiplied by scale.
+ ***************************************************************************/
+inline
+GTime& GTime::operator*=(const double& scale)
+{
+    m_time *= scale;
+    return *this;
+}
+
+
+/***********************************************************************//**
+ * @brief Time unary division operator
+ *
+ * @param[in] scale Scale.
+ * @return Time divided by scale.
+ ***************************************************************************/
+inline
+GTime& GTime::operator/=(const double& scale)
+{
+    m_time /= scale;
+    return *this;
+}
+
+
+/***********************************************************************//**
  * @brief Time addition operator friend
  *
  * @param[in] a First time.
@@ -230,7 +290,7 @@ GTime operator*(const double&amp; s, const GTime&amp; time)
  * @return Multiplied time.
  ***************************************************************************/
 inline
-GTime operator* (const GTime& time, const double& s)
+GTime operator*(const GTime& time, const double& s)
 {
     GTime result;
     result.m_time = s * time.m_time;
@@ -51,6 +51,7 @@ public:
     // Operators
     GEnergy& operator+=(const GEnergy& eng);
     GEnergy& operator-=(const GEnergy& eng);
+    GEnergy& operator*=(const double& scale);
     void     operator()(const double& eng, const std::string& unit);
     double   operator()(const std::string& unit) const;
@@ -105,6 +106,16 @@ public:
     GEnergy __truediv__(const double& factor) const {
         return ((*self) / factor);
     }
+    // Python 2.x operator/=
+    GEnergy __idiv__(const double& scale) {
+        self->operator/=(scale);
+        return (*self);
+    }
+    // Python 3.x operator/=
+    GEnergy __itruediv__(const double& scale) {
+        self->operator/=(scale);
+        return (*self);
+    }
     bool __eq__(const GEnergy& eng) const {
         return ((*self) == eng);
     }
@@ -44,6 +44,11 @@ public:
     GTime(const double& time, const GTimeReference& ref);
     virtual ~GTime(void);
+    // Operators
+    GTime& operator+=(const GTime& time);
+    GTime& operator-=(const GTime& time);
+    GTime& operator*=(const double& scale);
+
     // Methods
     void           clear(void);
     GTime*         clone(void) const;
@@ -85,6 +90,16 @@ public:
     GTime __truediv__(const double& factor) const {
         return ((*self) / factor);
     }
+    // Python 2.x operator/=
+    GTime __idiv__(const double& scale) {
+        self->operator/=(scale);
+        return (*self);
+    }
+    // Python 3.x operator/=
+    GTime __itruediv__(const double& scale) {
+        self->operator/=(scale);
+        return (*self);
+    }
     bool __eq__(const GTime& time) const {
         return ((*self) == time);
     }
@@ -17,15 +17,13 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # ==========================================================================
-from gammalib import *
-from math import *
-import os
+import gammalib
 # ========================================== #
 # Test class for GammaLib observation module #
 # ========================================== #
-class Test(GPythonTestSuite):
+class Test(gammalib.GPythonTestSuite):
     """
     Test class for GammaLib observation module.
     """
@@ -35,7 +33,7 @@ class Test(GPythonTestSuite):
         Constructor.
         """
         # Call base class constructor
-        GPythonTestSuite.__init__(self)
+        gammalib.GPythonTestSuite.__init__(self)
         # Return
         return
@@ -61,8 +59,8 @@ class Test(GPythonTestSuite):
         Test GEnergy class.
         """
         # Setup energies
-        energy    = GEnergy(3.0, "TeV")
-        energy_b  = energy.copy()
+        energy   = gammalib.GEnergy(3.0, "TeV")
+        energy_b = energy.copy()
         # Unary addition operator
         energy += energy_b
@@ -72,6 +70,14 @@ class Test(GPythonTestSuite):
         energy -= energy_b
         self.test_value(energy.TeV(), 3.0);
+        # Unary multiplication operator
+        energy *= 2.0
+        self.test_value(energy.TeV(), 6.0);
+
+        # Unary division operator
+        energy /= 2.0
+        self.test_value(energy.TeV(), 3.0);
+
         # Binary addition operator
         energy = energy + energy_b
         self.test_value(energy.TeV(), 6.0);
@@ -98,9 +104,25 @@ class Test(GPythonTestSuite):
         Test GTime class.
         """
         # Setup times
-        time   = GTime(3.0)
+        time   = gammalib.GTime(3.0)
         time_b = time.copy()
+        # Unary addition operator
+        time += time_b
+        self.test_value(time.secs(), 6.0);
+
+        # Unary subtraction operator
+        time -= time_b
+        self.test_value(time.secs(), 3.0);
+
+        # Unary multiplication operator
+        time *= 2.0
+        self.test_value(time.secs(), 6.0);
+
+        # Unary division operator
+        time /= 2.0
+        self.test_value(time.secs(), 3.0);
+        
         # Binary addition operator
         time = time + time_b
         self.test_value(time.secs(), 6.0);