source: branches/0.12-stable/yat/classifier/DataLookupWeighted1D.h @ 3275

#ifndef _theplu_yat_classifier_dataLookup_weighted_1D_ 
#define _theplu_yat_classifier_dataLookup_weighted_1D_ 

// $Id: DataLookupWeighted1D.h 3275 2014-07-04 14:34:12Z peter $

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

#include <utility>
#include <vector>

namespace theplu {
namespace yat {
namespace classifier {  

  ///
  /// @brief Class for general weighted vector view.
  ///
  /// @see MatrixLookupWeighted
  ///
  class DataLookupWeighted1D
  {
  
  public:
    /**
       value_type is DataWeight

       \since New in yat 0.5
     */
    typedef utility::DataWeight value_type;

    /**
       const_reference type is const DataWeight

       \since New in yat 0.5
     */
    typedef const utility::DataWeight const_reference;

    /// 'Read Only' iterator
    typedef MatrixLookupWeighted::const_row_iterator const_iterator;

    ///
    /// Constructor. 
    ///
    /// \param m MatrixLookupWeighted to look into
    /// @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& m, 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;

    /**
       \brief access operator
     */
    const_reference 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
  ///
  /// \relatesalso DataLookupWeighted1D
  ///
  double sum_weight(const DataLookupWeighted1D&);

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

#endif