Matrix_SymmetricInline.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_SYMMETRIC_INLINE_CXX
 
#include "Matrix_Symmetric.hxx"
 
namespace Seldon
{
 
 
  /****************
   * CONSTRUCTORS *
   ****************/
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline Matrix_Symmetric<T, Prop, Storage, Allocator>::Matrix_Symmetric():
    Matrix_Base<T, Allocator>()
  {
    me_ = NULL;
  }
 
 
  /**************
   * DESTRUCTOR *
   **************/
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline Matrix_Symmetric<T, Prop, Storage, Allocator>::~Matrix_Symmetric()
  {
    this->Clear();
  }
 
 
  /*******************
   * BASIC FUNCTIONS *
   *******************/
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline long Matrix_Symmetric<T, Prop, Storage, Allocator>::GetDataSize() const
  {
    return long(this->m_) * long(this->n_);
  }
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline size_t Matrix_Symmetric<T, Prop, Storage, Allocator>::GetMemorySize() const
  {
    size_t taille = sizeof(*this) + size_t(GetDataSize())*sizeof(T);
    taille += this->m_*sizeof(pointer);
    return taille;
  }
 
 
  /**********************************
   * ELEMENT ACCESS AND AFFECTATION *
   **********************************/
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline typename Matrix_Symmetric<T, Prop, Storage, Allocator>::reference
  Matrix_Symmetric<T, Prop, Storage, Allocator>::operator() (int i, int j)
  {
 
#ifdef SELDON_CHECK_BOUNDS
    CheckBounds(i, j, this->m_, this->n_, "Matrix_Symmetric");
#endif
 
    if (i > j)
      return me_[Storage::GetSecond(i, j)][Storage::GetFirst(i, j)];
    else
      return me_[Storage::GetFirst(i, j)][Storage::GetSecond(i, j)];
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline typename Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::const_reference
  Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::operator() (int i, int j) const
  {
 
#ifdef SELDON_CHECK_BOUNDS
    CheckBounds(i, j, this->m_, this->n_, "Matrix_Symmetric");
#endif
 
    if (i > j)
      return me_[Storage::GetSecond(i, j)][Storage::GetFirst(i, j)];
    else
      return me_[Storage::GetFirst(i, j)][Storage::GetSecond(i, j)];
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline typename Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::const_reference
  Matrix_Symmetric<T, Prop, Storage, Allocator>::Val(int i, int j) const
  {
 
#ifdef SELDON_CHECK_BOUNDS
    CheckBoundsSym(i, j, this->m_, this->n_, "Matrix_Symmetric");
#endif
 
    return me_[Storage::GetFirst(i, j)][Storage::GetSecond(i, j)];
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline typename Matrix_Symmetric<T, Prop, Storage, Allocator>::reference
  Matrix_Symmetric<T, Prop, Storage, Allocator>::Val(int i, int j)
  {
 
#ifdef SELDON_CHECK_BOUNDS
    CheckBoundsSym(i, j, this->m_, this->n_, "Matrix_Symmetric");
#endif
 
    return me_[Storage::GetFirst(i, j)][Storage::GetSecond(i, j)];
  }
 
  
 
  template <class T, class Prop, class Storage, class Allocator>
  inline typename Matrix_Symmetric<T, Prop, Storage, Allocator>::reference
  Matrix_Symmetric<T, Prop, Storage, Allocator>::Get(int i, int j)
  {
 
#ifdef SELDON_CHECK_BOUNDS
    CheckBounds(i, j, this->m_, this->n_, "Matrix_Symmetric");
#endif
 
    if (i > j)
      return me_[Storage::GetSecond(i, j)][Storage::GetFirst(i, j)];
    else
      return me_[Storage::GetFirst(i, j)][Storage::GetSecond(i, j)];
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline typename Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::const_reference
  Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::Get(int i, int j) const
  {
 
#ifdef SELDON_CHECK_BOUNDS
    CheckBounds(i, j, this->m_, this->n_, "Matrix_Symmetric");
#endif
 
    if (i > j)
      return me_[Storage::GetSecond(i, j)][Storage::GetFirst(i, j)];
    else
      return me_[Storage::GetFirst(i, j)][Storage::GetSecond(i, j)];
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline typename Matrix_Symmetric<T, Prop, Storage, Allocator>::reference
  Matrix_Symmetric<T, Prop, Storage, Allocator>::operator[] (int i)
  {
 
#ifdef SELDON_CHECK_BOUNDS
    CheckBounds(i, this->GetDataSize(), "Matrix_Symmetric");
#endif
 
    return this->data_[i];
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline typename Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::const_reference
  Matrix_Symmetric<T, Prop, Storage, Allocator>::operator[] (int i) const
  {
 
#ifdef SELDON_CHECK_BOUNDS
    CheckBounds(i, this->GetDataSize(), "Matrix_Symmetric");
#endif
 
    return this->data_[i];
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline Matrix_Symmetric<T, Prop, Storage, Allocator>&
  Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::operator= (const Matrix_Symmetric<T, Prop, Storage, Allocator>& A)
  {
    this->Copy(A);
 
    return *this;
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::Set(int i, int j, const T& x)
  {
    this->Get(i, j) = x;
  }
 
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::Copy(const Matrix_Symmetric<T, Prop, Storage, Allocator>& A)
  {
    this->Reallocate(A.GetM(), A.GetN());
 
    Allocator::memorycpy(this->data_, A.GetData(), this->GetDataSize());
  }
  
 
#ifdef SELDON_WITH_VIRTUAL
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::AddInteraction(int i, int j, const T& val)
  {
    if (i <= j)
      this->Val(i, j) += val;
  }
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::AddInteractionRow(int i, int n, const Vector<int>& col,
                      const Vector<T>& val, bool sorted)
  {
    for (int k = 0; k < n; k++)
      if (i <= col(k))
        this->Val(i, col(k)) += val(k);
  }
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::AddInteractionColumn(int i, int n, const Vector<int>& row,
                         const Vector<T>& val, bool sorted)
  {
    for (int k = 0; k < n; k++)
      if (row(k) <= i)
        this->Val(row(k), i) += val(k);
  }
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Symmetric<T, Prop, Storage, Allocator>
  ::ClearRow(int i)
  {
    for (int k = 0; k < this->n_; k++)
      SetComplexZero(this->Val(i, k));
  }
 
 
  template <class T, class Prop, class Storage, class Allocator>
  inline void Matrix_Symmetric<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_Symmetric<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_Symmetric<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_Symmetric<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_Symmetric<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_Symmetric<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_Symmetric<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_Symmetric<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_Symmetric<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_Symmetric<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_Symmetric<T, Prop, Storage, Allocator>  
  ::IsSymmetric() const
  {
    return true;
  }
#endif
  
  // MATRIX<COLSYM> //
 
 
  /****************
   * CONSTRUCTORS *
   ****************/
 
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, ColSym, Allocator>::Matrix():
    Matrix_Symmetric<T, Prop, ColSym, Allocator>()
  {
  }
 
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, ColSym, Allocator>::Matrix(int i, int j):
    Matrix_Symmetric<T, Prop, ColSym, Allocator>(i, j)
  {
  }
 
 
  /*****************
   * OTHER METHODS *
   *****************/
 
 
 
  template <class T, class Prop, class Allocator>
  template <class T0>
  inline Matrix<T, Prop, ColSym, Allocator>&
  Matrix<T, Prop, ColSym, Allocator>::operator= (const T0& x)
  {
    this->Fill(x);
 
    return *this;
  }
 
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, ColSym, Allocator>&
  Matrix<T, Prop, ColSym, Allocator>::operator= (const Matrix<T, Prop,
                                                       ColSym,
                                                       Allocator>& A)
  {
    this->Copy(A);
    return *this;
  }
 
 
 
  template <class T, class Prop, class Allocator>
  template <class T0>
  Matrix<T, Prop, ColSym, Allocator>&
  Matrix<T, Prop, ColSym, Allocator>::operator*= (const T0& x)
  {
    for (long i = 0; i < this->GetDataSize();i++)
      this->data_[i] *= x;
 
    return *this;
  }
 
 
  // MATRIX<ROWSYM> //
 
 
  /****************
   * CONSTRUCTORS *
   ****************/
 
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, RowSym, Allocator>::Matrix():
    Matrix_Symmetric<T, Prop, RowSym, Allocator>()
  {
  }
 
 
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, RowSym, Allocator>::Matrix(int i, int j):
    Matrix_Symmetric<T, Prop, RowSym, Allocator>(i, j)
  {
  }
 
 
  /*****************
   * OTHER METHODS *
   *****************/
 
 
 
  template <class T, class Prop, class Allocator>
  template <class T0>
  inline Matrix<T, Prop, RowSym, Allocator>&
  Matrix<T, Prop, RowSym, Allocator>::operator= (const T0& x)
  {
    this->Fill(x);
 
    return *this;
  }
 
  
 
  template <class T, class Prop, class Allocator>
  inline Matrix<T, Prop, RowSym, Allocator>&
  Matrix<T, Prop, RowSym, Allocator>::operator= (const Matrix<T, Prop,
                                                       RowSym,
                                                       Allocator>& A)
  {
    this->Copy(A);
    return *this;
  }
 
 
 
  template <class T, class Prop, class Allocator>
  template <class T0>
  inline Matrix<T, Prop, RowSym, Allocator>&
  Matrix<T, Prop, RowSym, Allocator>::operator*= (const T0& x)
  {
    for (long i = 0; i < this->GetDataSize();i++)
      this->data_[i] *= x;
 
    return *this;
  }
 
} // namespace Seldon.
 
#define SELDON_FILE_MATRIX_SYMMETRIC_INLINE_CXX
#endif