MatrixLookupWeighted.h

#ifndef _theplu_yat_classifier_matrix_lookup_weighted_ 
#define _theplu_yat_classifier_matrix_lookup_weighted_ 

// $Id: MatrixLookupWeighted.h 2374 2010-12-12 07:23:27Z peter $

/*
  Copyright (C) 2006 Jari Häkkinen, Peter Johansson, Markus Ringnér
  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
  Copyright (C) 2009, 2010 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/DataWeight.h"
#include "yat/utility/deprecate.h"
#include "yat/utility/Index.h"
#include "yat/utility/MatrixWeighted.h"
#include "yat/utility/SmartPtr.h"
#include "yat/utility/StrideIterator.h"

#include <boost/iterator/permutation_iterator.hpp>

#include <iosfwd>
#include <utility>
#include <vector>

namespace theplu {
namespace yat {
namespace classifier {  

  class MatrixLookup;

  class MatrixLookupWeighted
  {
  public:
    typedef utility::DataWeight value_type;

    typedef const utility::DataWeight& const_reference;

    typedef utility::StrideIterator<
    utility::Container2DIterator<const MatrixLookupWeighted, 
                                 const value_type, const_reference> >
    const_iterator;

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

    typedef boost::permutation_iterator<
      utility::MatrixWeighted::const_row_iterator,
      utility::Index::const_iterator> const_row_iterator;

    MatrixLookupWeighted(const utility::MatrixWeighted& matrix,
                         const utility::Index& rows,
                         const utility::Index& columns);

    explicit MatrixLookupWeighted(const utility::MatrixWeighted& matrix,
                                  bool owner=false);

    explicit MatrixLookupWeighted(const MatrixLookup& matrix);


    MatrixLookupWeighted(const MatrixLookupWeighted& other);

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

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

    MatrixLookupWeighted(const size_t rows, const size_t columns, 
                         const double value=0, const double weight=1);

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

    virtual ~MatrixLookupWeighted();

    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;

    double data(size_t row, size_t column) 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;

    double weight(size_t row, size_t column) const;

    bool weighted(void) const;

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

    const MatrixLookupWeighted& operator=(const MatrixLookupWeighted&);
    
  private:
    typedef utility::SmartPtr<const utility::MatrixWeighted> MatrixWP;
    utility::Index column_index_;
    MatrixWP data_;
    utility::Index row_index_;

    // for assertions
    bool validate(void) const;
  };  
  
  std::ostream& operator<< (std::ostream& s, const MatrixLookupWeighted&);

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

#endif