bspline.hpp

Go to the documentation of this file.

/*
 * $Id: bspline.hpp 257 2012-08-22 16:14:53Z jdl3 $
 * Copyright (C) 2012, 2018, 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_BSPLINE_HPP
#define CCGSL_BSPLINE_HPP
 
#include<gsl/gsl_bspline.h>
#include"vector.hpp"
#include"matrix.hpp"
 
namespace gsl {
  namespace bspline {
    class workspace {
    public:
      workspace(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit workspace( size_t const k, size_t const nbreak ){
    ccgsl_pointer = gsl_bspline_alloc( k, nbreak );
    // just plausibly we could allocate bspline but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_bspline_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit workspace( gsl_bspline_workspace* 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
      workspace( workspace const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      workspace& operator=( workspace const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_bspline_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
      }
      // destructor
      ~workspace(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_bspline_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      workspace( workspace&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
    std::swap( count, v.count );
    v.ccgsl_pointer = nullptr;
      }
      workspace& operator=( workspace&& v ){
    workspace( std::move( v ) ).swap( *this );
    return *this;
      }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( workspace const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( workspace const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( workspace const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( workspace const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( workspace const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( workspace 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( workspace& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_bspline_workspace* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_bspline_workspace* 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; }
      gsl::vector knots(){
    gsl::vector return_value;
    return_value.wrap_gsl_vector_without_ownership( ccgsl_pointer->knots );
    return return_value;
      }
    };
 
    inline size_t ncoeffs( workspace& w ){ return gsl_bspline_ncoeffs( w.get() ); }
 
    inline size_t order( workspace& w ){ return gsl_bspline_order( w.get() ); }
 
    inline size_t nbreak( workspace& w ){ return gsl_bspline_nbreak( w.get() ); }
 
    inline double breakpoint( size_t i, workspace& w ){
      return gsl_bspline_breakpoint( i, w.get() ); }
 
    inline double greville_abscissa( size_t i, workspace& w ){
      return gsl_bspline_greville_abscissa( i, w.get() ); }
 
    inline int knots( vector const& breakpts, workspace& w ){
      return gsl_bspline_knots( breakpts.get(), w.get() ); }
 
    inline int knots_uniform( double const a, double const b, workspace& w ){
      return gsl_bspline_knots_uniform( a, b, w.get() ); }
 
    inline int eval( double const x, vector& B, workspace& w ){
      return gsl_bspline_eval( x, B.get(), w.get() ); }
 
#ifndef DOXYGEN_SKIP
    inline int eval_nonzero( double const x, vector& Bk, size_t* istart,
                 size_t* iend, workspace& w ){
      return gsl_bspline_eval_nonzero( x, Bk.get(), istart, iend, w.get() ); }
#endif /* DOXYGEN_SKIP */
    inline int eval_nonzero( double const x, vector& Bk, size_t& istart,
                 size_t& iend, workspace& w ){
      return gsl_bspline_eval_nonzero( x, Bk.get(), &istart, &iend, w.get() ); }
 
    inline int deriv_eval( double const x, size_t const nderiv, matrix& dB,
               workspace& w ){
      return gsl_bspline_deriv_eval( x, nderiv, dB.get(), w.get() ); }
 
#ifndef DOXYGEN_SKIP
    inline int deriv_eval_nonzero( double const x, size_t const nderiv, matrix& dB,
                   size_t* istart, size_t* iend, workspace& w ){
      return gsl_bspline_deriv_eval_nonzero( x, nderiv, dB.get(), istart, iend, w.get() ); }
#endif /* DOXYGEN_SKIP */
    inline int deriv_eval_nonzero( double const x, size_t const nderiv, matrix& dB,
                   size_t& istart, size_t& iend, workspace& w ){
      return gsl_bspline_deriv_eval_nonzero( x, nderiv, dB.get(), &istart, &iend, w.get() ); }
    
  }
}
#endif