GSLUtility.h

Go to the documentation of this file.

#ifndef GSLUtility_h
#define GSLUtility_h
 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include <iostream>
#include <sstream>
#include <string>
#include <vector>
#include <algorithm>
 
#include <QString>
 
#include <tnt/tnt_array1d.h>
#include <tnt/tnt_array1d_utils.h>
#include <tnt/tnt_array2d.h>
#include <tnt/tnt_array2d_utils.h>
 
#include <gsl/gsl_vector.h>
#include <gsl/gsl_matrix.h>
 
//  Some GSL optimization on by default, off if DEBUG or SAFE_GSL is defined
#ifndef DEBUG
#ifndef SAFE_GSL
#define GSL_RANGE_CHECK_OFF 1
#endif
#endif
 
#include "IException.h"
 
namespace Isis {
  namespace GSL {
 
    class GSLUtility {
      public:
        typedef TNT::Array1D<double> GSLVector;
        typedef TNT::Array2D<double> GSLMatrix;
 
        static GSLUtility *getInstance();
 
        inline bool success(int status) const {
          return (status == GSL_SUCCESS);
        }
 
        inline QString status(int gsl_errno) const {
          return (QString(gsl_strerror(gsl_errno)));
        }
 
        void check(int gsl_status, const char *src = __FILE__, int line = __LINE__)
        const;
 
 
        size_t Rows(const gsl_matrix *m) const;
        size_t Columns(const gsl_matrix *m) const;
 
        size_t Rows(const GSLMatrix &m) const;
        size_t Columns(const GSLMatrix &m) const;
 
        size_t size(const gsl_vector *v) const;
        size_t size(const gsl_matrix *m) const;
 
        gsl_vector *vector(size_t n, bool zero = false) const;
        gsl_matrix *matrix(size_t n1, size_t n2, bool zero = false) const;
        gsl_matrix *identity(size_t n1, size_t n2) const;
        void setIdentity(gsl_matrix *m) const;
 
        void free(gsl_vector *v) const;
        void free(gsl_matrix *m) const;
 
        GSLVector gslToGSL(const gsl_vector *v) const;
        GSLMatrix gslToGSL(const gsl_matrix *m) const;
        gsl_vector *GSLTogsl(const GSLVector &v, gsl_vector *gv = 0) const;
        gsl_matrix *GSLTogsl(const GSLMatrix &m, gsl_matrix *gm = 0) const;
 
 
      private:
        //  Private Constructor/Destructor makes this a singleton
        GSLUtility();
        ~GSLUtility() { }
 
        static GSLUtility *_instance;  
 
        static void handler(const char *reason, const char *file, int line,
                            int gsl_errno);
 
 
    };
 
  } // namespace GSL
}     // namespace Isis
#endif