rng.hpp

Go to the documentation of this file.

/*
 * $Id: rng.hpp 293 2012-12-17 20:27:36Z jdl3 $
 * Copyright (C) 2010, 2011 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_RNG_HPP
#define CCGSL_RNG_HPP
 
#include<new>
#include<algorithm>
#include<gsl/gsl_rng.h>
 
namespace gsl {
  class rng {
  public:
    typedef gsl_rng_type const* type;
    static type const borosh13(){ return gsl_rng_borosh13; }
    static type const coveyou(){ return gsl_rng_coveyou; }
    static type const cmrg(){ return gsl_rng_cmrg; }
    static type const fishman18(){ return gsl_rng_fishman18; }
    static type const fishman20(){ return gsl_rng_fishman20; }
    static type const fishman2x(){ return gsl_rng_fishman2x; }
    static type const gfsr4(){ return gsl_rng_gfsr4; }
    static type const knuthran(){ return gsl_rng_knuthran; }
    static type const knuthran2(){ return gsl_rng_knuthran2; }
    static type const knuthran2002(){ return gsl_rng_knuthran2002; }
    static type const lecuyer21(){ return gsl_rng_lecuyer21; }
    static type const minstd(){ return gsl_rng_minstd; }
    static type const mrg(){ return gsl_rng_mrg; }
    static type const mt19937(){ return gsl_rng_mt19937; }
    static type const mt19937_1999(){ return gsl_rng_mt19937_1999; }
    static type const mt19937_1998(){ return gsl_rng_mt19937_1998; }
    static type const r250(){ return gsl_rng_r250; }
    static type const ran0(){ return gsl_rng_ran0; }
    static type const ran1(){ return gsl_rng_ran1; }
    static type const ran2(){ return gsl_rng_ran2; }
    static type const ran3(){ return gsl_rng_ran3; }
    static type const rand(){ return gsl_rng_rand; }
    static type const rand48(){ return gsl_rng_rand48; }
    static type const random128_bsd(){ return gsl_rng_random128_bsd; }
    static type const random128_glibc2(){ return gsl_rng_random128_glibc2; }
    static type const random128_libc5(){ return gsl_rng_random128_libc5; }
    static type const random256_bsd(){ return gsl_rng_random256_bsd; }
    static type const random256_glibc2(){ return gsl_rng_random256_glibc2; }
    static type const random256_libc5(){ return gsl_rng_random256_libc5; }
    static type const random32_bsd(){ return gsl_rng_random32_bsd; }
    static type const random32_glibc2(){ return gsl_rng_random32_glibc2; }
    static type const random32_libc5(){ return gsl_rng_random32_libc5; }
    static type const random64_bsd(){ return gsl_rng_random64_bsd; }
    static type const random64_glibc2(){ return gsl_rng_random64_glibc2; }
    static type const random64_libc5(){ return gsl_rng_random64_libc5; }
    static type const random8_bsd(){ return gsl_rng_random8_bsd; }
    static type const random8_glibc2(){ return gsl_rng_random8_glibc2; }
    static type const random8_libc5(){ return gsl_rng_random8_libc5; }
    static type const random_bsd(){ return gsl_rng_random_bsd; }
    static type const random_glibc2(){ return gsl_rng_random_glibc2; }
    static type const random_libc5(){ return gsl_rng_random_libc5; }
    static type const randu(){ return gsl_rng_randu; }
    static type const ranf(){ return gsl_rng_ranf; }
    static type const ranlux(){ return gsl_rng_ranlux; }
    static type const ranlux389(){ return gsl_rng_ranlux389; }
    static type const ranlxd1(){ return gsl_rng_ranlxd1; }
    static type const ranlxd2(){ return gsl_rng_ranlxd2; }
    static type const ranlxs0(){ return gsl_rng_ranlxs0; }
    static type const ranlxs1(){ return gsl_rng_ranlxs1; }
    static type const ranlxs2(){ return gsl_rng_ranlxs2; }
    static type const ranmar(){ return gsl_rng_ranmar; }
    static type const slatec(){ return gsl_rng_slatec; }
    static type const taus(){ return gsl_rng_taus; }
    static type const taus2(){ return gsl_rng_taus2; }
    static type const taus113(){ return gsl_rng_taus113; }
    static type const transputer(){ return gsl_rng_transputer; }
    static type const tt800(){ return gsl_rng_tt800; }
    static type const uni(){ return gsl_rng_uni; }
    static type const uni32(){ return gsl_rng_uni32; }
    static type const vax(){ return gsl_rng_vax; }
    static type const waterman14(){ return gsl_rng_waterman14; }
    static type const zuf(){ return gsl_rng_zuf; }
    static type const Default(){ return gsl_rng_default; }
  public:
    rng(){
      ccgsl_pointer = 0;
      count = 0; // initially nullptr will do
    }
    // Refines assignable
    explicit rng( gsl_rng_type const* T ){
      ccgsl_pointer = gsl_rng_alloc( T );
      // just plausibly we could allocate mathieu_rng but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    gsl_rng_free( ccgsl_pointer );
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    explicit rng( gsl_rng* 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
    rng( rng const& v ){ ccgsl_pointer = v.ccgsl_pointer;
      count = v.count; if( count != 0 ) ++*count; }
    // assignment operator
    rng& operator=( rng const& v ){
      // first, possibly delete anything pointed to by this
      if( count == 0 or --*count == 0 ){
    if( ccgsl_pointer != 0 ) gsl_rng_free( ccgsl_pointer );
    delete count;
      } // Then copy
      ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count; return *this;
    }
    // destructor
    ~rng(){
      if( count == 0 or --*count == 0 ){
    // could have allocated null pointer
    if( ccgsl_pointer != 0 ) gsl_rng_free( ccgsl_pointer );
    delete count;
      }
    }
    // Refines equality comparable
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    rng( rng&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
      std::swap( count, v.count );
      v.ccgsl_pointer = nullptr;
    }
    rng& operator=( rng&& v ){
      rng( std::move( v ) ).swap( *this );
      return *this;
    }
#endif
    // == operator
    bool operator==( rng const& v ) const { return ccgsl_pointer == v.ccgsl_pointer; }
    // != operator
    bool operator!=( rng const& v ) const { return not operator==( v ); }
    // Refines forward container
    // Refines less than comparable
    // operator<
    bool operator<( rng const& v ) const { return ccgsl_pointer < v.ccgsl_pointer; }
    // operator>
    bool operator>( rng const& v ) const { return ccgsl_pointer > v.ccgsl_pointer; }
    // operator<=
    bool operator<=( rng const& v ) const { return ccgsl_pointer <= v.ccgsl_pointer; }
    // operator>=
    bool operator>=( rng 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( rng& v ){
      std::swap( ccgsl_pointer, v.ccgsl_pointer );
      std::swap( count, v.count );
    }
  private:
    gsl_rng* ccgsl_pointer;
    size_t* count;
  public:
    // shared reference functions
    gsl_rng* 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; }
    // Functions
    static type* types_setup(){ return gsl_rng_types_setup(); }
     int memcpy( rng const& src ){ return gsl_rng_memcpy( get(), src.get() ); } 
     rng clone() const { return rng( gsl_rng_clone( get() ) ); } 
     void set( unsigned long int seed ) const { gsl_rng_set( get(), seed ); } 
     unsigned long int max() const { return gsl_rng_max( get() ); } 
     unsigned long int min() const { return gsl_rng_min( get() ); } 
     char const* name() const { return gsl_rng_name( get() ); } 
     int fread( FILE* stream ){ return gsl_rng_fread( stream, get() ); } 
     int fwrite( FILE* stream ) const { return gsl_rng_fwrite( stream, get() ); } 
     size_t size() const { return gsl_rng_size( get() ); } 
     void* state() const { return gsl_rng_state( get() ); } 
     void print_state() const { gsl_rng_print_state( get() ); } 
    static type env_setup(){ return gsl_rng_env_setup(); } 
     unsigned long int get_value() const { return gsl_rng_get( get() ); } 
     double uniform() const { return gsl_rng_uniform( get() ); } 
     double uniform_pos() const { return gsl_rng_uniform_pos( get() ); } 
     unsigned long int uniform_int( unsigned long int n ) const {
      return gsl_rng_uniform_int( get(), n ); } 
  };
}
 
#endif