net.automatalib.algorithms.graph.apsp.APSPResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of automata-misc-algorithms Show documentation

This artifact contains several miscellaneous, well-known algorithms, which however are rather specific in their concrete use case and therefore not fit for the AutomataLib Utilities library. Examples include Dijkstra's algorithm for the SSSP problem, the Floyd-Warshall algorithm for the APSP problem and Tarjan's algorithm for finding all strongly-connected components in a graph.

The newest version!

/* Copyright (C) 2013-2014 TU Dortmund
 * This file is part of AutomataLib, http://www.automatalib.net/.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.automatalib.algorithms.graph.apsp;

import java.util.List;

import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;

import net.automatalib.algorithms.graph.GraphAlgorithms;

/**
 * Result interface for the all pairs shortest paths problem.
 * 
 * @author Malte Isberner
 *
 * @param  node class
 * @param  edge class
 */
@ParametersAreNonnullByDefault
public interface APSPResult {

	
	/**
	 * Retrieves the length of the shortest path between the given nodes.
	 * @param src the source node
	 * @param tgt the target node
	 * @return the length of the shortest path from {@code src} to {@code tgt},
	 * or {@link GraphAlgorithms#INVALID_DISTANCE} if there exists no such path.
	 */
	public float getShortestPathDistance(N src, N tgt);
	
	/**
	 * Retrieves the shortest path between the given nodes, or {@code null} if there
	 * exists no such path.
	 * @param src the source node
	 * @param tgt the target node
	 * @return the shortest path from {@code src} to {@code tgt}, or {@code null}
	 * if there exists no such path.
	 */
	@Nullable
	public List getShortestPath(N src, N tgt);
}