rstat.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_RSTAT
#define CCGSL_RSTAT
 
#include<cmath>
#include<gsl/gsl_rstat.h>
#include"vector.hpp"
 
namespace gsl {
  namespace rstat {
    class workspace {
    public:
      explicit workspace(){
    ccgsl_pointer = gsl_rstat_alloc();
    // 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_rstat_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit workspace( gsl_rstat_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_rstat_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_rstat_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_rstat_workspace* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_rstat_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; }
    public:
      // member functions
      size_t n() const { return gsl_rstat_n( get() ); } 
      int add( double const x ){ return gsl_rstat_add( x, get() ); } 
      double min() const { return gsl_rstat_min( get() ); } 
      double
      max() const { return gsl_rstat_max( get() ); } 
      double mean() const { return gsl_rstat_mean( get() ); } 
      double variance() const { return gsl_rstat_variance( get() ); } 
      double sd() const { return gsl_rstat_sd( get() ); } 
      double rms() const { return gsl_rstat_rms( get() ); } 
      double sd_mean() const { return gsl_rstat_sd_mean( get() ); } 
      double median() const { return gsl_rstat_median( get() ); } 
      double skew() const { return gsl_rstat_skew( get() ); } 
      double kurtosis() const { return gsl_rstat_kurtosis( get() ); } 
      int reset(){ return gsl_rstat_reset( get() ); } 
    };
    // namespace functions
    inline size_t n( workspace const& w ){ return gsl_rstat_n( w.get() ); } 
    inline int add( double const x, workspace& w ){ return gsl_rstat_add( x, w.get() ); } 
    inline double min( workspace const& w ){ return gsl_rstat_min( w.get() ); } 
    inline double
    max( workspace const& w ){ return gsl_rstat_max( w.get() ); } 
    inline double mean( workspace const& w ){ return gsl_rstat_mean( w.get() ); } 
    inline double variance( workspace const& w ){ return gsl_rstat_variance( w.get() ); } 
    inline double sd( workspace const& w ){ return gsl_rstat_sd( w.get() ); } 
    inline double rms( workspace const& w ){ return gsl_rstat_rms( w.get() ); } 
    inline double sd_mean( workspace const& w ){ return gsl_rstat_sd_mean( w.get() ); } 
    inline double median( workspace& w ){ return gsl_rstat_median( w.get() ); } 
    inline double skew( workspace const& w ){ return gsl_rstat_skew( w.get() ); } 
    inline double kurtosis( workspace const& w ){ return gsl_rstat_kurtosis( w.get() ); } 
    inline int reset( workspace& w ){ return gsl_rstat_reset( w.get() ); } 
    class quantile_workspace {
    public:
      quantile_workspace(){
    ccgsl_pointer = 0;
    count = 0; // initially nullptr will do
      }
      explicit quantile_workspace( double const p ){
    ccgsl_pointer = gsl_rstat_quantile_alloc( p );
    // just plausibly we could allocate quantile_workspace but not count
    try { count = new size_t; } catch( std::bad_alloc& e ){
      // try to tidy up before rethrowing
      gsl_rstat_quantile_free( ccgsl_pointer );
      throw e;
    }
    *count = 1; // initially there is just one reference to ccgsl_pointer
      }
      explicit quantile_workspace( gsl_rstat_quantile_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
      quantile_workspace( quantile_workspace const& v ){ ccgsl_pointer = v.ccgsl_pointer;
    count = v.count; if( count != 0 ) ++*count; }
      // assignment operator
      quantile_workspace& operator=( quantile_workspace const& v ){
    // first, possibly delete anything pointed to by this
    if( count == 0 or --*count == 0 ){
      if( ccgsl_pointer != 0 ) gsl_rstat_quantile_free( ccgsl_pointer );
      delete count;
    } // Then copy
    ccgsl_pointer = v.ccgsl_pointer; count = v.count; if( count != 0 ) ++*count;
    return *this;
      }
      // destructor
      ~quantile_workspace(){
    if( count == 0 or --*count == 0 ){
      // could have allocated null pointer
      if( ccgsl_pointer != 0 ) gsl_rstat_quantile_free( ccgsl_pointer );
      delete count;
    }
      }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
      quantile_workspace( quantile_workspace&& v )
    : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
    std::swap( count, v.count );
    v.ccgsl_pointer = nullptr;
      }
      quantile_workspace& operator=( quantile_workspace&& v ){
    quantile_workspace( std::move( v ) ).swap( *this );
    return *this;
      }
#endif
      // Refines equality comparable
      // == operator
      bool operator==( quantile_workspace const& v ) const
      { return ccgsl_pointer == v.ccgsl_pointer; }
      // != operator
      bool operator!=( quantile_workspace const& v ) const { return not operator==( v ); }
      // Refines forward container
      // Refines less than comparable
      // operator<
      bool operator<( quantile_workspace const& v ) const
      { return ccgsl_pointer < v.ccgsl_pointer; }
      // operator>
      bool operator>( quantile_workspace const& v ) const
      { return ccgsl_pointer > v.ccgsl_pointer; }
      // operator<=
      bool operator<=( quantile_workspace const& v ) const
      { return ccgsl_pointer <= v.ccgsl_pointer; }
      // operator>=
      bool operator>=( quantile_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( quantile_workspace& v ){
    std::swap( ccgsl_pointer, v.ccgsl_pointer );
    std::swap( count, v.count );
      }
    private:
      gsl_rstat_quantile_workspace* ccgsl_pointer;
      size_t* count;
    public:
      // shared reference functions
      gsl_rstat_quantile_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; }
    public:
      // member functions
      int reset(){
    return gsl_rstat_quantile_reset( get() ); }
      int add( double const x ){
    return gsl_rstat_quantile_add( x, get() ); }
      double get_value(){
    return gsl_rstat_quantile_get( get() ); }
    };
    namespace quantile {
      inline int reset( quantile_workspace& w ){
    return gsl_rstat_quantile_reset( w.get() ); }
      inline int add( double const x, quantile_workspace& w ){
    return gsl_rstat_quantile_add( x, w.get() ); }
      inline double get( quantile_workspace& w ){
    return gsl_rstat_quantile_get( w.get() ); }
    }
  }
}
 
#endif