Initial commit

Author: gmardau

.gitignore

@@ -0,0 +1,3 @@
+src/btree
+src/kd_tree
+src/orthtree

.vscode/settings.json

@@ -0,0 +1,43 @@
+{
+	"files.associations": {
+		"array": "cpp",
+		"*.tcc": "cpp",
+		"cctype": "cpp",
+		"chrono": "cpp",
+		"clocale": "cpp",
+		"cmath": "cpp",
+		"cstdint": "cpp",
+		"cstdio": "cpp",
+		"cstdlib": "cpp",
+		"cstring": "cpp",
+		"ctime": "cpp",
+		"cwchar": "cpp",
+		"cwctype": "cpp",
+		"exception": "cpp",
+		"functional": "cpp",
+		"initializer_list": "cpp",
+		"iosfwd": "cpp",
+		"iostream": "cpp",
+		"istream": "cpp",
+		"limits": "cpp",
+		"memory": "cpp",
+		"new": "cpp",
+		"numeric": "cpp",
+		"optional": "cpp",
+		"ostream": "cpp",
+		"ratio": "cpp",
+		"stdexcept": "cpp",
+		"streambuf": "cpp",
+		"string_view": "cpp",
+		"system_error": "cpp",
+		"tuple": "cpp",
+		"type_traits": "cpp",
+		"typeinfo": "cpp",
+		"utility": "cpp",
+		"variant": "cpp",
+		"cstddef": "cpp",
+		"fstream": "cpp",
+		"iomanip": "cpp",
+		"sstream": "cpp"
+	}
+}

.vscode/tasks.json

@@ -0,0 +1,8 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{ "taskName": "Compile examples", "type": "shell", "group": "build", "command": "make clean all -C docs/examples" },
+		{ "taskName": "Do tests",         "type": "shell", "group": "test",  "command": "make tests -C test && test/test" },
+		{ "taskName": "Compile tests",    "type": "shell", "group": "test",  "command": "make tests -C test" },
+		{ "taskName": "Run tests",        "type": "shell", "group": "test",  "command": "test/test" } ]
+}

LICENSE

