matrix_sparse/Matrix_ComplexSparse.hxx

// Copyright (C) 2001-2009 Vivien Mallet
//
// 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/.


// To be included by Seldon.hxx

#ifndef SELDON_FILE_MATRIX_COMPLEXSPARSE_HXX

#include "../share/Common.hxx"
#include "../share/Properties.hxx"
#include "../share/Storage.hxx"
#include "../share/Errors.hxx"
#include "../share/Allocator.hxx"

namespace Seldon
{



  template <class T, class Prop, class Storage,
            class Allocator = SELDON_DEFAULT_ALLOCATOR<T> >
  class Matrix_ComplexSparse: public Matrix_Base<T, Allocator>
  {
    // typedef declaration.
  public:
    typedef typename Allocator::value_type value_type;
    typedef typename Allocator::pointer pointer;
    typedef typename Allocator::const_pointer const_pointer;
    typedef typename Allocator::reference reference;
    typedef typename Allocator::const_reference const_reference;
    typedef complex<value_type> entry_type;
    typedef complex<value_type> access_type;
    typedef complex<value_type> const_access_type;

    // Attributes.
  protected:
    // Number of non-zero elements.
    int real_nz_;
    int imag_nz_;
    // Index (in data_) of first element stored for each row or column.
    int* real_ptr_;
    int* imag_ptr_;
    // Column or row index (in the matrix) each element.
    int* real_ind_;
    int* imag_ind_;

    // Data.
    T* real_data_;
    T* imag_data_;

    // Methods.
  public:
    // Constructors.
    Matrix_ComplexSparse();
    Matrix_ComplexSparse(int i, int j);
    Matrix_ComplexSparse(int i, int j, int real_nz, int imag_nz);
    template <class Storage0, class Allocator0,
              class Storage1, class Allocator1,
              class Storage2, class Allocator2>
    Matrix_ComplexSparse(int i, int j,
                         Vector<T, Storage0, Allocator0>& real_values,
                         Vector<int, Storage1, Allocator1>& real_ptr,
                         Vector<int, Storage2, Allocator2>& real_ind,
                         Vector<T, Storage0, Allocator0>& imag_values,
                         Vector<int, Storage1, Allocator1>& imag_ptr,
                         Vector<int, Storage2, Allocator2>& imag_ind);
    Matrix_ComplexSparse(const Matrix_ComplexSparse<T, Prop,
                         Storage, Allocator>& A);

    // Destructor.
    ~Matrix_ComplexSparse();
    void Clear();

    // Memory management.
    template <class Storage0, class Allocator0,
              class Storage1, class Allocator1,
              class Storage2, class Allocator2>
    void SetData(int i, int j,
                 Vector<T, Storage0, Allocator0>& real_values,
                 Vector<int, Storage1, Allocator1>& real_ptr,
                 Vector<int, Storage2, Allocator2>& real_ind,
                 Vector<T, Storage0, Allocator0>& imag_values,
                 Vector<int, Storage1, Allocator1>& imag_ptr,
                 Vector<int, Storage2, Allocator2>& imag_ind);
    void SetData(int i, int j,
                 int real_nz, pointer real_values, int* real_ptr,
                 int* real_ind,
                 int imag_nz, pointer imag_values, int* imag_ptr,
                 int* imag_ind);
    void Nullify();
    void Copy(const Matrix_ComplexSparse<T, Prop, Storage, Allocator>& A);

    // Basic methods.
    int GetNonZeros() const;
    int GetDataSize() const;
    int* GetRealPtr() const;
    int* GetImagPtr() const;
    int* GetRealInd() const;
    int* GetImagInd() const;
    int GetRealPtrSize() const;
    int GetImagPtrSize() const;
    int GetRealIndSize() const;
    int GetImagIndSize() const;
    T* GetRealData() const;
    T* GetImagData() const;

    // Element acess and affectation.
    complex<value_type> operator() (int i, int j) const;
    complex<value_type>& Val(int i, int j);
    const complex<value_type>& Val(int i, int j) const;
    Matrix_ComplexSparse<T, Prop, Storage, Allocator>&
    operator= (const Matrix_ComplexSparse<T, Prop, Storage, Allocator>& A);

    // Convenient functions.
    void Print() const;
  };


  template <class T, class Prop, class Allocator>
  class Matrix<T, Prop, ColComplexSparse, Allocator>:
    public Matrix_ComplexSparse<T, Prop, ColComplexSparse, Allocator>
  {
    // typedef declaration.
  public:
    typedef typename Allocator::value_type value_type;
    typedef Prop property;
    typedef ColComplexSparse storage;
    typedef Allocator allocator;

  public:
    Matrix()  throw();
    Matrix(int i, int j);
    Matrix(int i, int j, int real_nz, int imag_nz);
    template <class Storage0, class Allocator0,
              class Storage1, class Allocator1,
              class Storage2, class Allocator2>
    Matrix(int i, int j,
           Vector<T, Storage0, Allocator0>& real_values,
           Vector<int, Storage1, Allocator1>& real_ptr,
           Vector<int, Storage2, Allocator2>& real_ind,
           Vector<T, Storage0, Allocator0>& imag_values,
           Vector<int, Storage1, Allocator1>& imag_ptr,
           Vector<int, Storage2, Allocator2>& imag_ind);
  };


  template <class T, class Prop, class Allocator>
  class Matrix<T, Prop, RowComplexSparse, Allocator>:
    public Matrix_ComplexSparse<T, Prop, RowComplexSparse, Allocator>
  {
    // typedef declaration.
  public:
    typedef typename Allocator::value_type value_type;
    typedef Prop property;
    typedef RowComplexSparse storage;
    typedef Allocator allocator;

  public:
    Matrix()  throw();
    Matrix(int i, int j);
    Matrix(int i, int j, int real_nz, int imag_nz);
    template <class Storage0, class Allocator0,
              class Storage1, class Allocator1,
              class Storage2, class Allocator2>
    Matrix(int i, int j,
           Vector<T, Storage0, Allocator0>& values,
           Vector<int, Storage1, Allocator1>& ptr,
           Vector<int, Storage2, Allocator2>& ind,
           Vector<T, Storage0, Allocator0>& imag_values,
           Vector<int, Storage1, Allocator1>& imag_ptr,
           Vector<int, Storage2, Allocator2>& imag_ind);
  };


} // namespace Seldon.

#define SELDON_FILE_MATRIX_COMPLEXSPARSE_HXX
#endif