edlang/strsim/index.html
2024-02-13 06:38:44 +00:00

16 lines
8.7 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."><title>strsim - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="strsim" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../strsim/index.html">strsim</a><span class="version">0.11.0</span></h2></div><div class="sidebar-elems"><ul class="block">
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../strsim/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">strsim</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/strsim/lib.rs.html#1-1307">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="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="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.StrSimError.html" title="enum strsim::StrSimError">StrSimError</a></div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.damerau_levenshtein.html" title="fn strsim::damerau_levenshtein">damerau_levenshtein</a></div><div class="desc docblock-short">Like optimal string alignment, but substrings can be edited an unlimited
number of times, and the triangle inequality holds.</div></li><li><div class="item-name"><a class="fn" href="fn.generic_damerau_levenshtein.html" title="fn strsim::generic_damerau_levenshtein">generic_damerau_levenshtein</a></div><div class="desc docblock-short">Like optimal string alignment, but substrings can be edited an unlimited
number of times, and the triangle inequality holds.</div></li><li><div class="item-name"><a class="fn" href="fn.generic_hamming.html" title="fn strsim::generic_hamming">generic_hamming</a></div><div class="desc docblock-short">Calculates the number of positions in the two sequences where the elements
differ. Returns an error if the sequences have different lengths.</div></li><li><div class="item-name"><a class="fn" href="fn.generic_jaro.html" title="fn strsim::generic_jaro">generic_jaro</a></div><div class="desc docblock-short">Calculates the Jaro similarity between two sequences. The returned value
is between 0.0 and 1.0 (higher value means more similar).</div></li><li><div class="item-name"><a class="fn" href="fn.generic_jaro_winkler.html" title="fn strsim::generic_jaro_winkler">generic_jaro_winkler</a></div><div class="desc docblock-short">Like Jaro but gives a boost to sequences that have a common prefix.</div></li><li><div class="item-name"><a class="fn" href="fn.generic_levenshtein.html" title="fn strsim::generic_levenshtein">generic_levenshtein</a></div><div class="desc docblock-short">Calculates the minimum number of insertions, deletions, and substitutions
required to change one sequence into the other.</div></li><li><div class="item-name"><a class="fn" href="fn.hamming.html" title="fn strsim::hamming">hamming</a></div><div class="desc docblock-short">Calculates the number of positions in the two strings where the characters
differ. Returns an error if the strings have different lengths.</div></li><li><div class="item-name"><a class="fn" href="fn.jaro.html" title="fn strsim::jaro">jaro</a></div><div class="desc docblock-short">Calculates the Jaro similarity between two strings. The returned value
is between 0.0 and 1.0 (higher value means more similar).</div></li><li><div class="item-name"><a class="fn" href="fn.jaro_winkler.html" title="fn strsim::jaro_winkler">jaro_winkler</a></div><div class="desc docblock-short">Like Jaro but gives a boost to strings that have a common prefix.</div></li><li><div class="item-name"><a class="fn" href="fn.levenshtein.html" title="fn strsim::levenshtein">levenshtein</a></div><div class="desc docblock-short">Calculates the minimum number of insertions, deletions, and substitutions
required to change one string into the other.</div></li><li><div class="item-name"><a class="fn" href="fn.normalized_damerau_levenshtein.html" title="fn strsim::normalized_damerau_levenshtein">normalized_damerau_levenshtein</a></div><div class="desc docblock-short">Calculates a normalized score of the DamerauLevenshtein algorithm between
0.0 and 1.0 (inclusive), where 1.0 means the strings are the same.</div></li><li><div class="item-name"><a class="fn" href="fn.normalized_levenshtein.html" title="fn strsim::normalized_levenshtein">normalized_levenshtein</a></div><div class="desc docblock-short">Calculates a normalized score of the Levenshtein algorithm between 0.0 and
1.0 (inclusive), where 1.0 means the strings are the same.</div></li><li><div class="item-name"><a class="fn" href="fn.osa_distance.html" title="fn strsim::osa_distance">osa_distance</a></div><div class="desc docblock-short">Like Levenshtein but allows for adjacent transpositions. Each substring can
only be edited once.</div></li><li><div class="item-name"><a class="fn" href="fn.sorensen_dice.html" title="fn strsim::sorensen_dice">sorensen_dice</a></div><div class="desc docblock-short">Calculates a Sørensen-Dice similarity distance using bigrams.
See <a href="https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient">https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient</a>.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.HammingResult.html" title="type strsim::HammingResult">HammingResult</a></div></li></ul></section></div></main></body></html>