Matrix_SparseInline.cxx

// Copyright (C) 2001-2011 Vivien Mallet
// 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_SPARSE_INLINE_CXX
 
#include "Matrix_Sparse.hxx"
 
#include <set>
 
/*
  Functions defined in this file:
 
  reads coordinate form (i, j, val) from an input stream
  ReadCoordinateMatrix(FileStream, row_index, col_index, values, cplx)
  
  writes coordinate form (i, j, val) in an input stream
  WriteCoordinateMatrix(FileStream, row_index, col_index, values, cplx)
 
  These functions are used by ReadText/WriteText
*/
 
namespace Seldon
{
 
 
  /****************
   * CONSTRUCTORS *
   ****************/
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline Matrix_Sparse<T, Prop, Storage, Allocator>::Matrix_Sparse():
    Matrix_Base<T, Allocator>()
  {
    nz_ = 0;
    ptr_ = NULL;
    ind_ = NULL;
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline Matrix_Sparse<T, Prop, Storage, Allocator>::Matrix_Sparse(int i,
                                                                   int j):
    Matrix_Base<T, Allocator>()
  {
    nz_ = 0;
    ptr_ = NULL;
    ind_ = NULL;
 
    Reallocate(i, j);
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline Matrix_Sparse<T, Prop, Storage, Allocator>::
  Matrix_Sparse(int i, int j, long nz):
    Matrix_Base<T, Allocator>()
  {
    this->nz_ = 0;
    ind_ = NULL;
    ptr_ = NULL;
 
    Reallocate(i, j, nz);
  }
 
 
  /**************
   * DESTRUCTOR *
   **************/
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline Matrix_Sparse<T, Prop, Storage, Allocator>::~Matrix_Sparse()
  {
    this->Clear();
  }
 
  
  /*******************
   * BASIC FUNCTIONS *
   *******************/
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline long Matrix_Sparse<T, Prop, Storage, Allocator>::GetNonZeros() const
  {
    return nz_;
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline long Matrix_Sparse<T, Prop, Storage, Allocator>::GetDataSize() const
  {
    return nz_;
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline long* Matrix_Sparse<T, Prop, Storage, Allocator>::GetPtr() const
  {
    return ptr_;
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline int* Matrix_Sparse<T, Prop, Storage, Allocator>::GetInd() const
  {
    return ind_;
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline int Matrix_Sparse<T, Prop, Storage, Allocator>::GetPtrSize() const
  {
    return (Storage::GetFirst(this->m_, this->n_) + 1);
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline long Matrix_Sparse<T, Prop, Storage, Allocator>::GetIndSize() const
  {
    return nz_;
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline const typename Matrix_Sparse<T, Prop, Storage, Allocator>::value_type&
  Matrix_Sparse<T, Prop, Storage, Allocator>::Get(int i, int j) const
  {
    return Val(i, j);
  }
  
  
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::AddInteraction(int i, int j, const T& val)
  {
    Get(i, j) += val;
  }
 
  
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::AddInteractionRow(int i, int nb, const Vector<int>& col,
                      const Vector<T>& val, bool sorted)
  {
    throw Undefined("AddInteractionRow", "Not implemented");
  }
  
  
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::Set(int i, int j, const T& val)
  {
    Get(i, j) = val;
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::SetEntry(int i, int j, const T& val)
  {
    Get(i, j) = val;
  }
 
  
 
  template <class T, class Prop, class Storage, class Allocator>
  inline Matrix_Sparse<T, Prop, Storage, Allocator>&
  Matrix_Sparse<T, Prop, Storage, Allocator>
  ::operator= (const Matrix_Sparse<T, Prop, Storage, Allocator>& A)
  {
    this->Copy(A);
 
    return *this;
  }
 
 
#ifdef SELDON_WITH_VIRTUAL
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::ApplySor(const SeldonTranspose& trans, Vector<Treal>& x, const Vector<Treal>& r,
             const typename ClassComplexType<T>::Treal& omega,
             int nb_iter, int stage_ssor) const
  {
    SOR(trans, static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this),
        x, r, omega, nb_iter, stage_ssor);
  }
  
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::ApplySor(const SeldonTranspose& trans, Vector<Tcplx>& x, const Vector<Tcplx>& r,
             const typename ClassComplexType<T>::Treal& omega,
             int nb_iter, int stage_ssor) const
  {
    SOR(trans,
        static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this),
        x, r, omega, nb_iter, stage_ssor);
  }
  
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::MltAddVector(const Treal& alpha, const Vector<Treal>& x,
                 const Treal& beta, Vector<Treal>& y) const
  {
    MltAdd(alpha,
           static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this),
           x, beta, y);
  }
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::MltAddVector(const Tcplx& alpha, const Vector<Tcplx>& x,
                 const Tcplx& beta, Vector<Tcplx>& y) const
  {
    MltAdd(alpha,
           static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this),
           x, beta, y);
  }
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::MltAddVector(const Treal& alpha, const SeldonTranspose& trans,
                 const Vector<Treal>& x,
                 const Treal& beta, Vector<Treal>& y) const
  {
    MltAdd(alpha, trans,
           static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this),
           x, beta, y);
  }
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::MltAddVector(const Tcplx& alpha, const SeldonTranspose& trans,
                 const Vector<Tcplx>& x,
                 const Tcplx& beta, Vector<Tcplx>& y) const
  {
    MltAdd(alpha, trans,
           static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this),
           x, beta, y);
  }
  
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::MltVector(const Vector<Treal>& x, Vector<Treal>& y) const
  {
    Mlt(static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this), x, y);
  }
  
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>
  ::MltVector(const Vector<Tcplx>& x, Vector<Tcplx>& y) const
  {
    Mlt(static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this), x, y);
  }
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>  
  ::MltVector(const SeldonTranspose& trans,
              const Vector<Treal>& x, Vector<Treal>& y) const
  {
    Mlt(trans,
        static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this), x, y);
  }
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Sparse<T, Prop, Storage, Allocator>  
  ::MltVector(const SeldonTranspose& trans,
              const Vector<Tcplx>& x, Vector<Tcplx>& y) const
  {
    Mlt(trans,
        static_cast<const Matrix<T, Prop, Storage, Allocator>& >(*this), x, y);
  }
 
