# Copyright 2019-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._michelet.
Michelet similarity
"""
from ._token_distance import _TokenDistance
__all__ = ['Michelet']
[docs]class Michelet(_TokenDistance):
r"""Michelet similarity.
For two sets X and Y and a population N, Michelet similarity
:cite:`Turner:1988` is
.. math::
sim_{Michelet}(X, Y) =
\frac{|X \cap Y|^2}{|X| \cdot |Y|}
In :ref:`2x2 confusion table terms <confusion_table>`, where a+b+c+d=n,
this is
.. math::
sim_{Michelet} =
\frac{a^2}{(a+b)(a+c)}
Following :cite:`SequentiX:2018`, this is termed "Michelet", though
Turner is most often listed as the first author in papers presenting this
measure.
.. versionadded:: 0.4.0
"""
def __init__(self, tokenizer=None, intersection_type='crisp', **kwargs):
"""Initialize Michelet instance.
Parameters
----------
tokenizer : _Tokenizer
A tokenizer instance from the :py:mod:`abydos.tokenizer` package
intersection_type : str
Specifies the intersection type, and set type as a result:
See :ref:`intersection_type <intersection_type>` description in
:py:class:`_TokenDistance` for details.
**kwargs
Arbitrary keyword arguments
Other Parameters
----------------
qval : int
The length of each q-gram. Using this parameter and tokenizer=None
will cause the instance to use the QGram tokenizer with this
q value.
metric : _Distance
A string distance measure class for use in the ``soft`` and
``fuzzy`` variants.
threshold : float
A threshold value, similarities above which are counted as
members of the intersection for the ``fuzzy`` variant.
.. versionadded:: 0.4.0
"""
super(Michelet, self).__init__(
tokenizer=tokenizer, intersection_type=intersection_type, **kwargs
)
[docs] def sim(self, src, tar):
"""Return the Michelet similarity of two strings.
Parameters
----------
src : str
Source string (or QGrams/Counter objects) for comparison
tar : str
Target string (or QGrams/Counter objects) for comparison
Returns
-------
float
Michelet similarity
Examples
--------
>>> cmp = Michelet()
>>> cmp.sim('cat', 'hat')
0.25
>>> cmp.sim('Niall', 'Neil')
0.13333333333333333
>>> cmp.sim('aluminum', 'Catalan')
0.013888888888888888
>>> cmp.sim('ATCG', 'TAGC')
0.0
.. versionadded:: 0.4.0
"""
if src == tar:
return 1.0
self._tokenize(src, tar)
a = self._intersection_card()
apb = self._src_card()
apc = self._tar_card()
if not a:
return 0.0
return a * a / (apb * apc)
if __name__ == '__main__':
import doctest
doctest.testmod()