math_matrix.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program 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.
 */
 
#ifndef MATRIX_H_
#define MATRIX_H_
 
#include <cstddef>
#include <ostream>
#include <iomanip>
#include "../../types.h"
#include "math_vector.h"
#include "common/assert.h"
 
namespace ug
{
 
template <std::size_t N, std::size_t M, typename T = number> class MathMatrix;
 
template <std::size_t N, std::size_t M, typename T>
class MathMatrix
{
  public:
    typedef T value_type;
    typedef std::size_t size_type;
    static const std::size_t RowSize = N;
    static const std::size_t ColSize = M;
 
  public:
    MathMatrix() {}
    MathMatrix(const MathMatrix& v) {assign(v);}
 
    MathMatrix& operator=  (const MathMatrix& v)
    {
      assign(v);
      return *this;
    }
 
    MathMatrix& operator+= (const MathMatrix& B)
    {
      for(std::size_t i = 0; i < N; ++i){
        for(std::size_t j = 0; j < M; ++j){
          m_data[i][j] += B(i,j);
        }
      }
      return *this;
    }
 
    MathMatrix& operator-= (const MathMatrix& B)
    {
      for(std::size_t i = 0; i < N; ++i){
        for(std::size_t j = 0; j < M; ++j){
          m_data[i][j] -= B(i,j);
        }
      }
      return *this;
    }
 
    MathMatrix& operator= (const value_type& val)
    {
      for(std::size_t i = 0; i < N; ++i){
        for(std::size_t j = 0; j < M; ++j){
          m_data[i][j] = val;
        }
      }
      return *this;
    }
 
    MathMatrix& operator+= (const value_type& val)
    {
      for(std::size_t i = 0; i < N; ++i){
        for(std::size_t j = 0; j < M; ++j){
          m_data[i][j] += val;
        }
      }
      return *this;
    }
 
    MathMatrix& operator-= (const value_type& val)
    {
      for(std::size_t i = 0; i < N; ++i){
        for(std::size_t j = 0; j < M; ++j){
          m_data[i][j] -= val;
        }
      }
      return *this;
    }
 
    MathMatrix& operator/= (const value_type& val)
    {
      for(std::size_t i = 0; i < N; ++i){
        for(std::size_t j = 0; j < M; ++j){
          m_data[i][j] /= val;
        }
      }
      return *this;
    }
 
    MathMatrix& operator*= (const value_type& val)
    {
      for(std::size_t i = 0; i < N; ++i){
        for(std::size_t j = 0; j < M; ++j){
          m_data[i][j] *= val;
        }
      }
      return *this;
    }
 
    value_type operator* (const MathMatrix& v) const
    {
      value_type res = 0.0;
      for(std::size_t i = 0; i < N; ++i){
        for(std::size_t j = 0; j < M; ++j){
          res += m_data[i][j] * v.m_data[i][j];
        }
      }
      return res;
    }
 
    inline std::size_t num_rows() const {return N;}
    inline std::size_t num_cols() const {return M;}
 
    inline value_type* operator[](std::size_t index){
      UG_ASSERT(index < N, "Invalid index");
      return m_data[index];
    }
    inline const value_type* operator[](std::size_t index) const{
      UG_ASSERT(index < N, "Invalid index");
      return m_data[index];
    }
 
    inline value_type& operator() (std::size_t row, std::size_t col){
      UG_ASSERT(row < N && col < M, "Accessing "<<N<<"x"<<M<<"Matrix at entry ("<<row<<","<<col<<")");
      return m_data[row][col];
    }
    inline const value_type& operator() (std::size_t row, std::size_t col) const{
      UG_ASSERT(row < N && col < M, "Accessing "<<N<<"x"<<M<<"Matrix at entry ("<<row<<","<<col<<")");
      return m_data[row][col];
    }
 
    inline value_type& entry(std::size_t row, std::size_t col)        {return (*this)(row,col);}
    inline const value_type& entry(std::size_t row, std::size_t col) const  {return (*this)(row,col);}
 
    inline void assign(const MathVector<N, value_type>& vec, const std::size_t row) {
      UG_ASSERT(vec.Size == N, "Wrong vector size");
      for(std::size_t j = 0; j < N; j++)
        m_data[row][j] = vec[j];
    }
 
  protected:
    value_type m_data[N][M];
 
    inline void assign(const MathMatrix& v)
    {
      for(std::size_t i = 0; i < N; ++i){
        for(std::size_t j = 0; j < M; ++j){
          m_data[i][j] = v.m_data[i][j] ;
        }
      }
    }
 
};
 
// this are explicit instantiations to avoid compiler errors on XL
// {
template <typename T> class MathMatrix<0,0,T>{
  public:
    typedef T value_type;
    typedef std::size_t size_type;
};
template <std::size_t N, typename T> class MathMatrix<N,0,T>{
  public:
    typedef T value_type;
    typedef std::size_t size_type;
};
template <std::size_t N, typename T> class MathMatrix<0,N,T>{
  public:
    typedef T value_type;
    typedef std::size_t size_type;
};
// }
 
template <std::size_t N, std::size_t M>
std::ostream& operator<< (std::ostream& outStream, const ug::MathMatrix<N,M>& m)
{
  for(std::size_t i = 0; i < N; ++i)
  {
    for(std::size_t j = 0; j < M; ++j)
    {
      outStream << "[" << i << "][" << j << "]: " << std::scientific << std::setprecision(8) << std::setw(15) << m.entry(i, j) << std::endl;
    }
  }
  return outStream;
}
 
std::ostream& operator<< (std::ostream& outStream, const ug::MathMatrix<2,2>& m);
std::ostream& operator<< (std::ostream& outStream, const ug::MathMatrix<2,3>& m);
std::ostream& operator<< (std::ostream& outStream, const ug::MathMatrix<3,2>& m);
std::ostream& operator<< (std::ostream& outStream, const ug::MathMatrix<3,3>& m);
 
// end group math_matrix
 
} //end of namespace: lgmath
 
 
#endif /* MathMatrix_H_ */