org.javanetworkanalyzer.data.VDist 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;

/**
 * Interface for vertices that measure the distance from a source node.
 *
 * @param  Distance type (usually Integer or Double)
 *
 * @author Adam Gouge
 */
public interface VDist {

    /**
     * Returns the length of the shortest path from a source node to this node.
     *
     * @return The length of the shortest path from a source node to this node.
     */
    D getDistance();

    /**
     * Sets the new length of a shortest path from a source node to this node.
     *
     * @param newDistance Length of a shortest path to this node.
     */
    void setDistance(D newDistance);

    /**
     * Resets this node's distance to the default distance value.
     */
    void reset();

    /**
     * Sets this node's distance to zero.
     */
    void setSource();
}