Package org.drip.graph.shortestpath

Class AugmentedVertex

java.lang.Object
org.drip.graph.shortestpath.AugmentedVertex
public class AugmentedVertex
extends java.lang.Object
AugmentedVertex contains the Augmentations of a Vertex during a Shortest Path Algorithm. The References are:

  • Dijkstra, E. W. (1959): A Note on Two Problems in Connection with Graphs Numerische Mathematik 1 269-271
  • Felner, A. (2011): Position Paper: Dijkstra’s Algorithm versus Uniform Cost Search or a Case against Dijkstra’s Algorithm Proceedings of the 4th International Symposium on Combinatorial Search 47-51
  • Mehlhorn, K. W., and P. Sanders (2008): Algorithms and Data Structures: The Basic Toolbox Springer
  • Russell, S., and P. Norvig (2009): Artificial Intelligence: A Modern Approach 3rd Edition Prentice Hall
  • Wikipedia (2019): Dijkstra's Algorithm https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm




Author:
Lakshmi Krishnamurthy

  • Constructor Summary

    Constructors
    Constructor Description
    AugmentedVertex​(double gScore, double hScore)
    AugmentedVertex Constructor

  • Method Summary

    Modifier and Type Method Description
    double fScore()
    Retrieve the Vertex Path F Score
    double gScore()
    Retrieve the Vertex Path G Score
    double hScore()
    Retrieve the Vertex Path H Score
    static AugmentedVertex NonHeuristic()
    Generate a Non-heuristic Instance of AugmentedVertex
    Edge precedingEdge()
    Retrieve the Preceding Edge
    java.lang.String precedingVertexName()
    Retrieve the Preceding Vertex Name
    boolean processed()
    Indicate if the Vertex has been Processed
    boolean setPrecedingEdge​(Edge precedingEdge)
    Set the Preceding Edge in the Path
    boolean setProcessed​(boolean processed)
    Set the Vertex Processing Status
    boolean updateGScore​(double gScore)
    Update the Vertex Path G Score

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • AugmentedVertex

      public AugmentedVertex​(double gScore, double hScore) throws java.lang.Exception
      AugmentedVertex Constructor
      Parameters:
      gScore - G Score
      hScore - H Score
      Throws:
      java.lang.Exception - Thrown if the Inputs are Invalid

  • Method Details

    • NonHeuristic

      public static final AugmentedVertex NonHeuristic()
      Generate a Non-heuristic Instance of AugmentedVertex
      Returns:
      Non-heuristic Instance of AugmentedVertex

    • precedingEdge

      public Edge precedingEdge()
      Retrieve the Preceding Edge
      Returns:
      The Preceding Edge

    • processed

      public boolean processed()
      Indicate if the Vertex has been Processed
      Returns:
      TRUE - The Vertex has been Processed

    • gScore

      public double gScore()
      Retrieve the Vertex Path G Score
      Returns:
      The Vertex Path G Score

    • hScore

      public double hScore()
      Retrieve the Vertex Path H Score
      Returns:
      The Vertex Path H Score

    • fScore

      public double fScore()
      Retrieve the Vertex Path F Score
      Returns:
      The Vertex Path F Score

    • setPrecedingEdge

      public boolean setPrecedingEdge​(Edge precedingEdge)
      Set the Preceding Edge in the Path
      Parameters:
      precedingEdge - The Preceding Edge in the Path
      Returns:
      TRUE - The Preceding Edge in the Path successfully set

    • setProcessed

      public boolean setProcessed​(boolean processed)
      Set the Vertex Processing Status
      Parameters:
      processed - The Vertex Processing Status
      Returns:
      TRUE - The Vertex Processing Status successfully set

    • updateGScore

      public boolean updateGScore​(double gScore)
      Update the Vertex Path G Score
      Parameters:
      gScore - The Vertex Path G Score
      Returns:
      TRUE - The Vertex Path G Score successfully updated

    • precedingVertexName

      public java.lang.String precedingVertexName()
      Retrieve the Preceding Vertex Name
      Returns:
      The Preceding Vertex Name