2015-02-24 21:42:05 +00:00
|
|
|
jellyfish |release|
|
|
|
|
|
===================
|
|
|
|
|
|
|
|
|
|
Overview
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
jellyfish is a library of functions for approximate and phonetic matching of strings.
|
|
|
|
|
|
2015-02-25 20:49:26 +00:00
|
|
|
The library provides implementations of the following algorithms:
|
2015-02-24 21:42:05 +00:00
|
|
|
|
2015-02-25 20:49:26 +00:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 3
|
2015-02-24 21:42:05 +00:00
|
|
|
|
2015-02-25 20:49:26 +00:00
|
|
|
phonetic
|
|
|
|
|
stemming
|
|
|
|
|
comparison
|
2015-04-22 19:53:14 +00:00
|
|
|
changelog
|
2015-02-24 21:42:05 +00:00
|
|
|
|
2015-02-25 20:49:26 +00:00
|
|
|
Implementation
|
|
|
|
|
--------------
|
2015-02-24 21:42:05 +00:00
|
|
|
|
2015-02-27 06:02:37 +00:00
|
|
|
Each algorithm has C and Python implementations.
|
2015-02-24 21:42:05 +00:00
|
|
|
|
2016-11-17 22:54:18 +00:00
|
|
|
On a typical CPython install the C implementation will be used. The Python versions
|
|
|
|
|
are available for PyPy and systems where compiling the CPython extension is not
|
|
|
|
|
possible.
|
|
|
|
|
|
|
|
|
|
To explicitly use a specific implementation, refer to the appropriate module::
|
|
|
|
|
|
|
|
|
|
import jellyfish._jellyfish as pyjellyfish
|
|
|
|
|
import jellyfish.cjellyfish as cjellyfish
|
2015-02-24 21:42:05 +00:00
|
|
|
|
2016-11-21 16:24:42 +00:00
|
|
|
If you've already imported jellyfish and are not sure what implementation you
|
|
|
|
|
are using, you can check by querying ``jellyfish.library``::
|
|
|
|
|
|
|
|
|
|
if jellyfish.library == 'Python':
|
|
|
|
|
# Python implementation
|
|
|
|
|
elif jellyfish.library == 'C':
|
|
|
|
|
# C implementation
|
|
|
|
|
|
2015-02-24 21:42:05 +00:00
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
