org.javanetworkanalyzer.data.VCent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-network-analyzer Show documentation
Graph theory and social network analysis algorithms implemented on JGraphT graphs.
The newest version!
/*
 * Java Network Analyzer provides a collection of graph theory and social
 * network analysis algorithms implemented on mathematical graphs using the
 * JGraphT library.
 *
 * Java Network Analyzer is developed by the GIS group of the DECIDE team of the 
 * Lab-STICC CNRS laboratory, see .
 * It is part of the OrbisGIS tool ecosystem.
 *
 * The GIS group of the DECIDE team is located at :
 *
 * Laboratoire Lab-STICC – CNRS UMR 6285
 * Equipe DECIDE
 * UNIVERSITÉ DE BRETAGNE-SUD
 * Institut Universitaire de Technologie de Vannes
 * 8, Rue Montaigne - BP 561 56017 Vannes Cedex
 * 
 * Java Network Analyzer is distributed under LGPL 3 license.
 *
 * Copyright (C) 2012-2014 CNRS (IRSTV CNRS FR 2488)
 * Copyright (C) 2015-2018 CNRS (Lab-STICC CNRS UMR 6285)
 *
 * Java Network Analyzer is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * Java Network Analyzer is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * Java Network Analyzer. If not, see .
 * 
 * For more information, please consult: 
 * or contact directly:
 * info_at_ orbisgis.org
 */
package org.javanetworkanalyzer.data;

import java.util.Set;

/**
 * Vertex for centrality computations (used by graph analyzers).
 *
 * @param  Vertex
 *
 * @author Adam Gouge
 */
public interface VCent extends VPred {

    /**
     * Resets the shortest path count and dependency to zero.
     */
    void reset();

    /**
     * Sets the shortest path count to one and the dependency to zero.
     */
    void setSource();

    /**
     * Returns the id of this node.
     *
     * @return The id of this node.
     */
    int getID();

    /**
     * Returns the predecessors.
     *
     * @return The predecessors.
     */
    Set getPredecessors();

    /**
     * Gets the number of shortest paths to this node
     *
     * @return spCount Number of shortest paths to this node
     */
    long getSPCount();

    /**
     * Accumulates the number of shortest paths leading to this node
     *
     * @param additionalSPCount Number of further shortest paths leading to this
     *                          node
     */
    void accumulateSPCount(long additionalSPCount);

    /**
     * Resets the number of shortest paths leading to this node
     *
     * @param newSPCount New number shortest paths leading to this node
     */
    void setSPCount(long newSPCount);

    /**
     * Gets the dependency of this node to any other vertex
     *
     * @return dependency Dependency of this node to any other vertex
     */
    double getDependency();

    /**
     * Accumulates the dependency of this node
     *
     * @param additionalDependency New dependency to be added
     */
    void accumulateDependency(double additionalDependency);

    /**
     * Gets the betweenness value for this node.
     *
     * @return The betweenness value of this node.
     */
    double getBetweenness();

    /**
     * Accumulates the betweenness value in each run by adding the new
     * betweenness value to the old
     *
     * @param additionalBetweenness betweenness value from a run starting at
     *                              certain source node
     */
    void accumulateBetweenness(double additionalBetweenness);

    /**
     * Sets the betweenness.
     *
     * @param betweenness The betweenness to set.
     */
    void setBetweenness(double betweenness);

    /**
     * Returns the closeness.
     *
     * @return The closeness.
     */
    double getCloseness();

    /**
     * Sets the closeness.
     *
     * @param closeness The closeness to set.
     */
    void setCloseness(double closeness);
}