]> rtime.felk.cvut.cz Git - hubacji1/rrts.git/blobdiff - README.md
Remove changelog
[hubacji1/rrts.git] / README.md
index ac907f30ce40d777d1004df0810c0647bc0c7509..4fdfd97c71f7d5fa850b3fcb50883d12c4ed2101 100644 (file)
--- a/README.md
+++ b/README.md
@@ -33,39 +33,69 @@ and upgrades to RRT, *extensions* are declared in `rrtext.h` and implemented in
 `rrtextX.cc`, where `X` is the number of an extension.
 
 ## Implemented extensions
-There is a list of implemented extensions and what they include:
-- `rrtext10.cc`: "cost" RS-B -- Reeds & Shepp (build), B-Spline paper (search)
-- `rrtext9.cc`: "nn" 3D grid for nodes storage,
-- `rrtext8.cc`: "nn" 3D [K-d tree][] for nodes storage,
-- `rrtext7.cc`: "nn" 2D [K-d tree][] for nodes storage,
-- `rrtext6.cc`: "cost" RS-RS -- Reeds & Shepp (build), Reeds & Shepp (search),
-- `rrtext5.cc`: "cost" RS-E -- Reeds & Shepp (build), Euclidean (search),
-- `rrtext4.cc`: "nn" 2D grid for nodes storage,
-- `rrtext3.cc`: "path optimization" Dijkstra algorithm,
-- `rrtext2.cc`: "collision" [cute c2][] for collision detection,
-- `rrtext1.cc`: "cost" RS-H -- Reeds & Shepp (build), Matej's heur. (search).
+There is a list of implemented extensions and what they include. The extension
+number accomply to file `src/rrtextN.cc` where `N` is:
+
+1.  "cost" RS-M -- Reeds & Shepp (build), Matej's heur. (search).
+2.  "collision" [cute c2][] for collision detection,
+3.  "path optimization" Dijkstra algorithm,
+4.  "nn" 2D grid for nodes storage,
+5.  "cost" RS-E -- Reeds & Shepp (build), Euclidean (search),
+6.  "cost" RS-RS -- Reeds & Shepp (build), Reeds & Shepp (search),
+7.  "nn" 2D [K-d tree][] for nodes storage,
+8.  "nn" 3D [K-d tree][] for nodes storage,
+9.  "nn" 3D grid for nodes storage,
+10. "cost" RS-H -- Reeds & Shepp (build), B-Spline paper (search)
+11. "goal zone" gz -- Use drivable of libbcar to check if goal found.
+12. "steer" -- Use random control input for `steer1`, use R&S for `steer2`.
+13. "path optimization" -- Dijkstra algorithm, goal zone for interesting nodes.
 
 [cute c2]: https://github.com/RandyGaul/cute_headers/blob/master/cute_c2.h
 [K-d tree]: https://en.wikipedia.org/wiki/K-d_tree
 
 ## Compound extensions
-There is a list of classes with reference to extensions used:
-- `RRTCE16`: cute, Dijkstra, 3D grid, RS-H.
-- `RRTCE15`: cute, Dijkstra, 3D grid, RS-RS.
-- `RRTCE14`: cute, Dijkstra, 3D tree, RS-H.
-- `RRTCE13`: cute, Dijkstra, 3D tree, RS-RS.
-- `RRTCE12`: cute, Dijkstra, 2D tree, RS-H.
-- `RRTCE11`: cute, Dijkstra, 2D tree, RS-E.
-- `RRTCE10`: cute, Dijkstra, 2D tree, RS-RS.
-- `RRTCE9`: cute, Dijkstra, 2D grid, RS-H.
-- `RRTCE8`: cute, Dijkstra, 2D grid, RS-RS.
-- `RRTCE7`: cute, Dijkstra, 2D grid, RS-E.
-- `RRTCE6`: cute, 2D grid, RS-RS.
-- `RRTCE5`: cute, 2D grid, RS-E.
-- `RRTCE4`: RS-H, cute, 2D grid.
-- `RRTCE3`: cute, RS-RS.
-- `RRTCE2`: cute, RS-E.
-- `RRTCE1`: RS-H, cute.
+There is a list of classes with reference to extensions used. The extensio
+number accomply to class `RRTCEn` where `n` is:
+
+1.  cute, gz, Dijkstra, RS-M.
+2.  cute, gz, Dijkstra, RS-E.
+3.  cute, gz, Dijkstra, RS-RS.
+4.  RS-M, cute, 2D grid.
+5.  cute, 2D grid, RS-E.
+6.  cute, 2D grid, RS-RS.
+7.  cute, Dijkstra, 2D grid, RS-E.
+8.  cute, Dijkstra, 2D grid, RS-RS.
+9.  cute, Dijkstra, 2D grid, RS-M.
+10. cute, Dijkstra, 2D tree, RS-RS.
+11. cute, Dijkstra, 2D tree, RS-E.
+12. cute, Dijkstra, 2D tree, RS-M.
+13. cute, Dijkstra, 3D tree, RS-RS.
+14. cute, Dijkstra, 3D tree, RS-M.
+15. cute, Dijkstra, 3D grid, RS-RS.
+16. cute, Dijkstra, 3D grid, RS-M.
+17. cute, gz, Dijkstra, RS-H.
+
+18. cute, gz, Dijkstra, 2D grid, RS-RS
+19. cute, gz, Dijkstra, 2D grid, RS-E
+20. cute, gz, Dijkstra, 2D grid, RS-M
+21. cute, gz, Dijkstra, 2D grid, RS-H
+
+22. cute, gz, Dijkstra, 2D tree, RS-RS
+23. cute, gz, Dijkstra, 2D tree, RS-E
+24. cute, gz, Dijkstra, 2D tree, RS-M
+25. cute, gz, Dijkstra, 2D tree, RS-H
+
+26. cute, gz, Dijkstra, 3D grid, RS-RS
+27. cute, gz, Dijkstra, 3D grid, RS-E
+28. cute, gz, Dijkstra, 3D grid, RS-M
+29. cute, gz, Dijkstra, 3D grid, RS-H
+
+30. cute, gz, Dijkstra, 3D tree, RS-RS
+31. cute, gz, Dijkstra, 3D tree, RS-E
+32. cute, gz, Dijkstra, 3D tree, RS-M
+33. cute, gz, Dijkstra, 3D tree, RS-H
+
+34. cute, gz, Dijkstra, 3D tree, RS-H, diff. steer
 
 # Contribute
 Use [OneFlow][3] branching model and keep the [changelog][4].