spmatrix.hpp

Go to the documentation of this file.

/*
 * $Id: spmatrix.hpp 313 2014-02-22 14:29:57Z jdl3 $
 * Copyright (C) 2010, 2011, 2012, 2019, 2020, 2021 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_SPMATRIX_HPP
#define CCGSL_SPMATRIX_HPP
 
#include<cstddef>
#include<gsl/gsl_spmatrix.h>
#include<new>
 
#include"exception.hpp"
#include"vector.hpp"
#include"matrix.hpp"
 
namespace gsl {
  class spmatrix {
  public:
    enum {
      COO = GSL_SPMATRIX_COO,
      CSC = GSL_SPMATRIX_CSC,
      CSR = GSL_SPMATRIX_CSR,
      TRIPLET = GSL_SPMATRIX_TRIPLET,
      CCS = GSL_SPMATRIX_CCS,
      CRS = GSL_SPMATRIX_CRS
    };
    spmatrix(){
      ccgsl_pointer = 0;
      count = 0; // initially nullptr will do
    }
    // Refines random access container
    // Refines assignable
    explicit spmatrix( size_t const n1, size_t const n2 ){
      if( n1 > 0 and n2 > 0 ) ccgsl_pointer = gsl_spmatrix_alloc( n1, n2 );
      else { ccgsl_pointer = new gsl_spmatrix; ccgsl_pointer->size1 = n1;
    ccgsl_pointer->size2 = n2; ccgsl_pointer->data = 0; }
      // just plausibly we could allocate spmatrix 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_spmatrix_free( ccgsl_pointer );
    else delete ccgsl_pointer;
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    explicit spmatrix( size_t const n1, size_t const n2, size_t nzmax, size_t sptype ){
      if( n1 > 0 and n2 > 0 )
    ccgsl_pointer = gsl_spmatrix_alloc_nzmax( n1, n2, nzmax, sptype );
      else { ccgsl_pointer = new gsl_spmatrix; ccgsl_pointer->size1 = n1;
    ccgsl_pointer->size2 = n2; ccgsl_pointer->data = 0; }
      // just plausibly we could allocate spmatrix 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_spmatrix_free( ccgsl_pointer );
    else delete ccgsl_pointer;
    throw e;
      }
      *count = 1; // initially there is just one reference to ccgsl_pointer
    }
    explicit spmatrix( gsl_spmatrix* 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
    }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    spmatrix( std::initializer_list<std::initializer_list<double> > initializer_list ){
      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_spmatrix_alloc( n1, n2 );
      // just plausibly we could allocate spmatrix 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_spmatrix_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
    spmatrix( spmatrix const& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( v.count ){
      if( count != 0 ) ++*count; // spmatrix is now shared.
    }
    // assignment operator
    spmatrix& operator=( spmatrix 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_spmatrix_free( ccgsl_pointer );
    else delete ccgsl_pointer;
    delete count;
      }
      // Then copy
      ccgsl_pointer = v.ccgsl_pointer;
      count = v.count;
      if( count != 0 ) ++*count; // block is now shared.
      return *this;
    }
    // clone()
    spmatrix clone() const {
      spmatrix copy( get()->size1, get()->size2 );
      // Now copy
      gsl_spmatrix_memcpy( copy.get(), get() );
      // return new object
      return copy;
    }
    // destructor
    ~spmatrix(){
      if( count != 0 and --*count == 0 ){
    // could have allocated null pointer
    if( ccgsl_pointer != 0 ){
      if( ccgsl_pointer->size1 > 0 and ccgsl_pointer->size2 > 0 )
        gsl_spmatrix_free( ccgsl_pointer );
      else delete ccgsl_pointer; }
    delete count;
      }
    }
    // Allow possibility of assigning from gsl_spmatrix without sharing
    void wrap_gsl_spmatrix_without_ownership( gsl_spmatrix* 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_spmatrix_free( ccgsl_pointer );
      else delete ccgsl_pointer; }
      }
      ccgsl_pointer = v;
      if(0 == count) count = new size_t;
      *count = 2; // should never be able to delete ccgsl_pointer
    }
    void reset(){ spmatrix().swap( *this ); }
#ifdef __GXX_EXPERIMENTAL_CXX0X__
    spmatrix( spmatrix&& v ) : ccgsl_pointer( v.ccgsl_pointer ), count( nullptr ){
      std::swap( count, v.count );
      v.ccgsl_pointer = nullptr;
    }
    spmatrix& operator=( spmatrix&& v ){
      spmatrix( std::move( v ) ).swap( *this );
      return *this;
    }
#endif
  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; }
    size_t nzmax() const { return ccgsl_pointer == 0 ? 0 : ccgsl_pointer->nzmax; }
    int sptype() const { return ccgsl_pointer == 0 ? 0 : ccgsl_pointer->sptype; }
    double* data() { 
      if( ccgsl_pointer == 0 ) gsl_error( "null vector", __FILE__, __LINE__, GSL_EFAULT );
      return ccgsl_pointer->data; }
    double const* data() const {
      if( ccgsl_pointer == 0 ) gsl_error( "null vector", __FILE__, __LINE__, GSL_EFAULT );
      return ccgsl_pointer->data; }
    void swap( spmatrix& m ){
      std::swap( ccgsl_pointer, m.ccgsl_pointer );
      std::swap( count, m.count );
    }
    int realloc( size_t const nzmax ){ return gsl_spmatrix_realloc( nzmax, get() ); }
    size_t nnz() const { return gsl_spmatrix_nnz( get() ); }  
    char const* type() const { return gsl_spmatrix_type( get() ); }
    int set_zero(){ return gsl_spmatrix_set_zero( get() ); }
    int tree_rebuild(){ return gsl_spmatrix_tree_rebuild( get() ); }
    spmatrix csc() const {
      spmatrix dest { size1(), size2() }; 
      gsl_spmatrix_csc( dest.get(), get() );
      return dest;
    }
    spmatrix csr() const {
      spmatrix dest { size1(), size2() }; 
      gsl_spmatrix_csr( dest.get(), get() );
      return dest;
    }
    spmatrix compress( int const sptype ) const {
      spmatrix dest { gsl_spmatrix_compress( get(), sptype ) };
      return dest; }
    spmatrix compcol() const {
      spmatrix dest { gsl_spmatrix_compcol( get() ) };
      return dest; }
    spmatrix ccs() const {
      spmatrix dest { gsl_spmatrix_ccs( get() ) };
      return dest; }
    spmatrix crs() const {
      spmatrix dest { gsl_spmatrix_crs( get() ) };
      return dest; }
    int memcpy( spmatrix& dest ) const { return gsl_spmatrix_memcpy( dest.get(), get() ); }
    int fprintf( FILE* stream, char const* format ) const {
      return gsl_spmatrix_fprintf( stream, get(), format ); }
    int fwrite( FILE* stream ) const {
      return gsl_spmatrix_fwrite( stream, get() ); }
    int fread( FILE* stream ){
      return gsl_spmatrix_fread( stream, get() ); }
    double get( size_t const i, size_t const j ) const {
      return gsl_spmatrix_get( get(), i, j ); }
    int set( size_t const i, size_t const j, double const x ){
      return gsl_spmatrix_set( get(), i, j, x ); }
    double* ptr( size_t const i, size_t const j ) const {
      return gsl_spmatrix_ptr( get(), i, j ); }
    // BEGIN REAL ONLY
    int minmax( double& min_out, double& max_out ) const {
      return gsl_spmatrix_minmax( get(), &min_out, &max_out ); }
    int min_index( size_t& imin_out, size_t& jmin_out ) const {
      return gsl_spmatrix_min_index( get(), &imin_out, &jmin_out ); }
    // END REAL ONLY
    int scale( double const x ){ return gsl_spmatrix_scale( get(), x ); }
    int scale_columns( gsl::vector const& x ){
      return gsl_spmatrix_scale_columns( get(), x.get() ); }
    int scale_rows( gsl::vector const& x ){
      return gsl_spmatrix_scale_rows( get(), x.get() ); }
    int equal( spmatrix const& b ) const { return gsl_spmatrix_equal( get(), b.get() ); }
    int transpose(){ return gsl_spmatrix_transpose( get() ); }
    int transpose2(){ return gsl_spmatrix_transpose2( get() ); }
    // Now the static functions
    static int realloc( size_t const nzmax, gsl::spmatrix& spMatrix ){
      return gsl_spmatrix_realloc( nzmax, spMatrix.get() ); }
    static size_t nnz( spmatrix const& spMatrix ){
      return gsl_spmatrix_nnz( spMatrix.get() ); }  
    static char const* type( spmatrix const& spMatrix ){
      return gsl_spmatrix_type( spMatrix.get() ); }
    static int set_zero( spmatrix& spMatrix ){
      return gsl_spmatrix_set_zero( spMatrix.get() ); }
    static int tree_rebuild( spmatrix& spMatrix ){
      return gsl_spmatrix_tree_rebuild( spMatrix.get() ); }
    static spmatrix csc( spmatrix const& spMatrix ){
      spmatrix dest { spMatrix.size1(), spMatrix.size2() }; 
      gsl_spmatrix_csc( dest.get(), spMatrix.get() );
      return dest; }
    static spmatrix csr( spmatrix const& spMatrix ){
      spmatrix dest { spMatrix.size1(), spMatrix.size2() }; 
      gsl_spmatrix_csr( dest.get(), spMatrix.get() );
      return dest; }
    static spmatrix compress( spmatrix const& spMatrix, int const sptype ){
      spmatrix dest { gsl_spmatrix_compress( spMatrix.get(), sptype ) };
      return dest; }
    static spmatrix compcol( spmatrix const& spMatrix ){
      spmatrix dest { gsl_spmatrix_compcol( spMatrix.get() ) };
      return dest; }
    static spmatrix ccs( spmatrix const& spMatrix ){
      spmatrix dest { gsl_spmatrix_ccs( spMatrix.get() ) };
      return dest; }
    static spmatrix crs( spmatrix const& spMatrix ){
      spmatrix dest { gsl_spmatrix_crs( spMatrix.get() ) };
      return dest; }
    static int memcpy( spmatrix& dest, spmatrix const& src ){
      return gsl_spmatrix_memcpy( dest.get(), src.get() ); }
    static int fprintf( FILE* stream, spmatrix const& spMatrix, char const* format ){
      return gsl_spmatrix_fprintf( stream, spMatrix.get(), format ); }
    static spmatrix fscanf( FILE* stream ){
      return spmatrix { gsl_spmatrix_fscanf( stream ) }; }
    static int fwrite( FILE* stream, spmatrix& spMatrix ){
      return gsl_spmatrix_fwrite( stream, spMatrix.get() ); }
    static int fread( FILE* stream, spmatrix& spMatrix ){
      return gsl_spmatrix_fread( stream, spMatrix.get() ); }
    static int add( spmatrix& c, spmatrix const& a, spmatrix const& b ){
      return gsl_spmatrix_add( c.get(), a.get(), b.get() ); }
    static spmatrix add( spmatrix const& a, spmatrix const& b ){
      spmatrix c { a.size1(), a.size2() };
      gsl_spmatrix_add( c.get(), a.get(), b.get() );
      return c;
    }
#ifndef GSL_DISABLE_DEPRECATED
    static int add_to_dense( gsl::matrix& a, spmatrix const&b ){
      return gsl_spmatrix_add_to_dense( a.get(), b.get() ); }
#endif
    static int dense_add( gsl::matrix& a, spmatrix const&b ){
      return gsl_spmatrix_dense_add( a.get(), b.get() ); }
    static int dense_sub( gsl::matrix& a, spmatrix const&b ){
      return gsl_spmatrix_dense_sub( a.get(), b.get() ); }
    static double norm1( gsl::spmatrix const& a ){
      return gsl_spmatrix_norm1( a.get() ); }
    static int d2sp( gsl::spmatrix& S, gsl::matrix const& A ){
      return gsl_spmatrix_d2sp( S.get(), A.get() ); }
    static int sp2d( gsl::matrix& A, spmatrix const& S ){
      return gsl_spmatrix_sp2d( A.get(), S.get() ); }
    static int equal( spmatrix const& a, spmatrix const& b ){
      return gsl_spmatrix_equal( a.get(), b.get() ); }
    static int transpose( spmatrix& a ){ return gsl_spmatrix_transpose( a.get() ); }
    static int transpose2( spmatrix& a ){ return gsl_spmatrix_transpose2( a.get() ); }
    static int transpose_memcpy( spmatrix& dest, spmatrix const& src ){
      return gsl_spmatrix_transpose_memcpy( dest.get(), src.get() ); }
  private:
    gsl_spmatrix* ccgsl_pointer;
    size_t* count;
  public:
    // shared reference functions
    gsl_spmatrix* get(){ return ccgsl_pointer; }
    gsl_spmatrix 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; }
  };
}
#endif