-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.md.in
53 lines (30 loc) · 2.54 KB
/
README.md.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Introduction
<h1>CHDR @CHDR_VERSION_MAJOR@.@CHDR_VERSION_MINOR@.@CHDR_VERSION_PATCH@</h1>
A comprehensive solution for pathfinding in K-dimensions.
## Table of Contents
- [Background](#background)
- [Manual](docs/manual/getting_started.md)
- [Roadmap](docs/manual/roadmap.md)
- [License](#license)
- [References](#references)
## Background
The CHDR project aims to be the fastest and most efficient pathfinding library available.
CHDR provides a user-friendly API with ultra-low latency, minimal memory usage,
and high-performance implementations of cutting-edge algorithms widely used in Robotics,
Game Development, GNSS Navigation, Artificial Intelligence, and other high-performance applications.
Its flexible design ensures compatibility across numerous platforms, compilers, and toolchains.
Offered as a lightweight, header-only C++17 library with a modular, standards-compliant architecture,
CHDR compiles seamlessly under strict conditions and has passed rigorous testing with tools like Valgrind and Google's Sanitizers.
By leveraging advanced metaprogramming techniques, CHDR strikes the perfect balance between usability and performance.
It supports efficient routing in 1D, 2D, 3D, 4D, and even higher-dimensional spaces,
making it an ideal choice for developers seeking fast and reliable pathfinding solutions.
## Usage
For full guides, example implementations, and step-by-step tutorials on how to use the library effectively, please refer to
the [manual](docs/manual/getting_started.md).
## Contributing
If you encounter any issues or have suggestions for improvements, feel free to post them in the project's issue tracker. Your feedback helps us make CHDR better for the entire community. At this time, please note that derivative works or modifications to the library are not permitted under the current license agreement. Refer to the [license](#license) section for more information.
## License
**[Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/deed.en)**
CHDR is currently licensed under **[CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/deed.en)**. Please refer to the license documentation for exact details. For permission regarding use in commercial or derivative works, please contact the developers.
## References
Reinefeld, A. and Marsland, T. A., 1994. Enhanced iterative-deepening search. IEEE Transactions on Pattern Analysis and Machine Intelligence, 16 (7), 701–710. Available at https://doi.org/10.1109/34.297950. [Accessed 3 Oct. 2024].