| <!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="Build a deterministic finite automaton (DFA) that computes the levenshtein distance from a given string."><meta name="keywords" content="rust, rustlang, rust-lang, levenshtein_automata"><title>levenshtein_automata - 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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer 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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../levenshtein_automata/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../levenshtein_automata/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate levenshtein_automata</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.2.1</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">levenshtein_automata</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></h1><span class="out-of-band"><a class="srclink" href="../src/levenshtein_automata/lib.rs.html#1-112">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Build a deterministic finite automaton (DFA) that computes |
| the levenshtein distance from a given string.</p> |
| <h2 id="example"><a href="#example">Example</a></h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>levenshtein_automata::{LevenshteinAutomatonBuilder, Distance}; |
| |
| <span class="comment">// Building this factory is not free. |
| </span><span class="kw">let </span>lev_automaton_builder = LevenshteinAutomatonBuilder::new(<span class="number">2</span>, <span class="bool-val">true</span>); |
| |
| <span class="comment">// We can now build an entire dfa. |
| </span><span class="kw">let </span>dfa = lev_automaton_builder.build_dfa(<span class="string">"Levenshtein"</span>); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>state = dfa.initial_state(); |
| <span class="kw">for </span><span class="kw-2">&</span>b <span class="kw">in </span><span class="string">"Levenshtain"</span>.as_bytes() { |
| state = dfa.transition(state, b); |
| } |
| |
| <span class="macro">assert_eq!</span>(dfa.distance(state), Distance::Exact(<span class="number">1</span>));</code></pre></div> |
| <p>The implementation is based on the following paper |
| <strong>Fast String Correction with Levenshtein-Automata (2002)</strong> by by Klaus Schulz and Stoyan Mihov. |
| I also tried to explain it in the following <a href="https://fulmicoton.com/posts/levenshtein/">blog post</a>.</p> |
| <p>!</p> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DFA.html" title="levenshtein_automata::DFA struct">DFA</a></div><div class="item-right docblock-short">Implementation of a Deterministic Finite Automaton for |
| a Levenshtein Automaton targeting UTF-8 encoded strings.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LevenshteinAutomatonBuilder.html" title="levenshtein_automata::LevenshteinAutomatonBuilder struct">LevenshteinAutomatonBuilder</a></div><div class="item-right docblock-short">Builder for Levenshtein Automata.</div></div></div><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.Distance.html" title="levenshtein_automata::Distance enum">Distance</a></div><div class="item-right docblock-short">Levenshtein Distance computed by a Levenshtein Automaton.</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SINK_STATE.html" title="levenshtein_automata::SINK_STATE constant">SINK_STATE</a></div><div class="item-right docblock-short">Sink state. See <a href="./index.html">DFA</a></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="levenshtein_automata" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
