abydos.distance._distance

Complexity

Total Complexity

7

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Test Coverage

Coverage

94.44%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	TokenDistance._get_qgrams()	0	25	4
A	Distance.sim()	0	14	1
A	Distance.dist()	0	14	1
A	Distance.dist_abs()	0	14	1

# -*- coding: utf-8 -*-

# Copyright 2018 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._distance.

The distance._distance module implements abstract class Distance.
"""

from __future__ import unicode_literals

from collections import Counter

from ..tokenizer import QGrams


class Distance(object):

The variable __class__ seems to be unused.

    """Abstract Distance class."""

    def sim(self, src, tar, *args, **kwargs):
        """Return similarity.

        Args:
            src (str): Source string for comparison
            tar (str): Target string for comparison
            *args: Variable length argument list.
            **kwargs: Arbitrary keyword arguments.

        Returns:
            float: Similarity

        """
        return 1.0 - self.dist(src, tar, *args, **kwargs)

    def dist(self, src, tar, *args, **kwargs):
        """Return distance.

        Args:
            src (str): Source string for comparison
            tar (str): Target string for comparison
            *args: Variable length argument list.
            **kwargs: Arbitrary keyword arguments.

        Returns:
            float: Distance

        """
        return 1.0 - self.sim(src, tar, *args, **kwargs)

    def dist_abs(self, src, tar, *args, **kwargs):
        """Return absolute distance.

        Args:
            src (str): Source string for comparison
            tar (str): Target string for comparison
            *args: Variable length argument list.
            **kwargs: Arbitrary keyword arguments.

        Returns:
            int: Absolute distance

        """
        return self.dist(src, tar, *args, **kwargs)


class TokenDistance(Distance):

The variable __class__ seems to be unused.

    """Abstract Token Distance class."""

    def _get_qgrams(self, src, tar, qval=0, skip=0):

This method could be written as a function/class method.

        """Return the Q-Grams in src & tar.

        Args:
            src (str): Source string (or QGrams/Counter objects) for comparison
            tar (str): Target string (or QGrams/Counter objects) for comparison
            qval (int): The length of each q-gram; 0 for non-q-gram version
            skip (int): the number of characters to skip (only works when src
                and tar are strings

        Returns:
            tuple of Counters: Q-Grams

        Examples:
            >>> pe = TokenDistance()
            >>> pe._get_qgrams('AT', 'TT', qval=2)
            (QGrams({'$A': 1, 'AT': 1, 'T#': 1}),
             QGrams({'$T': 1, 'TT': 1, 'T#': 1}))

        """
        if isinstance(src, Counter) and isinstance(tar, Counter):
            return src, tar
        if qval > 0:
            return QGrams(src, qval, '$#', skip), QGrams(tar, qval, '$#', skip)
        return Counter(src.strip().split()), Counter(tar.strip().split())


if __name__ == '__main__':
    import doctest

    doctest.testmod()