README.md

   1 # RRT\* algorithm
   2 RRTS is a C++ library with implementation of RRT\* planning algorithm.
   3
   4 # License
   5 The project is published under [GNU GPLv3][1].
   6
   7 [1]: ./LICENSE
   8
   9 # Build
  10 To build the project run the following commands:
  11 ```
  12 mkdir build
  13 cd build
  14 cmake ../
  15 make
  16 ```
  17
  18 To build with ninja:
  19 ```
  20 mkdir build
  21 cd build
  22 cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ../
  23 ninja -v
  24 ```
  25
  26 ## Dependencies
  27 - `libbcar`
  28 - `libjsoncpp-dev`
  29
  30 # RRT Extensions
  31 There is basic RRT\* algorithm in `rrts.cc` file. To test different approaches
  32 and upgrades to RRT, *extensions* are declared in `rrtext.h` and implemented in
  33 `rrtextX.cc`, where `X` is the number of an extension.
  34
  35 ## Implemented extensions
  36 There is a list of implemented extensions and what they include. The extension
  37 number accomply to file `src/rrtextN.cc` where `N` is:
  38
  39 1.  "cost" RS-H -- Reeds & Shepp (build), Matej's heur. (search).
  40 2.  "collision" [cute c2][] for collision detection,
  41 3.  "path optimization" Dijkstra algorithm,
  42 4.  "nn" 2D grid for nodes storage,
  43 5.  "cost" RS-E -- Reeds & Shepp (build), Euclidean (search),
  44 6.  "cost" RS-RS -- Reeds & Shepp (build), Reeds & Shepp (search),
  45 7.  "nn" 2D [K-d tree][] for nodes storage,
  46 8.  "nn" 3D [K-d tree][] for nodes storage,
  47 9.  "nn" 3D grid for nodes storage,
  48 10. "cost" RS-B -- Reeds & Shepp (build), B-Spline paper (search)
  49
  50 [cute c2]: https://github.com/RandyGaul/cute_headers/blob/master/cute_c2.h
  51 [K-d tree]: https://en.wikipedia.org/wiki/K-d_tree
  52
  53 ## Compound extensions
  54 There is a list of classes with reference to extensions used. The extensio
  55 number accomply to class `RRTCEn` where `n` is:
  56
  57 1.  cute, RS-H.
  58 2.  cute, RS-E.
  59 3.  cute, RS-RS.
  60 4.  RS-H, cute, 2D grid.
  61 5.  cute, 2D grid, RS-E.
  62 6.  cute, 2D grid, RS-RS.
  63 7.  cute, Dijkstra, 2D grid, RS-E.
  64 8.  cute, Dijkstra, 2D grid, RS-RS.
  65 9.  cute, Dijkstra, 2D grid, RS-H.
  66 10. cute, Dijkstra, 2D tree, RS-RS.
  67 11. cute, Dijkstra, 2D tree, RS-E.
  68 12. cute, Dijkstra, 2D tree, RS-H.
  69 13. cute, Dijkstra, 3D tree, RS-RS.
  70 14. cute, Dijkstra, 3D tree, RS-H.
  71 15. cute, Dijkstra, 3D grid, RS-RS.
  72 16. cute, Dijkstra, 3D grid, RS-H.
  73 17. cute, RS-B.
  74
  75 # Contribute
  76 Use [OneFlow][3] branching model and keep the [changelog][4].
  77
  78 Write [great git commit messages][5]:
  79 1. Separate subject from body with a blank line.
  80 2. Limit the subject line to 50 characters.
  81 3. Capitalize the subject line.
  82 4. Do not end the subject line with a period.
  83 5. Use the imperative mood in the subject line.
  84 6. Wrap the body at 72 characters.
  85 7. Use the body to explain what and why vs. how.
  86
  87 When adding feature or hotfix, use [Test-driven development (TDD)][2]:
  88 1. Add tests to `ut` folder, add methods declaration, basic structure.
  89 2. Run tests (just `make` in `build` folder), check that tests *fail*.
  90 3. Implement functionality.
  91 4. Run tests, check that tests *pass*.
  92 5. Refactor.
  93
  94 [2]: https://en.wikipedia.org/wiki/Test-driven_development
  95 [3]: https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow
  96 [4]: ./CHANGELOG.md
  97 [5]: https://chris.beams.io/posts/git-commit/
  98
  99 # Documentation
 100 The documentation is generated by Doxygen, at least version `1.8.15` is needed.
 101 Just run `doxygen` in the project root directory.