/** \file
 * \brief Declaration of base class of shortest path algorithms
 *        including some useful functions dealing with
 *        shortest paths flow (generater, checker).
 *
 * \author Gunnar W. Klau
 *
 * \par License:
 * This file is part of the Open Graph Drawing Framework (OGDF).
 *
 * \par
 * Copyright (C)<br>
 * See README.md in the OGDF root directory for details.
 *
 * \par
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * Version 2 or 3 as published by the Free Software Foundation;
 * see the file LICENSE.txt included in the packaging of this file
 * for details.
 *
 * \par
 * This program 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 General Public License for more details.
 *
 * \par
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, see
 * http://www.gnu.org/copyleft/gpl.html
 */

#pragma once

#include <ogdf/basic/Graph.h>

namespace ogdf {


class OGDF_EXPORT ShortestPathModule {
public:
	ShortestPathModule() { }

	virtual ~ShortestPathModule() { }

	// computes shortest paths
	// Precond.:
	// returns true iff a feasible min-cost flow exists
	virtual bool call(const Graph& G, // directed graph
			const node s, // source node
			const EdgeArray<int>& length, // length of an edge
			NodeArray<int>& d, // contains shortest path distances after call
			NodeArray<edge>& pi) = 0;
};

}
