From 7a4636c3c711160a588a934d699578670f8da4e4 Mon Sep 17 00:00:00 2001 From: Matt Pearce Date: Mon, 16 Mar 2020 11:13:12 +0000 Subject: [PATCH] #109: Add parameters to ERR javadoc. --- .../core/domain/metrics/impl/ExpectedReciprocalRank.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/rre-core/src/main/java/io/sease/rre/core/domain/metrics/impl/ExpectedReciprocalRank.java b/rre-core/src/main/java/io/sease/rre/core/domain/metrics/impl/ExpectedReciprocalRank.java index 9dc69979..82533618 100644 --- a/rre-core/src/main/java/io/sease/rre/core/domain/metrics/impl/ExpectedReciprocalRank.java +++ b/rre-core/src/main/java/io/sease/rre/core/domain/metrics/impl/ExpectedReciprocalRank.java @@ -45,6 +45,14 @@ public class ExpectedReciprocalRank extends Metric { /** * Builds a new ExpectedReciprocalRank metric with the default gain unit function and one diversity topic. + * + * @param k the top k reference elements used for building the measure. + * @param maxgrade the maximum grade available when judging documents. If + * {@code null}, will default to {@link Metric#DEFAULT_MAX_GRADE}. + * @param defaultgrade the default grade to use when judging documents. If + * {@code null}, will default to either {@code maxgrade / 2} + * or {@link Metric#DEFAULT_MISSING_GRADE}, depending + * whether or not {@code maxgrade} has been specified. */ public ExpectedReciprocalRank(@JsonProperty("maxgrade") final Float maxgrade, @JsonProperty("defaultgrade") final Float defaultgrade,