Review GTools and GCsv class.

Some arguments that were not already passed as const references are now declared as const references. Inline methods were added to GCvs.

Review GTools and GCsv class.
Some arguments that were not already passed as const references are now declared as const references. Inline methods were added to GCvs.
Jürgen Knödlseder
1 parent d866ddac
Showing 5 changed files with 105 additions and 57 deletions
include/GCsv.hpp
include/GTools.hpp
pyext/GCsv.i
src/support/GCsv.cpp
src/support/GTools.cpp
@@ -36,32 +36,45 @@
 /***********************************************************************//**
  * @class GCsv
  *
- * @brief Column separated values table class definition
+ * @brief Column separated values table class
+ *
+ * This class implements a table of std::string elements that is loaded
+ * from a column separated value ASCII file. The column separation string
+ * can be specified upon loading of the file (by default the class assumes
+ * that elements are separated by a white space).
+ *
+ * The class provides operators for string element access, and methods for
+ * conversion of the string values:
+ *
+ *    double      real    = csv.real(row,col);
+ *    int         integer = csv.integer(row,col);
+ *    std::string string  = csv.string(row,col);
+ *  
  ***************************************************************************/
 class GCsv : public GBase {
 public:
     // Constructors and destructors
     GCsv(void);
-    GCsv(const std::string& filename, std::string sep = " ");
+    GCsv(const std::string& filename, const std::string& sep = " ");
     GCsv(const GCsv& csv);
     virtual ~GCsv(void);
     // Operators
-    GCsv&              operator= (const GCsv& csv);
-    std::string&       operator() (const int& row, const int& col);
-    const std::string& operator() (const int& row, const int& col) const;
+    GCsv&              operator=(const GCsv& csv);
+    std::string&       operator()(const int& row, const int& col);
+    const std::string& operator()(const int& row, const int& col) const;
     // Methods
     void        clear(void);
     GCsv*       clone(void) const;
+    int         size(void) const;
+    const int&  ncols(void) const;
+    const int&  nrows(void) const;
     std::string string(const int& row, const int& col) const;
     double      real(const int& row, const int& col) const;
     int         integer(const int& row, const int& col) const;
-    void        load(const std::string& filename, std::string sep = " ");
-    int         ncols(void) const { return m_cols; }
-    int         nrows(void) const { return m_rows; }
-    int         size(void) const { return m_rows*m_cols; }
+    void        load(const std::string& filename, const std::string& sep = " ");
     std::string print(const GChatter& chatter = NORMAL) const;
 protected:
@@ -76,4 +89,40 @@ protected:
     std::vector<std::vector<std::string> > m_data;  //!< CSV table data
 };
+
+/***********************************************************************//**
+ * @brief Return table size (columns times rows)
+ *
+ * @return Table size.
+ ***************************************************************************/
+inline
+int GCsv::size(void) const
+{
+    return m_rows*m_cols;
+}
+
+
+/***********************************************************************//**
+ * @brief Return number of columns
+ *
+ * @return Number of columns.
+ ***************************************************************************/
+inline
+const int& GCsv::ncols(void) const
+{
+    return m_cols;
+}
+
+
+/***********************************************************************//**
+ * @brief Return number of rows
+ *
+ * @return Number of rows.
+ ***************************************************************************/
+inline
+const int& GCsv::nrows(void) const
+{
+    return m_rows;
+}
+
 #endif /* GCSV_HPP */
