This implementation was derived by using the 4 rules that are outlined in Bram Cohen's blog, and then was further extended to support low-occurrence common elements.
The basic idea of the algorithm is to create a histogram of occurrences for each element of sequence A. Each element of sequence B is then considered in turn. If the element also exists in sequence A, and has a lower occurrence count, the positions are considered as a candidate for the longest common subsequence (LCS). After scanning of B is complete the LCS that has the lowest number of occurrences is chosen as a split point. The region is split around the LCS, and the algorithm is recursively applied to the sections before and after the LCS.
By always selecting a LCS position with the lowest occurrence count, this algorithm behaves exactly like Bram Cohen's patience diff whenever there is a unique common element available between the two sequences. When no unique elements exist, the lowest occurrence element is chosen instead. This offers more readable diffs than simply falling back on the standard Myers' O(ND) algorithm would produce.
To prevent the algorithm from having an O(N^2) running time, an upper limit
on the number of unique elements in a histogram bucket is configured by
setMaxChainLength(int). If sequence A has more than this many
elements that hash into the same hash bucket, the algorithm passes the region
to setFallbackAlgorithm(DiffAlgorithm). If no fallback algorithm is
configured, the region is emitted as a replace edit.
During scanning of sequence B, any element of A that occurs more than
setMaxChainLength(int) times is never considered for an LCS match
position, even if it is common between the two sequences. This limits the
number of locations in sequence A that must be considered to find the LCS,
and helps maintain a lower running time bound.
So long as setMaxChainLength(int) is a small constant (such as 64),
the algorithm runs in O(N * D) time, where N is the sum of the input lengths
and D is the number of edits in the resulting EditList. If the supplied
org. has a good hash function,
this implementation typically out-performs
org., even though its theoretical running
time is the same.
This implementation has an internal limitation that prevents it from handling sequences with more than 268,435,456 (2^28) elements.
| Modifier and Type | Class and Description |
|---|---|
| private class |
| Modifier and Type | Field and Description |
|---|---|
| pack-priv DiffAlgorithm | fallback
Algorithm to use when there are too many element occurrences. |
| pack-priv int | maxChainLength
Maximum number of positions to consider for a given element hash. |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public <S extends Sequence> void | diffNonCommon(EditList
result list to append the region's edits onto. edits, HashedSequenceComparator<S> the comparator supplying the element equivalence function. cmp, HashedSequence<S> the first (also known as old or pre-image) sequence. Edits
returned by this algorithm will reference indexes using the
'A' side: a, HashedSequence<S> org.,
org..the second (also known as new or post-image) sequence. Edits
returned by this algorithm will reference indexes using the
'B' side: b, Edit org.,
org..the region being compared within the two sequences. region)Implements abstract org. Compare two sequences and identify a list of edits between them. |
| public void | setFallbackAlgorithm(DiffAlgorithm
the secondary algorithm. If null the region will be denoted as
a single REPLACE block. alg)Set the algorithm used when there are too many element occurrences. |
| public void | setMaxChainLength(int
new maximum length. maxLen)Maximum number of positions to consider for a given element hash. |
| fallback | back to summary |
|---|---|
| pack-priv DiffAlgorithm fallback Algorithm to use when there are too many element occurrences. | |
| maxChainLength | back to summary |
|---|---|
| pack-priv int maxChainLength Maximum number of positions to consider for a given element hash. All elements with the same hash are stored into a single chain. The chain size is capped to ensure search is linear time at O(len_A + len_B) rather than quadratic at O(len_A * len_B). | |
| HistogramDiff | back to summary |
|---|---|
| public HistogramDiff() | |
| diffNonCommon | back to summary |
|---|---|
| public <S extends Sequence> void diffNonCommon(EditList edits, HashedSequenceComparator<S> cmp, HashedSequence<S> a, HashedSequence<S> b, Edit region) Implements abstract org. Doc from org. Compare two sequences and identify a list of edits between them.
This method should be invoked only after the two sequences have been
proven to have no common starting or ending elements. The expected
elimination of common starting and ending elements is automatically
performed by the
| |
| setFallbackAlgorithm | back to summary |
|---|---|
| public void setFallbackAlgorithm(DiffAlgorithm alg) Set the algorithm used when there are too many element occurrences.
| |
| setMaxChainLength | back to summary |
|---|---|
| public void setMaxChainLength(int maxLen) Maximum number of positions to consider for a given element hash. All elements with the same hash are stored into a single chain. The chain size is capped to ensure search is linear time at O(len_A + len_B) rather than quadratic at O(len_A * len_B).
| |
| Modifier and Type | Field and Description |
|---|---|
| private final HashedSequence | |
| private final HashedSequence | |
| private final HashedSequenceComparator | |
| pack-priv final EditList | edits
Result edits we have determined that must be made to convert a to b. |
| private final List |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| private void | |
| pack-priv void | |
| private void | |
| private SubsequenceComparator |
| a | back to summary |
|---|---|
| private final HashedSequence<S> a | |
| b | back to summary |
|---|---|
| private final HashedSequence<S> b | |
| cmp | back to summary |
|---|---|
| private final HashedSequenceComparator<S> cmp | |
| edits | back to summary |
|---|---|
| pack-priv final EditList edits Result edits we have determined that must be made to convert a to b. | |
| queue | back to summary |
|---|---|
| private final List<Edit> queue | |
| State | back to summary |
|---|---|
| pack-priv State(EditList edits, HashedSequenceComparator<S> cmp, HashedSequence<S> a, HashedSequence<S> b) | |
| diff | back to summary |
|---|---|
| private void diff(Edit r) | |
| diffRegion | back to summary |
|---|---|
| pack-priv void diffRegion(Edit r) | |
| diffReplace | back to summary |
|---|---|
| private void diffReplace(Edit r) | |
| subcmp | back to summary |
|---|---|
| private SubsequenceComparator | |