Lifelong Planning A* (LPA*) is a replanning method that is an incremental version of A* algorithm for single-shot grid-based 2D path finding.

Current project provides an implementation of LPA* algorithm adapted for single-shot grid-based 2D environment.

Current implementation is not a complete LPA* with random map changes. For the sake of accuracy and efficiency testing the main cycle consists of three parts:

• First iteration of LPA* (which equals A*): builds simple path from start to goal
• Forced map chages: building an obstacle somewhere along the found path
• Second iteration of LPA*: recalculating the path depending on map changes
• Forced map changes: destroy that new obstacle
• Third iteration of LPA*: recalculating the path depending on map changes

Additionaly, there is an implementation of pure A* algorithm to check LPA* after each iteration. Check after second iteration tests the accuracy of processing new obstacles. Check after thrid iteration tests the accuracy of processing the absence of old obstacles.

Algorithm supports XML files as input and output format. Input file contains map and environment representation (see "Input and Output files" or samples)

To go and try this algorithm you can use QtCreator or CMake. Both .pro and CMakeLists files are available in the repository.

Notice, that project uses C++11 standart. Make sure that your compiler supports it.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Qt Creator - a cross-platform C++, JavaScript and QML integrated development environment which is part of the SDK for the Qt GUI Application development framework.

CMake - an open-source, cross-platform family of tools designed to build, test and package software.

Download current repository to your local machine. Use

git clone https://github.com/PathPlanning/LPAstar.git

or direct downloading.

Built current project using Qt Creator or CMake. To launch the compiled file you will need to pass input XML file as an argument. Output file for this project will be placed in the same folder as input file and, by default, will be named _log.xml. For examlpe,

"initial_file_name.xml" -> "initial_file_name_log.xml"

For more detailed information there are some samples in the samples folder.

Both files are an XML file with a specific structure. Input file should contain:

• Mandatory tag <map>. It describes the environment.

  • <height> and <width> - mandatory tags that define size of the map. Origin is in the upper left corner. (0,0) - is upper left, (width-1, height-1) is lower right.
  • <startx> and <starty> - mandatory tags that define horizontal (X) and vertical (Y) offset of the start location from the upper left corner. Legal values for startx are [0, .., width-1], for starty - [0, .., height-1].
  • <finishx> and <finishy> - mandatory tags that horizontal (X) and vertical (Y) offset of the goal location.
  • <grid> - mandatory tag that describes the square grid constituting the map. It consists of <row> tags. Each <row> contains a sequence of "0" and "1" separated by blanks. "0" stands for traversable cell, "1" - for untraversable (actually any other figure but "0" can be used instead of "1").
  • <cellsize> - optional tag that defines the size of one cell. One might add it to calculate scaled length of the path.
  • <title>, <URL>, <coordinates>, etc - optional tags containing additional information on the map.

• Mandatory tag <algorithm>. It describes the parameters of the algorithm.

  • <metrictype> - defines the type of metric for heuristic function. Possible values - "euclidean", "diagonal", "manhattan", "chebyshev". Default value is "euclidean".
  • <hweight> - defines the weight of heuristic function. Default value is "1".
  • <allowdiagonal> - boolean tag that defines the possibility to make diagonal moves. Setting it to "false" restricts agent to make cardinal (horizonal, vertical) moves only. Default value is "true".
  • <cutcorners> - boolean tag that defines the possibilty to make diagonal moves when one adjacent cell is untraversable. The tag is ignored if diagonal moves are not allowed. Default value is "false".
  • <allowsqueeze> - boolean tag that defines the possibility to make diagonal moves when both adjacent cells are untraversable. The tag is ignored if cutting corners is not allowed. Default value is "false".

• Optional tag <options>. Options that are not related to search.

  • <loglevel> - defines the level of detalization of log-file. Default value is "1". Possible values:
    • "0" or "none" - log-file is not created.
    • "0.5" or "tiny" - All the input data is copied to the log-file plus short <summary> is appended. <summary> contains info of the path length, number of steps, elapsed time, etc.
    • "1" or "short" - 0.5-log plus <path> is appended. It looks like <grid> but cells forming the path are marked by "*" instead of "0". The following tags are also appended: <hplevel> and <lplevel>. <lplevel> is the sequence of coordinates of cells forming the path. <hplevel> is the sequence of sections forming the path.
  • <logpath> - defines the directory where the log-file should be written. If not specified directory of the input file is used.
  • <logname> - defines the name of log-file. If not specified the name of the log file is: "input file name"+"_log"+input file extension.

The main tag in Output file, which containes path length, memory and time:

<summary numberofsteps="107" nodescreated="127" length="15.414213" length_scaled="41.618375587463383" time="0.000512" astar_length="15.414213" astar_correct="1"/>

• "numberofsteps" stands for the number of iterations (number of expanded vertices)
• "nodescreated" stands for the number of nodes that were examined in general (= memory)
• "length" stands for length of the final path
• "length_scaled" stands for actual length counting the size of cell in map
• "time" stands for elapsed time
• "astar_length" and "astar_correct" stand for checking the algorithm with A* ("astar_correct" equals 1, if "astar_length" equals to "length", and 0 - otherwise).