@@ -71,10 +71,13 @@ namespace gammalib {
     std::string              toupper(const std::string& s);
     std::string              tolower(const std::string& s);
     std::vector<std::string> split(const std::string& s, const std::string& sep);
-    std::string              fill(const std::string& s, int n);
-    std::string              left(const std::string& s, int n, char c = ' ');
-    std::string              right(const std::string& s, int n, char c = ' ');
-    std::string              center(const std::string& s, int n, char c = ' ');
+    std::string              fill(const std::string& s, const int& n);
+    std::string              left(const std::string& s, const int& n,
+                                  const char& c = ' ');
+    std::string              right(const std::string& s, const int& n,
+                                   const char& c = ' ');
+    std::string              center(const std::string& s, const int& n,
+                                    const char& c = ' ');
     std::string              parformat(const std::string& s, const int& indent = 0);
     double                   plaw_photon_flux(const double& emin,
                                               const double& emax,
@@ -87,7 +90,8 @@ namespace gammalib {
     bool                     file_exists(const std::string& filename);
     bool                     isinfinite(const double& x);
     bool                     isnotanumber(const double& x);
-    bool 					 contains(std::string str1, std::string str2);
+    bool 					 contains(const std::string& str,
+                                      const std::string& substring);
     void                     warning(const std::string& origin,
                                      const std::string& message);
 }
@@ -20,7 +20,7 @@
  ***************************************************************************/
 /**
  * @file GCsv.hpp
- * @brief Column separated values table class Python bindings
+ * @brief Column separated values table class definition
  * @author Juergen Knoedlseder
  */
 %{
@@ -86,20 +86,20 @@ class GCsv : public GBase {
 public:
     // Constructors and destructors
     GCsv(void);
-    GCsv(const std::string& filename, std::string sep = " ");
+    GCsv(const std::string& filename, const std::string& sep = " ");
     GCsv(const GCsv& csv);
     virtual ~GCsv(void);
     // Methods
     void        clear(void);
     GCsv*       clone(void) const;
+    int         size(void) const;
+    const int&  ncols(void) const;
+    const int&  nrows(void) const;
     std::string string(const int& row, const int& col) const;
     double      real(const int& row, const int& col) const;
     int         integer(const int& row, const int& col) const;
-    void        load(const std::string& filename, std::string sep = " ");
-    int         ncols(void) const { return m_cols; }
-    int         nrows(void) const { return m_rows; }
-    int         size(void) const { return m_rows*m_cols; }
+    void        load(const std::string& filename, const std::string& sep = " ");
 };
@@ -113,6 +113,9 @@ public:
     void __setitem__(int GCsvInx[], std::string value) {
         (*self)(GCsvInx[0], GCsvInx[1]) = value;
     }
+    int __len__() {
+        return (self->size());
+    }
     GCsv copy() {
         return (*self);
     }
@@ -34,8 +34,8 @@
 #include "GException.hpp"
 /* __ Method name definitions ____________________________________________ */
-#define G_ACCESS                              "GCsv::operator() (int&, int&)"
-#define G_LOAD                        "GCsv::load(std::string&, std::string)"
+#define G_ACCESS                               "GCsv::operator()(int&, int&)"
+#define G_LOAD                       "GCsv::load(std::string&, std::string&)"
 /* __ Macros _____________________________________________________________ */
@@ -69,7 +69,7 @@ GCsv::GCsv(void)
  * @param[in] filename Filename.
  * @param[in] sep Column separator (default is whitespace).
  ***************************************************************************/
-GCsv::GCsv(const std::string& filename, std::string sep)
+GCsv::GCsv(const std::string& filename, const std::string& sep)
 { 
     // Initialise private
     init_members();
@@ -123,8 +123,9 @@ GCsv::~GCsv(void)
  * @brief Assignment operator
  *
  * @param[in] csv Column separated values table.
+ * @return Column separated values table.
  ***************************************************************************/
-GCsv& GCsv::operator= (const GCsv& csv)
+GCsv& GCsv::operator=(const GCsv& csv)
 { 
     // Execute only if object is not identical
     if (this != &csv) {
@@ -151,7 +152,7 @@ GCsv&amp; GCsv::operator= (const GCsv&amp; csv)
  * @param[in] row Table row.
  * @param[in] col Table column.
  ***************************************************************************/
-std::string& GCsv::operator() (const int& row, const int& col)
+std::string& GCsv::operator()(const int& row, const int& col)
 {
     // Perform range check
     #if defined(G_RANGE_CHECK)
@@ -171,7 +172,7 @@ std::string&amp; GCsv::operator() (const int&amp; row, const int&amp; col)
  * @param[in] row Table row.
  * @param[in] col Table column.
  ***************************************************************************/
-const std::string& GCsv::operator() (const int& row, const int& col) const
+const std::string& GCsv::operator()(const int& row, const int& col) const
 {
     // Perform range check
     #if defined(G_RANGE_CHECK)
@@ -192,7 +193,7 @@ const std::string&amp; GCsv::operator() (const int&amp; row, const int&amp; col) const
  ==========================================================================*/
 /***********************************************************************//**
- * @brief Clear instance
+ * @brief Clear CSV table
  *
  * This method properly resets the object to an initial state.
  ***************************************************************************/
@@ -210,7 +211,9 @@ void GCsv::clear(void)
 /***********************************************************************//**
- * @brief Clone instance
+ * @brief Clone CSV table
+ *
+ * @return Pointer to deep copy of CSV table.
  **************************************************************************/
 GCsv* GCsv::clone(void) const
 {
@@ -283,16 +286,11 @@ int GCsv::integer(const int&amp; row, const int&amp; col) const
  * Load CSV table from ASCII file.
  * Any environment variable present in the filename will be expanded.
  **************************************************************************/
-void GCsv::load(const std::string& filename, std::string sep)
+void GCsv::load(const std::string& filename, const std::string& sep)
 {
     // Clear instance
     clear();
-    // If no seperator is given then assume a whitespace
-    if (sep.length() == 0) {
-        sep = " ";
-    }
-
     // Allocate line buffer
     const int n = 10000; 
     char  line[n];
@@ -317,8 +315,9 @@ void GCsv::load(const std::string&amp; filename, std::string sep)
         std::string sline = gammalib::strip_chars(gammalib::strip_whitespace(std::string(line)),"\n");
         // Skip line if empty
-        if (sline.length() == 0)
+        if (sline.length() == 0) {
             continue;
+        }
         // Split line in elements
         std::vector<std::string> elements = gammalib::split(sline, sep);
@@ -433,10 +432,3 @@ void GCsv::free_members(void)
     // Return
     return;
 }
-
-
-/*==========================================================================
- =                                                                         =
- =                                 Friends                                 =
- =                                                                         =
- ==========================================================================*/
@@ -244,7 +244,7 @@ std::string gammalib::str(const unsigned short int&amp; value)
 {
     std::ostringstream s_value;
     s_value << value;
-    return  s_value.str();
+    return s_value.str();
 }
@@ -257,7 +257,7 @@ std::string gammalib::str(const unsigned int&amp; value)
 {
     std::ostringstream s_value;
     s_value << value;
-    return  s_value.str();
+    return s_value.str();
 }
@@ -270,7 +270,7 @@ std::string gammalib::str(const unsigned long int&amp; value)
 {
     std::ostringstream s_value;
     s_value << value;
-    return  s_value.str();
+    return s_value.str();
 }
@@ -283,7 +283,7 @@ std::string gammalib::str(const unsigned long long int&amp; value)
 {
     std::ostringstream s_value;
     s_value << value;
-    return  s_value.str();
+    return s_value.str();
 }
@@ -296,7 +296,7 @@ std::string gammalib::str(const short int&amp; value)
 {
     std::ostringstream s_value;
     s_value << value;
-    return  s_value.str();
+    return s_value.str();
 }
@@ -309,7 +309,7 @@ std::string gammalib::str(const int&amp; value)
 {
     std::ostringstream s_value;
     s_value << value;
-    return  s_value.str();
+    return s_value.str();
 }
@@ -322,7 +322,7 @@ std::string gammalib::str(const long int&amp; value)
 {
     std::ostringstream s_value;
     s_value << value;
-    return  s_value.str();
+    return s_value.str();
 }
@@ -335,7 +335,7 @@ std::string gammalib::str(const long long int&amp; value)
 {
     std::ostringstream s_value;
     s_value << value;
-    return  s_value.str();
+    return s_value.str();
 }
@@ -348,7 +348,7 @@ std::string gammalib::str(const float&amp; value)
 {
     std::ostringstream s_value;
     s_value << value;
-    return  s_value.str();
+    return s_value.str();
 }
@@ -361,7 +361,7 @@ std::string gammalib::str(const double&amp; value)
 {
     std::ostringstream s_value;
     s_value << value;
-    return  s_value.str();
+    return s_value.str();
 }
@@ -598,7 +598,7 @@ std::vector&lt;std::string&gt; gammalib::split(const std::string&amp; s,
  *
  * Replicates a given string n time.
  ***************************************************************************/
-std::string gammalib::fill(const std::string& s, int n)
+std::string gammalib::fill(const std::string& s, const int& n)
 {
     // Initialise result
     std::string result = "";
@@ -623,7 +623,7 @@ std::string gammalib::fill(const std::string&amp; s, int n)
  * Left justify string by adding whitespace to the right to achieve a length
  * of n characters.
  ***************************************************************************/
-std::string gammalib::left(const std::string& s, int n, char c)
+std::string gammalib::left(const std::string& s, const int& n, const char& c)
 {
     // Compute number of characters to fill right
     int n_right  = n - s.length();
@@ -646,7 +646,7 @@ std::string gammalib::left(const std::string&amp; s, int n, char c)
  * Right justify string by adding whitespace to the left to achieve a length
  * of n characters.
  ***************************************************************************/
-std::string gammalib::right(const std::string& s, int n, char c)
+std::string gammalib::right(const std::string& s, const int& n, const char& c)
 {
     // Compute number of characters to fill right
     int n_left  = n - s.length();
@@ -669,7 +669,7 @@ std::string gammalib::right(const std::string&amp; s, int n, char c)
  * Center string by adding whitespace to the left and the right to achieve a
  * length of n characters.
  ***************************************************************************/
-std::string gammalib::center(const std::string& s, int n, char c)
+std::string gammalib::center(const std::string& s, const int& n, const char& c)
 {
     // Compute number of characters to fill left and right
     int n_right = (n-s.length()) / 2;
@@ -833,7 +833,7 @@ bool gammalib::file_exists(const std::string&amp; filename)
  *
  * Checks if substring is contained in str
  ***************************************************************************/
-bool gammalib::contains(std::string str, std::string substring)
+bool gammalib::contains(const std::string& str, const std::string& substring)
 {
     // Initialise result
     bool result = false;