Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document tree traversals in C API #391

Closed
jeromekelleher opened this issue Oct 23, 2019 · 2 comments
Closed

Document tree traversals in C API #391

jeromekelleher opened this issue Oct 23, 2019 · 2 comments
Labels
C API Issue is about the C API
Milestone

Comments

@jeromekelleher
Copy link
Member

We need to document the basics of how to traverse around a tree in the C API. This should include documentating the (a) parent/left_child/right_sib elements in the tree struct; and (b) giving a tutorial example of doing this. We should do two tutorial examples: (1) traversing upwards from the samples to do something; and (2) traversing downwards in a standard preorder way. It might be fun to compare a recursive vs the usual iterative stack based approach to doing this in terms of performance.

We should also address #63 as well though, to clear up what how the quintuply linked tree structure works.

@jeromekelleher jeromekelleher added this to the C API 1.0.0 milestone Oct 23, 2019
@jeromekelleher jeromekelleher added the C API Issue is about the C API label Oct 23, 2019
@molpopgen
Copy link
Member

Will do! I'll need about a week, though--teaching is hitting hard now, but clears up after 1/11 (or 11/1 for those of us in the US).

@jeromekelleher
Copy link
Member Author

Thanks @molpopgen! I might merge #392 in the mean time then, but it would be great if you could loop back and have a run through the new docs when teaching clears up in November (not January I hope!).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C API Issue is about the C API
Projects
None yet
Development

No branches or pull requests

2 participants