wasmer/rustdoc/strsim/index.html
2019-09-06 15:57:44 -07:00

20 lines
7.0 KiB
HTML
Raw Permalink 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="API documentation for the Rust `strsim` crate."><meta name="keywords" content="rust, rustlang, rust-lang, strsim"><title>strsim - Rust</title><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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../strsim/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate strsim</p><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><p class='location'></p><script>window.sidebarCurrent = {name: 'strsim', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><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><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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-786' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>strsim</a></span></h1><div class='docblock'><p>This library implements string similarity metrics.</p>
</div><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.StrSimError.html" title='strsim::StrSimError enum'>StrSimError</a></td><td class='docblock-short'></td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.damerau_levenshtein.html" title='strsim::damerau_levenshtein fn'>damerau_levenshtein</a></td><td class='docblock-short'><p>Like optimal string alignment, but substrings can be edited an unlimited
number of times, and the triangle inequality holds.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.hamming.html" title='strsim::hamming fn'>hamming</a></td><td class='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>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.jaro.html" title='strsim::jaro fn'>jaro</a></td><td class='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>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.jaro_winkler.html" title='strsim::jaro_winkler fn'>jaro_winkler</a></td><td class='docblock-short'><p>Like Jaro but gives a boost to strings that have a common prefix.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.levenshtein.html" title='strsim::levenshtein fn'>levenshtein</a></td><td class='docblock-short'><p>Calculates the minimum number of insertions, deletions, and substitutions
required to change one string into the other.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.normalized_damerau_levenshtein.html" title='strsim::normalized_damerau_levenshtein fn'>normalized_damerau_levenshtein</a></td><td class='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>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.normalized_levenshtein.html" title='strsim::normalized_levenshtein fn'>normalized_levenshtein</a></td><td class='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>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.osa_distance.html" title='strsim::osa_distance fn'>osa_distance</a></td><td class='docblock-short'><p>Like Levenshtein but allows for adjacent transpositions. Each substring can
only be edited once.</p>
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table><tr class='module-item'><td><a class="type" href="type.HammingResult.html" title='strsim::HammingResult type'>HammingResult</a></td><td class='docblock-short'></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "strsim";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>