algebra/tridiagonal_matrix.h

// -*- c++ -*-

// +--------------------------------------------------------------------+
// | This file is part of MathTL - the Mathematical Template Library    |
// |                                                                    |
// | Copyright (c) 2002-2009                                            |
// | Thorsten Raasch, Manuel Werner                                     |
// +--------------------------------------------------------------------+

#ifndef _MATHTL_TRIDIAGONAL_MATRIX_H
#define _MATHTL_TRIDIAGONAL_MATRIX_H

#include <iostream>
#include <algebra/vector.h>

namespace MathTL
{
  template <class C>
  class TridiagonalMatrix
  {
  public:
    typedef typename Vector<C>::size_type size_type;

    explicit TridiagonalMatrix(const size_type n = 1);

    TridiagonalMatrix(const TridiagonalMatrix<C>& M);

    const size_type row_dimension() const;
    
    const size_type column_dimension() const;
    
    const size_type size() const;
    
    void resize(const size_type rows);

    const size_type memory_consumption() const;
    
    bool empty() const;
    
    const C operator () (const size_type row, const size_type column) const;
    
    const C get_entry(const size_type row, const size_type column) const;

    C& operator () (const size_type row, const size_type column);
    
    void set_entry(const size_type row, const size_type column, const C value);

    template <class C2>
    bool operator == (const TridiagonalMatrix<C2>& M) const;

    template <class C2>
    bool operator != (const TridiagonalMatrix<C2>& M) const;

    TridiagonalMatrix<C>& operator = (const TridiagonalMatrix<C>& M);

    template <class VECTOR>
    void apply(const VECTOR& x, VECTOR& Mx) const;

    template <class VECTOR>
    void apply_transposed(const VECTOR& x, VECTOR& Mtx) const;

    void print(std::ostream& os,
               const unsigned int tabwidth = 5,
               const unsigned int precision = 2) const;

  protected:
    Vector<C> a_, b_, c_;

    size_type rowdim_;
  };

  template <class C>
  std::ostream& operator << (std::ostream& os, const TridiagonalMatrix<C>& M);
}

// include implementation of inline functions
#include <algebra/tridiagonal_matrix.cpp>

#endif