min.hpp

Go to the documentation of this file.

/*
 * $Id: min.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_MIN_HPP
#define CCGSL_MIN_HPP
 
#include<new>
#include<gsl/gsl_min.h>
#include"function_scl.hpp"
 
namespace gsl {
  namespace min {
    class fminimizer {
    public:
      typedef gsl_min_fminimizer_type type;
      fminimizer(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      // Refines random access container
      // Refines assignable
      explicit fminimizer( type const* T ){
    ccgsl_pointer = gsl_min_fminimizer_alloc( T );
    // just plausibly we could allocate fminimizer but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_min_fminimizer_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit fminimizer( gsl_min_fminimizer* 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
      fminimizer( fminimizer const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      fminimizer& operator=( fminimizer const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_min_fminimizer_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
      }
      // destructor
      ~fminimizer(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_min_fminimizer_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      fminimizer( fminimizer&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
    std::swap( count, v.count );
    v.ccgsl_pointer = nullptr;
      }
      fminimizer& operator=( fminimizer&& v ){
    fminimizer( std::move( v ) ).swap( *this );
    return *this;
      }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( fminimizer const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( fminimizer const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( fminimizer const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( fminimizer const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( fminimizer const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( fminimizer 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( fminimizer& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_min_fminimizer* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_min_fminimizer* 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 static int set( fminimizer& s, function_scl& f, double x_minimum,
                 double x_lower, double x_upper ){
    return gsl_min_fminimizer_set( s.get(), &f, x_minimum, x_lower, x_upper ); }
#ifndef DOXYGEN_SKIP
      inline static int set( fminimizer& s, gsl_function* f, double x_minimum,
                 double x_lower, double x_upper ){
    return gsl_min_fminimizer_set( s.get(), f, x_minimum, x_lower, x_upper ); }
#endif // DOXYGEN_SKIP
 
      inline static int set_with_values( fminimizer& s, function_scl& f,
                     double x_minimum, double f_minimum,
                     double x_lower, double f_lower,
                     double x_upper, double f_upper ){
    return gsl_min_fminimizer_set_with_values( s.get(), &f, x_minimum, f_minimum,
                           x_lower, f_lower, x_upper, f_upper ); }
#ifndef DOXYGEN_SKIP
      inline static int set_with_values( fminimizer& s, gsl_function* f,
                     double x_minimum, double f_minimum,
                     double x_lower, double f_lower,
                     double x_upper, double f_upper ){
    return gsl_min_fminimizer_set_with_values( s.get(), f, x_minimum, f_minimum,
                           x_lower, f_lower, x_upper, f_upper ); }
#endif // DOXYGEN_SKIP
 
      inline static int iterate( fminimizer& s ){ return gsl_min_fminimizer_iterate( s.get() ); }
 
      inline static std::string name( fminimizer const& s ){
    return gsl_min_fminimizer_name( s.get() ); }
 
      inline static double x_minimum( fminimizer const& s ){
    return gsl_min_fminimizer_x_minimum( s.get() ); }
 
      inline static double x_lower( fminimizer const& s ){
    return gsl_min_fminimizer_x_lower( s.get() ); }
 
      inline static double x_upper( fminimizer const& s ){
    return gsl_min_fminimizer_x_upper( s.get() ); }
 
      inline static double f_minimum( fminimizer const& s ){
    return gsl_min_fminimizer_f_minimum( s.get() ); }
 
      inline static double f_lower( fminimizer const& s ){
    return gsl_min_fminimizer_f_lower( s.get() ); }
 
      inline static double f_upper( fminimizer const& s ){
    return gsl_min_fminimizer_f_upper( s.get() ); }
 
      inline int set( function_scl& f, double x_minimum, double x_lower, double x_upper ){
    return gsl_min_fminimizer_set( get(), &f, x_minimum, x_lower, x_upper ); }
#ifndef DOXYGEN_SKIP
      inline int set( gsl_function* f, double x_minimum, double x_lower, double x_upper ){
    return gsl_min_fminimizer_set( get(), f, x_minimum, x_lower, x_upper ); }
#endif // DOXYGEN_SKIP
 
      inline int set_with_values( function_scl& f, double x_minimum, double f_minimum,
                  double x_lower, double f_lower, double x_upper, double f_upper ){
    return gsl_min_fminimizer_set_with_values( get(), &f, x_minimum, f_minimum,
                           x_lower, f_lower, x_upper, f_upper ); }
#ifndef DOXYGEN_SKIP
      inline int set_with_values( gsl_function* f, double x_minimum, double f_minimum,
                  double x_lower, double f_lower, double x_upper, double f_upper ){
    return gsl_min_fminimizer_set_with_values( get(), f, x_minimum, f_minimum,
                           x_lower, f_lower, x_upper, f_upper ); }
#endif // DOXYGEN_SKIP
 
 
      int iterate(){ return gsl_min_fminimizer_iterate( get() ); }
 
      char const* name() const { return gsl_min_fminimizer_name( get() ); }
 
      double x_minimum() const { return gsl_min_fminimizer_x_minimum( get() ); }
 
      double x_lower(){ return gsl_min_fminimizer_x_lower( get() ); }
 
      double x_upper() const { return gsl_min_fminimizer_x_upper( get() ); }
 
      double f_minimum() const { return gsl_min_fminimizer_f_minimum( get() ); }
 
      double f_lower() const { return gsl_min_fminimizer_f_lower( get() ); }
 
      double f_upper() const { return gsl_min_fminimizer_f_upper( get() ); }
 
      inline static type const* goldensection(){ return gsl_min_fminimizer_goldensection; }
 
      inline static type const* brent(){ return gsl_min_fminimizer_brent; }
 
      inline static type const* quad_golden(){ return gsl_min_fminimizer_quad_golden; }
 
    };
 
    inline int test_interval( double x_lower, double x_upper, double epsabs, double epsrel ){
      return gsl_min_test_interval( x_lower, x_upper, epsabs, epsrel ); }
 
    inline int find_bracket( function_scl& f, double& x_minimum, double& f_minimum,
                 double& x_lower, double& f_lower, double& x_upper,
                 double& f_upper, size_t eval_max ){
      return gsl_min_find_bracket( &f, &x_minimum, &f_minimum, &x_lower, &f_lower, &x_upper,
                   &f_upper, eval_max ); }
#ifndef DOXYGEN_SKIP
    inline int find_bracket( gsl_function* f, double* x_minimum, double* f_minimum,
                 double* x_lower, double* f_lower, double* x_upper,
                 double* f_upper, size_t eval_max ){
      return gsl_min_find_bracket( f, x_minimum, f_minimum, x_lower, f_lower, x_upper,
                   f_upper, eval_max ); }
#endif
  }
}
#endif