File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/SimilarityDetector.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::SimilarityDetector - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-levenshtein_distance">#levenshtein_distance</a>
<li ><a href="#method-i-similar_word_list">#similar_word_list</a>
<li ><a href="#method-i-similar_words">#similar_words</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::SimilarityDetector">
<h1 id="class-Bundler::SimilarityDetector" class="class">
class Bundler::SimilarityDetector
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="SimilarityScore">SimilarityScore
<dd>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(corpus)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>initialize with an array of words to be matched against</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/similarity_detector.rb, line 8</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">corpus</span>)
<span class="ruby-ivar">@corpus</span> = <span class="ruby-identifier">corpus</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-similar_word_list" class="method-detail ">
<div class="method-heading">
<span class="method-name">similar_word_list</span><span
class="method-args">(word, limit = 3)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>return the result of 'similar_words', concatenated into a list (eg “a, b, or c”)</p>
<div class="method-source-code" id="similar_word_list-source">
<pre><span class="ruby-comment"># File lib/bundler/similarity_detector.rb, line 20</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">similar_word_list</span>(<span class="ruby-identifier">word</span>, <span class="ruby-identifier">limit</span> = <span class="ruby-value">3</span>)
<span class="ruby-identifier">words</span> = <span class="ruby-identifier">similar_words</span>(<span class="ruby-identifier">word</span>, <span class="ruby-identifier">limit</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">words</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
<span class="ruby-identifier">words</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">words</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
[<span class="ruby-identifier">words</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">-2</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">", "</span>), <span class="ruby-identifier">words</span>[<span class="ruby-value">-1</span>]].<span class="ruby-identifier">join</span>(<span class="ruby-string">" or "</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-similar_words" class="method-detail ">
<div class="method-heading">
<span class="method-name">similar_words</span><span
class="method-args">(word, limit = 3)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>return an array of words similar to 'word' from the corpus</p>
<div class="method-source-code" id="similar_words-source">
<pre><span class="ruby-comment"># File lib/bundler/similarity_detector.rb, line 13</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">similar_words</span>(<span class="ruby-identifier">word</span>, <span class="ruby-identifier">limit</span> = <span class="ruby-value">3</span>)
<span class="ruby-identifier">words_by_similarity</span> = <span class="ruby-ivar">@corpus</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">w</span><span class="ruby-operator">|</span> <span class="ruby-constant">SimilarityScore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">w</span>, <span class="ruby-identifier">levenshtein_distance</span>(<span class="ruby-identifier">word</span>, <span class="ruby-identifier">w</span>)) }
<span class="ruby-identifier">words_by_similarity</span>.<span class="ruby-identifier">select</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">distance</span> <span class="ruby-operator"><=</span> <span class="ruby-identifier">limit</span> }.<span class="ruby-identifier">sort_by</span>(<span class="ruby-operator">&</span><span class="ruby-value">:distance</span>).<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:string</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-levenshtein_distance" class="method-detail ">
<div class="method-heading">
<span class="method-name">levenshtein_distance</span><span
class="method-args">(this, that, ins = 2, del = 2, sub = 1)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="https://www.informit.com/articles/article.aspx?p=683059&seqNum=36">www.informit.com/articles/article.aspx?p=683059&seqNum=36</a></p>
<div class="method-source-code" id="levenshtein_distance-source">
<pre><span class="ruby-comment"># File lib/bundler/similarity_detector.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">levenshtein_distance</span>(<span class="ruby-identifier">this</span>, <span class="ruby-identifier">that</span>, <span class="ruby-identifier">ins</span> = <span class="ruby-value">2</span>, <span class="ruby-identifier">del</span> = <span class="ruby-value">2</span>, <span class="ruby-identifier">sub</span> = <span class="ruby-value">1</span>)
<span class="ruby-comment"># ins, del, sub are weighted costs</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">this</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">that</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">dm</span> = [] <span class="ruby-comment"># distance matrix</span>
<span class="ruby-comment"># Initialize first row values</span>
<span class="ruby-identifier">dm</span>[<span class="ruby-value">0</span>] = (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-identifier">this</span>.<span class="ruby-identifier">length</span>).<span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">ins</span> }
<span class="ruby-identifier">fill</span> = [<span class="ruby-value">0</span>] <span class="ruby-operator">*</span> (<span class="ruby-identifier">this</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
<span class="ruby-comment"># Initialize first column values</span>
(<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-identifier">that</span>.<span class="ruby-identifier">length</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">dm</span>[<span class="ruby-identifier">i</span>] = [<span class="ruby-identifier">i</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">del</span>, <span class="ruby-identifier">fill</span>.<span class="ruby-identifier">flatten</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># populate matrix</span>
(<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-identifier">that</span>.<span class="ruby-identifier">length</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
(<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-identifier">this</span>.<span class="ruby-identifier">length</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">j</span><span class="ruby-operator">|</span>
<span class="ruby-comment"># critical comparison</span>
<span class="ruby-identifier">dm</span>[<span class="ruby-identifier">i</span>][<span class="ruby-identifier">j</span>] = [
<span class="ruby-identifier">dm</span>[<span class="ruby-identifier">i</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>][<span class="ruby-identifier">j</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>] <span class="ruby-operator">+</span> (<span class="ruby-identifier">this</span>[<span class="ruby-identifier">j</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">that</span>[<span class="ruby-identifier">i</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>] <span class="ruby-operator">?</span> <span class="ruby-value">0</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">sub</span>),
<span class="ruby-identifier">dm</span>[<span class="ruby-identifier">i</span>][<span class="ruby-identifier">j</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">ins</span>,
<span class="ruby-identifier">dm</span>[<span class="ruby-identifier">i</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>][<span class="ruby-identifier">j</span>] <span class="ruby-operator">+</span> <span class="ruby-identifier">del</span>,
].<span class="ruby-identifier">min</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># The last value in matrix is the Levenshtein distance between the strings</span>
<span class="ruby-identifier">dm</span>[<span class="ruby-identifier">that</span>.<span class="ruby-identifier">length</span>][<span class="ruby-identifier">this</span>.<span class="ruby-identifier">length</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>