org.jgrapht.alg.shortestpath.DijkstraShortestPath Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jgrapht-core Show documentation
The newest version!
/*
 * (C) Copyright 2003-2023, by John V Sichi and Contributors.
 *
 * JGraphT : a free Java graph-theory library
 *
 * See the CONTRIBUTORS.md file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the
 * GNU Lesser General Public License v2.1 or later
 * which is available at
 * http://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR LGPL-2.1-or-later
 */
package org.jgrapht.alg.shortestpath;

import org.jgrapht.*;
import org.jgrapht.alg.util.*;
import org.jheaps.*;
import org.jheaps.tree.*;

import java.util.function.*;

/**
 * An implementation of Dijkstra's
 * shortest path algorithm using a pairing heap by default. A custom heap implementation can by
 * specified during the construction time.
 *
 * @param  the graph vertex type
 * @param  the graph edge type
 * @author John V. Sichi
 */
public final class DijkstraShortestPath
    extends BaseShortestPathAlgorithm
{
    private final double radius;
    private final Supplier>> heapSupplier;

    /**
     * Constructs a new instance of the algorithm for a given graph. The constructed algorithm will
     * use pairing heap as a default heap implementation.
     *
     * @param graph the graph
     */
    public DijkstraShortestPath(Graph graph)
    {
        this(graph, Double.POSITIVE_INFINITY, PairingHeap::new);
    }

    /**
     * Constructs a new instance of the algorithm for a given graph. The constructed algorithm will
     * use pairing heap as a default heap implementation.
     *
     * @param graph the graph
     * @param radius limit on path length, or Double.POSITIVE_INFINITY for unbounded search
     */
    public DijkstraShortestPath(Graph graph, double radius)
    {
        this(graph, radius, PairingHeap::new);
    }

    /**
     * Constructs a new instance of the algorithm for a given graph. The constructed algorithm will
     * use the heap supplied by the {@code heapSupplier}
     *
     * @param graph the graph
     * @param heapSupplier supplier of the preferable heap implementation
     */
    public DijkstraShortestPath(
        Graph graph, Supplier>> heapSupplier)
    {
        this(graph, Double.POSITIVE_INFINITY, heapSupplier);
    }

    /**
     * Constructs a new instance of the algorithm for a given graph.
     *
     * @param graph the graph
     * @param radius limit on path length, or Double.POSITIVE_INFINITY for unbounded search
     * @param heapSupplier supplier of the preferable heap implementation
     */
    public DijkstraShortestPath(
        Graph graph, double radius,
        Supplier>> heapSupplier)
    {
        super(graph);
        if (radius < 0.0) {
            throw new IllegalArgumentException("Radius must be non-negative");
        }
        this.heapSupplier = heapSupplier;
        this.radius = radius;
    }

    /**
     * Find a path between two vertices. For a more advanced search (e.g. limited by radius or using
     * another heap), use the constructor instead.
     *
     * @param graph the graph to be searched
     * @param source the vertex at which the path should start
     * @param sink the vertex at which the path should end
     * @param  the graph vertex type
     * @param  the graph edge type
     * @return a shortest path, or null if no path exists
     */
    public static  GraphPath findPathBetween(Graph graph, V source, V sink)
    {
        return new DijkstraShortestPath<>(graph).getPath(source, sink);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public GraphPath getPath(V source, V sink)
    {
        if (!graph.containsVertex(source)) {
            throw new IllegalArgumentException(GRAPH_MUST_CONTAIN_THE_SOURCE_VERTEX);
        }
        if (!graph.containsVertex(sink)) {
            throw new IllegalArgumentException(GRAPH_MUST_CONTAIN_THE_SINK_VERTEX);
        }
        if (source.equals(sink)) {
            return createEmptyPath(source, sink);
        }

        DijkstraClosestFirstIterator it =
            new DijkstraClosestFirstIterator<>(graph, source, radius, heapSupplier);

        while (it.hasNext()) {
            V vertex = it.next();
            if (vertex.equals(sink)) {
                break;
            }
        }

        return it.getPaths().getPath(sink);
    }

    /**
     * {@inheritDoc}
     * 
     * Note that in the case of Dijkstra's algorithm it is more efficient to compute all
     * single-source shortest paths using this method than repeatedly invoking
     * {@link #getPath(Object, Object)} for the same source but different sink vertex.
     */
    @Override
    public SingleSourcePaths getPaths(V source)
    {
        if (!graph.containsVertex(source)) {
            throw new IllegalArgumentException(GRAPH_MUST_CONTAIN_THE_SOURCE_VERTEX);
        }

        DijkstraClosestFirstIterator it =
            new DijkstraClosestFirstIterator<>(graph, source, radius, heapSupplier);

        while (it.hasNext()) {
            it.next();
        }

        return it.getPaths();
    }

}