dgmatrix.h

// -*-C++-*-
// ==========================================================================
// Module mathlib
// File dgmatrix.h
// Declaration of template class TDiagMatrix ('template diagonal matrix')
//
// The following typedefs for specific template types have been defined
// for convenience:
//  RDiagMatrix = TDiagMatrix<double>   ('real')
//  FDiagMatrix = TDiagMatrix<float>    ('float')
//  CDiagMatrix = TDiagMatrix<complex>  ('complex')
//  IDiagMatrix = TDiagMatrix<int>      ('integer')
//  DiagMatrix  = TDiagMatrix<double>   for backward compatibility
//
// Inheritance:
// ------------
// TGenericSparseMatrix ----> TDiagMatrix
// ==========================================================================

#ifndef __DGMATRIX_H
#define __DGMATRIX_H

#include "gsmatrix.h"
#include "dnsmatrix.h"

// ==========================================================================
// class TDiagMatrix
// ==========================================================================
template<class MT> class TDiagMatrix: public TGenericSparseMatrix<MT> {
public:
    TDiagMatrix ();

    TDiagMatrix (int r, int c, const MT v = (MT)0);

    TDiagMatrix (const TDiagMatrix<MT> &mat);

    virtual ~TDiagMatrix ();

    MatrixStorage StorageType() const { return MATRIX_DIAG; }

    void New (int nrows, int ncols);

    virtual MT Get (int r, int c) const
    { return (r == c) ? this->val[r] : (MT)0; }

    TVector<MT> Row (int r) const;

    TVector<MT> Col (int c) const;

    int SparseRow (int r, idxtype *colidx, MT *val) const;

    void ColScale (const TVector<MT> &scale);

    void RowScale (const TVector<MT> &scale);

    TDiagMatrix &operator= (const TDiagMatrix<MT> &mat);

    TDiagMatrix &operator= (const MT &v);

    void Copy (const TDiagMatrix<MT> &mat);

    operator TDenseMatrix<MT> ();

    MT &operator() (int r, int c);

    TDiagMatrix operator+ (const TDiagMatrix &mat) const;

    TDiagMatrix operator- (const TDiagMatrix &mat) const;

    bool Exists (int r, int c) const;

    int Get_index (int r, int c) const;

    MT GetNext (int &r, int &c) const;

    void Ax (const TVector<MT> &x, TVector<MT> &b) const;

    void Ax (const TVector<MT> &x, TVector<MT> &b, int r1, int r2) const;

    void ATx (const TVector<MT> &x, TVector<MT> &b) const;
};

// ==========================================================================
// typedefs for specific instances of `TDiagMatrix'
// ==========================================================================
typedef TDiagMatrix<double> RDiagMatrix;    // 'real'
typedef TDiagMatrix<float>  FDiagMatrix;    // 'float'
typedef TDiagMatrix<std::complex<double> >  CDiagMatrix;    // 'complex'
typedef TDiagMatrix<int>    IDiagMatrix;    // 'integer'
typedef TDiagMatrix<double> DiagMatrix; // for backward compatibility
// ==========================================================================

#endif // !__DGMATRIX_H