Remove index range check from operator[] and declare operator inline. Add at() m…

…ethod for index range check. Put size() method inline.

Remove index range check from operator[] and declare operator inline. Add at() m…
…ethod for index range check. Put size() method inline.
Jürgen Knödlseder
1 parent 74b633f0
Showing 9 changed files with 290 additions and 181 deletions
include/GModelSpatial.hpp
include/GModelSpectral.hpp
include/GModelTemporal.hpp
pyext/GModelSpatial.i
pyext/GModelSpectral.i
pyext/GModelTemporal.i
src/model/GModelSpatial.cpp
src/model/GModelSpectral.cpp
src/model/GModelTemporal.cpp
@@ -97,8 +97,10 @@ public:
     virtual std::string    print(const GChatter& chatter = NORMAL) const = 0;
     // Methods
-    int  size(void) const;
-    void autoscale(void);
+    GModelPar&       at(const int& index);
+    const GModelPar& at(const int& index) const;
+    int              size(void) const;
+    void             autoscale(void);
 protected:
     // Protected methods
@@ -112,6 +114,36 @@ protected:
 /***********************************************************************//**
+ * @brief Returns model parameter
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
+ *
+ * Returns model parameter without @p index range checking.
+ ***************************************************************************/
+inline
+GModelPar& GModelSpatial::operator[](const int& index)
+{
+    return *(m_pars[index]);
+}
+
+
+/***********************************************************************//**
+ * @brief Returns model parameter (const version)
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
+ *
+ * Returns model parameter without @p index range checking.
+ ***************************************************************************/
+inline
+const GModelPar& GModelSpatial::operator[](const int& index) const
+{
+    return *(m_pars[index]);
+}
+
+
+/***********************************************************************//**
  * @brief Return number of parameters
  *
  * @return Number of parameters in spatial model component.
 /***************************************************************************
  *         GModelSpectral.hpp - Abstract spectral model base class         *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2009-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2009-2014 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -97,8 +97,10 @@ public:
     virtual std::string     print(const GChatter& chatter = NORMAL) const = 0;
     // Methods
-    int  size(void) const;
-    void autoscale(void);
+    GModelPar&       at(const int& index);
+    const GModelPar& at(const int& index) const;
+    int              size(void) const;
+    void             autoscale(void);
 protected:
     // Protected methods
@@ -110,4 +112,48 @@ protected:
     std::vector<GModelPar*> m_pars;  //!< Parameter pointers
 };
+
+/***********************************************************************//**
+ * @brief Returns model parameter
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
+ *
+ * Returns model parameter without @p index range checking.
+ ***************************************************************************/
+inline
+GModelPar& GModelSpectral::operator[](const int& index)
+{
+    return *(m_pars[index]);
+}
+
+
+/***********************************************************************//**
+ * @brief Returns model parameter (const version)
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
+ *
+ * Returns model parameter without @p index range checking.
+ ***************************************************************************/
+inline
+const GModelPar& GModelSpectral::operator[](const int& index) const
+{
+    return *(m_pars[index]);
+}
+
+
+/***********************************************************************//**
+ * @brief Return number of parameters
+ *
+ * @return Number of parameters in spectral model component.
+ *
+ * Returns the number of parameters in the spectral model component.
+ ***************************************************************************/
+inline
+int GModelSpectral::size(void) const
+{
+    return (m_pars.size());
+}
+
 #endif /* GMODELSPECTRAL_HPP */
 /***************************************************************************
  *         GModelTemporal.hpp - Abstract temporal model base class         *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2009-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2009-2014 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -76,8 +76,10 @@ public:
     virtual std::string     print(const GChatter& chatter = NORMAL) const = 0;
     // Methods
-    int  size(void) const;
-    void autoscale(void);
+    GModelPar&       at(const int& index);
+    const GModelPar& at(const int& index) const;
+    int              size(void) const;
+    void             autoscale(void);
 protected:
     // Protected methods
@@ -89,4 +91,48 @@ protected:
     std::vector<GModelPar*> m_pars;  //!< Parameter pointers
 };
+
+/***********************************************************************//**
+ * @brief Returns model parameter
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
+ *
+ * Returns model parameter without @p index range checking.
+ ***************************************************************************/
+inline
+GModelPar& GModelTemporal::operator[](const int& index)
+{
+    return *(m_pars[index]);
+}
+
+
+/***********************************************************************//**
+ * @brief Returns model parameter (const version)
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
+ *
+ * Returns model parameter without @p index range checking.
+ ***************************************************************************/
+inline
+const GModelPar& GModelTemporal::operator[](const int& index) const
+{
+    return *(m_pars[index]);
+}
+
+
+/***********************************************************************//**
+ * @brief Return number of parameters
+ *
+ * @return Number of parameters in temporal model component.
+ *
+ * Returns the number of parameters in the temporal model component.
+ ***************************************************************************/
+inline
+int GModelTemporal::size(void) const
+{
+    return (m_pars.size());
+}
+
 #endif /* GMODELTEMPORAL_HPP */
