splinalg.hpp

Go to the documentation of this file.

/*
 * $Id$
 * Copyright (C) 2010, 2018, 2019, 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_SPLINALG_HPP
#define CCGSL_SPLINALG_HPP
 
#include<cmath>
#include<gsl/gsl_splinalg.h>
#include"vector.hpp"
#include"spmatrix.hpp"
 
namespace gsl {
  namespace splinalg {
    class itersolve {
    public:
      gsl_splinalg_itersolve_type const*& gmres = gsl_splinalg_itersolve_gmres;
      itersolve(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit itersolve( gsl_splinalg_itersolve_type const* T, size_t const n,
              size_t const m = 0){
    ccgsl_pointer = gsl_splinalg_itersolve_alloc( T, n, m );
    // just plausibly we could allocate itersolve but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_splinalg_itersolve_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit itersolve( gsl_splinalg_itersolve* 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
      itersolve( itersolve const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      itersolve& operator=( itersolve const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_splinalg_itersolve_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count;
    return *this;
      }
      // destructor
      ~itersolve(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_splinalg_itersolve_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      itersolve( itersolve&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
    std::swap( count, v.count );
    v.ccgsl_pointer = nullptr;
      }
      itersolve& operator=( itersolve&& v ){
    itersolve( std::move( v ) ).swap( *this );
    return *this;
      }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( itersolve const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( itersolve const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( itersolve const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( itersolve const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( itersolve const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( itersolve 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( itersolve& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_splinalg_itersolve* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_splinalg_itersolve* 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:
      char const* itersolve_name() const { return gsl_splinalg_itersolve_name( get() ); }
      int itersolve_iterate( spmatrix const& A, vector const& b, double const tol, vector& x ){
    return gsl_splinalg_itersolve_iterate( A.get(), b.get(), tol, x.get(), get() ); } 
      double itersolve_normr() const { return gsl_splinalg_itersolve_normr( get() ); }
    };
  }
}
 
#endif