Package es.uam.eps.ir.relison.diffusion.metrics.creator.individual

Class CreatorRecall<U extends java.io.Serializable,I extends java.io.Serializable,F>

java.lang.Object

es.uam.eps.ir.relison.diffusion.metrics.AbstractIndividualSimulationMetric<U,I,F>

es.uam.eps.ir.relison.diffusion.metrics.creator.individual.CreatorRecall<U,I,F>

Type Parameters:

U - type of the users.

I - type of the information pieces.

F - type of the features.

All Implemented Interfaces:

IndividualSimulationMetric<U,I,F>, SimulationMetric<U,I,F>

public class CreatorRecall<U extends java.io.Serializable,I extends java.io.Serializable,F>
extends AbstractIndividualSimulationMetric<U,I,F>

For each user in the network, this metric computes the proportion of users in the network who have created an information piece that has been received by the user (i.e. supposing that all the received pieces indicated the original creator, this metric indicates the fraction of the people in the network that each user has discovered).

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	RECALL	Name fixed value.
private java.util.Map<U,java.util.Set<U>>	retrieved	The different "retrieved" users.

Fields inherited from class es.uam.eps.ir.relison.diffusion.metrics.AbstractIndividualSimulationMetric

data, initialized

Constructor Summary

Constructors

Constructor	Description
CreatorRecall()	Constructor.

Method Summary

Modifier and Type	Method	Description
double	calculate()	Calculates the metric for the current state of the simulation.
double	calculate(U user)	Calculates the metric value for a single user.
void	clear()	Resets the metric.
protected void	initialize()	Initializes all the variables needed for computing and updating the values of the metric.
void	update(Iteration<U,I,F> iteration)	Updates the different values which are necessary for computing a metric, given the information received by users in an iteration of the simulation.

Methods inherited from class es.uam.eps.ir.relison.diffusion.metrics.AbstractIndividualSimulationMetric

calculateIndividuals, getName, initialize, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface es.uam.eps.ir.relison.diffusion.metrics.IndividualSimulationMetric

calculate, calculateIndividuals

Methods inherited from interface es.uam.eps.ir.relison.diffusion.metrics.SimulationMetric

calculate, initialize

Field Details

RECALL

private static final java.lang.String RECALL

Name fixed value.

See Also:

Constant Field Values

retrieved

private final java.util.Map<U extends java.io.Serializable,java.util.Set<U extends java.io.Serializable>> retrieved

The different "retrieved" users.

Constructor Details

CreatorRecall

public CreatorRecall()

Constructor.

Method Details

calculate

public double calculate(U user)

Description copied from interface: IndividualSimulationMetric

Calculates the metric value for a single user.

Parameters:

user - the single user.

Returns:

the value of the metric, NaN if something failed.

calculate

public double calculate()

Description copied from interface: SimulationMetric

Calculates the metric for the current state of the simulation.

Returns:

the value of the metric for the current state of the simulation

update

public void update(Iteration<U,I,F> iteration)

Description copied from interface: SimulationMetric

Updates the different values which are necessary for computing a metric, given the information received by users in an iteration of the simulation.

Parameters:

iteration - the new iteration.

clear

public void clear()

Description copied from interface: SimulationMetric

Resets the metric.

initialize

protected void initialize()

Description copied from class: AbstractIndividualSimulationMetric

Initializes all the variables needed for computing and updating the values of the metric.

Specified by:

initialize in class AbstractIndividualSimulationMetric<U extends java.io.Serializable,I extends java.io.Serializable,F>