Add documentation for PairingHeap data structure#803
Open
krrishverma1805-web wants to merge 1 commit intotypelevel:masterfrom
Open
Add documentation for PairingHeap data structure#803krrishverma1805-web wants to merge 1 commit intotypelevel:masterfrom
krrishverma1805-web wants to merge 1 commit intotypelevel:masterfrom
Conversation
Author
|
@gemelen can you please review this.. |
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
1 participant
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
PairingHeapdata structure with runnablemdocexamples.Why
PairingHeapis a key data structure in cats-collections with excellent empirical performance and an efficient O(1) merge operation. It currently has no documentation page, unlikeHeap(which hasbinaryheap.md),Diet,Dequeue,Set, etc.Contents
The new page covers:
PairingHeapis and its theoretical backgroundHeapto help users choose between themmdocexamples: creation, add, remove, fromIterable, combine (merge), and takeLargestChecklist
binaryheap.md,dequeue.md, etc.)mdocexamples compile successfully (sbt docs/mdoc— 0 errors)