de.hpi.fgis.dude.similarityfunction.aggregators
Class HarmonicMean

java.lang.Object
  de.hpi.fgis.dude.similarityfunction.AbstractSimilarityFunction
      de.hpi.fgis.dude.similarityfunction.aggregators.Aggregator
          de.hpi.fgis.dude.similarityfunction.aggregators.HarmonicMean

All Implemented Interfaces:

SimilarityFunction, AutoJsonable

public class HarmonicMean
extends Aggregator

HarmonicMean returns the harmonic mean of the added SimilarityFunctions.

Author:

Matthias Pohl

Nested Class Summary

Nested classes/interfaces inherited from interface de.hpi.fgis.dude.similarityfunction.SimilarityFunction

SimilarityFunction.SimilarityValidationState

Constructor Summary

protected	HarmonicMean() Internal constructor for Jsonable deserialization.
	HarmonicMean(SimilarityFunction... simFunctions) Initializes a HarmonicMean instance.

Method Summary

protected double

getAggregatedSimilarity(double[] similarities, int[] multipliers) Aggregates the passed similarities and returns the aggregated similarity.

Methods inherited from class de.hpi.fgis.dude.similarityfunction.aggregators.Aggregator

add, add, calculateSimilarity, equals, hashCode

Methods inherited from class de.hpi.fgis.dude.similarityfunction.AbstractSimilarityFunction

getLastValidationState, getSimilarity, setValidationState

Methods inherited from class java.lang.Object

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

Constructor Detail

HarmonicMean

protected HarmonicMean()

Internal constructor for Jsonable deserialization.

HarmonicMean

public HarmonicMean(SimilarityFunction... simFunctions)

Initializes a HarmonicMean instance.

Parameters:

simFunctions - The aggregated similarity functions.

Method Detail

getAggregatedSimilarity

protected double getAggregatedSimilarity(double[] similarities,
                                         int[] multipliers)

Description copied from class: Aggregator

Aggregates the passed similarities and returns the aggregated similarity.

Specified by:

getAggregatedSimilarity in class Aggregator

Parameters:

similarities - The similarities on which the aggregated similarity is based.

multipliers - The multipliers.

Returns:

The aggregated similarity.