fft_complex.hpp

Go to the documentation of this file.

/*
 * $Id: fft_complex.hpp 283 2012-08-26 15:36:43Z jdl3 $
 * Copyright (C) 2012 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_FFT_COMPLEX_HPP
#define CCGSL_FFT_COMPLEX_HPP
 
#include <gsl/gsl_fft_complex.h>
#include "complex.hpp"
#include "vector_complex.hpp"
#include "fft.hpp"
 
namespace gsl {
  namespace fft {
    namespace complex {
      namespace radix2 {
    inline int forward( gsl::complex_packed_array data, size_t const stride, size_t const n ){
      return gsl_fft_complex_radix2_forward( data, stride, n ); }
 
    inline int backward( gsl::complex_packed_array data, size_t const stride, size_t const n ){
      return gsl_fft_complex_radix2_backward( data, stride, n ); }
 
    inline int inverse( gsl::complex_packed_array data, size_t const stride, size_t const n ){
      return gsl_fft_complex_radix2_inverse( data, stride, n ); }
 
    inline int transform( gsl::complex_packed_array data, size_t const stride, size_t const n,
                  fft::direction const sign ){
      return gsl_fft_complex_radix2_transform( data, stride, n, sign ); }
 
    inline int dif_forward( gsl::complex_packed_array data, size_t const stride, size_t const n ){
      return gsl_fft_complex_radix2_dif_forward( data, stride, n ); }
 
    inline int dif_backward( gsl::complex_packed_array data, size_t const stride, size_t const n ){
      return gsl_fft_complex_radix2_dif_backward( data, stride, n ); }
 
    inline int dif_inverse( gsl::complex_packed_array data, size_t const stride, size_t const n ){
      return gsl_fft_complex_radix2_dif_inverse( data, stride, n ); }
 
    inline int dif_transform( gsl::complex_packed_array data, size_t const stride, size_t const n,
                  fft::direction const sign ){
      return gsl_fft_complex_radix2_dif_transform( data, stride, n, sign ); }
 
    // Version swithout stride argument
    inline int forward( gsl::complex_packed_array data, size_t const n ){
      return gsl_fft_complex_radix2_forward( data, 1, n ); }
 
    inline int backward( gsl::complex_packed_array data, size_t const n ){
      return gsl_fft_complex_radix2_backward( data, 1, n ); }
 
    inline int inverse( gsl::complex_packed_array data, size_t const n ){
      return gsl_fft_complex_radix2_inverse( data, 1, n ); }
 
    inline int transform( gsl::complex_packed_array data, size_t const n,
                  fft::direction const sign ){
      return gsl_fft_complex_radix2_transform( data, 1, n, sign ); }
 
    inline int dif_forward( gsl::complex_packed_array data, size_t const n ){
      return gsl_fft_complex_radix2_dif_forward( data, 1, n ); }
 
    inline int dif_backward( gsl::complex_packed_array data, size_t const n ){
      return gsl_fft_complex_radix2_dif_backward( data, 1, n ); }
 
    inline int dif_inverse( gsl::complex_packed_array data, size_t const n ){
      return gsl_fft_complex_radix2_dif_inverse( data, 1, n ); }
 
    inline int dif_transform( gsl::complex_packed_array data, size_t const n,
                  fft::direction const sign ){
      return gsl_fft_complex_radix2_dif_transform( data, 1, n, sign ); }
    
    template<typename DATA>
    inline int forward( DATA& data, size_t const stride = 1 ){
      return gsl_fft_complex_radix2_forward( data.data(), stride, data.size() / (2 * stride) ); }
 
    template<typename DATA>
    inline int backward( DATA& data, size_t const stride = 1 ){
      return gsl_fft_complex_radix2_backward( data.data(), stride, data.size() / (2 * stride) ); }
 
    template<typename DATA>
    inline int inverse( DATA& data, size_t const stride = 1 ){
      return gsl_fft_complex_radix2_inverse( data.data(), stride, data.size() / (2 * stride) ); }
 
    template<typename DATA>
    inline int transform( DATA& data, size_t const stride, fft::direction const sign ){
      return gsl_fft_complex_radix2_transform( data.data(), stride,
                           data.size() / (2 * stride), sign ); }
    template<typename DATA>
    inline int transform( DATA& data, fft::direction const sign ){
      return gsl_fft_complex_radix2_transform( data.data(), 1, data.size() / 2, sign ); }
 
    template<typename DATA>
    inline int dif_forward( DATA& data, size_t const stride = 1 ){
      return gsl_fft_complex_radix2_dif_forward( data.data(), stride, data.size() / (2 * stride) ); }
 
    template<typename DATA>
    inline int dif_backward( DATA& data, size_t const stride = 1 ){
      return gsl_fft_complex_radix2_dif_backward( data.data(), stride, data.size() / (2 * stride) ); }
 
    template<typename DATA>
    inline int dif_inverse( DATA& data, size_t const stride = 1 ){
      return gsl_fft_complex_radix2_dif_inverse( data.data(), stride, data.size() / (2 * stride) ); }
 
    template<typename DATA>
    inline int dif_transform( DATA& data, size_t const stride, fft::direction const sign ){
      return gsl_fft_complex_radix2_dif_transform( data.data(), stride,
                               data.size() / (2 * stride), sign ); }
    template<typename DATA>
    inline int dif_transform( DATA& data, fft::direction const sign ){
      return gsl_fft_complex_radix2_dif_transform( data.data(), 1, data.size() / 2, sign ); }
    template<>
    inline int forward( gsl::vector_complex& data, size_t const stride ){
      return gsl_fft_complex_radix2_forward( data.data(), stride, data.size() / stride ); }
 
    template<>
    inline int backward( gsl::vector_complex& data, size_t const stride ){
      return gsl_fft_complex_radix2_backward( data.data(), stride, data.size() / stride ); }
 
    template<>
    inline int inverse( gsl::vector_complex& data, size_t const stride ){
      return gsl_fft_complex_radix2_inverse( data.data(), stride, data.size() / stride ); }
 
    template<>
    inline int transform( gsl::vector_complex& data, size_t const stride, fft::direction const sign ){
      return gsl_fft_complex_radix2_transform( data.data(), stride, data.size() / stride, sign ); }
 
    // stride-free versions
 
    inline int forward( gsl::vector_complex& data ){
      return gsl_fft_complex_radix2_forward( data.data(), 1, data.size() ); }
 
    inline int backward( gsl::vector_complex& data ){
      return gsl_fft_complex_radix2_backward( data.data(), 1, data.size() ); }
 
    inline int inverse( gsl::vector_complex& data ){
      return gsl_fft_complex_radix2_inverse( data.data(), 1, data.size() ); }
 
    inline int transform( gsl::vector_complex& data, fft::direction const sign ){
      return gsl_fft_complex_radix2_transform( data.data(), 1,
                           data.size(), sign ); }
 
    inline int dif_forward( gsl::vector_complex& data ){
      return gsl_fft_complex_radix2_dif_forward( data.data(), 1, data.size() ); }
 
    inline int dif_backward( gsl::vector_complex& data ){
      return gsl_fft_complex_radix2_dif_backward( data.data(), 1, data.size() ); }
 
    inline int dif_inverse( gsl::vector_complex& data ){
      return gsl_fft_complex_radix2_dif_inverse( data.data(), 1, data.size() ); }
 
    inline int dif_transform( gsl::vector_complex& data, fft::direction const sign ){
      return gsl_fft_complex_radix2_dif_transform( data.data(), 1,
                               data.size(), sign ); }
      }
 
      class wavetable {
      public:
    wavetable(){
      ccgsl_pointer = 0;
      count = 0; // initially nullptr will do
    }
    // Refines random access container
    // Refines assignable
    explicit wavetable( size_t const n ){
      ccgsl_pointer = gsl_fft_complex_wavetable_alloc( n );
      // just plausibly we could allocate wavetable but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
        // try to tidy up before rethrowing
        gsl_fft_complex_wavetable_free( ccgsl_pointer );
        throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    explicit wavetable( gsl_fft_complex_wavetable* 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
    wavetable( wavetable const& v ){ ccgsl_pointer = v.ccgsl_pointer;
      count = v.count; if( count != 0 ) ++*count; }
    // assignment operator
    wavetable& operator=( wavetable const& v ){
      // first, possibly delete anything pointed to by this
      if( count == 0 or --*count == 0 ){
        if( ccgsl_pointer != 0 ) gsl_fft_complex_wavetable_free( ccgsl_pointer );
        delete count;
      } // Then copy
      ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
    }
    // clone()
    wavetable clone() const {
      wavetable copy( ccgsl_pointer->n );
      // Now copy
      if( gsl_fft_complex_memcpy( copy.ccgsl_pointer, ccgsl_pointer ) != GSL_SUCCESS )
        throw( std::bad_alloc() );
      // return new object
      return copy;
    }
 
    // destructor
    ~wavetable(){
      if( count == 0 or --*count == 0 ){
        // could have allocated null pointer
        if( ccgsl_pointer != 0 ) gsl_fft_complex_wavetable_free( ccgsl_pointer );
        delete count;
      }
    }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    wavetable( wavetable&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
      std::swap( count, v.count );
      v.ccgsl_pointer = nullptr;
    }
    wavetable& operator=( wavetable&& v ){
      wavetable( std::move( v ) ).swap( *this );
      return *this;
    }
#endif
    // Refines equality comparable
    // == operator
    bool operator==( wavetable const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
    // != operator
    bool operator!=( wavetable const& v ) const { return not operator==( v ); }
    // Refines forward container
    // Refines less than comparable
    // operator<
    bool operator<( wavetable const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
    // operator>
    bool operator>( wavetable const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
    // operator<=
    bool operator<=( wavetable const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
    // operator>=
    bool operator>=( wavetable 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( wavetable& v ){
      std::swap( ccgsl_pointer, v.ccgsl_pointer );
      std::swap( count, v.count );
    }
      private:
    gsl_fft_complex_wavetable* ccgsl_pointer;
    size_t* count;
      public:
    // shared reference functions
    gsl_fft_complex_wavetable* 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 workspace {
      public:
    workspace(){
      ccgsl_pointer = 0;
      count = 0; // initially nullptr will do
    }
    // Refines random access container
    // Refines assignable
    explicit workspace( size_t const n ){
      ccgsl_pointer = gsl_fft_complex_workspace_alloc( n );
      // just plausibly we could allocate workspace but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
        // try to tidy up before rethrowing
        gsl_fft_complex_workspace_free( ccgsl_pointer );
        throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    explicit workspace( gsl_fft_complex_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_fft_complex_workspace_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_fft_complex_workspace_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_fft_complex_workspace* ccgsl_pointer;
    size_t* count;
      public:
    // shared reference functions
    gsl_fft_complex_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 forward( gsl::complex_packed_array data, size_t const stride, size_t const n,
              wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_forward( data, stride, n, wavetable.get(), work.get() ); }
 
      inline int backward( gsl::complex_packed_array data, size_t const stride, size_t const n,
               wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_backward( data, stride, n, wavetable.get(), work.get() ); }
 
      inline int inverse( gsl::complex_packed_array data, size_t const stride, size_t const n,
              wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_inverse( data, stride, n, wavetable.get(), work.get() ); }
 
      inline int transform( gsl::complex_packed_array data, size_t const stride, size_t const n,
                wavetable const& wavetable, workspace& work, fft::direction const sign ){
    return gsl_fft_complex_transform( data, stride, n, wavetable.get(), work.get(), sign ); }
 
      // stride-free versions
      
      inline int forward( gsl::complex_packed_array data, size_t const n,
              wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_forward( data, 1, n, wavetable.get(), work.get() ); }
 
      inline int backward( gsl::complex_packed_array data, size_t const n,
               wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_backward( data, 1, n, wavetable.get(), work.get() ); }
 
      inline int inverse( gsl::complex_packed_array data, size_t const n,
              wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_inverse( data, 1, n, wavetable.get(), work.get() ); }
 
      inline int transform( gsl::complex_packed_array data, size_t const n,
                wavetable const& wavetable, workspace& work, fft::direction const sign ){
    return gsl_fft_complex_transform( data, 1, n, wavetable.get(), work.get(), sign ); }
 
      // template versions
      
      template<typename DATA>
      inline int forward( DATA& data, size_t const stride, wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_forward( data.data(), stride, data.size() / (2 * stride),
                    wavetable.get(), work.get() ); }
 
      template<typename DATA>
      inline int backward(DATA& data, size_t const stride, wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_backward( data.data(), stride, data.size() / (2 * stride),
                     wavetable.get(), work.get() ); }
 
      template<typename DATA>
      inline int inverse( DATA& data, size_t const stride, wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_inverse( data.data(), stride, data.size() / (2 * stride),
                    wavetable.get(), work.get() ); }
 
      template<typename DATA>
      inline int transform( DATA& data, size_t const stride,
                wavetable const& wavetable, workspace& work, fft::direction const sign ){
    return gsl_fft_complex_transform( data.data(), stride, data.size() / (2 * stride),
                      wavetable.get(), work.get(), sign ); }
      template<>
      inline int forward( gsl::vector_complex& data, size_t const stride,
              wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_forward( data.data(), stride, data.size() / stride,
                    wavetable.get(), work.get() ); }
 
      template<>
      inline int backward( gsl::vector_complex& data, size_t const stride,
               wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_backward( data.data(), stride, data.size() / stride,
                     wavetable.get(), work.get() ); }
 
      template<>
      inline int inverse( gsl::vector_complex& data, size_t const stride,
              wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_inverse( data.data(), stride, data.size() / stride,
                    wavetable.get(), work.get() ); }
 
      template<>
      inline int transform( gsl::vector_complex& data, size_t const stride,
                wavetable const& wavetable, workspace& work, fft::direction const sign ){
    return gsl_fft_complex_transform( data.data(), stride, data.size() / stride,
                      wavetable.get(), work.get(), sign ); }
 
      // stride-free versions
 
      template<typename DATA>
      inline int forward( DATA& data, wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_forward( data.data(), 1, data.size() / 2,
                    wavetable.get(), work.get() ); }
 
      template<typename DATA>
      inline int backward(DATA& data, wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_backward( data.data(), 1, data.size() / 2,
                     wavetable.get(), work.get() ); }
 
      template<typename DATA>
      inline int inverse( DATA& data, wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_inverse( data.data(), 1, data.size() / 2,
                    wavetable.get(), work.get() ); }
 
      template<typename DATA>
      inline int transform( DATA& data,
                wavetable const& wavetable, workspace& work, fft::direction const sign ){
    return gsl_fft_complex_transform( data.data(), 1, data.size() / 2,
                      wavetable.get(), work.get(), sign ); }
      template<>
      inline int forward( gsl::vector_complex& data,
              wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_forward( data.data(), 1, data.size(),
                    wavetable.get(), work.get() ); }
 
      template<>
      inline int backward( gsl::vector_complex& data,
               wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_backward( data.data(), 1, data.size(),
                     wavetable.get(), work.get() ); }
 
      template<>
      inline int inverse( gsl::vector_complex& data,
              wavetable const& wavetable, workspace& work ){
    return gsl_fft_complex_inverse( data.data(), 1, data.size(),
                    wavetable.get(), work.get() ); }
 
      template<>
      inline int transform( gsl::vector_complex& data,
                wavetable const& wavetable, workspace& work, fft::direction const sign ){
    return gsl_fft_complex_transform( data.data(), 1, data.size(),
                      wavetable.get(), work.get(), sign ); }
    }
  }
}
 
#endif