interp.hpp

Go to the documentation of this file.

/*
 * $Id: interp.hpp 293 2012-12-17 20:27:36Z jdl3 $
 * Copyright (C) 2012, 2020 John D Lamb
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#ifndef CCGSL_INTERP_HPP
#define CCGSL_INTERP_HPP
 
#include<new>
#include<stdexcept>
#include<gsl/gsl_interp.h>
 
namespace gsl {
  class interp {
  public:
    typedef gsl_interp_type type;
    interp(){
      ccgsl_pointer = 0;
      count = 0; // initially nullptr will do
    }
    // Refines random access container
    // Refines assignable
    explicit interp( type const* T, size_t const n ){
      ccgsl_pointer = gsl_interp_alloc( T, n );
      // just plausibly we could allocate interp but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    gsl_interp_free( ccgsl_pointer );
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    explicit interp( gsl_interp* v ){
      ccgsl_pointer = v;
      // just plausibly we could fail to allocate count: no further action needed.
      count = new size_t;
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    // copy constructor
    interp( interp const& v ){ ccgsl_pointer = v.ccgsl_pointer;
      count = v.count; if( count != 0 ) ++*count; }
    // assignment operator
    interp& operator=( interp const& v ){
      // first, possibly delete anything pointed to by this
      if( count == 0 or --*count == 0 ){
    if( ccgsl_pointer != 0 ) gsl_interp_free( ccgsl_pointer );
    delete count;
      } // Then copy
      ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
    }
    // destructor
    ~interp(){
      if( count == 0 or --*count == 0 ){
    // could have allocated null pointer
    if( ccgsl_pointer != 0 ) gsl_interp_free( ccgsl_pointer );
    delete count;
      }
    }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    interp( interp&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
      std::swap( count, v.count );
      v.ccgsl_pointer = nullptr;
    }
    interp& operator=( interp&& v ){
      interp( std::move( v ) ).swap( *this );
      return *this;
    }
#endif
    // Refines equality comparable
    // == operator
    bool operator==( interp const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
    // != operator
    bool operator!=( interp const& v ) const { return not operator==( v ); }
    // Refines forward container
    // Refines less than comparable
    // operator<
    bool operator<( interp const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
    // operator>
    bool operator>( interp const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
    // operator<=
    bool operator<=( interp const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
    // operator>=
    bool operator>=( interp const& v ) const { return ccgsl_pointer >= v.ccgsl_pointer; }
    bool empty() const { return ccgsl_pointer == 0; }
    // swap() --- should work even if sizes don't match
    void swap( interp& v ){
      std::swap( ccgsl_pointer, v.ccgsl_pointer );
      std::swap( count, v.count );
    }
  private:
    gsl_interp* ccgsl_pointer;
    size_t* count;
  public:
    // shared reference functions
    gsl_interp* get() const { return ccgsl_pointer; }
    bool unique() const { return count != 0 and *count == 1; }
    size_t use_count() const { return count == 0 ? 0 : *count; }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    explicit
#endif
    operator bool() const { return ccgsl_pointer != 0; }
 
    class accel {
    public:
      // Refines random access container
      // Refines assignable
      accel(){
    ccgsl_pointer = gsl_interp_accel_alloc();
    // just plausibly we could allocate accel but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_interp_accel_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit accel( gsl_interp_accel* v ){
    ccgsl_pointer = v;
    // just plausibly we could fail to allocate count: no further action needed.
    count = new size_t;
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      // copy constructor
      accel( accel const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      accel& operator=( accel const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_interp_accel_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
      }
      // destructor
      ~accel(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_interp_accel_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    accel( accel&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
      std::swap( count, v.count );
      v.ccgsl_pointer = nullptr;
    }
    accel& operator=( accel&& v ){
      accel( std::move( v ) ).swap( *this );
      return *this;
    }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( accel const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( accel const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( accel const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( accel const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( accel const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( accel const& v ) const { return ccgsl_pointer >= v.ccgsl_pointer; }
      bool empty() const { return ccgsl_pointer == 0; }
      // swap() --- should work even if sizes don't match
      void swap( accel& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_interp_accel* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_interp_accel* get() const { return ccgsl_pointer; }
      bool unique() const { return count != 0 and *count == 1; }
      size_t use_count() const { return count == 0 ? 0 : *count; }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      explicit
#endif
      operator bool() const { return ccgsl_pointer != 0; }
    
      int reset(){ return gsl_interp_accel_reset( get() ); }
      size_t find( double const xa[], size_t len, double x ){
    return gsl_interp_accel_find( get(), xa, len, x ); }
      template<typename XA>
      size_t find( XA const& xa, double x ){
    return gsl_interp_accel_find( get(), xa.data(), xa.size(), x ); }
    };
 
    int init( double const xa[], double const ya[], size_t const size ){
      return gsl_interp_init( get(), xa, ya, size ); }
 
    template<typename XA,typename YA>
    int init( XA const& xa, YA const& ya ){
      if( ya.size() != xa.size() )
    throw std::length_error("gsl::interp::init(): xa and ya must have the same size.");
      return gsl_interp_init( get(), xa.data(), ya.data(), xa.size() ); }
 
    char const* name() const { return gsl_interp_name( get() ); }
 
    unsigned int min_size() const { return gsl_interp_min_size( get() ); }
 
    unsigned int type_min_size( gsl_interp_type const* T ){
      return gsl_interp_type_min_size( T ); }
#ifndef DOXYGEN_SKIP 
    int eval_e( double const xa[], double const ya[], double x, accel& a, double* y ) const {
      return gsl_interp_eval_e( get(), xa, ya, x, a.get(), y ); }
#endif /* DOXYGEN_SKIP */
      int eval_e( double const xa[], double const ya[], double x, accel& a, double& y ) const {
    return gsl_interp_eval_e( get(), xa, ya, x, a.get(), &y ); }
 
    double eval( double const xa[], double const ya[], double x, accel& a ) const {
      return gsl_interp_eval( get(), xa, ya, x, a.get() ); }
 
