Matrix_ArraySparse.cxx

// Copyright (C) 2003-2011 Marc Duruflé
//
// This file is part of the linear-algebra library Seldon,
// http://seldon.sourceforge.net/.
//
// Seldon is free software; you can redistribute it and/or modify it under the
// terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 2.1 of the License, or (at your option)
// any later version.
//
// Seldon 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 Lesser General Public License for
// more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Seldon. If not, see http://www.gnu.org/licenses/.
 
 
#ifndef SELDON_FILE_MATRIX_ARRAY_SPARSE_CXX
 
#include "Matrix_ArraySparse.hxx"
 
namespace Seldon
{
 
 
  /*********************
   * MEMORY MANAGEMENT *
   *********************/
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::
  Reallocate(int i, int j)
  {
    // Clears previous entries.
    Clear();
 
    this->m_ = i;
    this->n_ = j;
 
    int n = Storage::GetFirst(i, j);
    val_.Reallocate(n);
  }
 
  
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::Resize(int i, int j)
  {
    int n = Storage::GetFirst(this->m_, this->n_);
    int new_n = Storage::GetFirst(i, j);
    if (n != new_n)
      {
        Vector<Vector<T, VectSparse, Allocator>, VectFull,
          NewAlloc<Vector<T, VectSparse, Allocator> > > new_val;
 
        new_val.Reallocate(new_n);
 
        for (int k = 0 ; k < min(n, new_n) ; k++)
          Swap(new_val(k), this->val_(k));
 
        val_.SetData(new_n, new_val.GetData());
        new_val.Nullify();
 
      }
 
    this->m_ = i;
    this->n_ = j;
  }
 
 
  /*******************
   * BASIC FUNCTIONS *
   *******************/
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  long Matrix_ArraySparse<T, Prop, Storage, Allocator>::GetNonZeros()
    const
  {
    long nnz = 0;
    for (int i = 0; i < this->val_.GetM(); i++)
      nnz += this->val_(i).GetM();
 
    return nnz;
  }
 
 
  template<class T, class Prop, class Storage, class Allocator>
  size_t Matrix_ArraySparse<T, Prop, Storage, Allocator>::GetMemorySize() const
  {
    size_t taille = sizeof(*this) + sizeof(pointer)*this->val_.GetM();
    for (int i = 0; i < this->val_.GetM(); i++)
      taille += this->val_(i).GetMemorySize();
    
    return taille;
  }
  
 
  /************************
   * CONVENIENT FUNCTIONS *
   ************************/
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::Print() const
  {
    if (Storage::GetFirst(1, 0) == 1)
      for (int i = 0; i < this->m_; i++)
        {
          for (int j = 0; j < this->val_(i).GetM(); j++)
            cout << (i+1) << " " << this->val_(i).Index(j)+1
                 << " " << this->val_(i).Value(j) << endl;
        }
    else
      for (int i = 0; i < this->n_; i++)
        {
          for (int j = 0; j < this->val_(i).GetM(); j++)
            cout << this->val_(i).Index(j)+1 << " " << i+1
                 << " " << this->val_(i).Value(j) << endl;
        }
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::Assemble()
  {
    for (int i = 0; i < val_.GetM(); i++)
      val_(i).Assemble();
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  template<class T0>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::
  RemoveSmallEntry(const T0& epsilon)
  {
    for (int i = 0; i < val_.GetM(); i++)
      val_(i).RemoveSmallEntry(epsilon);
  }
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::SetIdentity()
  {
    T one; SetComplexOne(one);
    this->n_ = this->m_;
    for (int i = 0; i < this->m_; i++)
      {
        val_(i).Reallocate(1);
        val_(i).Index(0) = i;
        val_(i).Value(0) = one;
      }
  }
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::Zero()
  {
    for (int i = 0; i < val_.GetM(); i++)
      val_(i).Zero();
  }
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::Fill()
  {
    int value = 0;
    for (int i = 0; i < val_.GetM(); i++)
      for (int j = 0; j < val_(i).GetM(); j++)
        {
          SetComplexReal(value, val_(i).Value(j));
          value++;
        }
  }
 
 
  template <class T, class Prop, class Storage, class Allo> template<class T0>
  void Matrix_ArraySparse<T, Prop, Storage, Allo>::Fill(const T0& x)
  {
    for (int i = 0; i < val_.GetM(); i++)
      val_(i).Fill(x);
  }
 
 
  template <class T, class Prop, class Storage, class Allocator>
  template <class T0>
  Matrix_ArraySparse<T, Prop, Storage, Allocator>&
  Matrix_ArraySparse<T, Prop, Storage, Allocator>::operator= (const T0& x)
  {
    this->Fill(x);
  }
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::FillRand()
  {
#ifndef SELDON_WITHOUT_REINIT_RANDOM
    srand(time(NULL));
#endif
    for (int i = 0; i < val_.GetM(); i++)
      val_(i).FillRand();
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::
  Write(string FileName) const
  {
    ofstream FileStream;
    FileStream.open(FileName.c_str(), ofstream::binary);
 
#ifdef SELDON_CHECK_IO
    // Checks if the file was opened.
    if (!FileStream.is_open())
      throw IOError("Matrix_ArraySparse::Write(string FileName)",
                    string("Unable to open file \"") + FileName + "\".");
#endif
 
    this->Write(FileStream);
 
    FileStream.close();
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::
  Write(ostream& FileStream) const
  {
 
#ifdef SELDON_CHECK_IO
    // Checks if the stream is ready.
    if (!FileStream.good())
      throw IOError("Matrix_ArraySparse::Write(ofstream& FileStream)",
                    "Stream is not ready.");
#endif
 
    FileStream.write(reinterpret_cast<char*>(const_cast<int*>(&this->m_)),
                     sizeof(int));
    FileStream.write(reinterpret_cast<char*>(const_cast<int*>(&this->n_)),
                     sizeof(int));
 
    for (int i = 0; i < val_.GetM(); i++)
      val_(i).Write(FileStream);
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::
  WriteText(string FileName, bool cplx) const
  {
    ofstream FileStream; FileStream.precision(14);
    FileStream.open(FileName.c_str());
 
    // changing precision
    FileStream.precision(cout.precision());
    
#ifdef SELDON_CHECK_IO
    // Checks if the file was opened.
    if (!FileStream.is_open())
      throw IOError("Matrix_ArraySparse::Write(string FileName)",
                    string("Unable to open file \"") + FileName + "\".");
#endif
 
    this->WriteText(FileStream, cplx);
 
    FileStream.close();
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::
  WriteText(ostream& FileStream, bool cplx) const
  {
 
#ifdef SELDON_CHECK_IO
    // Checks if the stream is ready.
    if (!FileStream.good())
      throw IOError("Matrix_ArraySparse::Write(ofstream& FileStream)",
                    "Stream is not ready.");
#endif
 
    // conversion in coordinate format (1-index convention)
    const Matrix<T, Prop, Storage, Allocator>& leaf_class =
      static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this);
 
    T zero; int index = 1;
    WriteCoordinateMatrix(leaf_class, FileStream, zero, index, cplx);
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::
  Read(string FileName)
  {
    ifstream FileStream;
    FileStream.open(FileName.c_str(), ifstream::binary);
 
#ifdef SELDON_CHECK_IO
    // Checks if the file was opened.
    if (!FileStream.is_open())
      throw IOError("Matrix_ArraySparse::Read(string FileName)",
                    string("Unable to open file \"") + FileName + "\".");
#endif
 
    this->Read(FileStream);
 
    FileStream.close();
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::
  Read(istream& FileStream)
  {
 
#ifdef SELDON_CHECK_IO
    // Checks if the stream is ready.
    if (!FileStream.good())
      throw IOError("Matrix_ArraySparse::Read(ofstream& FileStream)",
                    "Stream is not ready.");
#endif
 
    FileStream.read(reinterpret_cast<char*>(const_cast<int*>(&this->m_)),
                    sizeof(int));
    FileStream.read(reinterpret_cast<char*>(const_cast<int*>(&this->n_)),
                    sizeof(int));
 
    val_.Reallocate(Storage::GetFirst(this->m_, this->n_));
    for (int i = 0; i < val_.GetM(); i++)
      val_(i).Read(FileStream);
 
#ifdef SELDON_CHECK_IO
    // Checks if data was read.
    if (!FileStream.good())
      throw IOError("Matrix_ArraySparse::Read(istream& FileStream)",
                    string("Input operation failed.")
                    + string(" The input file may have been removed")
                    + " or may not contain enough data.");
#endif
 
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::
  ReadText(string FileName, bool cplx)
  {
    ifstream FileStream;
    FileStream.open(FileName.c_str());
 
#ifdef SELDON_CHECK_IO
    // Checks if the file was opened.
    if (!FileStream.is_open())
      throw IOError("Matrix_ArraySparse::ReadText(string FileName)",
                    string("Unable to open file \"") + FileName + "\".");
#endif
 
    this->ReadText(FileStream, cplx);
 
    FileStream.close();
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  void Matrix_ArraySparse<T, Prop, Storage, Allocator>::
  ReadText(istream& FileStream, bool cplx)
  {
    Matrix<T, Prop, Storage, Allocator>& leaf_class =
      static_cast<Matrix<T, Prop, Storage, Allocator>& >(*this);
    
    T zero; int index = 1;
    ReadCoordinateMatrix(leaf_class, FileStream, zero, index, -1, cplx);
  }
 
 
  // MATRIX<ARRAY_COLSPARSE> //
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayColSparse, Allocator>::
  AddInteractionRow(int i, int nb, int* col_, T* value_,
                    bool already_sorted)
  {
    IVect col;
    col.SetData(nb, col_);
    Vector<T> val;
    val.SetData(nb, value_);
    AddInteractionRow(i, nb, col, val, already_sorted);
    col.Nullify();
    val.Nullify();
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayColSparse, Allocator>::
  AddInteractionColumn(int i, int nb, int* row_, T* value_,
                       bool already_sorted)
  {
    IVect row;
    row.SetData(nb, row_);
    Vector<T> val;
    val.SetData(nb, value_);
    AddInteractionColumn(i, nb, row, val, already_sorted);
    row.Nullify();
    val.Nullify();
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayColSparse, Allocator>::
  AddInteractionRow(int i, int nb, const Vector<int>& col,
                    const Vector<T>& val, bool already_sorted)
  {
    for (int j = 0; j < nb; j++)
      this->val_(col(j)).AddInteraction(i, val(j));
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayColSparse, Allocator>::
  AddInteractionColumn(int i, int nb, const Vector<int>& row,
                       const Vector<T>& val, bool already_sorted)
  {
    this->val_(i).AddInteractionRow(nb, row, val, already_sorted);
  }
 
 
  // MATRIX<ARRAY_ROWSPARSE> //
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayRowSparse, Allocator>::
  AddInteractionRow(int i, int nb, int* col_, T* value_,
                    bool already_sorted)
  {
    IVect col;
    col.SetData(nb, col_);
    Vector<T> val;
    val.SetData(nb, value_);
    AddInteractionRow(i, nb, col, val, already_sorted);
    col.Nullify();
    val.Nullify();
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayRowSparse, Allocator>::
  AddInteractionColumn(int i, int nb, int* row_, T* value_,
                       bool already_sorted)
  {
    IVect row;
    row.SetData(nb, row_);
    Vector<T> val;
    val.SetData(nb, value_);
    AddInteractionColumn(i, nb, row, val, already_sorted);
    row.Nullify();
    val.Nullify();
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayRowSparse, Allocator>::
  AddInteractionRow(int i, int nb, const Vector<int>& col,
                    const Vector<T>& val, bool already_sorted)
  {
    this->val_(i).AddInteractionRow(nb, col, val, already_sorted);
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayRowSparse, Allocator>::
  AddInteractionColumn(int i, int nb, const Vector<int>& row,
                       const Vector<T>& val, bool already_sorted)
  {
    for (int j = 0; j < nb; j++)
      this->val_(row(j)).AddInteraction(i, val(j));
  }
 
 
  // MATRIX<ARRAY_COLSYMSPARSE> //
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayColSymSparse, Allocator>::
  AddInteractionRow(int i, int nb, int* col_, T* value_,
                    bool already_sorted)
  {
    IVect col;
    col.SetData(nb, col_);
    Vector<T> val;
    val.SetData(nb, value_);
    AddInteractionRow(i, nb, col, val, already_sorted);
    col.Nullify();
    val.Nullify();
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayColSymSparse, Allocator>::
  AddInteractionColumn(int i, int nb, int* row_, T* value_,
                       bool already_sorted)
  {
    IVect row;
    row.SetData(nb, row_);
    Vector<T> val;
    val.SetData(nb, value_);
    AddInteractionColumn(i, nb, row, val, already_sorted);
    row.Nullify();
    val.Nullify();
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayColSymSparse, Allocator>::
  AddInteractionRow(int i, int nb, const Vector<int>& col,
                    const Vector<T>& val, bool already_sorted)
  {
    for (int j = 0; j < nb; j++)
      if (i <= col(j))
        this->val_(col(j)).AddInteraction(i, val(j));
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayColSymSparse, Allocator>::
  AddInteractionColumn(int i, int nb, const Vector<int>& row,
                       const Vector<T>& val, bool already_sorted)
  {
    IVect new_row(nb);
    Vector<T> new_val(nb);
    nb = 0;
    for (int j = 0; j < new_row.GetM(); j++)
      if (row(j) <= i)
        {
          new_row(nb) = row(j);
          new_val(nb) = val(j); nb++;
        }
 
    this->val_(i).AddInteractionRow(nb, new_row, new_val, already_sorted);
  }
 
  
  // MATRIX<ARRAY_ROWSYMSPARSE> //
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayRowSymSparse, Allocator>::
  AddInteractionRow(int i, int nb, int* col_, T* value_,
                    bool already_sorted)
  {
    IVect col;
    col.SetData(nb, col_);
    Vector<T> val;
    val.SetData(nb, value_);
    AddInteractionRow(i, nb, col, val, already_sorted);
    col.Nullify();
    val.Nullify();
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayRowSymSparse, Allocator>::
  AddInteractionColumn(int i, int nb, int* row_, T* value_,
                       bool already_sorted)
  {
    IVect row;
    row.SetData(nb, row_);
    Vector<T> val;
    val.SetData(nb, value_);
    AddInteractionColumn(i, nb, row, val, already_sorted);
    row.Nullify();
    val.Nullify();
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayRowSymSparse, Allocator>::
  AddInteractionRow(int i, int nb, const Vector<int>& col,
                    const Vector<T>& val, bool already_sorted)
  {
    IVect new_col(nb);
    Vector<T> new_val(nb);
    nb = 0;
    for (int j = 0; j < new_col.GetM(); j++)
      if (i <= col(j))
        {
          new_col(nb) = col(j);
          new_val(nb) = val(j); nb++;
        }
 
    this->val_(i).AddInteractionRow(nb, new_col, new_val, already_sorted);
  }
 
 
 
  template <class T, class Prop, class Allocator>
  void Matrix<T, Prop, ArrayRowSymSparse, Allocator>::
  AddInteractionColumn(int i, int nb, const Vector<int>& row,
                       const Vector<T>& val, bool already_sorted)
  {
    for (int j = 0; j < nb; j++)
      if (row(j) <= i)
        this->val_(row(j)).AddInteraction(i, val(j));
  }
  
} // namespace Seldon
 
#define SELDON_FILE_MATRIX_ARRAY_SPARSE_CXX
#endif