multiroots.hpp

Go to the documentation of this file.

/*
 * $Id: multiroots.hpp 171 2012-06-19 19:15:15Z jdl3 $
 * Copyright (C) 2010, 2011, 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_MULTIROOTS_HPP
#define CCGSL_MULTIROOTS_HPP
 
#include<gsl/gsl_multiroots.h>
#include"vector.hpp"
#include"multiroot_function.hpp"
#include"matrix.hpp"
#include"multiroot_function_fdf.hpp"
 
namespace gsl {
  namespace multiroot {
    inline int fdjacobian( multiroot::function& F, vector const& x, vector const& f,
               double epsrel, matrix& jacobian ){
      return gsl_multiroot_fdjacobian( &F, x.get(), f.get(), epsrel, jacobian.get() ); }
#ifndef DOXYGEN_SKIP
    inline int fdjacobian( gsl_multiroot_function* F, vector const& x, vector const& f,
               double epsrel, matrix& jacobian ){
      return gsl_multiroot_fdjacobian( F, x.get(), f.get(), epsrel, jacobian.get() ); }
#endif // DOXYGEN_SKIP
 
    class fsolver {
    public:
      typedef gsl_multiroot_fsolver_type type;
      fsolver(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit fsolver( type const* T, size_t const n ){
    ccgsl_pointer = gsl_multiroot_fsolver_alloc( T, n );
    // just plausibly we could allocate fsolver but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_multiroot_fsolver_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit fsolver( gsl_multiroot_fsolver* 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
      fsolver( fsolver const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      fsolver& operator=( fsolver const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_multiroot_fsolver_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
      }
      // destructor
      ~fsolver(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_multiroot_fsolver_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    fsolver( fsolver&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
      std::swap( count, v.count );
      v.ccgsl_pointer = nullptr;
    }
    fsolver& operator=( fsolver&& v ){
      fsolver( std::move( v ) ).swap( *this );
      return *this;
    }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( fsolver const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( fsolver const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( fsolver const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( fsolver const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( fsolver const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( fsolver 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( fsolver& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_multiroot_fsolver* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_multiroot_fsolver* 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; }
 
#ifndef DOXYGEN_SKIP
      inline static int set( fsolver& s, function* f, vector const& x ){
    return gsl_multiroot_fsolver_set( s.get(), f, x.get() ); }
#endif // DOXYGEN_SKIP
      inline static int set( fsolver& s, function& f, vector const& x ){
    return gsl_multiroot_fsolver_set( s.get(), &f, x.get() ); }
 
      inline static int iterate( fsolver& s ){
    return gsl_multiroot_fsolver_iterate( s.get() ); }
 
      inline static std::string name( fsolver const& s ){
    return std::string( gsl_multiroot_fsolver_name( s.get() ) ); }
 
      inline static vector root( fsolver const& s ){
    vector result( gsl_multiroot_fsolver_root( s.get() ) );
    return result;
      }
 
      inline static vector dx( fsolver const& s ){
    vector result( gsl_multiroot_fsolver_dx( s.get() ) );
    return result;
      }
 
      inline static vector f( fsolver const& s ){
    vector result( gsl_multiroot_fsolver_f( s.get() ) );
    return result;
      }
      
      // Member functions
 
#ifndef DOXYGEN_SKIP
      int set( function* f, vector const& x ){
    return gsl_multiroot_fsolver_set( get(), f, x.get() ); }
#endif // DOXYGEN_SKIP
      int set( function& f, vector const& x ){
    return gsl_multiroot_fsolver_set( get(), &f, x.get() ); }
 
      int iterate(){
    return gsl_multiroot_fsolver_iterate( get() ); }
 
      char const* name(){ return gsl_multiroot_fsolver_name( get() ); }
 
      vector const root(){
    vector result;
    result.wrap_gsl_vector_without_ownership( gsl_multiroot_fsolver_root( get() ) );
    return result;
      }
 
      vector const dx(){
    vector result;
    result.wrap_gsl_vector_without_ownership( gsl_multiroot_fsolver_dx( get() ) );
    return result;
      }
 
      vector const f(){
    vector result;
    result. wrap_gsl_vector_without_ownership( gsl_multiroot_fsolver_f( get() ) );
    return result;
      }
 
      // Solver types
      inline static type const* dnewton(){ return gsl_multiroot_fsolver_dnewton; }
      inline static type const* broyden(){ return gsl_multiroot_fsolver_broyden; }
      inline static type const* hybrid(){ return gsl_multiroot_fsolver_hybrid; }
      inline static type const* hybrids(){ return gsl_multiroot_fsolver_hybrids; }
    };
 
    class fdfsolver {
    public:
      typedef gsl_multiroot_fdfsolver_type type;
      fdfsolver(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit fdfsolver( type const* T, size_t const n ){
    ccgsl_pointer = gsl_multiroot_fdfsolver_alloc( T, n );
    // just plausibly we could allocate fdfsolver but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_multiroot_fdfsolver_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit fdfsolver( gsl_multiroot_fdfsolver* 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
      fdfsolver( fdfsolver const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      fdfsolver& operator=( fdfsolver const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_multiroot_fdfsolver_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
      }
      // destructor
      ~fdfsolver(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_multiroot_fdfsolver_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    fdfsolver( fdfsolver&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
      std::swap( count, v.count );
      v.ccgsl_pointer = nullptr;
    }
    fdfsolver& operator=( fdfsolver&& v ){
      fdfsolver( std::move( v ) ).swap( *this );
      return *this;
    }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( fdfsolver const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( fdfsolver const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( fdfsolver const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( fdfsolver const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( fdfsolver const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( fdfsolver 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( fdfsolver& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_multiroot_fdfsolver* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_multiroot_fdfsolver* 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; }
 
#ifndef DOXYGEN_SKIP
      inline static int set( fdfsolver& s, function_fdf* f, vector const& x ){
    return gsl_multiroot_fdfsolver_set( s.get(), f, x.get() ); }
#endif // DOXYGEN_SKIP
      inline static int set( fdfsolver& s, function_fdf& f, vector const& x ){
    return gsl_multiroot_fdfsolver_set( s.get(), &f, x.get() ); }
 
      inline static int iterate( fdfsolver& s ){
    return gsl_multiroot_fdfsolver_iterate( s.get() ); }
 
      inline static std::string name( fdfsolver const& s ){
    return std::string( gsl_multiroot_fdfsolver_name( s.get() ) ); }
 
      inline static vector root( fdfsolver const& s ){
    vector result( gsl_multiroot_fdfsolver_root( s.get() ) );
    return result;
      }
 
      inline static vector dx( fdfsolver const& s ){
    vector result( gsl_multiroot_fdfsolver_dx( s.get() ) );
    return result;
      }
 
      inline static vector f( fdfsolver const& s ){
    vector result( gsl_multiroot_fdfsolver_f( s.get() ) );
    return result;
      }
      
      // Member functions
 
#ifndef DOXYGEN_SKIP
      int set( function_fdf* f, vector const& x ){
    return gsl_multiroot_fdfsolver_set( get(), f, x.get() ); }
#endif // DOXYGEN_SKIP
      int set( function_fdf& f, vector const& x ){
    return gsl_multiroot_fdfsolver_set( get(), &f, x.get() ); }
 
      int iterate(){
    return gsl_multiroot_fdfsolver_iterate( get() ); }
 
      char const* name(){ return gsl_multiroot_fdfsolver_name( get() ); }
 
      vector const root(){
    vector result;
    result.wrap_gsl_vector_without_ownership( gsl_multiroot_fdfsolver_root( get() ) );
    return result;
      }
 
      vector const dx(){
    vector result;
    result.wrap_gsl_vector_without_ownership( gsl_multiroot_fdfsolver_dx( get() ) );
    return result;
      }
 
      vector const f(){
    vector result;
    result. wrap_gsl_vector_without_ownership( gsl_multiroot_fdfsolver_f( get() ) );
    return result;
      }
 
      // Solver types
      inline static type const* hybridsj(){ return gsl_multiroot_fdfsolver_hybridsj; }
      inline static type const* hybridj(){ return gsl_multiroot_fdfsolver_hybridj; }
      inline static type const* newton(){ return gsl_multiroot_fdfsolver_newton; }
      inline static type const* gnewton(){ return gsl_multiroot_fdfsolver_gnewton; }
    };
 
    namespace test {
      inline int delta( vector const& dx, vector const& x, double epsabs, double epsrel ){
    return gsl_multiroot_test_delta( dx.get(), x.get(), epsabs, epsrel ); }
      
      inline int residual( vector const& f, double epsabs ){
    return gsl_multiroot_test_residual( f.get(), epsabs ); }
    }
  }
}
#endif