#ifndef DOXYGEN_SKIP 
    int eval_deriv_e( double const xa[], double const ya[], double x, accel& a, double* d )
      const { return gsl_interp_eval_deriv_e( get(), xa, ya, x, a.get(), d ); }
#endif /* DOXYGEN_SKIP */
    int eval_deriv_e( double const xa[], double const ya[], double x, accel& a, double& d )
      const { return gsl_interp_eval_deriv_e( get(), xa, ya, x, a.get(), &d ); }
 
    double eval_deriv( double const xa[], double const ya[], double x, accel& a ) const {
      return gsl_interp_eval_deriv( get(), xa, ya, x, a.get() ); }
 
#ifndef DOXYGEN_SKIP 
    int eval_deriv2_e( double const xa[], double const ya[], double x, accel& a, double* d2 )
      const { return gsl_interp_eval_deriv2_e( get(), xa, ya, x, a.get(), d2 ); }
#endif /* DOXYGEN_SKIP */
    int eval_deriv2_e( double const xa[], double const ya[], double x, accel& a, double& d2 )
      const { return gsl_interp_eval_deriv2_e( get(), xa, ya, x, a.get(), &d2 ); }
 
    double eval_deriv2( double const xa[], double const ya[], double x, accel& a ) const {
      return gsl_interp_eval_deriv2( get(), xa, ya, x, a.get() ); }
 
#ifndef DOXYGEN_SKIP 
    int eval_integ_e( double const xa[], double const ya[], double a, double b,
              accel& acc, double* result ) const {
      return gsl_interp_eval_integ_e( get(), xa, ya, a, b, acc.get(), result ); }
#endif /* DOXYGEN_SKIP */
    int eval_integ_e( double const xa[], double const ya[], double a, double b,
              accel& acc, double& result ) const {
      return gsl_interp_eval_integ_e( get(), xa, ya, a, b, acc.get(), &result ); }
 
    double eval_integ( double const xa[], double const ya[], double a, double b, accel& acc )
      const { return gsl_interp_eval_integ( get(), xa, ya, a, b, acc.get() ); }
 
    size_t bsearch( double const x_array[], double x, size_t index_lo, size_t index_hi ){
      return gsl_interp_bsearch( x_array, x, index_lo, index_hi ); }
 
    // Template versions
