NAME

Text::Same::ChunkPair

DESCRIPTION

A class representing a pair of chunk indexes (generally line numbers)

SYNOPSIS

  my $pair = new Text::Same::ChunkPair($chunk_index1, $chunk_index2);

METHODS

See below. Methods private to this module are prefixed by an underscore.

new

 Title   : new
 Usage   : $pair = new Text::Same::ChunkPair($chunk_index1, $chunk_index2);
 Function: Creates a new ChunkPair object from two chunk indexes
 Returns : A Text::Same::ChunkPair object
 Args    : two chunk indexes

chunk_index1

 Title   : chunk_index1
 Usage   : my $chunk_index = $pair->chunk_index1;
 Function: return the first chunk_index of this ChunkPair
 Args    : none

chunk_index2

 Title   : chunk_index2
 Usage   : my $chunk_index = $pair->chunk_index2;
 Function: return the second chunk_index of this ChunkPair
 Args    : none

packed_pair

 Title   : packed_pair
 Usage   : my $packed_pair = $chunk_pair->packed_pair();
 Function: return a packed representation of this ChunkPair by pack()ing
           index1 and index2 into a string
 Args    : none

make_packed_pair

 Title   : make_packed_pair
 Usage   : my $packed_pair = $chunk_pair->make_packed_pair($index1, $index2);
 Function: return a packed representation of the pair of indexes by pack()ing
           them into a string
 Args    : two indexes

as_string

 Title   : as_string
 Usage   : my $str = $match->as_string
 Function: return a string representation of this ChunkPair
 Args    : none

AUTHOR

Kim Rutherford <kmr+same@xenu.org.uk>

COPYRIGHT & LICENSE

Copyright 2005,2006 Kim Rutherford. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

DISCLAIMER

This module is provided "as is" without warranty of any kind. It may redistributed under the same conditions as Perl itself.