cs_matrix.h

Go to the documentation of this file.

// This file is part of HermesCommon
//
// Copyright (c) 2009 hp-FEM group at the University of Nevada, Reno (UNR).
// Email: hpfem-group@unr.edu, home page: http://www.hpfem.org/.
//
// Hermes2D 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.
//
// Hermes2D 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 Hermes2D; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#ifndef __HERMES_COMMON_CS_MATRIX_H
#define __HERMES_COMMON_CS_MATRIX_H

#include "algebra/matrix.h"

namespace Hermes
{
  namespace Algebra
  {
    template <typename Scalar>
    class HERMES_API CSMatrix : public SparseMatrix < Scalar >
    {
    public:
      void create(unsigned int size, unsigned int nnz, int* ap, int* ai, Scalar* ax);

      static int find_position(int *Ai, int Alen, unsigned int idx);

      CSMatrix();
      CSMatrix(unsigned int size);
      virtual ~CSMatrix();

      void switch_orientation();

      virtual void add(unsigned int Ai_data_index, unsigned int Ai_index, Scalar v);

      virtual Scalar get(unsigned int Ai_data_index, unsigned int Ai_index) const;

      virtual void alloc();
      // Allocate data storage.
      virtual void alloc_data();
      virtual void free();
      virtual void zero();
      virtual void set_row_zero(unsigned int n);

      void export_to_file(const char *filename, const char *var_name, MatrixExportFormat fmt, char* number_format = "%lf", bool invert_storage = false);

      void import_from_file(const char *filename, const char *var_name, MatrixExportFormat fmt, bool invert_storage = false);

      virtual unsigned int get_nnz() const;
      virtual double get_fill_in() const;

      void multiply_with_Scalar(Scalar value);

      int *get_Ap() const;
      int *get_Ai() const;
      Scalar *get_Ax() const;

      using SparseMatrix<Scalar>::add_as_block;
      virtual void add_as_block(unsigned int i, unsigned int j, SparseMatrix<Scalar>* mat);

    protected:
      Scalar *Ax;
      int *Ai;
      int *Ap;
      unsigned int nnz;
      template<typename T> friend SparseMatrix<T>*  create_matrix();
    };

    template <typename Scalar>
    class HERMES_API CSCMatrix : public CSMatrix < Scalar >
    {
    public:
      CSCMatrix();

      CSCMatrix(unsigned int size);

      virtual ~CSCMatrix();

      virtual Scalar get(unsigned int m, unsigned int n) const;

      virtual void add(unsigned int m, unsigned int n, Scalar v);

      void multiply_with_vector(Scalar* vector_in, Scalar*& vector_out, bool vector_out_initialized) const;

      virtual void export_to_file(const char *filename, const char *var_name, MatrixExportFormat fmt, char* number_format = "%lf");
      virtual void import_from_file(const char *filename, const char *var_name, MatrixExportFormat fmt);

      SparseMatrix<Scalar>* duplicate() const;
    };

    template <typename Scalar>
    class HERMES_API CSRMatrix : public CSMatrix < Scalar >
    {
    public:
      CSRMatrix();

      CSRMatrix(unsigned int size);

      virtual ~CSRMatrix();

      virtual Scalar get(unsigned int m, unsigned int n) const;

      virtual void add(unsigned int m, unsigned int n, Scalar v);

      void export_to_file(const char *filename, const char *var_name, MatrixExportFormat fmt, char* number_format = "%lf");
      void import_from_file(const char *filename, const char *var_name, MatrixExportFormat fmt);

      SparseMatrix<Scalar>* duplicate() const;

      virtual void pre_add_ij(unsigned int row, unsigned int col);
    };
  }
}
#endif