Class ReciprocalRank

java.lang.Object

io.nosqlbench.engine.extensions.computefunctions.relavency.BaseRelevancyFunction

io.nosqlbench.engine.extensions.computefunctions.relavency.ReciprocalRank

All Implemented Interfaces:

RelevancyFunction, NBLabeledElement

public class ReciprocalRank
extends BaseRelevancyFunction

Nested Class Summary

Nested classes/interfaces inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

NBLabeledElement.BasicLabeledElement

Field Summary

Fields inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

EMPTY

Constructor Summary

Constructors

Constructor	Description
ReciprocalRank(String name, int k, Object... labels)
ReciprocalRank(String name, int k, Map<String,String> labels)

Method Summary

Modifier and Type	Method	Description
double	apply(int[] relevant, int[] actual)
String	getUniqueName()	Return a name which identifies this function in terms of its parameters.

Methods inherited from class io.nosqlbench.engine.extensions.computefunctions.relavency.BaseRelevancyFunction

getLabels, getName, prependLabels

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

description

Constructor Details

ReciprocalRank

public ReciprocalRank(String name,
 int k,
 Map<String,String> labels)

ReciprocalRank

public ReciprocalRank(String name,
 int k,
 Object... labels)

Method Details

apply

public double apply(int[] relevant,
 int[] actual)

getUniqueName

public String getUniqueName()

Description copied from interface: RelevancyFunction

Return a name which identifies this function in terms of its parameters. This is a temporary work-around until the graphite uniqueness semantics are removed and label set uniqueness works.

Returns:

A string which can be used to identify if the metric exists yet.