Skip to content

Commit c4b2d7f

Browse files
committed
Improved README.md. Removed references of report in Makefile, as the professor won't have the report LaTeX sources
1 parent 74fe747 commit c4b2d7f

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

Makefile

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ testall_explicit:
4444
# TODO: Test KruskalNaive excluded due to its excessively long runtime.
4545
# ./test.sh ${KRUSKAL_NAIVE}.${EXT}
4646

47-
report:
48-
cd report; make pdf1
47+
# report:
48+
# cd report; make pdf1
4949

5050
.PHONY: all algs ensure_build_dir
51-
.PHONY: ${KRUSKAL_NAIVE} ${KRUSKAL_UNION_FIND} ${KRUSKAL_UNION_FIND_COMPRESSED} ${PRIM_BINARY_HEAP} ${PRIM_K_HEAP} report
51+
.PHONY: ${KRUSKAL_NAIVE} ${KRUSKAL_UNION_FIND} ${KRUSKAL_UNION_FIND_COMPRESSED} ${PRIM_BINARY_HEAP} ${PRIM_K_HEAP} # report

README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ this process.
2121
compile given algorithm sources.
2222
- `make testall`, to run tests on our algorithms.
2323
- `make testall_explicit`, to run tests with verbose output on our algoritms.
24-
- `make report`, to build the report pdf.
2524

2625
Within the Makefile we provieded some variables to modify our pipeline.
2726
In particular you can use your own compiler rewriting the `CXX` flag. Other
@@ -55,10 +54,23 @@ These projects are:
5554
The shared data structures and utils are stored in the *Shared* folder.
5655

5756
The project comes with some extra folders:
58-
* **benchmark**: it contains CSV benchmarks of the algorithm as well as the script used to analyze them ([analysis.py](analysis.py));
57+
* **benchmark**: it contains CSV benchmarks of the algorithm as well as the script used to analyze them ([analysis.py](./benchmark/analysis.py));
5958
* **datasets**: it contains the input data for the graphs given by our professor, i.e. 68 random connected, weighted and non-directed graphs up to 100K nodes and ~130K edges;
6059
* **test**: it contains 68 test graphs and their exact MST value, used test our algorithms' correctness.
6160

61+
## Related Projects
62+
63+
Some of the data-structures created for this project are general enough that we were able to copy their source to
64+
separate, indipendent repositories, each with its own documentation and unit tests.
65+
These repositories are:
66+
67+
* [**priority-queue**](https://github.com/jkomyno/priority-queue) contains the sources [Heap.h](./Shared/Heap.h),
68+
[BinaryHeap.h](./Shared/BinaryHeap.h), [KHeap.h](./Shared/KHeap.h), [PriorityQueue.h](./Shared/PriorityQueue.h), as
69+
well as unit tests and example usage documentation.
70+
* [**disjoint-set**](https://github.com/jkomyno/disjoint-set) contains the sources [DisjointSetBase.h](./Shared/DisjointSetBase.h),
71+
[DisjointSet.h](./Shared/DisjointSet.h), [DisjointSetCompressed.h](./Shared/DisjointSetCompressed.h), as
72+
well as unit tests and example usage documentation.
73+
6274
## Authors
6375

6476
**Bryan Lucchetta**

0 commit comments

Comments
 (0)