Skip to content

Commit

Permalink
Fill out Using Algorithms quick-start document (#210)
Browse files Browse the repository at this point in the history
  • Loading branch information
zdavkeos committed Jun 22, 2024
1 parent f42e25b commit d8da71e
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 1 deletion.
76 changes: 75 additions & 1 deletion docs/docs/quickstart/basics/using-algorithms.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,78 @@
sidebar_position: 3
---

# Using Algorithms
# Using Algorithms

1. In your `main.cpp` import Graaf and algorithm of choice:

```c++
#include <graaflib/graph.h>
#include <graaflib/algorithm/cycle_detection/dfs_cycle_detection.h>
```

2. Build your graph:

```c++
graaf::directed_graph<const char, int> g;

const auto a = g.add_vertex('a');
const auto b = g.add_vertex('b');
const auto c = g.add_vertex('c');

g.add_edge(a, b, 1);
g.add_edge(c, a, 1);
```

3. Run the algorithm:

```c++
std::cout << "Has cycles: " << graaf::algorithm::dfs_cycle_detection(g) << "\n";
```

4. Visualize the graph:

```c++
#include <graaflib/io/dot.h>
...
graaf::io::to_dot(g, "./Cycles.dot");
```
5. Putting it all together:
```c++
#include <graaflib/graph.h>
#include <graaflib/io/dot.h>
#include <graaflib/algorithm/cycle_detection/dfs_cycle_detection.h>
#include <iostream>
int main(int argc, char** argv)
{
graaf::directed_graph<const char, int> g;
const auto a = g.add_vertex('a');
const auto b = g.add_vertex('b');
const auto c = g.add_vertex('c');
g.add_edge(a, b, 1);
g.add_edge(c, a, 1);
std::cout << "Vertices: " << g.vertex_count() << "\n";
std::cout << "Edges: " << g.edge_count() << "\n";
std::cout << "Has cycles: " << graaf::algorithm::dfs_cycle_detection(g) << "\n";
g.add_edge(b, c, 1);
std::cout << "Has cycles: " << graaf::algorithm::dfs_cycle_detection(g) << "\n";
graaf::io::to_dot(g, "./Cycles.dot");
std::cout << "Run: dot -Tpng -o Cycles.png Cycles.dot\n";
return 0;
}
```

### Congratulations! You just detected if there are cycles in the following graph

![Cycle detection example](../../../static/img/quickstart/Cycles.png)
Binary file added docs/static/img/quickstart/Cycles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d8da71e

Please sign in to comment.