readme: hilight remove fn assumes coords not changed#101
Open
kylezeeuwen wants to merge 1 commit intomourner:mainfrom
Open
readme: hilight remove fn assumes coords not changed#101kylezeeuwen wants to merge 1 commit intomourner:mainfrom
kylezeeuwen wants to merge 1 commit intomourner:mainfrom
Conversation
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.
Thank you for the great library !
I am using it in https://github.com/Displayr/rhtmlLabeledScatter which is a scatter / bubble plot library I have inherited and am heavily recfactoring. rbush has helped me clean up the collision detection logic used in the label placement algorithm.
I came across what I initially thought was a bug, but upon investigation it was me incorrectly using rbush.
The use case is that I am constantly moving the labels around, and checking for collisions. I observed that the remove call would not always remove the label rectangle. Upon investigating the remove implementation i realise that it optimises its tree traversal logic based on assumptions about the coordinates of the label rectangle. So if I change the x/y coords then call remove, sometimes the object would not get removed from the tree !
See the updates to the docs I made to hopefully save others some time.
Happy to change wording/format etc.