@@ -57,8 +57,9 @@ public:
     virtual void           write(GXmlElement& xml) const = 0;
     // Methods
-    int  size(void) const;
-    void autoscale(void);
+    GModelPar& at(const int& index);
+    int        size(void) const;
+    void       autoscale(void);
 };
@@ -61,8 +61,9 @@ public:
     virtual void            write(GXmlElement& xml) const = 0;
     // Methods
-    int  size(void) const;
-    void autoscale(void);
+    GModelPar& at(const int& index);
+    int        size(void) const;
+    void       autoscale(void);
 };
@@ -55,8 +55,9 @@ public:
     virtual void            write(GXmlElement& xml) const = 0;
     // Methods
-    int  size(void) const;
-    void autoscale(void);
+    GModelPar& at(const int& index);
+    int        size(void) const;
+    void       autoscale(void);
 };
 /***************************************************************************
  *          GModelSpatial.cpp - Abstract spatial model base class          *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2009-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2009-2014 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -32,8 +32,8 @@
 #include "GModelSpatial.hpp"
 /* __ Method name definitions ____________________________________________ */
-#define G_ACCESS1                           "GModelSpatial::operator[](int&)"
-#define G_ACCESS2                   "GModelSpatial::operator[](std::string&)"
+#define G_ACCESS                    "GModelSpatial::operator[](std::string&)"
+#define G_AT                             "GModelPar& GModelSpatial::at(int&)"
 /* __ Macros _____________________________________________________________ */
