Matrix.hpp

#pragma once
 
#include <opals/fwd.hpp>
 
#include <cstddef>
#include <array>
 
namespace opals {
 
  /**
  \class  Matrix
  \tparam T element type
  \tparam nRows_ number of rows
  \tparam nCols_ number of columns
 
  \brief A template class for storing a two-dimensional array of constant size.
 
  Matrix fulfills almost all the requirements of an STL reversible container.
  The complete implementation is exposed and hence, opals users may instantiate Matrix<T, nRows_, nCols_> with arbitrary template arguments.
  The class inherits most of its functionality from std::array, with elements stored in row-major order.
 
  \author wk
  \date   06.02.2011
  */
 
  template< class T, std::size_t nRows_, std::size_t nCols_ >
  class Matrix : public std::array<T, nRows_ * nCols_>
  {
  public:
    /// swap
    void swap(Matrix& other) { Matrix::array::swap(other); }
 
    /// \name element access
    /// zero-based indexing
    ///@{
    T&       operator()(size_t r, size_t c)
    {
      return (*this)[r * nCols_ + c];
    }
    const T& operator()(size_t r, size_t c) const
    {
      return (*this)[r * nCols_ + c];
    }
    ///@}
 
    /// \name size
    ///@{
    size_t nRows() const { return nRows_; }
    size_t nCols() const { return nCols_; }
    ///@}
 
  };
 
}