org.lenskit.eval.traintest.metrics

Class TypedMetricResult

java.lang.Object

org.lenskit.eval.traintest.metrics.MetricResult

org.lenskit.eval.traintest.metrics.TypedMetricResult

Direct Known Subclasses:

CoveragePredictMetric.Coverage, TopNEntropyMetric.EntropyResult, TopNLengthMetric.LengthResult, TopNMAPMetric.AggregateResult, TopNMAPMetric.UserResult, TopNMRRMetric.AggregateResult, TopNMRRMetric.UserResult, TopNPopularityMetric.PopResult, TopNPrecisionRecallMetric.PresRecResult

public abstract class TypedMetricResult
extends MetricResult

Base class for metric results that expose their values via getters.

Constructor Summary

Constructors

Constructor and Description
TypedMetricResult()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	getColumns(java.lang.Class<? extends TypedMetricResult> type) Get the columns for a typed metric result class.
static java.util.List<java.lang.String>	getColumns(java.lang.Class<? extends TypedMetricResult> type, java.lang.String suffix) Get the columns for a typed metric result class.
java.util.Map<java.lang.String,java.lang.Object>	getValues() Get the column values for this metric result.

Methods inherited from class org.lenskit.eval.traintest.metrics.MetricResult

empty, fromMap, fromNullable, singleton, withPrefix, withSuffix

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedMetricResult

public TypedMetricResult()

Method Detail

getColumns

public static java.util.List<java.lang.String> getColumns(java.lang.Class<? extends TypedMetricResult> type)

Get the columns for a typed metric result class.

Parameters:

type - The result class.

Returns:

The column labels for results of type type.

getColumns

@Nonnull
public static java.util.List<java.lang.String> getColumns(@Nullable
                                                                   java.lang.Class<? extends TypedMetricResult> type,
                                                                   @Nullable
                                                                   java.lang.String suffix)

Get the columns for a typed metric result class.

Parameters:

type - The result class. If null, an empty list of columns will be returned.

suffix - A suffix for column labels; if non-null, will be appended to each column label separated with a period.

Returns:

The column labels for results of type type.

getValues

public java.util.Map<java.lang.String,java.lang.Object> getValues()

Description copied from class: MetricResult

Get the column values for this metric result.

Specified by:

getValues in class MetricResult

Returns:

The values for the result.