spline2d.hpp

Go to the documentation of this file.

/*
 * $Id$
 * Copyright (C) 2012, 2019, 2021 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_SPLINE2D_HPP
#define CCGSL_SPLINE2D_HPP
 
#include<new>
#include<gsl/gsl_spline2d.h>
#include"interp.hpp"
#include"interp2d.hpp"
 
namespace gsl {
  class spline2d {
  public:
    typedef gsl_interp2d_type type;
    spline2d(){
      ccgsl_pointer = 0;
      count = 0; // initially nullptr will do
    }
    // Refines random access container
    // Refines assignable
    explicit spline2d( type const* T, size_t const xsize, size_t const ysize ){
      ccgsl_pointer = gsl_spline2d_alloc( T, xsize, ysize );
      // just plausibly we could allocate spline2d but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    gsl_spline2d_free( ccgsl_pointer );
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    explicit spline2d( gsl_spline2d* 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
    spline2d( spline2d const& v ){ ccgsl_pointer = v.ccgsl_pointer;
      count = v.count; if( count != 0 ) ++*count; }
    // assignment operator
    spline2d& operator=( spline2d const& v ){
      // first, possibly delete anything pointed to by this
      if( count == 0 or --*count == 0 ){
    if( ccgsl_pointer != 0 ) gsl_spline2d_free( ccgsl_pointer );
    delete count;
      } // Then copy
      ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
    }
    // destructor
    ~spline2d(){
      if( count == 0 or --*count == 0 ){
    // could have allocated null pointer
    if( ccgsl_pointer != 0 ) gsl_spline2d_free( ccgsl_pointer );
    delete count;
      }
    }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    spline2d( spline2d&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
      std::swap( count, v.count );
      v.ccgsl_pointer = nullptr;
    }
    spline2d& operator=( spline2d&& v ){
      spline2d( std::move( v ) ).swap( *this );
      return *this;
    }
#endif
    // Refines equality comparable
    // == operator
    bool operator==( spline2d const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
    // != operator
    bool operator!=( spline2d const& v ) const { return not operator==( v ); }
    // Refines forward container
    // Refines less than comparable
    // operator<
    bool operator<( spline2d const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
    // operator>
    bool operator>( spline2d const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
    // operator<=
    bool operator<=( spline2d const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
    // operator>=
    bool operator>=( spline2d 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( spline2d& v ){
      std::swap( ccgsl_pointer, v.ccgsl_pointer );
      std::swap( count, v.count );
    }
  private:
    gsl_spline2d* ccgsl_pointer;
    size_t* count;
  public:
    // shared reference functions
    gsl_spline2d* 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 init( double const xa[], double const ya[], double const za[],
          size_t xsize, size_t ysize ){
      return gsl_spline2d_init( get(), xa, ya, za, xsize, ysize ); } 
    template<typename XA,typename YA, typename ZA>
    int init( XA const& xa, YA const& ya, ZA const& za ){
      return gsl_spline2d_init( get(), xa.data(), ya.data(), za.data(),
                xa.size(), ya.size() ); } 
    double eval( double const x, double const y, interp::accel& xa, interp::accel& ya ) const {
      return gsl_spline2d_eval( get(), x, y, xa.get(), ya.get() ); } 
    int eval_e( double const x, double const y, interp::accel& xa, interp::accel& ya,
        double& z ) const {
      return gsl_spline2d_eval_e( get(), x, y, xa.get(), ya.get(), &z ); } 
    double eval_extrap( double const x, double const y, interp::accel& xa,
            interp::accel& ya ) const {
      return gsl_spline2d_eval_extrap( get(), x, y, xa.get(), ya.get() ); }
    int eval_extrap_e( double const x, double const y,
               interp::accel& xa, interp::accel& ya, double& z ) const {
      return gsl_spline2d_eval_extrap_e( get(), x, y, xa.get(), ya.get(), &z ); }
    double eval_deriv_x( double const x, double const y, interp::accel& xa,
             interp::accel& ya ) const {
      return gsl_spline2d_eval_deriv_x( get(), x, y, xa.get(), ya.get() ); } 
    int eval_deriv_x_e( double const x, double const y, interp::accel& xa, interp::accel& ya,
            double& z ) const {
      return gsl_spline2d_eval_deriv_x_e( get(), x, y, xa.get(), ya.get(), &z ); } 
    double eval_deriv_y( double const x, double const y, interp::accel& xa,
             interp::accel& ya ) const {
      return gsl_spline2d_eval_deriv_y( get(), x, y, xa.get(), ya.get() ); }
    int eval_deriv_y_e( double const x, double const y, interp::accel& xa, interp::accel& ya,
            double& z ) const {
      return gsl_spline2d_eval_deriv_y_e( get(), x, y, xa.get(), ya.get(), &z ); }
    double eval_deriv_xx( double const x, double const y, interp::accel& xa,
              interp::accel& ya ) const {
      return gsl_spline2d_eval_deriv_xx( get(), x, y, xa.get(), ya.get() ); }
    int eval_deriv_xx_e( double const x, double const y, interp::accel& xa, interp::accel& ya,
             double& z ) const {
      return gsl_spline2d_eval_deriv_xx_e( get(), x, y, xa.get(), ya.get(), &z ); } 
    double eval_deriv_yy( double const x, double const y, interp::accel& xa,
              interp::accel& ya ) const {
      return gsl_spline2d_eval_deriv_yy( get(), x, y, xa.get(), ya.get() ); } 
    int eval_deriv_yy_e( double const x, double const y, interp::accel& xa, interp::accel& ya,
             double& z ) const {
      return gsl_spline2d_eval_deriv_yy_e( get(), x, y, xa.get(), ya.get(), &z ); } 
    double eval_deriv_xy( double const x, double const y, interp::accel& xa,
              interp::accel& ya ) const {
      return gsl_spline2d_eval_deriv_xy( get(), x, y, xa.get(), ya.get() ); } 
    int eval_deriv_xy_e( double const x, double const y, interp::accel& xa, interp::accel& ya,
             double& z ) const {
      return gsl_spline2d_eval_deriv_xy_e( get(), x, y, xa.get(), ya.get(), &z ); } 
    size_t min_size() const { return gsl_spline2d_min_size( get() ); } 
    char const*
    name() const { return gsl_spline2d_name( get() ); } 
    int set( double zarr[], size_t const i, size_t const j, double const z ) const {
      return gsl_spline2d_set( get(), zarr, i, j, z ); } 
    template<typename ZARR>
    int set( ZARR& zarr, size_t const i, size_t const j, double const z ) const {
      return gsl_spline2d_set( get(), zarr.data(), i, j, z ); } 
    double get( double const zarr[], size_t const i, size_t const j ) const {
      return gsl_spline2d_get( get(), zarr, i, j ); }
    template<typename ZARR>
    double get( ZARR const& zarr, size_t const i, size_t const j ) const {
      return gsl_spline2d_get( get(), zarr.data(), i, j ); }
  };
}
#endif