chebyshev.hpp

Go to the documentation of this file.

/*
 * $Id: chebyshev.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_CHEB_HPP
#define CCGSL_CHEB_HPP
 
#include<new>
#include<gsl/gsl_chebyshev.h>
#include"mode.hpp"
#include"function_scl.hpp"
 
namespace gsl {
  namespace cheb {
    class series {
    public:
      series(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit series( size_t const order ){
    ccgsl_pointer = gsl_cheb_alloc( order );
    // just plausibly we could allocate series but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_cheb_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit series( gsl_cheb_series* 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
      series( series const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      series& operator=( series const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_cheb_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
      }
      // destructor
      ~series(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_cheb_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      series( series&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
    std::swap( count, v.count );
    v.ccgsl_pointer = nullptr;
      }
      series& operator=( series&& v ){
    series( std::move( v ) ).swap( *this );
    return *this;
      }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( series const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( series const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( series const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( series const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( series const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( series 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( series& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_cheb_series* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_cheb_series* 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; }
    public:
      int init( function_scl const& func, double const a, double const b ){
    return gsl_cheb_init( get(), &func, a, b ); }
      int init( gsl_function const* func, double const a, double const b ){
    return gsl_cheb_init( get(), func, a, b ); }
    };
 
    inline int init( series& cs, function_scl const& func, double const a, double const b ){
      return gsl_cheb_init( cs.get(), &func, a, b ); }
    inline int init( series& cs, gsl_function const* func, double const a, double const b ){
      return gsl_cheb_init( cs.get(), func, a, b ); }
 
    inline size_t order( series const& cs ){ return gsl_cheb_order( cs.get() ); }
 
    inline size_t size( series const& cs ){ return gsl_cheb_size( cs.get() ); }
 
    inline double* coeffs( series const& cs ){ return gsl_cheb_coeffs( cs.get() ); }
 
    inline double eval( series const& cs, double const x )
    { return gsl_cheb_eval( cs.get(), x ); }
 
#ifndef DOXYGEN_SKIP
    inline int eval_err( series const& cs, double const x, double* result, double* abserr ){
      return gsl_cheb_eval_err( cs.get(), x, result, abserr ); }
#endif /* DOXYGEN_SKIP */
    inline int eval_err( series const& cs, double const x, double& result, double& abserr ){
      return gsl_cheb_eval_err( cs.get(), x, &result, &abserr ); }
 
    inline double eval_n( series const& cs, size_t const order, double const x ){
      return gsl_cheb_eval_n( cs.get(), order, x ); }
    
#ifndef DOXYGEN_SKIP
    inline int eval_n_err( series const& cs, size_t const order, double const x,
               double* result, double* abserr ){
      return gsl_cheb_eval_n_err( cs.get(), order, x, result, abserr ); }
#endif /* DOXYGEN_SKIP */
    inline int eval_n_err( series const& cs, size_t const order, double const x,
               double& result, double& abserr ){
      return gsl_cheb_eval_n_err( cs.get(), order, x, &result, &abserr ); }
 
    inline double eval_mode( series const& cs, double const x, gsl::mode_t mode ){
      return gsl_cheb_eval_mode( cs.get(), x, mode ); }
    
#ifndef DOXYGEN_SKIP
    inline int eval_mode_e( series const& cs, double const x, gsl_mode_t mode,
                double* result, double* abserr ){
      return gsl_cheb_eval_mode_e( cs.get(), x, mode, result, abserr ); }
#endif /* DOXYGEN_SKIP */
    inline int eval_mode_e( series const& cs, double const x, gsl_mode_t mode,
                double& result, double& abserr ){
      return gsl_cheb_eval_mode_e( cs.get(), x, mode, &result, &abserr ); }
 
    inline int calc_deriv( series& deriv, series const& cs ){
      return gsl_cheb_calc_deriv( deriv.get(), cs.get() ); }
 
    inline int calc_integ( series& integ, series const& cs ){
      return gsl_cheb_calc_integ( integ.get(), cs.get() ); }
  }
}
#endif