MatrixLookup.h

#ifndef _theplu_yat_classifier_matrix_lookup_
#define _theplu_yat_classifier_matrix_lookup_

// $Id: MatrixLookup.h 3293 2014-07-25 03:42:58Z peter $

/*
  Copyright (C) 2005 Peter Johansson, Markus Ringnér
  Copyright (C) 2006 Jari Häkkinen, Peter Johansson, Markus Ringnér
  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
  Copyright (C) 2009, 2010, 2012, 2014 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat 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 yat 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 yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include "yat/utility/Container2DIterator.h"
#include "yat/utility/deprecate.h"
#include "yat/utility/Index.h"
#include "yat/utility/iterator_traits.h"
#include "yat/utility/Matrix.h"

#include <boost/iterator/permutation_iterator.hpp>
#include <boost/shared_ptr.hpp>

#include <iosfwd>
#include <vector>

namespace theplu {
namespace yat {
namespace classifier {

  class MatrixLookup
  {
  public:
    typedef utility::Matrix::value_type value_type;

    typedef utility::Matrix::const_reference const_reference;

    typedef utility::Container2DIterator<const MatrixLookup, const double,
                                         const_reference>
    const_iterator;

    typedef boost::permutation_iterator<utility::Matrix::const_column_iterator,
                                        utility::Index::const_iterator>
    const_column_iterator;

    typedef const_column_iterator const_row_iterator;

    MatrixLookup(const utility::Matrix& matrix, const bool own=false);

    MatrixLookup(const utility::Matrix& matrix, const utility::Index& row,
                 const utility::Index& column);

    MatrixLookup(const utility::Matrix& matrix,
                 const utility::Index& index,
                 const bool row_vectors) YAT_DEPRECATE;

    MatrixLookup(const MatrixLookup& other);

    MatrixLookup(const MatrixLookup& ml, const utility::Index& row,
                 const utility::Index& column);

    MatrixLookup(const MatrixLookup& ml, const utility::Index&,
                 const bool row_vectors);

    MatrixLookup(const size_t rows, const size_t columns, const double value=0);

    MatrixLookup(std::istream&, char sep='\0');

    virtual ~MatrixLookup();

    const_iterator begin(void) const;

    const_column_iterator begin_column(size_t) const;

    const_row_iterator begin_row(size_t) const;

    size_t columns(void) const;

    const_iterator end(void) const;

    const_column_iterator end_column(size_t) const;

    const_row_iterator end_row(size_t) const;

    size_t rows(void) const;

    bool weighted(void) const;

    const_reference operator()(size_t row, size_t column) const;

    const MatrixLookup& operator=(const MatrixLookup&);

  private:
    friend class MatrixLookupWeighted;

    utility::Index column_index_;
    typedef boost::shared_ptr<const utility::Matrix> MatrixP;
    MatrixP data_;
    utility::Index row_index_;

    // for assertions
    bool validate(void) const;
  };

  std::ostream& operator<< (std::ostream& s, const MatrixLookup&);

}}} // of namespace classifier, yat, and theplu

#endif