Adds ZTree.find/2 #32
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Much of the ZTree api offers a `!` variant that is very useful in testing. Looks like this function was missed because it wasn't being used anywhere.
The `find` API will receive a lot of use in the `Configuration` module where we will need it to locate `State` nodes that are the targets of `Transition`s. The implementation of `find` could use some work to use the ZTree in a more clever way to do the traversal, but since this is all internal details this implementation will allow us to move forward.
skbolton
commented
Sep 4, 2020
|
|
||
| # Iterates over a zipper stepping to next node in a depth first search | ||
| # Once entire tree has been visited `{:ok, :complete, tree}` is returned | ||
| @spec next(t()) :: {:ok, t()} | {:ok, :complete, t()} |
There was a problem hiding this comment.
My intention was to make this a private function. But after getting this all done I think it makes sense to make this public. This function operates as an iterator that you can use to walk all the elements in the ZTree. It needs to maintain some state in order to do the traversal. I think I am going to take a little more time to clean it up.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
findAPI will receive a lot of use in theConfigurationmodulewhere we will need it to locate
Statenodes that are the targets ofTransitions.The implementation of
findcould use some work to use the ZTree in amore clever way to do the traversal, but since this is all internal
details this implementation will allow us to move forward.