@@ -126,56 +126,6 @@ GModelSpatial&amp; GModelSpatial::operator= (const GModelSpatial&amp; model)
 /***********************************************************************//**
- * @brief Return model parameter
- *
- * @param[in] index Parameter index [0,...,size()-1].
- * @return Model parameter reference.
- *
- * @exception GException::out_of_range
- *            Parameter index is out of range.
- *
- * Returns reference to the model parameter of specified @p index.
- ***************************************************************************/
-GModelPar& GModelSpatial::operator[](const int& index)
-{
-    // Compile option: raise exception if index is out of range
-    #if defined(G_RANGE_CHECK)
-    if (index < 0 || index >= size()) {
-        throw GException::out_of_range(G_ACCESS1, index, 0, size()-1);
-    }
-    #endif
-
-    // Return reference
-    return *(m_pars[index]);
-}
-
-
-/***********************************************************************//**
- * @brief Returns model parameter (const version)
- *
- * @param[in] index Parameter index [0,...,size()-1].
- * @return Model parameter reference.
- *
- * @exception GException::out_of_range
- *            Parameter index is out of range.
- *
- * Returns reference to the model parameter of specified @p index.
- ***************************************************************************/
-const GModelPar& GModelSpatial::operator[](const int& index) const
-{
-    // Compile option: raise exception if index is out of range
-    #if defined(G_RANGE_CHECK)
-    if (index < 0 || index >= size()) {
-        throw GException::out_of_range(G_ACCESS1, index, 0, size()-1);
-    }
-    #endif
-
-    // Return reference
-    return *(m_pars[index]);
-}
-
-
-/***********************************************************************//**
  * @brief Returns model parameter
  *
  * @param[in] name Parameter name.
@@ -198,7 +148,7 @@ GModelPar&amp; GModelSpatial::operator[](const std::string&amp; name)
     // Throw exception if parameter name was not found
     if (index >= size()) {
-        throw GException::par_not_found(G_ACCESS2, name);
+        throw GException::par_not_found(G_ACCESS, name);
     }
     // Return reference
@@ -229,7 +179,7 @@ const GModelPar&amp; GModelSpatial::operator[](const std::string&amp; name) const
     // Throw exception if parameter name was not found
     if (index >= size()) {
-        throw GException::par_not_found(G_ACCESS2, name);
+        throw GException::par_not_found(G_ACCESS, name);
     }
     // Return reference
@@ -244,6 +194,52 @@ const GModelPar&amp; GModelSpatial::operator[](const std::string&amp; name) const
  ==========================================================================*/
 /***********************************************************************//**
+ * @brief Returns model parameter
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
+ *
+ * @exception GException::out_of_range
+ *            Parameter index is out of range.
+ *
+ * Returns model parameter with @p index range checking.
+ ***************************************************************************/
+GModelPar& GModelSpatial::at(const int& index)
+{
+    // Compile option: raise exception if index is out of range
+    if (index < 0 || index >= size()) {
+        throw GException::out_of_range(G_AT, index, 0, size()-1);
+    }
+
+    // Return reference
+    return *(m_pars[index]);
+}
+
+
+/***********************************************************************//**
+ * @brief Returns model parameter (const version)
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
+ *
+ * @exception GException::out_of_range
+ *            Parameter index is out of range.
+ *
+ * Returns model parameter with @p index range checking.
+ ***************************************************************************/
+const GModelPar& GModelSpatial::at(const int& index) const
+{
+    // Compile option: raise exception if index is out of range
+    if (index < 0 || index >= size()) {
+        throw GException::out_of_range(G_AT, index, 0, size()-1);
+    }
+
+    // Return reference
+    return *(m_pars[index]);
+}
+
+
+/***********************************************************************//**
  * @brief Autoscale parameters
  *
  * Sets the scale factors for all parameters so that the values are unity.
 /***************************************************************************
  *         GModelSpectral.cpp - Abstract spectral model base class         *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2009-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2009-2014 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -32,8 +32,8 @@
 #include "GModelSpectral.hpp"
 /* __ Method name definitions ____________________________________________ */
-#define G_ACCESS1                          "GModelSpectral::operator[](int&)"
-#define G_ACCESS2                  "GModelSpectral::operator[](std::string&)"
+#define G_ACCESS                   "GModelSpectral::operator[](std::string&)"
+#define G_AT                            "GModelPar& GModelSpectral::at(int&)"
 /* __ Macros _____________________________________________________________ */
@@ -102,8 +102,9 @@ GModelSpectral::~GModelSpectral(void)
  * @brief Assignment operator
  *
  * @param[in] model Spectral model.
+ * @return Spectral model.
  ***************************************************************************/
