Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dynesshely/prouter
A library to visualize algorithm by tracing your code.
https://github.com/dynesshely/prouter
algorithm algorithm-analysis algorithm-visualizer visualization
Last synced: 19 days ago
JSON representation
A library to visualize algorithm by tracing your code.
- Host: GitHub
- URL: https://github.com/dynesshely/prouter
- Owner: Dynesshely
- License: gpl-2.0
- Created: 2023-11-24T05:50:35.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-05-26T08:54:37.000Z (6 months ago)
- Last Synced: 2024-10-11T19:43:15.509Z (about 1 month ago)
- Topics: algorithm, algorithm-analysis, algorithm-visualizer, visualization
- Language: C++
- Homepage:
- Size: 106 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# About
Prouter is a library that allows you to trace your code and visualize your algorithm.
# Usages
## Includes
```c++
#include
```
and you'd better include `predefine.h` after main function like this:
```c++
#include
int main() {
#include
......
```
## Trace a var
```c++
double a = 3.0;
a = 4.0, a *= 2.0;
std::cout << a.history() << std::endl << std::endl;
```
Output:
```text
3.000000 -> 4.000000 -> 8.000000
```
## Trace an array
```c++
auto int_arrTracer = prouter::traceArray().named("int arr tracer");
int intarr[10] = {0};
int_arrTracer.trace(intarr, 10);
for (int i = 0; i < 10; ++i) intarr[i] = i;
int_arrTracer.printTo(std::cout, true).dispose();
auto num_arrTracer = prouter::traceArray().named("num arr tracer");
double numarr[10] = {0};
num_arrTracer.trace(numarr, 10);
for (int i = 0; i < 10; ++i) numarr[i] = i;
std::cout << num_arrTracer.history() << std::endl;
num_arrTracer.dispose(numarr);
```
Output:
```text
╔════════════════════════════════╗
║ int arr tracer ║
╠════════════════════════════════╣
║ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0] ║
╠════════════════════════════════╣
║ [0, 1, 0, 0, 0, 0, 0, 0, 0, 0] ║
╠════════════════════════════════╣
║ [0, 1, 2, 0, 0, 0, 0, 0, 0, 0] ║
╠════════════════════════════════╣
║ [0, 1, 2, 3, 0, 0, 0, 0, 0, 0] ║
╠════════════════════════════════╣
║ [0, 1, 2, 3, 4, 0, 0, 0, 0, 0] ║
╠════════════════════════════════╣
║ [0, 1, 2, 3, 4, 5, 0, 0, 0, 0] ║
╠════════════════════════════════╣
║ [0, 1, 2, 3, 4, 5, 6, 0, 0, 0] ║
╠════════════════════════════════╣
║ [0, 1, 2, 3, 4, 5, 6, 7, 0, 0] ║
╠════════════════════════════════╣
║ [0, 1, 2, 3, 4, 5, 6, 7, 8, 0] ║
╠════════════════════════════════╣
║ [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] ║
╚════════════════════════════════╝
[0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000]
[0.000000, 1.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000]
[0.000000, 1.000000, 2.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000]
[0.000000, 1.000000, 2.000000, 3.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000]
[0.000000, 1.000000, 2.000000, 3.000000, 4.000000, 0.000000, 0.000000, 0.000000, 0.000000, 0.000000]
[0.000000, 1.000000, 2.000000, 3.000000, 4.000000, 5.000000, 0.000000, 0.000000, 0.000000, 0.000000]
[0.000000, 1.000000, 2.000000, 3.000000, 4.000000, 5.000000, 6.000000, 0.000000, 0.000000, 0.000000]
[0.000000, 1.000000, 2.000000, 3.000000, 4.000000, 5.000000, 6.000000, 7.000000, 0.000000, 0.000000]
[0.000000, 1.000000, 2.000000, 3.000000, 4.000000, 5.000000, 6.000000, 7.000000, 8.000000, 0.000000]
[0.000000, 1.000000, 2.000000, 3.000000, 4.000000, 5.000000, 6.000000, 7.000000, 8.000000, 9.000000]
```
## Trace a loop
```c++
auto loopTracer = prouter::traceLoop().named("loop 1");
int f[13], i = 1, fc;
f[1] = 1, f[2] = 1;
loopTracer.trace(&i.named("i"))
.trace(&fc.named("fc"))
.trace(f, 13, 2);
for (; i <= 10; ++i, loopTracer.loop()) {
if (i >= 3)
f[i] = f[i - 1] + f[i - 2];
fc.setValue(f[i]);
}
loopTracer.end().printTo(std::cout);
```
Output:
```text
╔═══╦══════════╦══════════╦═════════════════════════════════════════════╗
║ ║ i ║ fc ║ default array tracer ║
╠═══╬══════════╬══════════╬═════════════════════════════════════════════╣
║ 0 ║ 1 -> 2 ║ 0 -> 1 ║ [0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] ║
╠═══╬══════════╬══════════╬═════════════════════════════════════════════╣
║ 1 ║ 2 -> 3 ║ 1 -> 1 ║ [0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] ║
╠═══╬══════════╬══════════╬═════════════════════════════════════════════╣
║ 2 ║ 3 -> 4 ║ 1 -> 2 ║ [0, 1, 1, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0] ║
╠═══╬══════════╬══════════╬═════════════════════════════════════════════╣
║ 3 ║ 4 -> 5 ║ 2 -> 3 ║ [0, 1, 1, 2, 3, 0, 0, 0, 0, 0, 0, 0, 0] ║
╠═══╬══════════╬══════════╬═════════════════════════════════════════════╣
║ 4 ║ 5 -> 6 ║ 3 -> 5 ║ [0, 1, 1, 2, 3, 5, 0, 0, 0, 0, 0, 0, 0] ║
╠═══╬══════════╬══════════╬═════════════════════════════════════════════╣
║ 5 ║ 6 -> 7 ║ 5 -> 8 ║ [0, 1, 1, 2, 3, 5, 8, 0, 0, 0, 0, 0, 0] ║
╠═══╬══════════╬══════════╬═════════════════════════════════════════════╣
║ 6 ║ 7 -> 8 ║ 8 -> 13 ║ [0, 1, 1, 2, 3, 5, 8, 13, 0, 0, 0, 0, 0] ║
╠═══╬══════════╬══════════╬═════════════════════════════════════════════╣
║ 7 ║ 8 -> 9 ║ 13 -> 21 ║ [0, 1, 1, 2, 3, 5, 8, 13, 21, 0, 0, 0, 0] ║
╠═══╬══════════╬══════════╬═════════════════════════════════════════════╣
║ 8 ║ 9 -> 10 ║ 21 -> 34 ║ [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 0, 0, 0] ║
╠═══╬══════════╬══════════╬═════════════════════════════════════════════╣
║ 9 ║ 10 -> 11 ║ 34 -> 55 ║ [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 0, 0] ║
╚═══╩══════════╩══════════╩═════════════════════════════════════════════╝
```
## Trace a stack
```c++
auto pstackTest = (new stack())->push(4)
.push(8)
.push(2)
.pop()
.push(9)
.pop()
.push(3)
.pop()
.push(1)
.pop()
.clear()
.printHistoryTo(std::cout);
```
> Here use `s_int` to avoid using `pint`
Output:
```text
+---+ +---+ +---+ +---+
| | | | | | | |
+---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+
--> | | --> | 2 | --> | | --> | 9 | --> | | --> | 3 | --> | | --> | 1 | --> | | -->
+---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+
| | | 8 | | 8 | | 8 | | 8 | | 8 | | 8 | | 8 | | 8 | | 8 |
+---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+
| 4 | | 4 | | 4 | | 4 | | 4 | | 4 | | 4 | | 4 | | 4 | | 4 | | |
+---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+
```
## Trace a queue
```c++
auto pqueueTest = (new queue())->push(3)
.push(7)
.pop()
.push(16)
.pop()
.push(12)
.push(244)
.push(9)
.pop()
.pop()
.clear()
.printHistoryTo(std::cout);
```
Output:
```text
+----+---+----+
0 | <- | 3 | <- |
+----+---+----+
+----+---+---+----+
1 | <- | 3 | 7 | <- |
+----+---+---+----+
+----+---+----+
2 | <- | 7 | <- |
+----+---+----+
+----+---+----+----+
3 | <- | 7 | 16 | <- |
+----+---+----+----+
+----+----+----+
4 | <- | 16 | <- |
+----+----+----+
+----+----+----+----+
5 | <- | 16 | 12 | <- |
+----+----+----+----+
+----+----+----+-----+----+
6 | <- | 16 | 12 | 244 | <- |
+----+----+----+-----+----+
+----+----+----+-----+---+----+
7 | <- | 16 | 12 | 244 | 9 | <- |
+----+----+----+-----+---+----+
+----+----+-----+---+----+
8 | <- | 12 | 244 | 9 | <- |
+----+----+-----+---+----+
+----+-----+---+----+
9 | <- | 244 | 9 | <- |
+----+-----+---+----+
+----+---------------+----+
10 | <- | | <- |
+----+---------------+----+
```
## Trace Algorithms
### LCS (Longest Common Sequence)
```c++
auto lcs = (new alg_lcs())->setValue(
"ABCBDAB",
"BDCABA"
).run().printLcsTo(std::cout);
```
Output:
```text
+-----------------------------+
| Longest Common Sequence |
+-----------------------------+
| - - A B C B D A B |
| - 0 0 0 0 0 0 0 0 |
| B 0 0 1 1 1 1 1 1 |
| D 0 0 1 1 1 2 2 2 |
| C 0 0 1 2 2 2 2 2 |
| A 0 1 1 2 2 2 3 3 |
| B 0 1 2 2 3 3 3 4 |
| A 0 1 2 2 3 3 4 4 |
+-----------------------------+
| len: 4 |
+-----------------------------+
| lcs: BCBA |
+-----------------------------+
| lcs: BDAB |
+-----------------------------+
```