org.heigit.bigspatialdata.oshdb.api.generic

Class WeightedValue<X extends Number>

java.lang.Object

org.heigit.bigspatialdata.oshdb.api.generic.WeightedValue<X>

Type Parameters:

X - A numeric data type for the value.

public class WeightedValue<X extends Number>
extends Object

Immutable object that stores a numeric value and an associated weight. Used to specify data input for the calculation of weighted averages.

Constructor Summary

Constructors

Constructor and Description
WeightedValue(X value, double weight)

Method Summary

Modifier and Type	Method and Description
X	getValue() Returns the stored numeric value.
double	getWeight() Returns the stored weight.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WeightedValue

public WeightedValue(X value,
                     double weight)

Method Detail

getValue

public X getValue()

Returns the stored numeric value.

Returns:

the stored numeric value

getWeight

public double getWeight()

Returns the stored weight.

Returns:

the value's associated weight