-GModelSpectral& GModelSpectral::operator= (const GModelSpectral& model)
+GModelSpectral& GModelSpectral::operator=(const GModelSpectral& model)
 { 
     // Execute only if object is not identical
     if (this != &model) {
@@ -125,48 +126,6 @@ GModelSpectral&amp; GModelSpectral::operator= (const GModelSpectral&amp; model)
 /***********************************************************************//**
- * @brief Returns model parameter
- *
- * @param[in] index Parameter index [0,...,size()-1].
- *
- * @exception GException::out_of_range
- *            Parameter index is out of range.
- ***************************************************************************/
-GModelPar& GModelSpectral::operator[](const int& index)
-{
-    // Compile option: raise exception if index is out of range
-    #if defined(G_RANGE_CHECK)
-    if (index < 0 || index >= size())
-        throw GException::out_of_range(G_ACCESS1, index, 0, size()-1);
-    #endif
-
-    // Return reference
-    return *(m_pars[index]);
-}
-
-
-/***********************************************************************//**
- * @brief Returns model parameter (const version)
- *
- * @param[in] index Parameter index [0,...,size()-1].
- *
- * @exception GException::out_of_range
- *            Parameter index is out of range.
- ***************************************************************************/
-const GModelPar& GModelSpectral::operator[](const int& index) const
-{
-    // Compile option: raise exception if index is out of range
-    #if defined(G_RANGE_CHECK)
-    if (index < 0 || index >= size())
-        throw GException::out_of_range(G_ACCESS1, index, 0, size()-1);
-    #endif
-
-    // Return reference
-    return *(m_pars[index]);
-}
-
-
-/***********************************************************************//**
  * @brief Returns reference to model parameter
  *
  * @param[in] name Parameter name.
@@ -179,13 +138,15 @@ GModelPar&amp; GModelSpectral::operator[](const std::string&amp; name)
     // Get parameter index
     int index = 0;
     for (; index < size(); ++index) {
-        if (m_pars[index]->name() == name)
+        if (m_pars[index]->name() == name) {
             break;
+        }
     }
     // Throw exception if parameter name was not found
-    if (index >= size())
-        throw GException::par_not_found(G_ACCESS2, name);
+    if (index >= size()) {
+        throw GException::par_not_found(G_ACCESS, name);
+    }
     // Return reference
     return *(m_pars[index]);
@@ -205,13 +166,15 @@ const GModelPar&amp; GModelSpectral::operator[](const std::string&amp; name) const
     // Get parameter index
     int index = 0;
     for (; index < size(); ++index) {
-        if (m_pars[index]->name() == name)
+        if (m_pars[index]->name() == name) {
             break;
+        }
     }
     // Throw exception if parameter name was not found
-    if (index >= size())
-        throw GException::par_not_found(G_ACCESS2, name);
+    if (index >= size()) {
+        throw GException::par_not_found(G_ACCESS, name);
+    }
     // Return reference
     return *(m_pars[index]);
@@ -225,16 +188,48 @@ const GModelPar&amp; GModelSpectral::operator[](const std::string&amp; name) const
  ==========================================================================*/
 /***********************************************************************//**
- * @brief Return number of parameters
+ * @brief Returns model parameter
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
+ *
+ * @exception GException::out_of_range
+ *            Parameter index is out of range.
+ *
+ * Returns model parameter with @p index range checking.
+ ***************************************************************************/
+GModelPar& GModelSpectral::at(const int& index)
+{
+    // Compile option: raise exception if index is out of range
+    if (index < 0 || index >= size()) {
+        throw GException::out_of_range(G_AT, index, 0, size()-1);
+    }
+
+    // Return reference
+    return *(m_pars[index]);
+}
+
+
+/***********************************************************************//**
+ * @brief Returns model parameter (const version)
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
  *
- * @return Number of parameters in spectral model component.
+ * @exception GException::out_of_range
+ *            Parameter index is out of range.
  *
- * Returns the number of parameters in the spectral model component.
+ * Returns model parameter with @p index range checking.
  ***************************************************************************/
-int GModelSpectral::size(void) const
+const GModelPar& GModelSpectral::at(const int& index) const
 {
-    // Return number of parameters
-    return (m_pars.size());
+    // Compile option: raise exception if index is out of range
+    if (index < 0 || index >= size()) {
+        throw GException::out_of_range(G_AT, index, 0, size()-1);
+    }
+
+    // Return reference
+    return *(m_pars[index]);
 }
 /***************************************************************************
  *         GModelTemporal.cpp - Abstract temporal model base class         *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2009-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2009-2014 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -32,8 +32,8 @@
 #include "GModelTemporal.hpp"
 /* __ Method name definitions ____________________________________________ */
-#define G_ACCESS1                          "GModelTemporal::operator[](int&)"
-#define G_ACCESS2                  "GModelTemporal::operator[](std::string&)"
+#define G_ACCESS                   "GModelTemporal::operator[](std::string&)"
+#define G_AT                            "GModelPar& GModelTemporal::at(int&)"
 /* __ Macros _____________________________________________________________ */
@@ -102,8 +102,9 @@ GModelTemporal::~GModelTemporal(void)
  * @brief Assignment operator
  *
  * @param[in] model Temporal model.
+ * @return Temporal model.
  ***************************************************************************/
-GModelTemporal& GModelTemporal::operator= (const GModelTemporal& model)
+GModelTemporal& GModelTemporal::operator=(const GModelTemporal& model)
 { 
     // Execute only if object is not identical
     if (this != &model) {
@@ -125,48 +126,6 @@ GModelTemporal&amp; GModelTemporal::operator= (const GModelTemporal&amp; model)
 /***********************************************************************//**
- * @brief Returns model parameter
- *
- * @param[in] index Parameter index [0,...,size()-1].
- *
- * @exception GException::out_of_range
- *            Parameter index is out of range.
- ***************************************************************************/
-GModelPar& GModelTemporal::operator[](const int& index)
-{
-    // Compile option: raise exception if index is out of range
-    #if defined(G_RANGE_CHECK)
-    if (index < 0 || index >= size())
-        throw GException::out_of_range(G_ACCESS1, index, 0, size()-1);
-    #endif
-
-    // Return reference
-    return *(m_pars[index]);
-}
-
-
-/***********************************************************************//**
- * @brief Returns model parameter (const version)
- *
- * @param[in] index Parameter index [0,...,size()-1].
- *
- * @exception GException::out_of_range
- *            Parameter index is out of range.
- ***************************************************************************/
-const GModelPar& GModelTemporal::operator[](const int& index) const
-{
-    // Compile option: raise exception if index is out of range
-    #if defined(G_RANGE_CHECK)
-    if (index < 0 || index >= size())
-        throw GException::out_of_range(G_ACCESS1, index, 0, size()-1);
-    #endif
-
-    // Return reference
-    return *(m_pars[index]);
-}
-
-
-/***********************************************************************//**
  * @brief Returns reference to model parameter
  *
  * @param[in] name Parameter name.
@@ -185,7 +144,7 @@ GModelPar&amp; GModelTemporal::operator[](const std::string&amp; name)
     // Throw exception if parameter name was not found
     if (index >= size())
-        throw GException::par_not_found(G_ACCESS2, name);
+        throw GException::par_not_found(G_ACCESS, name);
     // Return reference
     return *(m_pars[index]);
@@ -211,7 +170,7 @@ const GModelPar&amp; GModelTemporal::operator[](const std::string&amp; name) const
     // Throw exception if parameter name was not found
     if (index >= size())
-        throw GException::par_not_found(G_ACCESS2, name);
+        throw GException::par_not_found(G_ACCESS, name);
     // Return reference
     return *(m_pars[index]);
@@ -225,16 +184,48 @@ const GModelPar&amp; GModelTemporal::operator[](const std::string&amp; name) const
  ==========================================================================*/
 /***********************************************************************//**
- * @brief Return number of parameters
+ * @brief Returns model parameter
+ *
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
+ *
+ * @exception GException::out_of_range
+ *            Parameter index is out of range.
+ *
+ * Returns model parameter with @p index range checking.
+ ***************************************************************************/
+GModelPar& GModelTemporal::at(const int& index)
+{
+    // Compile option: raise exception if index is out of range
+    if (index < 0 || index >= size()) {
+        throw GException::out_of_range(G_AT, index, 0, size()-1);
+    }
+
+    // Return reference
+    return *(m_pars[index]);
+}
+
+
+/***********************************************************************//**
+ * @brief Returns model parameter (const version)
  *
- * @return Number of parameters in temporal model component.
+ * @param[in] index Parameter index [0,...,size()-1].
+ * @return Model parameter.
  *
- * Returns the number of parameters in the temporal model component.
+ * @exception GException::out_of_range
+ *            Parameter index is out of range.
+ *
+ * Returns model parameter with @p index range checking.
  ***************************************************************************/
-int GModelTemporal::size(void) const
+const GModelPar& GModelTemporal::at(const int& index) const
 {
-    // Return number of parameters
-    return (m_pars.size());
+    // Compile option: raise exception if index is out of range
+    if (index < 0 || index >= size()) {
+        throw GException::out_of_range(G_AT, index, 0, size()-1);
+    }
+
+    // Return reference
+    return *(m_pars[index]);
 }