algebra/sparse_matrix.h

// -*- c++ -*-

// +--------------------------------------------------------------------+
// | This file is part of MathTL - the Mathematical Template Library    |
// |                                                                    |
// | Copyright (c) 2002-2009                                            |
// | Thorsten Raasch, Manuel Werner                                     |
// +--------------------------------------------------------------------+

#ifndef _MATHTL_SPARSE_MATRIX_H
#define _MATHTL_SPARSE_MATRIX_H

#include <iostream>
#include <list>

#include <utils/array1d.h>
#include <algebra/vector.h>
#include <algebra/matrix_block.h>
#include <algebra/symmetric_matrix.h>
#include <algebra/triangular_matrix.h>
#include <algebra/infinite_vector.h>

// matrix norms, for convenience
#include <algebra/matrix_norms.h>

namespace MathTL
{
  template <class C>
  class SparseMatrix
    : public MatrixBlock<C>
  {
  public:
    typedef typename Vector<C>::size_type size_type;

    explicit SparseMatrix(const size_type n = 1);

    SparseMatrix(const SparseMatrix<C>& M);

    SparseMatrix(const size_type row_dimension, const size_type column_dimension);

    ~SparseMatrix();
    
    MatrixBlock<C>* clone() const;

    MatrixBlock<C>* clone_transposed() const;

    const size_type row_dimension() const;

    const size_type column_dimension() const;

    const size_type size() const;

    bool empty() const;

    void resize(const size_type rows, const size_type columns);

    const size_type entries_in_row(const size_type row) const;
    
    const size_type get_nth_index(const size_type row, const size_type n) const;

    const C get_nth_entry(const size_type row, const size_type n) const;

    const C get_entry(const size_type row, const size_type column) const;

    template <class MATRIX>
    void get_block(const size_type firstrow, const size_type firstcolumn,
                   const size_type rows, const size_type columns,
                   MATRIX& M) const;
    
    void get_row(const size_type row,
                 InfiniteVector<C, size_type>& v,
                 const size_type offset = 0) const;

    void set_entry(const size_type row, const size_type column, const C value);

    void set_row(const size_type row,
                 const std::list<size_type>& indices,
                 const std::list<C>& entries);

    template <class MATRIX>
    void set_block(const size_type firstrow, const size_type firstcolumn,
                   const MATRIX& M,
                   const bool reflect = false,
                   const double factor = 1.0);

    SparseMatrix<C>& operator = (const SparseMatrix<C>& M);

    void scale(const C s);

    void add(const C s, const SparseMatrix<C>& M);

    void diagonal(const size_type n, const C diag);

    template <class VECTOR>
    void apply(const VECTOR& x, VECTOR& Mx) const;

    void apply(const Vector<C>& x, Vector<C>& Mx) const;

    template <class VECTOR>
    void apply_transposed(const VECTOR& x, VECTOR& Mtx) const;

    void apply_transposed(const Vector<C>& x, Vector<C>& Mtx) const;
    
    void compress(const double eta = 1e-16);

    void print(std::ostream& os,
               const unsigned int tabwidth = 8,
               const unsigned int precision = 3) const;

    void matlab_output(const char *file, const char *Matrixname, const int binary, const int rowend = -1, const int columnend = -1) const;
    void matlab_output(const char *file, const char *Matrixname, const int binary, const int rowstart, const int rowend, const int columnstart, const int columnend) const;

    void matlab_input(const char *file);

  protected:
    C** entries_;

    size_type** indices_;

    size_type rowdim_;

    size_type coldim_;

    void kill();
  };

  template <class C>
  SparseMatrix<C> operator - (const SparseMatrix<C>& M, const SparseMatrix<C>& N);

  template <class C>
  SparseMatrix<C> operator * (const SparseMatrix<C>& M, const SparseMatrix<C>& N);

  template <class C>
  SparseMatrix<C> transpose(const SparseMatrix<C>& M);

  template <class C>
  std::ostream& operator << (std::ostream& os, const SparseMatrix<C>& M);
}

// include implementation of inline functions
#include <algebra/sparse_matrix.cpp>

#endif