Metadata-Version: 2.1
Name: binsdpy
Version: 0.1.0
Summary: Python implementation of binary similarity and distance measures.
Home-page: https://github.com/mikulatomas/binsdpy
Author: Tomáš Mikula
Author-email: mail@tomasmikula.cz
License: MIT license
Description: [![build](https://github.com/mikulatomas/binsdpy/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/mikulatomas/binsdpy/actions/workflows/build.yml?query=branch%3Amain)
        [![codecov](https://codecov.io/gh/mikulatomas/binsdpy/branch/main/graph/badge.svg?token=HI1I1OVOXK)](https://codecov.io/gh/mikulatomas/binsdpy)
        [![PyPI version](https://badge.fury.io/py/binsdpy.svg)](https://badge.fury.io/py/binsdpy)
        [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
        
        # binsdpy - binary similarity and distance measures
        Python implementation of binary similarity and distance measures (see [1]). The `bitsets` (immutable ordered set data type) and `numpy.ndarray` are suported as feature vectors.
        
        ## Example
        Example based on `bitsets`:
        ```python
        from bitsets import bitset
        from binsdpy.similarity import jaccard
        from binsdpy.distance import euclid
        
        Colors = bitset("Colors", ("red", "blue", "green", "yellow"))
        
        a = Colors.frommembers(["red", "blue"])
        b = Colors.frommembers(["red", "yellow"])
        
        jaccard(a, b)
        # > 0.3333333333333333
        euclid(a, b)
        # > 1.4142135623730951
        ```
        
        Example based on `np.ndarray`:
        ```python
        import numpy as np
        from binsdpy.similarity import jaccard
        from binsdpy.distance import euclid
        
        a = np.array([1, 1, 0, 0], dtype=bool)
        b = np.array([1, 0, 0, 1], dtype=bool)
        
        jaccard(a, b)
        # > 0.3333333333333333
        euclid(a, b)
        # > 1.4142135623730951
        ```
        
        ## Installation
        Package is avaliable in alpha version via `pip`.
        
        ```bash
        $ pip install binsdpy
        ```
        
        ## Dependencies
        binsdpy requires:
        
        * Python (>= 3.6)
        * bitset
        * numpy
        
        ## Reference
        > [1] Choi, S. S., Cha, S. H., & Tappert, C. C. (2010). A survey of binary similarity and distance measures. Journal of systemics, cybernetics and informatics, 8(1), 43-48.
        http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.352.6123&rep=rep1&type=pdf
        
        
Keywords: binary similarity distance measure
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
