es.uam.eps.ir.relison.diffusion.metrics.distributions.Distribution Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of RELISON-diffusion Show documentation

The newest version!

/*
 * Copyright (C) 2020 Information Retrieval Group at Universidad Autónoma
 * de Madrid, http://ir.ii.uam.es
 * 
 *  This Source Code Form is subject to the terms of the Mozilla Public
 *  License, v. 2.0. If a copy of the MPL was not distributed with this
 *  file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package es.uam.eps.ir.relison.diffusion.metrics.distributions;

import es.uam.eps.ir.relison.diffusion.data.Data;
import es.uam.eps.ir.relison.diffusion.simulation.Iteration;

import java.io.Serializable;

/**
 * Interface for defining a distribution of elements.
 *
 * @author Javier Sanz-Cruzado ([email protected])
 * @author Pablo Castells ([email protected])
 *
 * @param  Type of the users.
 * @param  Type of the information pieces.
 * @param  Type of the features.
 */
public interface Distribution
{    
    /**
     * Initializes the necessary parameters for the distribution.
     * @param data the data.
     */
    void initialize(Data data);

    /**
     * Updates the different values of the distribution.
     * @param iteration The current iteration.
     */
    void update(Iteration iteration);
    
    /**
     * Prints the distribution into a file.
     * @param file The output file.
     */
    void print(String file);
    
    /**
     * Resets the distribution.
     */
    void clear();
    
    /**
     * Obtains the name of the distribution.
     * @return the name.
     */
    String getName();
    
    /**
     * Checks if the distribution has been initialized.
     * @return true if the distribution has been initialized, false if it has not.
     */
    boolean isInitialized();
}