@@ -0,0 +1,21 @@
+# gmd-tree-library: STL-like Tree Library for C++
+
+**gmd-tree-library** is a templated container library built in C++. It contains several types of trees, acting as replacements for the *set*, *multiset*, *map*, and *multimap* containers of the STL. Its public interface is similar to the one found in the STL, with some extra functionality, specially on type conversion and iterators.
+
+## Usage
+
+**Requirements:** To use this library, a C++17 version of the compiler is required.
+
+This library adopts the single include policy. To use it, download the [latest release](https://github.com/gmardau/gmd-tree-library/releases) and place *src/* and *tree* in the desired location. Everything else can be removed. Finally, include the file *tree* in your project.
+
+[**API Reference**](https://github.com/gmardau/gmd-tree-library/blob/master/docs/wiki/tree.md)
+
+**Examples:** Example files can be found in docs/examples.
+
+## Future Development
+
+At the time of writing, the library contains only Binary trees. In future releases this library is expected to include Space Partitioning trees (namely KD-trees and Orthrees (n-analogue of quadtrees)) and B-trees.
+
+## License
+
+**gmd-tree-library** is released under the [GNU General Public License v3.0](https://github.com/gmardau/gmd-tree-library/blob/master/LICENSE).

README.md

@@ -0,0 +1,26 @@
+#include <iostream>
+
+using intpair = std::pair<int, int>;
+std::ostream& operator<<(std::ostream& os, const intpair& i) {
+	os << i.first << ',' << i.second; return os;
+}
+
+int main(const int, const char **)
+{
+	gmd::binary_tree_map<gmd::tree_avl, int, int> a{{3,1}, {1,2}, {2,3}};
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+
+	std::cout << "access value of key 2: " << a[2] << '\n';
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+
+	std::cout << "setting value of key 3: " << (a[3] = 3) << '\n';
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+
+	std::cout << "access value of key 4: " << a[4] << '\n';
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+
+	std::cout << "setting value of key 5: " << (a[5] = 5) << '\n';
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+
+	return 0;
+}

docs/examples/binary_tree/map/array_subscript.cpp

@@ -0,0 +1,28 @@
+#include <iostream>
+
+using intpair = std::pair<int, int>;
+std::ostream& operator<<(std::ostream& os, const intpair& i) {
+	os << i.first << ',' << i.second; return os;
+}
+
+int main(const int, const char **)
+{
+	// (1) Copy assignment
+	gmd::binary_tree_map<gmd::tree_avl, int, int> a{{3,0}, {5,0}, {2,0}};
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+	gmd::binary_tree_map<gmd::tree_avl, int, int> b; b = a;
+	std::cout << "b: "; for(intpair &x: b) std::cout << x << ' '; std::cout << '\n';
+
+	// (2) Move assignment
+	gmd::binary_tree_multimap<gmd::tree_avl, int, int> c{{1,0}, {6,0}, {1, 1}};
+	std::cout << "c: "; for(intpair &x: c) std::cout << x << ' '; std::cout << '\n';
+	gmd::binary_tree_map<gmd::tree_rb, int, int> d; d = std::move(c);
+	std::cout << "c: "; for(intpair &x: c) std::cout << x << ' '; std::cout << '\n';
+	std::cout << "d: "; for(intpair &x: d) std::cout << x << ' '; std::cout << '\n';
+
+	// (3) Initializer list assignment
+	a = {{7,0}, {4,0}};
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+
+	return 0;
+}

docs/examples/binary_tree/map/assign.cpp

@@ -0,0 +1,26 @@
+#include <iostream>
+
+using intpair = std::pair<int, int>;
+std::ostream& operator<<(std::ostream& os, const intpair& i) {
+	os << i.first << ',' << i.second; return os;
+}
+
+int main(const int, const char **)
+{
+	gmd::binary_tree_map<gmd::tree_avl, int, int> a{{3,1}, {1,2}, {2,3}};
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+
+	std::cout << "access value of key 2: " << a.at(2) << '\n';
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+
+	std::cout << "setting value of key 3: " << (a.at(3) = 3) << '\n';
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+
+	try {
+		std::cout << "access value of key 4: " << a.at(4) << '\n';
+	} catch (std::exception &e) {
+		std::cout << e.what() << '\n';
+	}
+
+	return 0;
+}

docs/examples/binary_tree/map/at.cpp

@@ -0,0 +1,22 @@
+#include <iostream>
+
+using intpair = std::pair<int, int>;
+std::ostream& operator<<(std::ostream& os, const intpair& i) {
+	os << i.first << ',' << i.second; return os;
+}
+
+int main(const int, const char **)
+{
+	gmd::binary_tree_map<gmd::tree_avl, int, int> a;
+
+	std::cout << "empty: " << (a.empty() ? "true" : "false") << "\n";
+	std::cout << "size: " << a.size() << "\n";
+	a.insert({{3,0}, {1,0}, {2,0}});
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+	std::cout << "empty: " << (a.empty() ? "true" : "false") << "\n";
+	std::cout << "size: " << a.size() << "\n";
+
+	std::cout << "max_size: " << a.max_size() << "\n";
+
+	return 0;
+}

docs/examples/binary_tree/map/capacity.cpp

@@ -0,0 +1,18 @@
+#include <iostream>
+
+using intpair = std::pair<int, int>;
+std::ostream& operator<<(std::ostream& os, const intpair& i) {
+	os << i.first << ',' << i.second; return os;
+}
+
+int main(const int, const char **)
+{
+	gmd::binary_tree_map<gmd::tree_avl, int, int> a{{4,0}, {2,0}, {3,0}, {1,0}};
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+
+	a.clear();
+	std::cout << "a: "; for(intpair &x: a) std::cout << x << ' '; std::cout << '\n';
+	std::cout << "size: " << a.size() << "\n";
+
+	return 0;
+}