github/semantic
1
1
Fork 0
mirror of https://github.com/github/semantic.git synced 2024-12-18 20:31:55 +03:00
Code Issues Projects Releases Wiki Activity

Some documentation tweaks

Browse Source
This commit is contained in:
joshvera 2016-09-16 10:40:26 -04:00
parent b3776d9dc5
commit 4f7ec950a2
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/Data/RandomWalkSimilarity.hs
View File

@ -34,7 +34,11 @@ import Data.Align.Generic
import Data.These
import Diff
-- | Given a function comparing two terms recursively, and a function to compute a Hashable label from an unpacked term, compute the diff of a pair of lists of terms using a random walk similarity metric, which completes in log-linear time. This implementation is based on the paper [_RWS-Diff—Flexible and Efficient Change Detection in Hierarchical Data_](https://github.com/github/semantic-diff/files/325837/RWS-Diff.Flexible.and.Efficient.Change.Detection.in.Hierarchical.Data.pdf).
-- | Given a function comparing two terms recursively, and a function to compute a Hashable label from an unpacked term,
-- compute the diff of a pair of lists of terms using a random walk similarity metric,
-- which completes in log-linear time.
--
--This implementation is based on the paper [_RWS-Diff—Flexible and Efficient Change Detection in Hierarchical Data_](https://github.com/github/semantic-diff/files/325837/RWS-Diff.Flexible.and.Efficient.Change.Detection.in.Hierarchical.Data.pdf).
rws :: forall f fields.
(GAlign f,
Traversable f,
@ -43,13 +47,10 @@ rws :: forall f fields.
HasField fields (Vector.Vector Double)) =>
(Term f (Record fields)
-> Term f (Record fields)
-- | A function which compares a pair of terms recursively, returning 'Just' their diffed value if appropriate, or 'Nothing' if they should not be compared.
-> Maybe (Diff f (Record fields)))
-> Maybe (Diff f (Record fields))) -- ^ A function which compares a pair of terms recursively, returning 'Just' their diffed value if appropriate, or 'Nothing' if they should not be compared.
-- | The list of old terms.
-> [Cofree f (Record fields)]
-- | The list of new terms.
-> [Cofree f (Record fields)]
-- | The resulting list of similarity-matched diffs.
-> [Cofree f (Record fields)] -- ^ The list of new terms.
-> [Cofree f (Record fields)] -- ^ The resulting list of similarity-matched diffs.
-> [Free (CofreeF f (Both (Record fields))) (Patch (Cofree f (Record fields)))]
rws compare as bs
| null as, null bs = []