matrix.hpp

Go to the documentation of this file.

/*
 * $Id: matrix.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_MATRIX_HPP
#define CCGSL_MATRIX_HPP
 
#include<gsl/gsl_matrix.h>
#include<gsl/gsl_permute_matrix_double.h>
#include<new>
 
#include"exception.hpp"
#include"vector.hpp"
#include"permutation.hpp"
 
// This file is used as a template
 
namespace gsl {
  namespace multiroot {
    // declare function_fdf class
    class function_fdf;
  }
  namespace multilarge {
    namespace nlinear {
      // declare class
      class function_fdf;
    }
  }
  namespace multiroot {
    // declare function_fdf class
    class function_fdf;
  }
  class matrix {
    friend class multiroot::function_fdf;
    friend class multifit::nlinear::function_fdf;
    friend class multilarge::nlinear::function_fdf;
  public:
    matrix(){
      owns_data = false;
      ccgsl_pointer = 0;
      count = 0; // initially nullptr will do
    }
    // Refines random access container
    // Refines assignable
    explicit matrix( size_t const n1, size_t const n2 ) : owns_data(true){
      if( n1 > 0 and n2 > 0 ) ccgsl_pointer = gsl_matrix_alloc( n1, n2 );
      else { ccgsl_pointer = new gsl_matrix; ccgsl_pointer->size1 = n1;
    ccgsl_pointer->size2 = n2; ccgsl_pointer->data = 0; }
      // just plausibly we could allocate matrix but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    if( n1 > 0 and n2 > 0 ) gsl_matrix_free( ccgsl_pointer );
    else delete ccgsl_pointer;
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    explicit matrix( gsl_matrix* 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__
    matrix( std::initializer_list<std::initializer_list<double> > initializer_list ) : owns_data(true){
      size_t const n1 = initializer_list.size();
      size_t const n2 = initializer_list.begin()->size();
      for( auto l : initializer_list ){
    if( l.size() != n2 ){
      gsl::exception e( "matrix rows have unequal sizes", __FILE__, __LINE__,
                exception::GSL_EBADLEN );
      throw( e );
    }
      }
      ccgsl_pointer = gsl_matrix_alloc( n1, n2 );
      // just plausibly we could allocate matrix but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
    // try to tidy up before rethrowing
    if( n1 > 0 and n2 > 0 ) gsl_matrix_free( ccgsl_pointer );
    else delete ccgsl_pointer;
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
      // now copy
      int r = 0;
      for( auto row : initializer_list ){
    size_t c = 0;
    for( auto x : row ){ set( r, c, x ); ++c; }
    ++r;
      }
    }
#endif
    // copy constructor
    matrix( matrix const& v ) : owns_data(true),
                ccgsl_pointer( v.ccgsl_pointer ), count( v.count ){
      if( count != 0 ) ++*count; // matrix is now shared.
    }
    // assignment operator
    matrix& operator=( matrix const& v ){
      // first, possibly delete anything pointed to by this
      if( count == 0 or --*count == 0 ){
    if( ccgsl_pointer != 0 and ccgsl_pointer->size1 > 0 and ccgsl_pointer->size2 > 0 ) gsl_matrix_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;
    }
    // clone()
    matrix clone() const {
      matrix copy( get()->size1, get()->size2 );
      // Now copy
      gsl_matrix_memcpy( copy.get(), get() );
      // return new object
      return copy;
    }
    // destructor
    ~matrix(){
      if( count != 0 and --*count == 0 ){
    // could have allocated null pointer
    if( ccgsl_pointer != 0 and owns_data ){
      if( ccgsl_pointer->size1 > 0 and ccgsl_pointer->size2 > 0 )
        gsl_matrix_free( ccgsl_pointer );
      else delete ccgsl_pointer; }
    delete count;
      }
    }
 
    // Allow possibility of assigning from gsl_matrix without sharing
    void wrap_gsl_matrix_without_ownership( gsl_matrix* v ){
      if( count != 0 and --*count == 0 ){
    // could have allocated null pointer
    if( ccgsl_pointer != 0 ){
      if( ccgsl_pointer->size1 != 0 and ccgsl_pointer->size1 != 0 )
        gsl_matrix_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
    }
    void reset(){ matrix().swap( *this ); }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    matrix( matrix&& v ) : owns_data {v.owns_data},
               ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
      std::swap( count, v.count );
      v.ccgsl_pointer = nullptr;
    }
    matrix& operator=( matrix&& v ){
      matrix( std::move( v ) ).swap( *this );
      return *this;
    }
#endif
  private:
    struct vector_ptr : public vector {
      vector_ptr( vector const& v ) : vector( v ){}
      vector& operator*(){ return *this; }
      vector* operator->(){ return this; }
    };
    template<typename container,typename content,bool reverse_t> class iterator_base {
      friend class vector;
    public:
      typedef std::bidirectional_iterator_tag iterator_category;
      typedef vector value_type;
      typedef vector_ptr pointer;
      typedef value_type reference;
    public:
      // // operator*
      reference operator*() const {
    // Always try to return something
    static content something;
    // 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( "matrix not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    }
    // Check that position make sense
    if( position >= v->size1() ){
      gsl_error( "trying to dereference end()", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    }
    // position and v are valid: return data
    return v->row( position );
      }
      // // operator->
      pointer operator->() const {
    // Always try to return something
    static content something_base;
    static vector_ptr something( something_base );
    // 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( "matrix not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    }
    // Check that position make sense
    if( position >= v->size1() ){
      gsl_error( "trying to dereference end()", __FILE__, __LINE__, exception::GSL_EFAILED );
      return something;
    }
    // position and v are valid: return data
    vector_ptr ptr( v->row( position ) );
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    return std::move( ptr );
#else
    return ptr;
#endif
      }
      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 );
      }
    protected:
      void increment(){
    // Only makes sense if v points to a matrix
    if( v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return;
    } else if( v->ccgsl_pointer == 0 ){
      gsl_error( "matrix not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return;
    }
    // increment position and check against size
    if( reverse_t ){ if( position >= 0 ) --position; }
    else { if( position < v->size1() ) ++position; }
      }
      void decrement(){
    // Only makes sense if v points to a matrix
    if( v == 0 ){
      gsl_error( "iterator not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return;
    } else if( v->ccgsl_pointer == 0 ){
      gsl_error( "matrix not initialised", __FILE__, __LINE__, exception::GSL_EFAILED );
      return;
    }
    // decrement position and check against size
    if( reverse_t ){ if( position < v->size1() ) ++position; }
    else { if( position >= 0 ) --position; }
      }
      iterator_base(){ v = 0; }
      iterator_base( container* v, size_t position )
    : v( v ), position( position ){}
      container* v;
      size_t 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<matrix,vector,reverse_t>{
    public:
      // // Refines output iterator
      // // operator=
      iterator_t<reverse_t>& operator=( iterator_t<reverse_t> const& i ){
    iterator_base<matrix,vector,reverse_t>::v = i.v;
    iterator_base<matrix,vector,reverse_t>::position = i.position;
    return *this;
      }
      // // Refines forward iterator
      // // operator++ (both)
      iterator_t<reverse_t>& operator++(){
    iterator_base<matrix,vector,reverse_t>::increment();
    return *this;
      }
      iterator_t<reverse_t> operator++( int ){
    // return value
    iterator_t<reverse_t> result( *this );
    iterator_base<matrix,vector,reverse_t>::increment();
    return result;
      }
      // // Refines bidirectional iterator
      // // operator-- (both)
      iterator_t<reverse_t>& operator--(){
    iterator_base<matrix,vector,reverse_t>::decrement();
    return *this;
      }
      iterator_t<reverse_t> operator--( int ){
    // return value
    iterator_t<reverse_t> result( *this );
    iterator_base<matrix,vector,reverse_t>::decrement();
    return result;
      }
      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 );
      }
      iterator_t() : iterator_base<matrix,vector,reverse_t>(){}
    protected:
      friend class matrix;
      // We need a constructor for matrix
      iterator_t( matrix* v, size_t position )
      : iterator_base<matrix,vector,reverse_t>( v, position ){}
    };
    template<bool reverse_t> class const_iterator_t
      : public iterator_base<matrix const,vector const,reverse_t>{
    public:
      // // Refines output iterator
      // // operator=
      const_iterator_t<reverse_t>& operator=( const_iterator_t<reverse_t> const& i ){
    iterator_base<matrix const,vector const,reverse_t>::v = i.v;
    iterator_base<matrix const,vector const,reverse_t>::position = i.position;
    return *this;
      }
      // // Refines forward iterator
      // // operator++ (both)
      const_iterator_t<reverse_t>& operator++(){
    iterator_base<matrix const,vector const,reverse_t>::increment();
    return *this;
      }
      const_iterator_t<reverse_t> operator++( int ){
    // return value
    const_iterator_t<reverse_t> result( *this );
    iterator_base<matrix const,vector const,reverse_t>::increment();
    return result;
      }
      // // Refines bidirectional iterator
      // // operator-- (both)
      const_iterator_t<reverse_t>& operator--(){
    iterator_base<matrix const,vector const,reverse_t>::decrement();
    return *this;
      }
      const_iterator_t<reverse_t> operator--( int ){
    // return value
    const_iterator_t<reverse_t> result( *this );
    iterator_base<matrix const,vector const,reverse_t>::decrement();
    return result;
      }
      const_iterator_t() : iterator_base<matrix,vector,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==( 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 );
      }
    protected:
      // We need a constructor for matrix
      friend class matrix;
      const_iterator_t( matrix const* v, size_t position )
      : iterator_base<matrix const,vector const,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;
    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, size1() );
    }
    const_iterator end() const {
      if( ccgsl_pointer == 0 ) return const_iterator( this, 0 );
      return const_iterator( this, size1() );
    }
    // rbegin()
    reverse_iterator rbegin(){
      if( ccgsl_pointer ==0 ) return reverse_iterator( this, 0 );
      return reverse_iterator( this, size1() - 1 );
    }
    const_reverse_iterator rbegin() const {
      if( ccgsl_pointer == 0 ) return const_reverse_iterator( this, 0 );
      return const_reverse_iterator( this, size1() - 1 );
    }
    // rend()
    reverse_iterator rend(){
      return reverse_iterator( this, -1 );
    }
    const_reverse_iterator rend() const {
      return const_reverse_iterator( this, -1 );
    }
  public:
    // Sizes
    size_t size1() const { return ccgsl_pointer == 0 ? 0 : ccgsl_pointer->size1; }
    size_t size2() const { return ccgsl_pointer == 0 ? 0 : ccgsl_pointer->size2; }
    double* data() { 
      if( ccgsl_pointer == 0 ) gsl_error( "null vector", __FILE__, __LINE__, GSL_EFAULT );
#ifndef GSL_RANGE_CHECK_OFF
      if( ccgsl_pointer->size2 != ccgsl_pointer->tda )
    gsl_error( "matrix size2 and tda do not match", __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->size2 != ccgsl_pointer->tda )
    gsl_error( "matrix size2 and tda do not match", __FILE__, __LINE__, GSL_EBADLEN );
#endif
      return ccgsl_pointer->data; }
    void swap( matrix& m ){
      std::swap( ccgsl_pointer, m.ccgsl_pointer );
      std::swap( count, m.count );
    }
    void tricpy(CBLAS_UPLO_t Uplo, CBLAS_DIAG_t Diag, matrix const& src){
      gsl_matrix_tricpy( Uplo, Diag, get(), src.get() );
    }
    void transpose_tricpy(CBLAS_UPLO_t Uplo, CBLAS_DIAG_t Diag, matrix const& src){
      gsl_matrix_transpose_tricpy( Uplo, Diag, get(), src.get() );
    }
    // view operations
    matrix submatrix( size_t const i, size_t const j, size_t const n1, size_t const n2 ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m = gsl_matrix_submatrix( get(), i, j, n1, n2 ).matrix;
      return matrix( m );
    }
    vector row( size_t const i ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_row( get(), i ).vector;
      return vector( w );
    }
    vector column( size_t const j ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_column( get(), j ).vector;
      return vector( w );
    }
    vector
    diagonal(){ gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_diagonal( get() ).vector;
      return vector( w );
    }
    vector subdiagonal( size_t const k ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_subdiagonal( get(), k ).vector;
      return vector( w );
    }
    vector superdiagonal( size_t const k ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_superdiagonal( get(), k ).vector;
      return vector( w );
    }
    vector subrow( size_t const i, size_t const offset, size_t const n ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_subrow( get(), i, offset, n ).vector;
      return vector( w );
    }
    vector subcolumn( size_t const j, size_t const offset, size_t const n ){
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_subcolumn( get(), j, offset, n ).vector;
      return vector( w );
    }
    static matrix view_array( double* base, size_t const n1, size_t const n2 ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m = gsl_matrix_view_array( base, n1, n2 ).matrix;
      return matrix( m );
    }
    static matrix view_array_with_tda( double* base, size_t const n1, size_t const n2, size_t const tda ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m =  gsl_matrix_view_array_with_tda( base, n1, n2, tda ).matrix;
      return matrix( m );
    }
    static matrix view_vector( vector& v, size_t const n1, size_t const n2 ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m =  gsl_matrix_view_vector( v.get(), n1, n2 ).matrix;
      return matrix( m );
    }
    static matrix view_vector_with_tda( vector& v, size_t const n1, size_t const n2, size_t const tda ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m = gsl_matrix_view_vector_with_tda( v.get(), n1, n2, tda ).matrix;
      return matrix( m );
    }
    // const versions ...
    matrix const const_submatrix( size_t const i, size_t const j, size_t const n1, size_t const n2 ) const {
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m = gsl_matrix_const_submatrix( get(), i, j, n1, n2 ).matrix;
      return matrix( m );
    }
    vector const const_row( size_t const i ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_row( get(), i ).vector;
      return vector( w );
    }
    vector const const_column( size_t const j ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_column( get(), j ).vector;
      return vector( w );
    }
    vector const const_diagonal() const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_diagonal( get() ).vector;
      return vector( w );
    }
    vector const const_subdiagonal( size_t const k ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_subdiagonal( get(), k ).vector;
      return vector( w );
    }
    vector const const_superdiagonal( size_t const k ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_superdiagonal( get(), k ).vector;
      return vector( w );
    }
    vector const const_subrow( size_t const i, size_t const offset, size_t const n ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_subrow( get(), i, offset, n ).vector;
      return vector( w );
    }
    vector const const_subcolumn( size_t const j, size_t const offset, size_t const n ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_subcolumn( get(), j, offset, n ).vector;
      return vector( w );
    }
    matrix const submatrix( size_t const i, size_t const j, size_t const n1, size_t const n2 ) const {
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m = gsl_matrix_const_submatrix( get(), i, j, n1, n2 ).matrix;
      return matrix( m );
    }
    vector const row( size_t const i ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_row( get(), i ).vector;
      return vector( w );
    }
    vector const column( size_t const j ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_column( get(), j ).vector;
      return vector( w );
    }
    vector const diagonal() const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_diagonal( get() ).vector;
      return vector( w );
    }
    vector const subdiagonal( size_t const k ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_subdiagonal( get(), k ).vector;
      return vector( w );
    }
    vector const superdiagonal( size_t const k ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_superdiagonal( get(), k ).vector;
      return vector( w );
    }
    vector const subrow( size_t const i, size_t const offset, size_t const n ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_subrow( get(), i, offset, n ).vector;
      return vector( w );
    }
    vector const subcolumn( size_t const j, size_t const offset, size_t const n ) const {
      gsl_vector* w = static_cast<gsl_vector*>( malloc( sizeof( gsl_vector ) ) );
      *w = gsl_matrix_const_subcolumn( get(), j, offset, n ).vector;
      return vector( w );
    }
    static matrix const const_view_array( double const* base, size_t const n1, size_t const n2 ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m = gsl_matrix_const_view_array( base, n1, n2 ).matrix;
      return matrix( m );
    }
    static matrix const
    const_view_array_with_tda( double const* base, size_t const n1, size_t const n2, size_t const tda ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m =  gsl_matrix_const_view_array_with_tda( base, n1, n2, tda ).matrix;
      return matrix( m );
    }
    static matrix const const_view_vector( vector const& v, size_t const n1, size_t const n2 ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m =  gsl_matrix_const_view_vector( v.get(), n1, n2 ).matrix;
      return matrix( m );
    }
    static matrix const
    const_view_vector_with_tda( vector const& v, size_t const n1, size_t const n2, size_t const tda ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m = gsl_matrix_const_view_vector_with_tda( v.get(), n1, n2, tda ).matrix;
      return matrix( m );
    }
    static matrix const view_array( double const* base, size_t const n1, size_t const n2 ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m = gsl_matrix_const_view_array( base, n1, n2 ).matrix;
      return matrix( m );
    }
    static matrix const
    view_array_with_tda( double const* base, size_t const n1, size_t const n2, size_t const tda ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m =  gsl_matrix_const_view_array_with_tda( base, n1, n2, tda ).matrix;
      return matrix( m );
    }
    static matrix const view_vector( vector const& v, size_t const n1, size_t const n2 ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m =  gsl_matrix_const_view_vector( v.get(), n1, n2 ).matrix;
      return matrix( m );
    }
    static matrix const
    view_vector_with_tda( vector const& v, size_t const n1, size_t const n2, size_t const tda ){
      gsl_matrix* m = static_cast<gsl_matrix*>( malloc( sizeof( gsl_matrix ) ) );
      *m = gsl_matrix_const_view_vector_with_tda( v.get(), n1, n2, tda ).matrix;
      return matrix( m );
    }
  private:
    bool owns_data;
    gsl_matrix* ccgsl_pointer;
    size_t* count;
  public:
    // shared reference functions
    gsl_matrix* get(){ return ccgsl_pointer; }
    gsl_matrix 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 matrix calloc( size_t const n1, size_t const n2 ){ return matrix( gsl_matrix_calloc( n1, n2 ) ); }
    void set_zero(){ gsl_matrix_set_zero( get() ); }
    void set_all( double x ){ gsl_matrix_set_all( get(), x ); }
    int memcpy( matrix const& src ){ return gsl_matrix_memcpy( get(), src.get() ); }
    double max() const { return gsl_matrix_max( get() ); }
    double min() const { return gsl_matrix_min( get() ); }
    void minmax( double* min_out, double* max_out ) const {
      gsl_matrix_minmax( get(), min_out, max_out ); }
    void minmax( double& min_out, double& max_out ) const {
      gsl_matrix_minmax( get(), &min_out, &max_out ); }
    int add( matrix const& b ){ return gsl_matrix_add( get(), b.get() ); }
    int sub( matrix const& b ){ return gsl_matrix_sub( get(), b.get() ); }
    int scale( double const x ){ return gsl_matrix_scale( get(), x ); }
    int add_constant( double const x ){ return gsl_matrix_add_constant( get(), x ); }
    int isnull() const { return gsl_matrix_isnull( get() ); }
    int ispos() const { return gsl_matrix_ispos( get() ); }
    int isneg() const { return gsl_matrix_isneg( get() ); }
    int isnonneg() const { return gsl_matrix_isnonneg( get() ); }
    double get( size_t const i, size_t const j ) const { return gsl_matrix_get( get(), i, j ); }
    void set( size_t const i, size_t const j, double x ){ gsl_matrix_set( get(), i, j, x ); }
    double* ptr( size_t const i, size_t const j ){ return gsl_matrix_ptr( get(), i, j ); }
    double const* const_ptr( size_t const i, size_t const j ) const {
      return gsl_matrix_const_ptr( get(), i, j ); }
    int fread( FILE* stream ){ return gsl_matrix_fread( stream, get() ); }
    int fwrite( FILE* stream ) const { return gsl_matrix_fwrite( stream, get() ); }
    int fscanf( FILE* stream ){ return gsl_matrix_fscanf( stream, get() ); }
    int fprintf( FILE* stream, char const* format ) const {
      return gsl_matrix_fprintf( stream, get(), format ); }
    matrix( block& b, size_t const offset, size_t const n1, size_t const n2, size_t const d2 ){
      ccgsl_pointer = gsl_matrix_alloc_from_block( b.get(), offset, n1, n2, d2 );
      // 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_matrix_free( ccgsl_pointer );
        throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    matrix( matrix& m, size_t const k1, size_t const k2, size_t const n1, size_t const n2 ){
      ccgsl_pointer = gsl_matrix_alloc_from_matrix( m.get(), k1, k2, n1, n2 );
      // just plausibly we could allocate matrix but not count
      try { count = new size_t; } catch( std::bad_alloc& e ){
        // try to tidy up before rethrowing
        gsl_matrix_free( ccgsl_pointer );
        throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    // More functions
    void set_identity(){ gsl_matrix_set_identity( get() ); }
    int swap_rows( size_t const i, size_t const j ){ return gsl_matrix_swap_rows( get(), i, j ); }
    int swap_columns( size_t const i, size_t const j ){
      return gsl_matrix_swap_columns( get(), i, j ); }
    int swap_rowcol( size_t const i, size_t const j ){ return gsl_matrix_swap_rowcol( get(), i, j ); }
    int transpose(){ return gsl_matrix_transpose( get() ); }
    int transpose_memcpy( matrix const& src ){
      return gsl_matrix_transpose_memcpy( get(), src.get() ); }
#ifndef DOXYGEN_SKIP
    void max_index( size_t* imax, size_t* jmax ) const {
      gsl_matrix_max_index( get(), imax, jmax ); }
    void min_index( size_t* imin, size_t* jmin ) const {
      gsl_matrix_min_index( get(), imin, jmin ); }
    void minmax_index( size_t* imin, size_t* jmin, size_t* imax, size_t* jmax ) const {
      gsl_matrix_minmax_index( get(), imin, jmin, imax, jmax ); }
#endif
    void max_index( size_t& imax, size_t& jmax ) const {
      gsl_matrix_max_index( get(), &imax, &jmax ); }
    void min_index( size_t& imin, size_t& jmin ) const {
      gsl_matrix_min_index( get(), &imin, &jmin ); }
    void minmax_index( size_t& imin, size_t& jmin, size_t& imax, size_t& jmax ) const {
      gsl_matrix_minmax_index( get(), &imin, &jmin, &imax, &jmax ); }
    int
    mul_elements( matrix const& b ){
      return gsl_matrix_mul_elements( get(), b.get() ); }
    int div_elements( matrix const& b ){
      return gsl_matrix_div_elements( get(), b.get() ); }
    double norm1() const {
      return gsl_matrix_norm1( get() ); }
    int scale_rows( vector const& x ){
      return gsl_matrix_scale_rows( get(), x.get() ); }
    int scale_columns( vector const& x ){
      return gsl_matrix_scale_columns( get(), x.get() ); }
    int add_diagonal( double const x ){
      return gsl_matrix_add_diagonal( get(), x ); }
    int get_row( vector& v, size_t const i ) const {
      return gsl_matrix_get_row( v.get(), get(), i ); }
    int get_col( vector& v, size_t const j ) const {
      return gsl_matrix_get_col( v.get(), get(), j ); }
    int set_row( size_t const i, vector const& v ){
      return gsl_matrix_set_row( get(), i, v.get() ); }
    int set_col( size_t const j, vector const& v ){
      return gsl_matrix_set_col( get(), j, v.get() ); }
    // Extra functions for []
    vector operator[]( size_t const i ){
      // First check that iterator is initialised.
      if( ccgsl_pointer == 0 ){
    gsl_error( "matrix is null", __FILE__, __LINE__, exception::GSL_EFAULT );
    return vector();
      }
#ifndef GSL_RANGE_CHECK_OFF
#ifndef __GXX_EXPERIMENTAL_CXX0X__
      static vector something;
#endif
      //Check that position make sense
      if( i >= size1() ){
    gsl_error( "trying to read beyond last row of matrix",
           __FILE__, __LINE__, exception::GSL_EINVAL );
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    return vector();
#else
    return something;
#endif
      }
      // n is a valid position
#endif
      vector v(0);
      gsl_vector_view w = gsl_matrix_row( ccgsl_pointer, i );
      v.wrap_gsl_vector_without_ownership(&(w.vector));
      return v;
    }
    vector const operator[]( size_t const i ) const {
      // First check that iterator is initialised.
      if( ccgsl_pointer == 0 ){
    gsl_error( "matrix is null", __FILE__, __LINE__, exception::GSL_EFAULT );
    return vector();
      }
      vector v(0);
      gsl_vector_view w = gsl_matrix_row( ccgsl_pointer, i );
      v.wrap_gsl_vector_without_ownership(&(w.vector));
      return v;
    }
    inline int
    permute( permutation& p ){
      return gsl_permute_matrix( p.get(), get() ); } 
  };
 
  // Extra functions for vector allocation from matrix objects
  inline vector vector::alloc_row_from_matrix( matrix& m, size_t const i ){
    return vector ( gsl_vector_alloc_row_from_matrix( m.get(), i ) ); }
  inline vector vector::alloc_col_from_matrix( matrix& m, size_t const i ){
    return vector ( gsl_vector_alloc_col_from_matrix( m.get(), i ) ); }
}
#endif