source: trunk/yat/utility/DataWeight.h @ 1533

#ifndef _theplu_yat_utility_data_weight_
#define _theplu_yat_utility_data_weight_ 

// $Id: DataWeight.h 1533 2008-09-25 12:02:52Z peter $

/*
  Copyright (C) 2008 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/>.
*/

namespace theplu {
namespace yat {
namespace utility {

  /**
     \brief Holds a pair of data and associated weight

     \since New in yat 0.5
  */
  class DataWeight
  {
  public:
    /**
       \brief Default constructor

       \param data data value to hold
       \param weight weight value to hold
     */
    explicit DataWeight(double data=0.0, double weight=1.0);

    /**
       \return reference to data
     */
    double& data(void);

    /**
       \return const reference to data
     */
    const double& data(void) const;

    /**
       \return reference to weight
     */
    double& weight(void);

    /**
       \return const reference to weight
     */
    const double& weight(void) const;
  private:
    double data_;
    double weight_;
    // using compiler generated copy
    // DataWeight(const DataWeight&)
    // DataWeight& operator=(const DataWeight&);
  };

  /**
     \brief equality operator

     \return true if data are equal
   */
  bool operator==(const DataWeight&, const DataWeight&);

  /**
     \brief inequality operator

     \return true if data are inequal
   */
  bool operator!=(const DataWeight&, const DataWeight&);

  /**
     \brief comparison operator

     \return true if lhs data is less than rhs data
   */
  bool operator<(const DataWeight&, const DataWeight&);

  /**
     \brief comparison operator

     \return true if lhs data is greater than rhs data
   */
  bool operator>(const DataWeight&, const DataWeight&);

  /**
     \brief comparison operator

     \return true if  rhs > lhs
   */
  bool operator<=(const DataWeight&, const DataWeight&);

  /**
     \brief comparison operator

     \return true if  rhs < lhs
   */
  bool operator>=(const DataWeight&, const DataWeight&);


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

#endif