  template <class T, class Prop, class Storage, class Allocator>
  inline bool Matrix_Sparse<T, Prop, Storage, Allocator>  
  ::IsSymmetric() const
  {
    return false;
  }
#endif
 
  
  // MATRIX<COLSPARSE> //
 
 
  /****************
   * CONSTRUCTORS *
   ****************/
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, ColSparse, Allocator>::Matrix():
    Matrix_Sparse<T, Prop, ColSparse, Allocator>()
  {
  }
 
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, ColSparse, Allocator>::Matrix(int i, int j):
    Matrix_Sparse<T, Prop, ColSparse, Allocator>(i, j, 0)
  {
  }
 
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, ColSparse, Allocator>::Matrix(int i, int j, long nz):
    Matrix_Sparse<T, Prop, ColSparse, Allocator>(i, j, nz)
  {
  }
 
 
 
  template <class T, class Prop, class Allocator>
  template <class Storage0, class Allocator0,
            class Storage1, class Allocator1,
            class Storage2, class Allocator2>
  inline Matrix<T, Prop, ColSparse, Allocator>::
  Matrix(int i, int j,
         Vector<T, Storage0, Allocator0>& values,
         Vector<long, Storage1, Allocator1>& ptr,
         Vector<int, Storage2, Allocator2>& ind):
    Matrix_Sparse<T, Prop, ColSparse, Allocator>(i, j, values, ptr, ind)
  {
  }
 
 
 
  // MATRIX<ROWSPARSE> //
 
 
  /****************
   * CONSTRUCTORS *
   ****************/
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, RowSparse, Allocator>::Matrix():
    Matrix_Sparse<T, Prop, RowSparse, Allocator>()
  {
  }
 
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, RowSparse, Allocator>::Matrix(int i, int j):
    Matrix_Sparse<T, Prop, RowSparse, Allocator>(i, j, 0)
  {
  }
 
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, RowSparse, Allocator>::Matrix(int i, int j, long nz):
    Matrix_Sparse<T, Prop, RowSparse, Allocator>(i, j, nz)
  {
  }
 
 
 
  template <class T, class Prop, class Allocator>
  template <class Storage0, class Allocator0,
            class Storage1, class Allocator1,
            class Storage2, class Allocator2>
  inline Matrix<T, Prop, RowSparse, Allocator>::
  Matrix(int i, int j,
         Vector<T, Storage0, Allocator0>& values,
         Vector<long, Storage1, Allocator1>& ptr,
         Vector<int, Storage2, Allocator2>& ind):
    Matrix_Sparse<T, Prop, RowSparse, Allocator>(i, j, values, ptr, ind)
  {
  }
 
  
} // namespace Seldon.
 
#define SELDON_FILE_MATRIX_SPARSE_INLINE_CXX
#endif