#ifndef DOXYGEN_SKIP 
    template<typename XA,typename YA>
    int eval_e( XA const& xa, YA const& ya, double x, accel& a, double* y ) const {
      return gsl_interp_eval_e( get(), xa.data(), ya.data(), x, a.get(), y ); }
#endif /* DOXYGEN_SKIP */
    template<typename XA,typename YA>
    int eval_e( XA const& xa, YA const& ya, double x, accel& a, double& y ) const {
      return gsl_interp_eval_e( get(), xa.data(), ya.data(), x, a.get(), &y ); }
 
    template<typename XA,typename YA>
    double eval( XA const& xa, YA const& ya, double x, accel& a ) const {
      return gsl_interp_eval( get(), xa.data(), ya.data(), x, a.get() ); }
 
#ifndef DOXYGEN_SKIP 
    template<typename XA,typename YA>
    int eval_deriv_e( XA const& xa, YA const& ya, double x, accel& a, double* d ) const {
      return gsl_interp_eval_deriv_e( get(), xa.data(), ya.data(), x, a.get(), d ); }
#endif /* DOXYGEN_SKIP */
    template<typename XA,typename YA>
    int eval_deriv_e( XA const& xa, YA const& ya, double x, accel& a, double& d ) const {
      return gsl_interp_eval_deriv_e( get(), xa.data(), ya.data(), x, a.get(), &d ); }
 
    template<typename XA,typename YA>
    double eval_deriv( XA const& xa, YA const& ya, double x, accel& a ) const {
      return gsl_interp_eval_deriv( get(), xa.data(), ya.data(), x, a.get() ); }
 
#ifndef DOXYGEN_SKIP 
    template<typename XA,typename YA>
    int eval_deriv2_e( XA const& xa, YA const& ya, double x, accel& a, double* d2 ) const {
      return gsl_interp_eval_deriv2_e( get(), xa.data(), ya.data(), x, a.get(), d2 ); }
#endif /* DOXYGEN_SKIP */
    template<typename XA,typename YA>
    int eval_deriv2_e( XA const& xa, YA const& ya, double x, accel& a, double& d2 ) const {
      return gsl_interp_eval_deriv2_e( get(), xa.data(), ya.data(), x, a.get(), &d2 ); }
 
    template<typename XA,typename YA>
    double eval_deriv2( XA const& xa, YA const& ya, double x, accel& a ) const {
      return gsl_interp_eval_deriv2( get(), xa.data(), ya.data(), x, a.get() ); }
 
#ifndef DOXYGEN_SKIP 
    template<typename XA,typename YA>
    int eval_integ_e( XA const& xa, YA const& ya, double a, double b,
              accel& acc, double* result ) const {
      return gsl_interp_eval_integ_e( get(), xa.data(), ya.data(), a, b, acc.get(), result ); }
#endif /* DOXYGEN_SKIP */
    template<typename XA,typename YA>
    int eval_integ_e( XA const& xa, YA const& ya, double a, double b,
              accel& acc, double& result ) const {
      return gsl_interp_eval_integ_e( get(), xa.data(), ya.data(), a, b, acc.get(), &result ); }
 
    template<typename XA,typename YA>
    double eval_integ( XA const& xa, YA const& ya, double a, double b, accel& acc ) const {
      return gsl_interp_eval_integ( get(), xa.data(), ya.data(), a, b, acc.get() ); }
 
    template<typename X>
    static size_t bsearch( X const& x_array, double x, size_t index_lo, size_t index_hi ){
      return gsl_interp_bsearch( x_array.data(), x, index_lo, index_hi ); }
 
    // Types
    inline static type const* cspline(){ return gsl_interp_cspline; }
    inline static type const* cspline_periodic(){ return gsl_interp_cspline_periodic; }
    inline static type const* akima(){ return gsl_interp_akima; }
    inline static type const* akima_periodic(){ return gsl_interp_akima_periodic; }
    inline static type const* steffen(){ return gsl_interp_steffen; }
  };
}
#endif