source: trunk/yat/classifier/DataLookupWeighted1D.h @ 1090

#ifndef _theplu_yat_classifier_dataLookup_weighted_1D_ 
#define _theplu_yat_classifier_dataLookup_weighted_1D_ 

// $Id: DataLookupWeighted1D.h 1090 2008-02-14 15:22:54Z peter $

/*
  Copyright (C) 2006 Jari Häkkinen, Peter Johansson
  Copyright (C) 2007 Peter Johansson

  This file is part of the yat library, http://trac.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 2 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 this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#include "MatrixLookupWeighted.h"
#include "yat/utility/Iterator.h"
#include "yat/utility/IteratorPolicy.h"
#include "yat/utility/StrideIterator.h"

#include <iostream>
#include <utility>
#include <vector>

namespace theplu {
namespace yat {
namespace classifier {  

  ///
  /// @brief Class for general weighted vector view.
  ///
  /// @see MatrixLookupWeighted
  ///
  class DataLookupWeighted1D
  {
  
  public:
    /// 'Read Only' iterator
    typedef utility::StrideIterator<
    utility::Iterator<const MatrixLookupWeighted, 
                      const std::pair<double, double>, void, 
                      const std::pair<double, double>,
                      utility::IteratorPolicyWeighted<const MatrixLookupWeighted,
                                                      const double,
                                                      const double> > >
    const_iterator;

    ///
    /// Constructor. 
    ///
    /// @param row_vector if true (default) DataLookup1D is
    /// looking into a row of MatrixLookupWeighted, otherwise looking into
    /// a column. @param index which row/column to look into.
    ///
    DataLookupWeighted1D(const MatrixLookupWeighted&, const size_t index, 
                         const bool row_vector);

    ///
    /// Copy constructor
    ///
    DataLookupWeighted1D(const DataLookupWeighted1D&);

    ///
    /// Construct DataLookup1D that owns its underlying matrix. Object
    /// has size \a size and all its element is equal to \a value.
    ///
    DataLookupWeighted1D(const size_t size, double value=0, double weight=1); 

    ///
    /// @brief Destructor
    ///
    virtual ~DataLookupWeighted1D();

    /**
       \return 'Read Only' iterator to beginning of DataLookupWeighted1D.
     */
    const_iterator begin() const;

    /**
       \return data(i)
    */
    double data(const size_t i) const;
    
    /**
       \return 'Read Only' iterator to end of DataLookupWeighted1D.
     */
    const_iterator end() const;

    ///
    /// @return number of elements
    ///
    size_t size(void) const;

    ///
    /// @return weight(i)
    ///
    double weight(const size_t i) const;

    ///
    /// @return data(i) * weight(i)
    ///
    double operator()(const size_t i) const;

    ///
    /// @return data(i) * weight(i)
    ///
    double operator[](const size_t i) const;

  private:
    const DataLookupWeighted1D& operator=(const DataLookupWeighted1D&);

    const bool column_vector_;
    const size_t index_;
    const MatrixLookupWeighted* matrix_;
    const bool owner_;
    
  };

  ///
  /// @return sum of weights
  ///
  double sum_weight(const DataLookupWeighted1D&);

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

#endif