vector.hpp

Go to the documentation of this file.

/*
 * $Id: vector.hpp 313 2014-02-22 14:29:57Z jdl3 $
 * Copyright (C) 2010, 2011, 2012, 2019, 2020, 2021, 2024 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_VECTOR_HPP
#define CCGSL_VECTOR_HPP
 
#include<gsl/gsl_vector.h>
#include<new>
#include<iterator>
 
#include"exception.hpp"
#include"block.hpp"
 
// This file is used as a template
 
namespace gsl {
  // declare matrix class
  class matrix;
  namespace multimin {
    // declare class
    class function;
    // declare class
    class function_fdf;
  }
  namespace multifit {
    // declare class
    class function;
    // declare class
    class function_fdf;
    namespace nlinear {
      // declare class
      class function_fdf;
    }
  }
  namespace multilarge {
    namespace nlinear {
      // declare class
      class function_fdf;
    }
  }
  namespace multiroot {
    // declare class
    class function;
    // declare class
    class function_fdf;
  }
  class vector {
    friend class multimin::function;
    friend class multimin::function_fdf;
    friend class multifit::function;
    friend class multifit::function_fdf;
    friend class multiroot::function;
    friend class multiroot::function_fdf;
    friend class multifit::nlinear::function_fdf;
    friend class multilarge::nlinear::function_fdf;
  public:
    vector(){
      owns_data = false;
      ccgsl_pointer = 0;
      count = 0; // initially nullptr will do
    }
    // Refines random access container
    // Refines assignable
    explicit vector( size_t const n )
      : owns_data(true) {
      if( n > 0 ) ccgsl_pointer = gsl_vector_alloc( n );
      else { ccgsl_pointer = new gsl_vector; ccgsl_pointer->size = 0; ccgsl_pointer->data = 0; }
      // just plausibly we could allocate vector but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    if( n > 0 ) gsl_vector_free( ccgsl_pointer );
    else delete ccgsl_pointer;
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
#ifndef DOXYGEN_SKIP
    explicit vector( int const n )
      : owns_data(true){
      if( n > 0 ) ccgsl_pointer = gsl_vector_alloc( static_cast<size_t>( n ) );
      else if(n<0)
    gsl_error("failed tring to make a vector of negative length",
          __FILE__, __LINE__, exception::GSL_EDOM );
      else { ccgsl_pointer = new gsl_vector; ccgsl_pointer->size = 0; ccgsl_pointer->data = 0; }
      // just plausibly we could allocate vector but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    if( n > 0 ) gsl_vector_free( ccgsl_pointer );
    else delete ccgsl_pointer;
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
#endif // DOXYGEN_SKIP
    explicit vector( gsl_vector* v )
      : owns_data(true){
      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
    }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    vector( std::initializer_list<double> initializer_list )
      : owns_data{true}{
      size_t const n = initializer_list.size();
      ccgsl_pointer = gsl_vector_alloc( n );
      // just plausibly we could allocate vector but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    if( n > 0 ) gsl_vector_free( ccgsl_pointer );
    else delete ccgsl_pointer;
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
      // now copy
      auto p = begin();
      for( auto x : initializer_list ){ *p = x; ++p; }
    }
#endif
    // copy constructor
    vector( vector const& v )
      : owns_data(v.owns_data), ccgsl_pointer( v.ccgsl_pointer ), count( v.count ){
      if( count != 0 ) ++*count; // vector is now shared.
    }
    vector( vector& v )
      : owns_data(v.owns_data),
    ccgsl_pointer( v.ccgsl_pointer ), count( v.count ){
      if( count != 0 ) ++*count; // vector is now shared.
    }
    // assignment operator
    vector& operator=( vector const& v ){
      // first, possibly delete anything pointed to by @c this
      if( count == 0 or --*count == 0 ){
    if( ccgsl_pointer != 0 ){
      if( ccgsl_pointer->size > 0 ) gsl_vector_free( ccgsl_pointer );
      else delete ccgsl_pointer; }
    delete count;
      }
      // Then copy
      owns_data = v.owns_data;
      ccgsl_pointer = v.ccgsl_pointer;
      count = v.count;
      if( count != 0 ) ++*count; // block is now shared.
      return *this;
    }
    template<typename V> vector( V& v, size_t const stride = 1 )
      : owns_data(true){
      size_t const n = v.size() / stride;
      ccgsl_pointer = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      ccgsl_pointer->size = n;
      ccgsl_pointer->stride = stride;
      ccgsl_pointer->data = v.data();
      ccgsl_pointer->block = 0;
      ccgsl_pointer->owner = 0;
      // just plausibly we could allocate vector but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    if( n > 0 ) gsl_vector_free( ccgsl_pointer );
    else delete ccgsl_pointer;
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    // clone()
    vector clone() const {
      vector copy( get()->size );
      // Now copy
      gsl_vector_memcpy( copy.get(), get() );
      // return new object
      return copy;
    }
    // destructor
    ~vector(){
      if( count != 0 and --*count == 0 ){
    // could have allocated null pointer
    if( ccgsl_pointer != 0 and owns_data ){
      // only a vector created by wrap_gsl_vector_without_ownership
      if( ccgsl_pointer->size > 0 ) gsl_vector_free( ccgsl_pointer );
      else delete ccgsl_pointer; }
    delete count;
      }
    }
 
    // Allow possibility of assigning from gsl_vector without sharing
    void wrap_gsl_vector_without_ownership( gsl_vector* v ){
      if( count != 0 and --*count == 0 ){
    // could have allocated null pointer
    if( ccgsl_pointer != 0 ){
      if( ccgsl_pointer->size != 0 ) gsl_vector_free( ccgsl_pointer );
      else delete ccgsl_pointer; }
      }
      ccgsl_pointer = v;
      if(0 == count) count = new size_t;
      *count = 1;
      owns_data = false; // should never be able to delete ccgsl_pointer
    }
    // Refines equality comparable
    // == operator
    bool operator==( vector const& v ) const {
      // trivially equal if gsl_vector*s are identical
      if( ccgsl_pointer == v.ccgsl_pointer ) return true;
      // trivially not equal if one is zero: != should be same as xor here
      if( (ccgsl_pointer == 0) != (v.ccgsl_pointer == 0 ) ) return false;
      // trivially not equal if sizes are different
      if( ccgsl_pointer->size != v.ccgsl_pointer->size ) return false;
      // check elementwise for equality
      for( size_t i = 0; i < ccgsl_pointer->size; ++i )
    if( gsl_vector_get( ccgsl_pointer, i ) != gsl_vector_get( v.ccgsl_pointer, i ) ) return false; 
      return true;
    }
    void reset(){ vector().swap( *this ); }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    vector( vector&& v ) : owns_data {v.owns_data},
    ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
      std::swap( count, v.count );
      v.ccgsl_pointer = nullptr;
    }
    vector& operator=( vector&& v ){
      vector( std::move( v ) ).swap( *this );
      return *this;
    }
#endif
    // != operator
    bool operator!=( vector const& v ) const { return not operator==( v ); }
    // Refines forward container
    // Refines less than comparable
    // operator<
    bool operator<( vector const& v ) const {
      // null vector comes first
      if( ccgsl_pointer == 0 ) return v.ccgsl_pointer != 0;
      // if v is null then this > v
      if( v.ccgsl_pointer == 0 ) return false;
      // Now compare elementwise
      size_t const  size = ccgsl_pointer->size;
      size_t const  v_size = v.ccgsl_pointer->size;
      size_t const min = size > v_size ? size : v_size;
      for( size_t i = 0; i < min; ++i ){
    double const t = gsl_vector_get( ccgsl_pointer, i );
    double const u =gsl_vector_get( v.ccgsl_pointer, i );
    if( t < u ) return true;
    if( u < t ) return false;
      }
      // elements match.
      return size < v_size;
    }
    // operator>
    bool operator>( vector const& v ) const {
      // null vector comes first
      if( ccgsl_pointer == 0 ) return false;
      // if v is null then this > v
      if( v.ccgsl_pointer == 0 ) return true;
      // Now compare elementwise
      size_t const  size = ccgsl_pointer->size;
      size_t const  v_size = v.ccgsl_pointer->size;
      size_t const min = size > v_size ? size : v_size;
      for( size_t i = 0; i < min; ++i ){
    double const t = gsl_vector_get( ccgsl_pointer, i );
    double const u =gsl_vector_get( v.ccgsl_pointer, i );
    if( t > u ) return true;
    if( u > t ) return false;
      }
      // elements match.
      return size > v_size;
    }
    // operator<=
    bool operator<=( vector const& v ) const {
      return operator<( v ) or operator==( v );
    }
    // operator>=
    bool operator>=( vector const& v ) const {
      return operator>( v ) or operator==( v );
    }
    // Refines container
    // type value_type
    typedef double value_type;
    // type reference
    typedef value_type& reference;
    // type const_reference
    typedef value_type const& const_reference;
    // type pointer
    typedef value_type* pointer;
    // type const_pointer
    typedef value_type const* const_pointer;
    // type iterator
  private:
    template<typename container, typename content,bool reverse_t> class iterator_base {
      friend class vector;
    public:
      typedef std::random_access_iterator_tag iterator_category;
      typedef double value_type;
      typedef value_type* pointer;
      typedef value_type& reference;
      // // type iterator_traits<vector>::difference_type
      typedef ptrdiff_t difference_type;
    public:
      // // operator*
      reference operator*() const {
    // Always try to return something
    static content something = 0;
    // First check that iterator is initialised.
    if( v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    } else if( v->ccgsl_pointer == 0 ){
      gsl_error( "vector not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    }
    // Check that position make sense
    if( position >= static_cast<difference_type>( v->size() ) ){
      gsl_error( "trying to dereference beyond rbegin()", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    }
    if( position <= -1 ){
      gsl_error( "trying to dereference beyond begin()", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    }
    // position and v are valid: return data
    return *(v->ccgsl_pointer->data + position * v->ccgsl_pointer->stride);
      }
      // // operator->
      pointer operator->() const {
    // First check that iterator is initialised.
    if( v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return 0;
    } else if( v->ccgsl_pointer == 0 ){
      gsl_error( "vector not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return 0;
    }
    // Check that position make sense
    if( position >= static_cast<difference_type>( v->size() ) ){
      gsl_error( "trying to dereference end()", __FILE__, __LINE__, exception::GSL_EFAILED );
      return 0;
    }
    if( position <= -1 ){
      gsl_error( "trying to dereference rend()", __FILE__, __LINE__, exception::GSL_EFAILED );
      return 0;
    }
    // position and v are valid: return data
    return v->ccgsl_pointer->data + position * v->ccgsl_pointer->stride;
      }
      // // operator[]
      reference operator[]( difference_type const n ) const {
    // Always try to return something
    static content something = 0;
    // First check that iterator is initialised.
    if( v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    } else if( v->ccgsl_pointer == 0 ){
      gsl_error( "vector not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    }
    // Check that position make sense
    difference_type const p = reverse_t ? position - n : position + n;
    if( p >= static_cast<difference_type>( v->size() ) ){
      gsl_error( "trying to dereference beyond rbegin()", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    }
    if( p <= -1 ){
      gsl_error( "trying to dereference beyond begin()", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    }
    // p is a valid position
    return *(v->ccgsl_pointer->data + p * v->ccgsl_pointer->stride);
      }
      // // operator-: find distance between two iterators
      difference_type operator-( iterator_base<container,content,reverse_t> const& i ) const {
    // Warn if either iterator undefined
    if( v == 0 or i.v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return 0;
    } else if( v->ccgsl_pointer == 0 or i.v->ccgsl_pointer == 0 ){
      gsl_error( "vector not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return 0;
    }
    // Warn if iterators do not point to same vector
    if( v->ccgsl_pointer != i.v->ccgsl_pointer ){
      gsl_error( "trying to take difference of iterators for different vector objects", __FILE__, __LINE__,
             exception::GSL_EFAILED );
      return 0;
    }
    return reverse_t ? i.position - position : position - i.position;
      }
      // // operator!=
      // // operator<
      bool operator==( iterator_base<container,content,reverse_t> const& i ) const {
    return this->v == i.v and this->position == i.position;
      }
      bool operator!=( iterator_base<container,content,reverse_t> const& i ) const {
    return not this->operator==( i );
      }
      bool operator<( iterator_base<container,content,reverse_t> const& i ) const {
    // Warn if either iterator undefined
    if( v == 0 or i.v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return false;
    }
    // Warn if iterators do not point to same vector
    if( v->ccgsl_pointer != i.v->ccgsl_pointer ){
      gsl_error( "trying to take difference of iterators for different vector objects", __FILE__, __LINE__,
             exception::GSL_EFAILED );
      return false;
    }
    return reverse_t ? i.position < position : position < i.position;
      }
    protected:
      void increment(){
    // Only makes sense if v points to a vector
    if( v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return;
    } else if( v->ccgsl_pointer == 0 ){
      gsl_error( "vector not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return;
    }
    // increment position and check against size
    if( reverse_t ){ if( position >= 0 ) --position; }
    else { if( position < static_cast<difference_type>( v->size() ) ) ++position; }
      }
      void decrement(){
    // Only makes sense if v points to a vector
    if( v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return;
    } else if( v->ccgsl_pointer == 0 ){
      gsl_error( "vector not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return;
    }
    // decrement position and check against size
    if( reverse_t ){ if( position < static_cast<difference_type>( v->size() ) ) ++position; }
    else { if( position >= 0 ) --position; }
      }
      void shift( difference_type const n ){
    // Warn if iterator undefined
    if( v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return;
    } else if( v->ccgsl_pointer == 0 ){
      gsl_error( "vector not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return;
    }
    position += reverse_t ? -n : n;
      }
      iterator_base(){ v = 0; }
      iterator_base( container* v, difference_type position )
    : v( v ), position( position ){}
      container* v;
      difference_type position;
    };
    // Need to know about const_iterator_t
    template<bool reverse_t> class const_iterator_t;
    template<bool reverse_t> class iterator_t : public iterator_base<vector,double,reverse_t>{
    public:
      // // Refines output iterator
      // // operator=
      iterator_t<reverse_t>& operator=( iterator_t<reverse_t> const& i ){
    iterator_base<vector,double,reverse_t>::v = i.v;
    iterator_base<vector,double,reverse_t>::position = i.position;
    return *this;
      }
      // // Refines forward iterator
      // // operator++ (both)
      iterator_t<reverse_t>& operator++(){
    iterator_base<vector,double,reverse_t>::increment();
    return *this;
      }
      iterator_t<reverse_t> operator++( int ){
    // return value
    iterator_t<reverse_t> result( *this );
    iterator_base<vector,double,reverse_t>::increment();
    return result;
      }
      // // Refines bidirectional iterator
      // // operator-- (both)
      iterator_t<reverse_t>& operator--(){
    iterator_base<vector,double,reverse_t>::decrement();
    return *this;
      }
      iterator_t<reverse_t> operator--( int ){
    // return value
    iterator_t<reverse_t> result( *this );
    iterator_base<vector,double,reverse_t>::decrement();
    return result;
      }
      typedef typename iterator_base<vector,double,reverse_t>::difference_type
    difference_type;
      // // operator+=
      iterator_t<reverse_t>& operator+=( difference_type const n ){
    this->shift( n );
    return *this;
      }
      // // operator-=
      iterator_t<reverse_t>& operator-=( difference_type const n ){
    this->shift( -n );
    return *this;
      }
      // // operator+ (n+i)(i+n)
      iterator_t<reverse_t> operator+( difference_type const n ) const {
    iterator_t<reverse_t> result( *this );
    result.shift( n );
    return result;
      }
      // // operator- (n-i)(i-n)(i-j)
      iterator_t<reverse_t> operator-( difference_type const n ) const {
    iterator_t<reverse_t> result( *this );
    result.shift( -n );
    return result;
      }
      difference_type operator-( iterator_t<reverse_t> const& i ) const {
    return iterator_base<vector,double,reverse_t>::operator-( i );
      }
      difference_type operator-( const_iterator_t<reverse_t> const& i ) const {
    // Warn if either iterator undefined
    if( this->v == 0 or i.v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return 0;
    } else if( this->v->ccgsl_pointer == 0 or i.v->ccgsl_pointer == 0 ){
      gsl_error( "vector not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return 0;
    }
    // Warn if iterators do not point to same vector
    if( this->v->ccgsl_pointer != i.v->ccgsl_pointer ){
      gsl_error( "trying to take difference of iterators for different vector objects", __FILE__, __LINE__,
             exception::GSL_EFAILED );
      return 0;
    }
    return reverse_t ? i.position - this->position : this->position - i.position;
      }
      bool operator==( const_iterator_t<reverse_t> const& i ) const {
        return this->v == i.v and this->position == i.position;
      }
      bool operator!=( const_iterator_t<reverse_t> const& i ) const {
        return not this->operator==( i );
      }
      bool operator<( const_iterator_t<reverse_t> const& i ) const {
    // Warn if either iterator undefined
    if( this->v == 0 or i.v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return false;
    }
    // Warn if iterators do not point to same vector
    if( this->v->ccgsl_pointer != i.v->ccgsl_pointer ){
      gsl_error( "trying to take difference of iterators for different vector objects", __FILE__, __LINE__,
             exception::GSL_EFAILED );
      return false;
    }
    return reverse_t ? i.position < this->position : this->position < i.position;
      }
      iterator_t() : iterator_base<vector,double,reverse_t>(){}
    protected:
      friend class vector;
      // We need a constructor for vector
      iterator_t( vector* v, difference_type position )
      : iterator_base<vector,double,reverse_t>( v, position ){}
    };
    template<bool reverse_t> class const_iterator_t
      : public iterator_base<vector const,double,reverse_t>{
    public:
      // // Refines output iterator
      // // operator=
      const_iterator_t<reverse_t>& operator=( const_iterator_t<reverse_t> const& i ){
    iterator_base<vector const,double,reverse_t>::v = i.v;
    iterator_base<vector const,double,reverse_t>::position = i.position;
    return *this;
      }
      // // Refines forward iterator
      // // operator++ (both)
      const_iterator_t<reverse_t>& operator++(){
    iterator_base<vector const,double,reverse_t>::increment();
    return *this;
      }
      const_iterator_t<reverse_t> operator++( int ){
    // return value
    const_iterator_t<reverse_t> result( *this );
    iterator_base<vector const,double,reverse_t>::increment();
    return result;
      }
      // // Refines bidirectional iterator
      // // operator-- (both)
      const_iterator_t<reverse_t>& operator--(){
    iterator_base<vector const,double,reverse_t>::decrement();
    return *this;
      }
      const_iterator_t<reverse_t> operator--( int ){
    // return value
    const_iterator_t<reverse_t> result( *this );
    iterator_base<vector const,double,reverse_t>::decrement();
    return result;
      }
      typedef typename iterator_base<vector const,double,reverse_t>::difference_type
    difference_type;
      // // operator+=
      const_iterator_t<reverse_t>& operator+=( difference_type const n ){
    this->shift( n );
    return *this;
      }
      // // operator-=
      const_iterator_t<reverse_t>& operator-=( difference_type const n ){
    this->shift( -n );
    return *this;
      }
      // // operator+ (n+i)(i+n)
      const_iterator_t<reverse_t> operator+( difference_type const n ) const {
    const_iterator_t<reverse_t> result( *this );
    result += n;
    return result;
      }
      // // operator- (n-i)(i-n)(i-j)
      const_iterator_t<reverse_t> operator-( difference_type const n ) const {
    const_iterator_t<reverse_t> result( *this );
    result -= n;
    return result;
      }
      difference_type operator-( const_iterator_t<reverse_t> const& i ) const {
    return iterator_base<vector const,double,reverse_t>::operator-( i );
      }
      difference_type operator-( iterator_t<reverse_t> const& i ) const {
    // Warn if either iterator undefined
    if( this->v == 0 or i.v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return 0;
    } else if( this->v->ccgsl_pointer == 0 or i.v->ccgsl_pointer == 0 ){
      gsl_error( "vector not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return 0;
    }
    // Warn if iterators do not point to same vector
    if( this->v->ccgsl_pointer != i.v->ccgsl_pointer ){
      gsl_error( "trying to take difference of iterators for different vector objects", __FILE__, __LINE__,
             exception::GSL_EFAILED );
      return 0;
    }
    return reverse_t ? i.position - this->position : this->position - i.position;
      }
      const_iterator_t() : iterator_base<vector,double,reverse_t>(){}
      const_iterator_t( iterator_t<reverse_t> const&i ){
    const_iterator_t<reverse_t>::v = i.v;
    const_iterator_t<reverse_t>::position = i.position;
      }
      bool operator==( iterator_t<reverse_t> const& i ) const {
        return this->v == i.v and this->position == i.position;
      }
      bool operator!=( iterator_t<reverse_t> const& i ) const {
        return not this->operator==( i );
      }
      bool operator<( iterator_t<reverse_t> const& i ) const {
    // Warn if either iterator undefined
    if( this->v == 0 or i.v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return false;
    }
    // Warn if iterators do not point to same vector
    if( this->v->ccgsl_pointer != i.v->ccgsl_pointer ){
      gsl_error( "trying to take difference of iterators for different vector objects", __FILE__, __LINE__,
             exception::GSL_EFAILED );
      return false;
    }
    return reverse_t ? i.position < this->position : this->position < i.position;
      }
      bool operator==( const_iterator_t<reverse_t> const& i ) const {
        return this->v == i.v and this->position == i.position;
      }
      bool operator!=( const_iterator_t<reverse_t> const& i ) const {
        return not this->operator==( i );
      }
      bool operator<( const_iterator_t<reverse_t> const& i ) const {
    // Warn if either iterator undefined
    if( this->v == 0 or i.v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return false;
    }
    // Warn if iterators do not point to same vector
    if( this->v->ccgsl_pointer != i.v->ccgsl_pointer ){
      gsl_error( "trying to take difference of iterators for different vector objects", __FILE__, __LINE__,
             exception::GSL_EFAILED );
      return false;
    }
    return reverse_t ? i.position < this->position : this->position < i.position;
      }
    protected:
      // We need a constructor for vector
      friend class vector;
      const_iterator_t( vector const* v, difference_type position )
      : iterator_base<vector const,double,reverse_t>( v, position ){}
    };
  public:
    typedef const_iterator_t<false> const_iterator;
    typedef iterator_t<false> iterator;
    typedef const_iterator_t<true> const_reverse_iterator;
    typedef iterator_t<true> reverse_iterator;
    // type difference_type
    typedef const_iterator::difference_type difference_type;
    // type size_type
    typedef size_t size_type;
    // begin()
    iterator begin(){
      return iterator( this, 0 );
    }
    const_iterator begin() const {
      return const_iterator( this, 0 );
    }
    // end()
    iterator end(){
      if( ccgsl_pointer == 0 ) return iterator( this, 0 );
      return iterator( this, size() );
    }
    const_iterator end() const {
      if( ccgsl_pointer == 0 ) return const_iterator( this, 0 );
      return const_iterator( this, size() );
    }
    // size()
    size_type size() const { return ccgsl_pointer == 0 ? 0 : ccgsl_pointer->size; }
    double* data() { 
      if( ccgsl_pointer == 0 ) gsl_error( "null vector", __FILE__, __LINE__, GSL_EFAULT );
#ifndef GSL_RANGE_CHECK_OFF
      if( ccgsl_pointer->stride != 1 )
    gsl_error( "vector does not have stride of size 1", __FILE__, __LINE__, GSL_EBADLEN );
#endif
      return ccgsl_pointer->data; }
    double const* data() const {
      if( ccgsl_pointer == 0 ) gsl_error( "null vector", __FILE__, __LINE__, GSL_EFAULT );
#ifndef GSL_RANGE_CHECK_OFF
      if( ccgsl_pointer->stride != 1 )
    gsl_error( "vector does not have stride of size 1", __FILE__, __LINE__, GSL_EBADLEN );
#endif
      return ccgsl_pointer->data; }
    // max_size()
    size_type max_size() const { return ccgsl_pointer == 0 ? 0 : ccgsl_pointer->size; }
    // empty()
    bool empty() const { return ccgsl_pointer == 0 or ccgsl_pointer->size == 0; }
    // swap() --- should work even if sizes don't match
    void swap( vector& v ){
      std::swap( ccgsl_pointer, v.ccgsl_pointer );
      std::swap( count, v.count );
    }
    // Refines reversible container
    // rbegin()
    reverse_iterator rbegin(){
      if( ccgsl_pointer ==0 ) return reverse_iterator( this, 0 );
      return reverse_iterator( this, size() - 1 );
    }
    const_reverse_iterator rbegin() const {
      if( ccgsl_pointer ==0 ) return const_reverse_iterator( this, 0 );
      return const_reverse_iterator( this, size() - 1 );
    }
    // rend()
    reverse_iterator rend(){
      return reverse_iterator( this, -1 );
    }
    const_reverse_iterator rend() const {
      return const_reverse_iterator( this, -1 );
    }
    // operator[]
    double& operator[]( size_t const n ){
      // Always try to return something
      static double something = 0;
      // First check that iterator is initialised.
      if( ccgsl_pointer == 0 ){
    gsl_error( "vector is null", __FILE__, __LINE__, exception::GSL_EFAULT );
    return something;
      }
#ifndef GSL_RANGE_CHECK_OFF
      // Check that position make sense
      if( n >= size() ){
    gsl_error( "trying to read beyond end of vector", __FILE__, __LINE__, exception::GSL_EINVAL );
    return something;
      }
      // n is a valid position
#endif
      return *(ccgsl_pointer->data + n * ccgsl_pointer->stride);
    }
    double const& operator[]( size_t const n ) const {
      // Always try to return something
      static double something = 0;
      // First check that iterator is initialised.
      if( ccgsl_pointer == 0 ){
    gsl_error( "vector is null", __FILE__, __LINE__, exception::GSL_EFAULT );
    return something;
      }
#ifndef GSL_RANGE_CHECK_OFF
      // Check that position make sense
      if( n >= size() ){
    gsl_error( "trying to read beyond end of vector", __FILE__, __LINE__, exception::GSL_EINVAL );
    return something;
      }
      // n is a valid position
#endif
      return *(ccgsl_pointer->data + n * ccgsl_pointer->stride);
    }
  private:
    bool owns_data;
    gsl_vector* ccgsl_pointer;
    size_t* count;
  public:
    // shared reference functions
    gsl_vector* get() { return ccgsl_pointer; }
    gsl_vector const* 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; }
 
    // GSL functions
    static vector calloc( size_t const n ){ return vector( gsl_vector_calloc( n ) ); }
    void set_zero(){ gsl_vector_set_zero( get() ); }
    void set_all( double x ){ gsl_vector_set_all( get(), x ); }
    int set_basis( size_t i ){ return gsl_vector_set_basis( get(), i ); }
    int memcpy( vector const& src ){ return gsl_vector_memcpy( get(), src.get() ); }
    int reverse(){ return gsl_vector_reverse( get() ); }
    int swap_elements( size_t const i, size_t const j ){
      return gsl_vector_swap_elements( get(), i, j ); }
    double max() const { return gsl_vector_max( get() ); }
    double min() const { return gsl_vector_min( get() ); }
    void minmax( double* min_out, double* max_out ) const {
      gsl_vector_minmax( get(), min_out, max_out ); }
    size_t max_index() const { return gsl_vector_max_index( get() ); }
    size_t min_index() const { return gsl_vector_min_index( get() ); }
    void minmax_index( size_t* imin, size_t* imax ) const {
      gsl_vector_minmax_index( get(), imin, imax ); }
    void minmax_index( size_t& imin, size_t& imax ) const {
      gsl_vector_minmax_index( get(), &imin, &imax ); }
    int add( vector const& b ){ return gsl_vector_add( get(), b.get() ); }
    int sub( vector const& b ){ return gsl_vector_sub( get(), b.get() ); }
    int mul( vector const& b ){ return gsl_vector_mul( get(), b.get() ); }
    int div( vector const& b ){ return gsl_vector_div( get(), b.get() ); }
    int scale( double const x ){ return gsl_vector_scale( get(), x ); }
    int add_constant( double const x ){ return gsl_vector_add_constant( get(), x ); }
    int axpby( double const alpha, vector const& x,
           double const beta ){
      return gsl_vector_axpby( alpha, x.get(), beta, get() );
    }
    double sum( vector const& a ) const { return gsl_vector_sum( a.get() ); }
    int isnull() const { return gsl_vector_isnull( get() ); }
    int ispos() const { return gsl_vector_ispos( get() ); }
    int isneg() const { return gsl_vector_isneg( get() ); }
    int isnonneg() const { return gsl_vector_isnonneg( get() ); }
    double get( size_t const i ) const { return gsl_vector_get( get(), i ); }
    void set( size_t const i, double x ){ gsl_vector_set( get(), i, x ); }
    double* ptr( size_t const i ){ return gsl_vector_ptr( get(), i ); }
    double const* const_ptr( size_t const i ) const { return gsl_vector_const_ptr( get(), i ); }
    int fread( FILE* stream ){ return gsl_vector_fread( stream, get() ); }
    int fwrite( FILE* stream ) const { return gsl_vector_fwrite( stream, get() ); }
    int fscanf( FILE* stream ){ return gsl_vector_fscanf( stream, get() ); }
    int fprintf( FILE* stream, char const* format ) const {
      return gsl_vector_fprintf( stream, get(), format ); }
    vector( block& b, size_t const offset, size_t const n, size_t const stride = 1 ){
      ccgsl_pointer = gsl_vector_alloc_from_block( b.get(), offset, n, stride );
      // just plausibly we could allocate vector but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    gsl_vector_free( ccgsl_pointer );
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    vector( vector& v, size_t const offset, size_t const n, size_t const stride = 1 ){
      ccgsl_pointer = gsl_vector_alloc_from_vector( v.get(), offset, n, stride );
      // just plausibly we could allocate vector but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    gsl_vector_free( ccgsl_pointer );
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    static vector view_array( double* v, size_t n ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_view_array( v, n ).vector;
      return vector( w );
    }
 
    static vector view_array_with_stride( double* base, size_t stride, size_t n ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_view_array_with_stride( base, stride, n ).vector;
      return vector( w );
    }
 
 
    static vector const const_view_array( double const* v, size_t n ){
      gsl_vector* w = static_cast<gsl_vector *>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_view_array( v, n ).vector;
      return vector( w );
    }
 
    static vector const const_view_array_with_stride( double const* base, size_t stride, size_t n ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_view_array_with_stride( base, stride, n ).vector;
      return vector( w );
    }
 
 
#ifndef DOXYGEN_SKIP
    static vector const view_array( double const* v, size_t n ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_view_array( v, n ).vector;
      return vector( w );
    }
#endif //DOXYGEN_SKIP
 
 
#ifndef DOXYGEN_SKIP
    static vector const view_array_with_stride( double const* base, size_t stride, size_t n ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_view_array_with_stride( base, stride, n ).vector;
      return vector( w );
    }  
#endif //DOXYGEN_SKIP
 
 
    vector subvector( size_t i, size_t n ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_subvector( get(), i, n ).vector;
      return vector( w );
    }
 
 
    vector subvector_with_stride( size_t i, size_t stride, size_t n ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_subvector_with_stride( get(), i, stride, n ).vector;
      return vector( w );
    }
 
 
    vector const const_subvector( size_t i, size_t n ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_subvector( get(), i, n ).vector;
      return vector( w );
    }
 
 
    vector const const_subvector_with_stride( size_t i, size_t stride, size_t n ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_subvector_with_stride( get(), i, stride, n ).vector;
      return vector( w );
    }
 
 
#ifndef DOXYGEN_SKIP
    vector const subvector( size_t i, size_t n ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_subvector( get(), i, n ).vector;
      return vector( w );
    }
#endif //DOXYGEN_SKIP
 
 
#ifndef DOXYGEN_SKIP
    vector const subvector_with_stride( size_t i, size_t stride, size_t n ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_subvector_with_stride( get(), i, stride, n ).vector;
      return vector( w );
    }
#endif //DOXYGEN_SKIP
 
 
    template<typename ARRAY>
    static vector view_array( ARRAY& v, size_t n = 0 ){
      if(n > v.size())
        gsl_error( "n is too big", __FILE__, __LINE__, exception::GSL_EBADLEN );
      if(0 == n)
        n = v.size();
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_view_array( v.data(), n ).vector;
      return vector( w );
    }
 
 
    template<typename ARRAY>
    static vector view_array_with_stride( ARRAY& base, size_t stride, size_t n=0 ){
      if(0 == n)
        n = base.size()/stride;
      if((n-1)*stride > base.size())
        gsl_error( "n is too big", __FILE__, __LINE__, exception::GSL_EBADLEN );
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_view_array_with_stride( base.data(), stride, n ).vector;
      return vector( w );
    }
 
 
    template<typename ARRAY>
    static vector const const_view_array( ARRAY const& v, size_t n=0 ){
      if(n > v.size())
        gsl_error( "n is too big", __FILE__, __LINE__, exception::GSL_EBADLEN );
      if(0 == n)
        n = v.size();
      gsl_vector* w = static_cast<gsl_vector *>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_view_array( v.data(), n ).vector;
      return vector( w );
    }
 
 
    template<typename ARRAY>
    static vector const const_view_array_with_stride( ARRAY const& base, size_t stride, size_t n=0 ){
      if(0 == n)
        n = base.size()/stride;
      if((n-1)*stride > base.size())
        gsl_error( "n is too big", __FILE__, __LINE__, exception::GSL_EBADLEN );
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_view_array_with_stride( base.data(), stride, n ).vector;
      return vector( w );
    }
 
 
#ifndef DOXYGEN_SKIP
    template<typename ARRAY>
    static vector const view_array( ARRAY const& v, size_t n=0 ){
      if(n > v.size())
        gsl_error( "n is too big", __FILE__, __LINE__, exception::GSL_EBADLEN );
      if(0 == n)
        n = v.size();
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_view_array( v.data(), n ).vector;
      return vector( w );
    }
#endif //DOXYGEN_SKIP
 
 
#ifndef DOXYGEN_SKIP
    template<typename ARRAY>
    static vector const view_array_with_stride( ARRAY const& base, size_t stride, size_t n ){
      if(0 == n)
        n = base.size()/stride;
      if((n-1)*stride > base.size())
        gsl_error( "n is too big", __FILE__, __LINE__, exception::GSL_EBADLEN );
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_vector_const_view_array_with_stride( base.data(), stride, n ).vector;
      return vector( w );
    }  
#endif //DOXYGEN_SKIP
 
    // Extra allocators from matrix objects. The definition must come after matrix.
    static vector alloc_row_from_matrix( matrix& m, size_t const i );
    static vector alloc_col_from_matrix( matrix& m, size_t const j );
    static double get( gsl_vector const* v, size_t const i ){ return gsl_vector_get( v, i ); }
  };
 
  inline vector::iterator operator+
  ( vector::iterator::difference_type const n, vector::iterator const& i ){ return i + n; }
  
  inline vector::const_iterator operator+
  ( vector::const_iterator::difference_type const n, vector::const_iterator const& i ){ return i + n; }
  
  inline vector::reverse_iterator operator+
  ( vector::reverse_iterator::difference_type const n, vector::reverse_iterator const& i ){
    return i + n; }
  
  inline vector::const_reverse_iterator operator+
  ( vector::const_reverse_iterator::difference_type const n, vector::const_reverse_iterator const& i ){
    return i + n; }
  
}
#endif