theplu::yat::utility::DataWeight Class Reference

Holds a pair of data and associated weight. More...

#include <yat/utility/DataWeight.h>

List of all members.

Public Member Functions

 DataWeight (double data=0.0, double weight=1.0)
 Default constructor.
double & data (void)
const double & data (void) const
double & weight (void)
const double & weight (void) const


Detailed Description

Holds a pair of data and associated weight.

The class has comparison operators (declared outside class) that are designed to ignore the weights, and behaves like the corresponding double operator behaves for data().

Since:
New in yat 0.5

Constructor & Destructor Documentation

theplu::yat::utility::DataWeight::DataWeight ( double  data = 0.0,
double  weight = 1.0 
) [explicit]

Default constructor.

Parameters:
data data value to hold
weight weight value to hold


Member Function Documentation

double& theplu::yat::utility::DataWeight::data ( void   ) 

Returns:
reference to data

const double& theplu::yat::utility::DataWeight::data ( void   )  const

Returns:
const reference to data

double& theplu::yat::utility::DataWeight::weight ( void   ) 

Returns:
reference to weight

const double& theplu::yat::utility::DataWeight::weight ( void   )  const

Returns:
const reference to weight


The documentation for this class was generated from the following file:

Generated on Tue Jan 18 02:20:11 2011 for yat by  doxygen 1.5.5