Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/datahappy1/go_fuzzymatch

Go fuzzy matching tool using Levenshtein distance calculation
https://github.com/datahappy1/go_fuzzymatch

fuzzy fuzzy-matcher fuzzy-search golang levenshtein-distance

Last synced: about 1 month ago
JSON representation

Go fuzzy matching tool using Levenshtein distance calculation

Host: GitHub
URL: https://github.com/datahappy1/go_fuzzymatch
Owner: datahappy1
License: mit
Created: 2021-01-05T23:10:16.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2021-05-12T08:05:26.000Z (over 3 years ago)
Last Synced: 2024-10-15T06:37:00.729Z (3 months ago)
Topics: fuzzy, fuzzy-matcher, fuzzy-search, golang, levenshtein-distance
Language: Go
Homepage:
Size: 60.5 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # go_fuzzymatch

[![Go Report Card](https://goreportcard.com/badge/github.com/datahappy1/go_fuzzymatch)](https://goreportcard.com/report/github.com/datahappy1/go_fuzzymatch)

![Go](https://github.com/datahappy1/go_fuzzymatch/workflows/Go/badge.svg)

## description:

Fuzzy matching CLI tool written in Go. The string distance matching calculation is done using [Levenshtein distance algorithm](https://en.wikipedia.org/wiki/Levenshtein_distance). 

This tool implicitly formats the input strings using these actions:

- applies lowercase

- processes only alphabetical chars and digits

- in case the input string can be split by whitespace into an array of words, the array items are deduplicated  

This tool is able to operate in three modes:

- `simple` mode

- `deepDive` mode

- `combined` mode

### simple mode:

> simple mode is faster but less precise when comparing multi-word strings.

Example results in `simple` mode:

|string 1  |string 2  |calculated output  |

|---|---|---|

|apple inc|apple inc|100|

|apple inc|Apple Inc.|100|

|Apple|Apple Inc.|100|

|Apple Inc|Apple|100|

|aplle|Apple|80|

|Apple Corp.|Apple Corp. GMBH|80|

|GMBH Apple Corp|Apple Inc.|58|

|apple Inc.|GMBH Apple Corp.|58|

|aplle Inc.|GMBH Apple Corp.|50|

### deepDive mode:

> deepDive mode is slower but goes more in depth when comparing multi-word strings using permutations. 

> In this mode, if provided with two single word strings for comparison, the tool evaluates the strings like in simple mode.

Example results in `deepDive` mode:

|string 1  |string 2  |calculated output  |

|---|---|---|

|apple inc|apple inc|100|

|apple inc|Apple Inc.|100|

|Apple|Apple Inc.|100|

|Apple Inc|Apple|100|

|aplle|Apple|80|

|Apple Corp.|Apple Corp. GMBH|**100**|

|GMBH Apple Corp|Apple Inc.|**73**|

|apple Inc.|GMBH Apple Corp.|**73**|

|aplle Inc.|GMBH Apple Corp.|**63**|

### combined mode:

> combined mode starts strings evaluation using simple mode and if no match above `85` is found, it evaluates the strings again in a deepDive mode.

## how to run as a Command line tool:

`go run cmd\go_fuzzymatch\fuzzy_match.go -string1="apple" -string2="Apple inc." -mode=simple|deepDive|combined`