Dandraka.FuzzySubstringSearch 1.0.5

There is a newer version of this package available.
See the version list below for details.
dotnet add package Dandraka.FuzzySubstringSearch --version 1.0.5
NuGet\Install-Package Dandraka.FuzzySubstringSearch -Version 1.0.5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Dandraka.FuzzySubstringSearch" Version="1.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Dandraka.FuzzySubstringSearch --version 1.0.5
#r "nuget: Dandraka.FuzzySubstringSearch, 1.0.5"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Dandraka.FuzzySubstringSearch as a Cake Addin
#addin nuget:?package=Dandraka.FuzzySubstringSearch&version=1.0.5

// Install Dandraka.FuzzySubstringSearch as a Cake Tool
#tool nuget:?package=Dandraka.FuzzySubstringSearch&version=1.0.5

FuzzySubstringSearch

Implements n-gram matching in a string, returning a match percentage in the range of 0-100. Search is always case-insensitive.

Example:

using Dandraka.FuzzySubstringSearch;

public void FuzzySubstringSearchExample
{
	var g = new LookingGlass(true); // true = sequential mode on

	int m1 = g.NGram("I'm wearing hedphones now", "headphones", 2);
	Console.WriteLine(m1.ToString()); // 78

	int m2 = g.NGram(@"C:\Users\myuser\OneDrive\LookingGlass Project Team", "MYUSER");
	Console.WriteLine(m2.ToString()); // 100
}

What does 'Sequential Mode' mean?

Sequential mode, in this context, means that as soon as a part of search string is found, subsequect searches look only for the rest of the search string.

For example, when sequential is true, this is what happens when searching for 'cell' in target 'ball center' with 2-grams:

The word 'cell' has 3 x 2-grams: ce, el, ll.

Target 2-gram Is match
ba No
al No
ll Yes: matches ll, the 3rd 2-gram.
l[space] No
[space]c No
ce No: it could match ce but this is the 1st 2-gram, we've already found the 3rd and sequential is on.
en No
nt No
te No
er No

So the result is 1 match / 3 total = 33%.

When sequential is false this restriction does not apply:

Target 2-gram Is match
ba No
al No
ll Yes: matches ll, the 3rd 2-gram.
l[space] No
[space]c No
ce Yes: matches ce, the 1st 2-gram.
en No
nt No
te No
er No

So the result is 2 matches / 3 total = 67%.

Dandraka.FuzzySubstringSearch assembly

Dandraka.FuzzySubstringSearch namespace

public type description
class [LookingGlass] N-gram case-insensitive text search.

LookingGlass class

N-gram case-insensitive text search.

public class LookingGlass

Public Members

name description
[LookingGlass] Creates a LookingGlass instance with sequential search.
[LookingGlass] Creates a LookingGlass instance.
[NGram] Performs an N-gram case-insensitive search.

See Also

  • namespace [Dandraka.FuzzySubstringSearch]

LookingGlass constructor

Creates a LookingGlass instance with sequential search.

public LookingGlass()

See Also

  • class [LookingGlass]
  • namespace [Dandraka.FuzzySubstringSearch]

LookingGlass constructor

Creates a LookingGlass instance.

public LookingGlass(bool isSequential)
parameter description
isSequential Defines if search is limited to sequencial mode.

See Also

  • class [LookingGlass]
  • namespace [Dandraka.FuzzySubstringSearch]

LookingGlass.NGram method

Performs an N-gram case-insensitive search.

public int NGram(string TargetString, string SearchString, int NGramSize)
parameter description
TargetString The string in which search is being performed. Must not be null or empty.
SearchString The string sought within the target string. Must not be null or empty.
NGramSize The n-gram size, usually 2 or 3. Default is 3. Must be less or equal than the minimum of TargetString and SearchString length.

Return Value

An integer number between 0 and 100. Zero means that no part of the search string was found. 100 means that the search string was found verbatim.

See Also

  • class [LookingGlass]
  • namespace [Dandraka.FuzzySubstringSearch]
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.6 88 4/17/2024
1.0.5 76 4/17/2024
1.0.4 92 4/17/2024
1.0.3 100 4/17/2024
1.0.0 85 4/16/2024

Added tests and README with examples.