chickadee » npdiff

Outdated egg!

This is an egg for CHICKEN 4, the unsupported old release. You're almost certainly looking for the CHICKEN 5 version of this egg, if it exists.

If it does not exist, there may be equivalent functionality provided by another egg; have a look at the egg index. Otherwise, please consider porting this egg to the current version of CHICKEN.

npdiff

Compute the longest common subsequence of two sequences, and generate a script to transform one sequence into the other.

Usage

(require-extension npdiff)

Documentation

The npdiff library is an implementation of an algorithm for sequence comparison that has a worst-case running time of O(N*P), where P is the number of deletions required by the shortest edit script between the two sequences. The algorithm is described in the following paper:

Sun Wu, Udi Manber, Eugene Myers, and Webb Miller. An O(NP) sequence comparison algorithm. 
In Information Processing Letters, volume 35, pages 317--323, September 1990.

This library defines a data type that describes the three basic operations of an edit script (remove, insert, change) and a procedure that implements the algorithm for sequences of an arbitrary type, provided an equality predicate for that type, and accessors for the sequence.

Data types

(define-datatype diffop diffop? ...)

Representation of the three diff operations: insert, remove, change. The target in each operation is an index or a range of indices in the sequence being transformed (target sequence), and the source is a range of indices in the sequence being read from (source sequence). The operation definitions are:

(Insert target source seq context)
Insert operation
(Remove target seq context)
Remove operation
(Change target source seqin seqout contextin contextout)
Change operation

Procedures

make-diff:procedure

Creates a diff procedure, where

  • EQUAL? is an equality predicate for elements of the type being compared;
  • SEQ-REF is a procedure of the form LAMBDA SEQ INDEX -> ELEMENT which returns element INDEX from sequence SEQ;
  • SEQ-LENGTH is a procedure of the form LAMBDA SEQ -> LEN which returns the length of sequence SEQ;
  • HUNKS is a procedure of the type created by make-hunks, which is described below.

The returned procedure is of the form LAMBDA A B [CONTEXT-LEN] -> (HUNK ... ) where A and B are two sequences to be compared, and CONTEXT-LEN is an optional context length, which is used by the HUNKS procedure to create context in the hunks of the edit script

make-hunks:procedure

creates a procedure that creates insert/remove/change hunks given a stack of matching index ranges that is produced by the diff procedure above.

  • SEQ-REF is a procedure of the form LAMBDA SEQ INDEX -> ELEMENT which returns element INDEX from sequence SEQ;
  • SEQ-LENGTH is a procedure of the form LAMBDA SEQ -> LEN which returns the length of sequence SEQ;
  • SEQ-SLICE is a procedure of the form LAMBDA SEQ START END -> SEQ which returns a list with the elements contained within the specified range in the input sequence SEQ;

The returned procedure is of the form LAMBDA A B CSS [CONTEXT] -> (HUNK ... ) where A and B are the two sequences compared, CSS is the stack of matching ranges returned by diff, and CONTEXT is an optional argument that is used to add context to the generated hunks, if specified.

Examples

;; Creates a function to find the differences between two vectors
;; containing strings
(use npdiff vector-lib)

(define  (textdiff text1 text2 . rest)
  (let-optionals  rest ((context-len 0))
    (let ((A   (list->vector text1))
	  (B   (list->vector text2)))
      ((make-npdiff  string=? vector-ref vector-length 
		     (make-hunks vector-ref vector-length 
				 (compose vector->list vector-copy)))
       A B context-len))))

About this egg

Author

Ivan Raikov

Version history

1.16
Added missing else clause when constructing hunks for completely different sequences [thanks to Felix Winkelmann]
1.15
Increased amount of context used for remove hunks [related to a bug discovered by Daishi Kato]
1.14
Proper handling of boundary cases when either input sequence is empty [thanks to Daishi Kato]
1.13
Make sure context is included even if the two sequences are completely different
1.12
Updated version in setup file
1.11
Documentation converted to wiki format
1.10
Eliminated dependency on matchable
1.9
Ported to Chicken 4
1.8
Added missing files to the file manifest
1.7
Removed dependence on stack egg
1.5
Build script updated for better cross-platform compatibility
1.4
eggdoc documentation fix
1.3
License upgrade to GPL v3
1.2
Added license text to source files
1.1
Documentation fixes
1.0
Initial release

License

Copyright 2007-2011 Ivan Raikov. 

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

A full copy of the GPL license can be found at
<http://www.gnu.org/licenses/>.

Contents »