org.lenskit.eval.traintest.metrics

Class MetricResult

java.lang.Object

org.lenskit.eval.traintest.metrics.MetricResult

Direct Known Subclasses:

TypedMetricResult

public abstract class MetricResult
extends Object

Class containing metric results.

Constructor Summary

Constructors

Constructor and Description
MetricResult()

Method Summary

Modifier and Type	Method and Description
static MetricResult	empty() Create an empty metric result.
static MetricResult	fromMap(Map<String,?> values) Create an empty metric result.
static MetricResult	fromNullable(MetricResult result) Convert a null result to an empty result.
abstract Map<String,Object>	getValues() Get the column values for this metric result.
static MetricResult	singleton(String name, Object value) Create a singleton map result.
MetricResult	withPrefix(String pfx) Add a prefix to this metric result’s column names.
MetricResult	withSuffix(String sfx) Add a suffix to this metric result’s column names.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricResult

public MetricResult()

Method Detail

getValues

@Nonnull
public abstract Map<String,Object> getValues()

Get the column values for this metric result.

Returns:

The values for the result.

withSuffix

@Nonnull
public MetricResult withSuffix(String sfx)

Add a suffix to this metric result’s column names. The resulting keys are of the form “key.sfx”.

Parameters:

sfx - The suffix to add, or null for no change.

Returns:

The converted metric.

withPrefix

@Nonnull
public MetricResult withPrefix(String pfx)

Add a prefix to this metric result’s column names. The resulting keys are of the form “pfx.key”.

Parameters:

pfx - The prefix to add, or null for no change.

Returns:

The converted metric.

empty

@Nonnull
public static MetricResult empty()

Create an empty metric result.

Returns:

An empty metric result.

fromNullable

@Nonnull
public static MetricResult fromNullable(@Nullable
                                                  MetricResult result)

Convert a null result to an empty result.

Parameters:

result - The result.

Returns:

The result, or empty() if it is null.

fromMap

@Nonnull
public static MetricResult fromMap(Map<String,?> values)

Create an empty metric result.

Returns:

An empty metric result.

singleton

@Nonnull
public static MetricResult singleton(String name,
                                               Object value)

Create a singleton map result.

Parameters:

name - The column name.

value - The column value.

Returns:

The map result.