NAME
    Text::Levenshtein::XS - Calculate edit distance based on insertion,
    deletion, substitution, and transposition

VERSION
    version 0.43

SYNOPSIS
        use Text::Levenshtein::XS qw/distance/;

        print distance('Neil','Niel');
        # prints 2

DESCRIPTION
    Returns the number of edits (insert,delete,substitute) required to turn
    the source string into the target string. XS implementation (requires a
    C compiler). Works correctly with utf8.

        use Text::Levenshtein::XS qw/distance/;
        use utf8;

        distance('ⓕⓞⓤⓡ','ⓕⓤⓞⓡ'), 
        # prints 2

METHODS
  distance
    Arguments: $source_text, $target_text, (optional) $max_distance
    Return Value: Int $edit_distance || undef (if max_distance is exceeded)

    Returns: int that represents the edit distance between the two argument,
    or undef if $max_distance threshold is exceeded.

    Takes the edit distance between a source and target string using XS 2
    vector implementation.

        use Text::Levenshtein::XS qw/distance/;
        print distance('Neil','Niel');
        # prints 2

    Stops calculations and returns undef if $max_distance is set, non-zero
    (0 = no limit), and the algorithm has determined the final distance will
    be greater than $max_distance.

        my $distance = distance('Neil','Niel',1);
        print (defined $distance) ? $distance : "Exceeded max distance";
        # prints "Exceeded max distance"

NOTES
    Drop in replacement for Text::LevenshteinXS

SEE ALSO
    *   Text::Levenshtein::Damerau

    *   Text::Levenshtein::Damerau::PP

    *   Text::Levenshtein::Damerau::XS

    *   Text::Fuzzy

    *   Text::Levenshtein::Flexible

REPOSITORY
    <https://github.com/ugexe/Text--Levenshtein--XS>

BUGS
    Please report bugs to:

    <https://github.com/ugexe/Text--Levenshtein--XS/issues>

AUTHOR
    ugexe <ugexe@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2014 by Nick Logan.

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

