es.uam.eps.ir.ranksys.metrics

Interface SystemMetric<U,I>

Type Parameters:

U - type of the users

I - type of the items

All Known Implementing Classes:

AbstractSalesDiversityMetric, AbstractSystemMetric, AggregateDiversityMetric, AverageRecommendationMetric, EIUDC, EIUFD, EIURD, Entropy, GiniIndex, GiniSimpsonIndex, IUD

public interface SystemMetric<U,I>

System metric: a metric that evaluates recommendations to a community of users as a whole. Can be computed in parallel fashion via mutable reduction, i.e., Stream.collect()

Author:

Saúl Vargas (saul.vargas@uam.es), Pablo Castells (pablo.castells@uam.es)

Method Summary

Modifier and Type	Method and Description
void	add(Recommendation<U,I> recommendation) Add a recommendation to the metric.
void	combine(SystemMetric<U,I> other) Combines the recommendations added to other system metric to this one.
double	evaluate() Evaluates the metric for the recommendations added so far.
void	reset() Resets the metric by discarding the recommendations previously added.

Method Detail

add

void add(Recommendation<U,I> recommendation)

Add a recommendation to the metric.

Parameters:

recommendation - recommendation to be added to the computation.

evaluate

double evaluate()

Evaluates the metric for the recommendations added so far.

Returns:

result of the metric for the recommendations previously added

combine

void combine(SystemMetric<U,I> other)

Combines the recommendations added to other system metric to this one.

Parameters:

other - other system metric, should be of the same or compatible class

reset

void reset()

Resets the metric by discarding the recommendations previously added.