filter.hpp

Go to the documentation of this file.

/*
 * $Id$
 * Copyright (C) 2019 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_FILTER_HPP
#define CCGSL_FILTER_HPP
 
#include<gsl/gsl_filter.h>
#include"vector.hpp"
#include"vector_int.hpp"
 
namespace gsl {
  namespace filter {
    class gaussian_workspace {
    public:
      gaussian_workspace(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit gaussian_workspace( size_t const K ){
    ccgsl_pointer = gsl_filter_gaussian_alloc( K );
    // just plausibly we could allocate gaussian_impulse_workspace but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_filter_gaussian_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit gaussian_workspace( gsl_filter_gaussian_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
      gaussian_workspace( gaussian_workspace const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      gaussian_workspace& operator=( gaussian_workspace const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_filter_gaussian_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
      }
      // destructor
      ~gaussian_workspace(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_filter_gaussian_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      gaussian_workspace( gaussian_workspace&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
    std::swap( count, v.count );
    v.ccgsl_pointer = nullptr;
      }
      gaussian_workspace& operator=( gaussian_workspace&& v ){
    gaussian_workspace( std::move( v ) ).swap( *this );
    return *this;
      }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( gaussian_workspace const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( gaussian_workspace const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( gaussian_workspace const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( gaussian_workspace const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( gaussian_workspace const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( gaussian_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( gaussian_workspace& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_filter_gaussian_workspace* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_filter_gaussian_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; }
    };
    inline int gaussian( gsl_filter_end_t const endtype, double const alpha, size_t const order,
             vector const& x, vector& y, gaussian_workspace& w ){
      return gsl_filter_gaussian( endtype, alpha, order, x.get(), y.get(), w.get() ); } 
    inline int gaussian_kernel( double const alpha, size_t const order, int const normalize,
                vector& kernel ){
      return gsl_filter_gaussian_kernel( alpha, order, normalize, kernel.get() ); } 
    class median_workspace {
    public:
      median_workspace(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit median_workspace( size_t const K ){
    ccgsl_pointer = gsl_filter_median_alloc( K );
    // just plausibly we could allocate filter_median but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_filter_median_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit median_workspace( gsl_filter_median_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
      median_workspace( median_workspace const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      median_workspace& operator=( median_workspace const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_filter_median_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count;
    return *this;
      }
      // destructor
      ~median_workspace(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_filter_median_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      median_workspace( median_workspace&& v ) : ccgsl_pointer( v.ccgsl_pointer ),
                         count( nullptr ){
    std::swap( count, v.count );
    v.ccgsl_pointer = nullptr;
      }
      median_workspace& operator=( median_workspace&& v ){
    median_workspace( std::move( v ) ).swap( *this );
    return *this;
      }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( median_workspace const& v ) const {
    return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( median_workspace const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( median_workspace const& v ) const {
    return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( median_workspace const& v ) const {
    return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( median_workspace const& v ) const {
    return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( median_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( median_workspace& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_filter_median_workspace* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_filter_median_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; }
    };
    inline int median( gsl_filter_end_t const endtype, vector const& x, vector& y,
               median_workspace& w ){
      return gsl_filter_median( endtype, x.get(), y.get(), w.get() ); } 
    class rmedian_workspace {
    public:
      rmedian_workspace(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit rmedian_workspace( size_t const K ){
    ccgsl_pointer = gsl_filter_rmedian_alloc( K );
    // just plausibly we could allocate filter_gaussian_workspace but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_filter_rmedian_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit rmedian_workspace( gsl_filter_rmedian_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
      rmedian_workspace( rmedian_workspace const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      rmedian_workspace& operator=( rmedian_workspace const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_filter_rmedian_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count;
    return *this;
      }
      // destructor
      ~rmedian_workspace(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_filter_rmedian_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      rmedian_workspace( rmedian_workspace&& v ) : ccgsl_pointer( v.ccgsl_pointer ),
                           count( nullptr ){
    std::swap( count, v.count );
    v.ccgsl_pointer = nullptr;
      }
      rmedian_workspace& operator=( rmedian_workspace&& v ){
    rmedian_workspace( std::move( v ) ).swap( *this );
    return *this;
      }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( rmedian_workspace const& v ) const {
    return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( rmedian_workspace const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( rmedian_workspace const& v ) const {
    return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( rmedian_workspace const& v ) const {
    return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( rmedian_workspace const& v ) const {
    return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( rmedian_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( rmedian_workspace& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_filter_rmedian_workspace* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_filter_rmedian_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; }
    };
    inline int rmedian( gsl_filter_end_t const endtype, vector const& x, vector& y,
            rmedian_workspace& w ){
      return gsl_filter_rmedian( endtype, x.get(), y.get(), w.get() ); } 
    class impulse_workspace {
    public:
      impulse_workspace(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit impulse_workspace( size_t const K ){
    ccgsl_pointer = gsl_filter_impulse_alloc( K );
    // just plausibly we could allocate filter_impulse_workspace but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_filter_impulse_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit impulse_workspace( gsl_filter_impulse_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
      impulse_workspace( impulse_workspace const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      impulse_workspace& operator=( impulse_workspace const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_filter_impulse_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count;
    return *this;
      }
      // destructor
      ~impulse_workspace(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_filter_impulse_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      impulse_workspace( impulse_workspace&& v ) : ccgsl_pointer( v.ccgsl_pointer ),
                           count( nullptr ){
    std::swap( count, v.count );
    v.ccgsl_pointer = nullptr;
      }
      impulse_workspace& operator=( impulse_workspace&& v ){
    impulse_workspace( std::move( v ) ).swap( *this );
    return *this;
      }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( impulse_workspace const& v ) const {
    return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( impulse_workspace const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( impulse_workspace const& v ) const {
    return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( impulse_workspace const& v ) const {
    return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( impulse_workspace const& v ) const {
    return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( impulse_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( impulse_workspace& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_filter_impulse_workspace* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_filter_impulse_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; }
    };
    inline int impulse( gsl_filter_end_t const endtype, gsl_filter_scale_t const scale_type,
            double const t, vector const& x, vector& y, vector& xmedian,
            vector& xsigma, size_t& noutlier, vector_int& ioutlier,
            impulse_workspace& w ){
      return gsl_filter_impulse( endtype, scale_type, t, x.get(), y.get(), xmedian.get(),
                 xsigma.get(), &noutlier, ioutlier.get(), w.get() ); }
  }
}
#endif