org.jgrapht.alg.RankingPathElement Maven / Gradle / Ivy
Go to download
JGraphT is a free Java graph library
that provides mathematical graph-theory objects and algorithms
The newest version!
/* ==========================================
* JGraphT : a free Java graph-theory library
* ==========================================
*
* Project Info: http://jgrapht.sourceforge.net/
* Project Creator: Barak Naveh (http://sourceforge.net/users/barak_naveh)
*
* (C) Copyright 2003-2007, by Barak Naveh and Contributors.
*
* This library 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 2.1 of the License, or
* (at your option) any later version.
*
* This library 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 this library; if not, write to the Free Software Foundation,
* Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
*/
/* -------------------------
* RankingPathElement.java
* -------------------------
* (C) Copyright 2007-2007, by France Telecom
*
* Original Author: Guillaume Boulmier and Contributors.
* Contributor(s): John V. Sichi
*
* $Id: RankingPathElement.java 568 2007-09-30 00:12:18Z perfecthash $
*
* Changes
* -------
* 05-Jun-2007 : Initial revision (GB);
* 05-Jul-2007 : Added support for generics (JVS);
*
*/
package org.jgrapht.alg;
import org.jgrapht.*;
/**
* Helper class for {@link KShortestPaths}.
*
* @author Guillaume Boulmier
* @since July 5, 2007
*/
final class RankingPathElement
extends AbstractPathElement
{
//~ Instance fields --------------------------------------------------------
/**
* Weight of the path.
*/
private double weight;
//~ Constructors -----------------------------------------------------------
/**
* Creates a path element by concatenation of an edge to a path element.
*
* @param pathElement
* @param edge edge reaching the end vertex of the path element created.
* @param weight total cost of the created path element.
*/
RankingPathElement(
Graph graph,
RankingPathElement pathElement,
E edge,
double weight)
{
super(graph, pathElement, edge);
this.weight = weight;
}
/**
* Creates an empty path element.
*
* @param vertex end vertex of the path element.
*/
RankingPathElement(V vertex)
{
super(vertex);
this.weight = 0;
}
//~ Methods ----------------------------------------------------------------
/**
* Returns the weight of the path.
*
* @return .
*/
public double getWeight()
{
return this.weight;
}
/**
* Returns the previous path element.
*
* @return null is the path is empty.
*/
public RankingPathElement getPrevPathElement()
{
return (RankingPathElement) super.getPrevPathElement();
}
}
// End RankingPathElement.java