Metadata-Version: 2.1
Name: tinyalign
Version: 0.3.dev2
Summary: Fast banded edit distance
Home-page: https://github.com/marcelm/tinyalign/
Author: Marcel Martin
Author-email: marcel.martin@scilifelab.se
License: MIT
Description: [![CI](https://github.com/marcelm/tinyalign/actions/workflows/ci.yml/badge.svg)](https://github.com/marcelm/tinyalign/actions/workflows/ci.yml)
        
        
        # tinyalign
        
        A small Python module providing edit distance (aka Levenshtein distance, that
        is, counting insertions, deletions and substitutions) and Hamming distance
        computation.
        
        Its main purpose is to speed up computation of edit distance by
        allowing to specify a maximum number of differences `maxdiff` (banding). If
        that parameter is provided, the returned edit distance is anly accurate up to
        `maxdiff`. That is, if the actual edit distance is higher than `maxdiff`, a
        value larger than `maxdiff` is returned, but not necessarily the actual edit
        distance.
        
        For computing regular edit distances or if your *maxdiff* is less than 4, you
        should prefer [https://github.com/fujimotos/polyleven](polyleven), as that is
        faster in that case. When `maxdiff` is 4 or more, but not too close to the
        length of the shortest string, this module is faster.
        
        ```
        >>> from tinyalign import edit_distance, hamming_distance
        >>> edit_distance("banana", "ananas")
        2
        >>> hamming_distance("hello", "yello")
        1
        >>> edit_distance("hello", "world", maxdiff=2)
        3
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.6
Description-Content-Type: text/markdown
