[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Algorithm::DiffOld.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Algorithm::DiffOld 3"
.TH Algorithm::DiffOld 3 "2002-03-24" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
Algorithm::DiffOld \- Compute `intelligent' differences between two files / lists
but use the old (<=0.59) interface.
.SH "NOTE"
.IX Header "NOTE"
This has been provided as part of the Algorithm::Diff package by Ned Konz.
This particular module is \fB\s-1ONLY\s0\fR for people who \fB\s-1HAVE\s0\fR to have the old
interface, which uses a comparison function rather than a key generating
function.
.PP
Because each of the lines in one array have to be compared with each 
of the lines in the other array, this does M*N comparisions. This can
be very slow. I clocked it at taking 18 times as long as the stock
version of Algorithm::Diff for a 4000\-line file. It will get worse
quadratically as array sizes increase.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Algorithm::DiffOld qw(diff LCS traverse_sequences);
.Ve
.PP
.Vb 1
\&  @lcs    = LCS( \e@seq1, \e@seq2, $comparison_function );
.Ve
.PP
.Vb 1
\&  $lcsref = LCS( \e@seq1, \e@seq2, $comparison_function );
.Ve
.PP
.Vb 1
\&  @diffs = diff( \e@seq1, \e@seq2, $comparison_function );
.Ve
.PP
.Vb 6
\&  traverse_sequences( \e@seq1, \e@seq2,
\&                     { MATCH => $callback,
\&                       DISCARD_A => $callback,
\&                       DISCARD_B => $callback,
\&                     },
\&                     $comparison_function );
.Ve
.SH "COMPARISON FUNCTIONS"
.IX Header "COMPARISON FUNCTIONS"
Each of the main routines should be passed a comparison function. If you
aren't passing one in, \fBuse Algorithm::Diff instead\fR.
.PP
These functions should return a true value when two items should compare
as equal.
.PP
For instance,
.PP
.Vb 1
\&  @lcs    = LCS( \e@seq1, \e@seq2, sub { my ($a, $b) = @_; $a eq $b } );
.Ve
.PP
but if that is all you're doing with your comparison function, just use
Algorithm::Diff and let it do this (this is its default).
.PP
Or:
.PP
.Vb 5
\&  sub someFunkyComparisonFunction
\&  {
\&        my ($a, $b) = @_;
\&        $a =~ m{$b};
\&  }
.Ve
.PP
.Vb 1
\&  @diffs = diff( \e@lines, \e@patterns, \e&someFunkyComparisonFunction );
.Ve
.PP
which would allow you to diff an array \f(CW@lines\fR which consists of text
lines with an array \f(CW@patterns\fR which consists of regular expressions.
.PP
This is actually the reason I wrote this version \*(-- there is no way
to do this with a key generation function as in the stock Algorithm::Diff.
Commit	Line	Data
86530b38 AT	1	.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
	2	.\"
	3	.\" Standard preamble:
	4	.\" ========================================================================
	5	.de Sh \" Subsection heading
	6	.br
	7	.if t .Sp
	8	.ne 5
	9	.PP
	10	\fB\\$1\fR
	11	.PP
	12	..
	13	.de Sp \" Vertical space (when we can't use .PP)
	14	.if t .sp .5v
	15	.if n .sp
	16	..
	17	.de Vb \" Begin verbatim text
	18	.ft CW
	19	.nf
	20	.ne \\$1
	21	..
	22	.de Ve \" End verbatim text
	23	.ft R
	24	.fi
	25	..
	26	.\" Set up some character translations and predefined strings. \*(-- will
	27	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
	28	.\" double quote, and \*(R" will give a right double quote. \| will give a
	29	.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
	30	.\" do unbreakable dashes and therefore won't be available. \(C` and \(C'
	31	.\" expand to `' in nroff, nothing in troff, for use with C<>.
	32	.tr \(W-\|\(bv\(Tr
	33	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
	34	.ie n \{\
	35	. ds -- \(*W-
	36	. ds PI pi
	37	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
	38	. if (\n(.H=4u)&(1m=20u) .ds -- \(W\h'-12u'\(W\h'-8u'-\" diablo 12 pitch
	39	. ds L" ""
	40	. ds R" ""
	41	. ds C` ""
	42	. ds C' ""
	43	'br\}
	44	.el\{\
	45	. ds -- \\|\(em\\|
	46	. ds PI \(*p
	47	. ds L" ``
	48	. ds R" ''
	49	'br\}
	50	.\"
	51	.\" If the F register is turned on, we'll generate index entries on stderr for
	52	.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
	53	.\" entries marked with X<> in POD. Of course, you'll have to process the
	54	.\" output yourself in some meaningful fashion.
	55	.if \nF \{\
	56	. de IX
	57	. tm Index:\\$1\t\\n%\t"\\$2"
	58	..
	59	. nr % 0
	60	. rr F
	61	.\}
	62	.\"
	63	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
	64	.\" way too many mistakes in technical documents.
65	.hy 0
66	.if n .na
67	.\"
68	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69	.\" Fear. Run. Save yourself. No user-serviceable parts.
70	. \" fudge factors for nroff and troff
71	.if n \{\
72	. ds #H 0
73	. ds #V .8m
74	. ds #F .3m
75	. ds #[ \f1
76	. ds #] \fP
77	.\}
78	.if t \{\
79	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80	. ds #V .6m
81	. ds #F 0
82	. ds #[ \&
83	. ds #] \&
84	.\}
85	. \" simple accents for nroff and troff
86	.if n \{\
87	. ds ' \&
88	. ds ` \&
89	. ds ^ \&
90	. ds , \&
91	. ds ~ ~
92	. ds /
93	.\}
94	.if t \{\
95	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
96	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
97	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
98	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
99	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
100	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
101	.\}
102	. \" troff and (daisy-wheel) nroff accents
103	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
104	.ds 8 \h'\(#H'\(b\h'-\*(#H'
105	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
106	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
107	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
108	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
109	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
110	.ds ae a\h'-(\w'a'u*4/10)'e
111	.ds Ae A\h'-(\w'A'u*4/10)'E
112	. \" corrections for vroff
113	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
114	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
115	. \" for low resolution devices (crt and lpr)
116	.if \n(.H>23 .if \n(.V>19 \
117	\{\
118	. ds : e
119	. ds 8 ss
120	. ds o a
121	. ds d- d\h'-1'\(ga
122	. ds D- D\h'-1'\(hy
123	. ds th \o'bp'
124	. ds Th \o'LP'
125	. ds ae ae
126	. ds Ae AE
127	.\}
128	.rm #[ #] #H #V #F C
129	.\" ========================================================================
130	.\"
131	.IX Title "Algorithm::DiffOld 3"
132	.TH Algorithm::DiffOld 3 "2002-03-24" "perl v5.8.0" "User Contributed Perl Documentation"
133	.SH "NAME"
134	Algorithm::DiffOld \- Compute `intelligent' differences between two files / lists
135	but use the old (<=0.59) interface.
136	.SH "NOTE"
137	.IX Header "NOTE"
138	This has been provided as part of the Algorithm::Diff package by Ned Konz.
139	This particular module is \fB\s-1ONLY\s0\fR for people who \fB\s-1HAVE\s0\fR to have the old
140	interface, which uses a comparison function rather than a key generating
141	function.
142	.PP
143	Because each of the lines in one array have to be compared with each
144	of the lines in the other array, this does M*N comparisions. This can
145	be very slow. I clocked it at taking 18 times as long as the stock
146	version of Algorithm::Diff for a 4000\-line file. It will get worse
147	quadratically as array sizes increase.
148	.SH "SYNOPSIS"
149	.IX Header "SYNOPSIS"
150	.Vb 1
151	\& use Algorithm::DiffOld qw(diff LCS traverse_sequences);
152	.Ve
153	.PP
154	.Vb 1
155	\& @lcs = LCS( \e@seq1, \e@seq2, $comparison_function );
156	.Ve
157	.PP
158	.Vb 1
159	\& $lcsref = LCS( \e@seq1, \e@seq2, $comparison_function );
160	.Ve
161	.PP
162	.Vb 1
163	\& @diffs = diff( \e@seq1, \e@seq2, $comparison_function );
164	.Ve
165	.PP
166	.Vb 6
167	\& traverse_sequences( \e@seq1, \e@seq2,
168	\& { MATCH => $callback,
169	\& DISCARD_A => $callback,
170	\& DISCARD_B => $callback,
171	\& },
172	\& $comparison_function );
173	.Ve
174	.SH "COMPARISON FUNCTIONS"
175	.IX Header "COMPARISON FUNCTIONS"
176	Each of the main routines should be passed a comparison function. If you
177	aren't passing one in, \fBuse Algorithm::Diff instead\fR.
178	.PP
179	These functions should return a true value when two items should compare
180	as equal.
181	.PP
182	For instance,
183	.PP
184	.Vb 1
185	\& @lcs = LCS( \e@seq1, \e@seq2, sub { my ($a, $b) = @_; $a eq $b } );
186	.Ve
187	.PP
188	but if that is all you're doing with your comparison function, just use
189	Algorithm::Diff and let it do this (this is its default).
190	.PP
191	Or:
192	.PP
193	.Vb 5
194	\& sub someFunkyComparisonFunction
195	\& {
196	\& my ($a, $b) = @_;
197	\& $a =~ m{$b};
198	\& }
199	.Ve
200	.PP
201	.Vb 1
202	\& @diffs = diff( \e@lines, \e@patterns, \e&someFunkyComparisonFunction );
203	.Ve
204	.PP
205	which would allow you to diff an array \f(CW@lines\fR which consists of text
206	lines with an array \f(CW@patterns\fR which consists of regular expressions.
207	.PP
208	This is actually the reason I wrote this version \*(-- there is no way
209	to do this with a key generation function as in the stock Algorithm::Diff.