|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.jagg.Aggregator
net.sf.jagg.HarmonicMeanAggregator
public class HarmonicMeanAggregator
This class represents the "harmonic mean" aggregator over numeric values.
Field Summary |
---|
Fields inherited from class net.sf.jagg.Aggregator |
---|
PROP_SELF |
Constructor Summary | |
---|---|
HarmonicMeanAggregator(java.lang.String property)
Constructs an HarmonicMeanAggregator that operates on the specified
property. |
Method Summary | |
---|---|
void |
init()
Initialize the sum and count to zero. |
void |
iterate(java.lang.Object value)
If not null, add the reciprocal of the property value to the sum and count it. |
void |
merge(Aggregator agg)
Merge the given Aggregator into this one by adding counts
and sums. |
HarmonicMeanAggregator |
replicate()
Returns an uninitialized copy of this Aggregator object,
with the same property(ies) to analyze. |
java.lang.Double |
terminate()
Return the harmonic mean by dividing the count by the sum. |
DoubleDouble |
terminateDoubleDouble()
Return the result as a DoubleDouble . |
Methods inherited from class net.sf.jagg.Aggregator |
---|
equals, getAggregator, getAggregator, getProperty, getValueFromProperty, hashCode, isInUse, setInUse, setProperty, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public HarmonicMeanAggregator(java.lang.String property)
HarmonicMeanAggregator
that operates on the specified
property.
property
- Calculate the harmonic mean of this property's values.Method Detail |
---|
public HarmonicMeanAggregator replicate()
Aggregator
object,
with the same property(ies) to analyze.
replicate
in class Aggregator
Aggregator
object.public void init()
init
in class Aggregator
public void iterate(java.lang.Object value)
iterate
in class Aggregator
value
- The value to aggregate.Aggregator.getValueFromProperty(java.lang.Object, java.lang.String)
public void merge(Aggregator agg)
Aggregator
into this one by adding counts
and sums.
merge
in class Aggregator
agg
- The Aggregator
to merge into this one.public java.lang.Double terminate()
terminate
in class Aggregator
Double
. Could return
NaN
if no values have been accumulated or if a zero
exists in the values.public DoubleDouble terminateDoubleDouble()
DoubleDouble
. This is used mainly
when other Aggregators
that use this result must maintain a
high precision.
terminateDoubleDouble
in class Aggregator
DoubleDouble
, or
NaN
if no values have been accumulated.DoubleDouble
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |