This repository has been archived on 2022-04-04. You can view files and clone it, but cannot push or open issues or pull requests.

34 lines
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="This library implements string similarity metrics."><meta name="keywords" content="rust, rustlang, rust-lang, strsim"><title>strsim - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a class="sidebar-logo" href="../strsim/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
</a><h2 class="location">Crate strsim</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.10.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all strsim's items</p></a><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><div id="sidebar-vars" data-name="strsim" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../strsim/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">strsim</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/strsim/lib.rs.html#1-1005" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This library implements string similarity metrics.</p>
</div></details><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.StrSimError.html" title="strsim::StrSimError enum">StrSimError</a></div><div class="item-right docblock-short"></div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.damerau_levenshtein.html" title="strsim::damerau_levenshtein fn">damerau_levenshtein</a></div><div class="item-right docblock-short"><p>Like optimal string alignment, but substrings can be edited an unlimited
number of times, and the triangle inequality holds.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.generic_damerau_levenshtein.html" title="strsim::generic_damerau_levenshtein fn">generic_damerau_levenshtein</a></div><div class="item-right docblock-short"><p>Like optimal string alignment, but substrings can be edited an unlimited
number of times, and the triangle inequality holds.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.generic_hamming.html" title="strsim::generic_hamming fn">generic_hamming</a></div><div class="item-right docblock-short"><p>Calculates the number of positions in the two sequences where the elements
differ. Returns an error if the sequences have different lengths.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.generic_jaro.html" title="strsim::generic_jaro fn">generic_jaro</a></div><div class="item-right docblock-short"><p>Calculates the Jaro similarity between two sequences. The returned value
is between 0.0 and 1.0 (higher value means more similar).</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.generic_jaro_winkler.html" title="strsim::generic_jaro_winkler fn">generic_jaro_winkler</a></div><div class="item-right docblock-short"><p>Like Jaro but gives a boost to sequences that have a common prefix.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.generic_levenshtein.html" title="strsim::generic_levenshtein fn">generic_levenshtein</a></div><div class="item-right docblock-short"><p>Calculates the minimum number of insertions, deletions, and substitutions
required to change one sequence into the other.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.hamming.html" title="strsim::hamming fn">hamming</a></div><div class="item-right docblock-short"><p>Calculates the number of positions in the two strings where the characters
differ. Returns an error if the strings have different lengths.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.jaro.html" title="strsim::jaro fn">jaro</a></div><div class="item-right docblock-short"><p>Calculates the Jaro similarity between two strings. The returned value
is between 0.0 and 1.0 (higher value means more similar).</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.jaro_winkler.html" title="strsim::jaro_winkler fn">jaro_winkler</a></div><div class="item-right docblock-short"><p>Like Jaro but gives a boost to strings that have a common prefix.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.levenshtein.html" title="strsim::levenshtein fn">levenshtein</a></div><div class="item-right docblock-short"><p>Calculates the minimum number of insertions, deletions, and substitutions
required to change one string into the other.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.normalized_damerau_levenshtein.html" title="strsim::normalized_damerau_levenshtein fn">normalized_damerau_levenshtein</a></div><div class="item-right docblock-short"><p>Calculates a normalized score of the DamerauLevenshtein algorithm between
0.0 and 1.0 (inclusive), where 1.0 means the strings are the same.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.normalized_levenshtein.html" title="strsim::normalized_levenshtein fn">normalized_levenshtein</a></div><div class="item-right docblock-short"><p>Calculates a normalized score of the Levenshtein algorithm between 0.0 and
1.0 (inclusive), where 1.0 means the strings are the same.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.osa_distance.html" title="strsim::osa_distance fn">osa_distance</a></div><div class="item-right docblock-short"><p>Like Levenshtein but allows for adjacent transpositions. Each substring can
only be edited once.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sorensen_dice.html" title="strsim::sorensen_dice fn">sorensen_dice</a></div><div class="item-right docblock-short"><p>Calculates a Sørensen-Dice similarity distance using bigrams.
See http://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient.</p>
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.HammingResult.html" title="strsim::HammingResult type">HammingResult</a></div><div class="item-right docblock-short"></div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="strsim" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
</body></html>