Add documentation for TreeList data structure#802
Open
krrishverma1805-web wants to merge 1 commit intotypelevel:masterfrom
Open
Add documentation for TreeList data structure#802krrishverma1805-web wants to merge 1 commit intotypelevel:masterfrom
krrishverma1805-web wants to merge 1 commit intotypelevel:masterfrom
Conversation
Author
|
Hi @gemelen 👋 Would love your thoughts on this one when you get a chance. It addresses one of the items in TODO.md around making arbitrary instances available to downstream projects. Thanks! |
This file contains hidden or 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
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.
What this PR does
Adds a documentation page for the
TreeListdata structure with runnablemdocexamples.Why
TreeListis a significant data structure in cats-collections — it provides O(1) cons/uncons with O(log N) random access, and its stack-safe traversals make it useful for large collections. However, it currently has no documentation page, unlike other data structures such asHeap,Diet,Dequeue,Set, etc.Contents
The new page covers:
TreeListis and its theoretical background (Okasaki's Purely Functional Random Access Lists)mdocexamples: creation, random access, prepend/uncons, update, construction fromList, and concatenationChecklist
dequeue.md,binaryheap.md, etc.)mdocexamples compile successfully (sbt docs/mdoc— 0 errors)