added iterators for dfs and bfs

[kylebeggs]

Adds support to iterate through the nodes in a graph in a depth-first or breadth-first manner. (see #106 )

[kylebeggs]

The checks are failing because of other parts of the code, not what is included in this PR. I'm still kinda new to this - what is the procedure when this happens?

[simonschoelly]

The checks are failing because of other parts of the code, not what is included in this PR. I'm still kinda new to this - what is the procedure when this happens?

From the error logs, it looks as if in your PR you used some names that where already used for something else:

WARNING: using Traversals.tree in module Main conflicts with an existing identifier.
`` 

[kylebeggs]

Ah, I see. I fixed the issue. Tests still show one error but it seems to be in a completely different module

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.30%. Comparing base (afb8245) to head (10e7c6e).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #163      +/-   ##
==========================================
+ Coverage   97.28%   97.30%   +0.02%     
==========================================
  Files         118      120       +2     
  Lines        6876     6944      +68     
==========================================
+ Hits         6689     6757      +68     
  Misses        187      187              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[simonschoelly]

Ah, I see. I fixed the issue. Tests still show one error but it seems to be in a completely different module

Indeed - apparently the tests are failing in Julia v1.8 -> I will need to investigate here

[simonschoelly]

@kylebeggs If you rebase/merge the lastest master in your branch, the tests should pass now.

[etiennedeg]

Thanks a lot for your work on this, very appreciated.

[kylebeggs]

@simonschoelly @etiennedeg I am taking a new approach to this taking into account some of the comments. I converted this PR to a draft in the meantime

[kylebeggs]

@thchr thanks for the suggestion. @simonschoelly @etiennedeg I am opening this back up as I have made some changes. Please review and lets all work together to come up with something to get us started with iterators in this package.

[Tortar]

This is very cool, one thing I want to suggest for the bfs part is that to apply the optimization I already applied here: #250.

[gdalle]

Thank you for the PR! I cleaned up the code a little bit and ensured type stability in the structs

[Tortar]

Thanks @gdalle for the help! But tests are now failing somehow

[gdalle]

Yeah sorry I'll fix it in a moment

[gdalle]

tests are fixed now

[kylebeggs]

Great to see so much progress on this @Tortar @gdalle. What else is needed to get this merged? There has been a lot of activity, so it is a little difficult to see what exactly is left to do?

[gdalle]

Essentially address my unresolved comments above: adding more tests and some comments / docstrings describing the logic to make reviewing easier

[Tortar]

I tried to address all review comments by @gdalle, probably docstrings can be improved but hopefully should be okay nonetheless

[gdalle]

Thank you for the contribution!
There are things we could improve, like using the eltype of the graph instead of Int or testing on directed graphs, but this has been cooking for far too long and it is a needed feature.

[kylebeggs]

Huge thanks to @Tortar !!