Matrix.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Copyright (C) 2009-2011 Cassio Neri Moreira
 *
 * This file is part of the KeyValue library.
 *
 * The KeyValue library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 *
 * The KeyValue library 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 General
 * Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with KeyValue. If not, see <http://www.gnu.org/licenses/>.
 *
 * If you modify this library, or any covered work, by linking or combining
 * it with Excel (or a modified version of that program), containing parts
 * covered by the terms of End-User License Agreement for Microsoft
 * Software, the licensors of KeyValue grant you additional permission to
 * convey the resulting work.
 *
 **************************************************************************/

#ifndef KEYVALUE_KEY_GENERIC_MATRIX_H_
#define KEYVALUE_KEY_GENERIC_MATRIX_H_

#include "keyvalue/extern/String.h"
#include "keyvalue/key/converter/StdMatrix.h"
#include "keyvalue/key/Traits.h"

namespace keyvalue {
namespace key {

template <typename ElementType>
class Matrix : public Traits<ElementType, StdMatrix> {

public:

  explicit
  Matrix(const string& name);

  Matrix(const string& name, size_t nRows, size_t nCols_);

private:

private :

  void
  checkSize(size_t nRows, size_t nCols) const;

  size_t nRows_;
  size_t nCols_;

}; // class Matrix

/*--------------------------------------------------------------------------
 * Matrix()
 *------------------------------------------------------------------------*/

template <typename ElementType>
Matrix<ElementType>::Matrix(const string& name) :
  Matrix::Traits_(name),
  nRows_(0),
  nCols_(0) {
}

template <typename ElementType>
Matrix<ElementType>::Matrix(const string& name, const size_t nRows,
  const size_t nCols) :
  Matrix::Traits_(name),
  nRows_(nRows),
  nCols_(nCols) {
}

/*--------------------------------------------------------------------------
 * checkSize()
 *------------------------------------------------------------------------*/

template <typename ElementType>
void
Matrix<ElementType>::checkSize(const size_t nRows, const size_t nCols) const
{
  if (nRows_ != 0 && nRows_ != nRows)
    throw RuntimeError() & "Matrix assigned to key '" & Key::getName() &
      "' has wrong number of rows! Expecting " & nRows_ & " got " & nRows &
      ".";

  if (nCols_ != 0 && nCols_ != nCols)
    throw RuntimeError() & "Matrix assigned to key '" & Key::getName() &
      "' has wrong number of columns! Expecting " & nCols_ & " got " & nCols
      & ".";
}

} // namespace key
} // namespace keyvalue

#endif // KEYVALUE_KEY_GENERIC_MATRIX_H_