# Copyright 2014-2020 by Christopher C. Little.
# This file is part of Abydos.
#
# Abydos is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Abydos is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Abydos. If not, see <http://www.gnu.org/licenses/>.
"""abydos.distance._ident.
Identity similarity & distance
"""
from deprecation import deprecated
from ._distance import _Distance
from .. import __version__
__all__ = ['Ident', 'dist_ident', 'sim_ident']
[docs]class Ident(_Distance):
"""Identity distance and similarity.
.. versionadded:: 0.3.6
"""
[docs] def sim(self, src, tar):
"""Return the identity similarity of two strings.
Identity similarity is 1.0 if the two strings are identical,
otherwise 0.0
Parameters
----------
src : str
Source string for comparison
tar : str
Target string for comparison
Returns
-------
float
Identity similarity
Examples
--------
>>> cmp = Ident()
>>> cmp.sim('cat', 'hat')
0.0
>>> cmp.sim('cat', 'cat')
1.0
.. versionadded:: 0.1.0
.. versionchanged:: 0.3.6
Encapsulated in class
"""
return 1.0 if src == tar else 0.0
[docs]@deprecated(
deprecated_in='0.4.0',
removed_in='0.6.0',
current_version=__version__,
details='Use the Ident.sim method instead.',
)
def sim_ident(src, tar):
"""Return the identity similarity of two strings.
This is a wrapper for :py:meth:`Ident.sim`.
Parameters
----------
src : str
Source string for comparison
tar : str
Target string for comparison
Returns
-------
float
Identity similarity
Examples
--------
>>> sim_ident('cat', 'hat')
0.0
>>> sim_ident('cat', 'cat')
1.0
.. versionadded:: 0.1.0
"""
return Ident().sim(src, tar)
[docs]@deprecated(
deprecated_in='0.4.0',
removed_in='0.6.0',
current_version=__version__,
details='Use the Ident.dist method instead.',
)
def dist_ident(src, tar):
"""Return the identity distance between two strings.
This is a wrapper for :py:meth:`Ident.dist`.
Parameters
----------
src : str
Source string for comparison
tar : str
Target string for comparison
Returns
-------
float
Identity distance
Examples
--------
>>> dist_ident('cat', 'hat')
1.0
>>> dist_ident('cat', 'cat')
0.0
.. versionadded:: 0.1.0
"""
return Ident().dist(src, tar)
if __name__ == '__main__':
import doctest
doctest.testmod()