Improve linemerge
algorithm by adding prepending ability
#496
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.
Description
Currently, the greedy algorithm of
linemerge
would only attempts to "append", which would make it sensitive to line order. With this PR, the algorithm now attempt to "prepend" as well, which improves on the situation.Consider 3 points A, B, C and the pair of line AB and BC. The greedy algorithm works by picking the first line and merging it with any line whose endings match the end point (in this case B). Here, AB is picked and, since BC shares an endpoint, it is successfully merged.
If the input lines are swapped (BC then AB), the algorithm would first pick BC and look for lines with endpoint close to C. Since there are none, BC is kept as is, and then AB is processed. Since it's now alone, it's is also kept as is and the result is not merged. Now, the algo will also look for lines whose ending is close to B, finds AB, and successfully merges the two lines.
Obviously, the above is done while respecting the
no-flip
option.Checklist
black
andisort
)mypy
returns no errorpytest
succeedshelp
reference.rst
make clean && make html
indocs/
)