diff options
| author | Austin Ziegler <austin@zieglers.ca> | 2021-12-23 00:54:36 -0500 |
|---|---|---|
| committer | Austin Ziegler <austin@zieglers.ca> | 2021-12-23 00:54:36 -0500 |
| commit | df79aa3f5441f16cf693b7bb4774ac044cd047e7 (patch) | |
| tree | 6e1eaba206adc1a4ea8e6acce87242c58f86b6c8 /docs/LCS/Change.html | |
| parent | 66c70146f9d8889eeb4ea7867e97a2688f01ad4b (diff) | |
| download | diff-lcs-df79aa3f5441f16cf693b7bb4774ac044cd047e7.tar.gz | |
Rename doc to docs
Diffstat (limited to 'docs/LCS/Change.html')
| -rw-r--r-- | docs/LCS/Change.html | 500 |
1 files changed, 500 insertions, 0 deletions
diff --git a/docs/LCS/Change.html b/docs/LCS/Change.html new file mode 100644 index 0000000..c714eea --- /dev/null +++ b/docs/LCS/Change.html @@ -0,0 +1,500 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class LCS::Change - diff-lcs-1.5.0 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">Object +</div> + + +<div id="includes-section" class="nav-section"> + <h3>Included Modules</h3> + + <ul class="link-list"> + <li><span class="include">Comparable</span> + </ul> +</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-from_a">::from_a</a> + <li ><a href="#method-c-new">::new</a> + <li ><a href="#method-c-valid_action-3F">::valid_action?</a> + <li ><a href="#method-i-3C-3D-3E">#<=></a> + <li ><a href="#method-i-3D-3D">#==</a> + <li ><a href="#method-i-adding-3F">#adding?</a> + <li ><a href="#method-i-changed-3F">#changed?</a> + <li ><a href="#method-i-deleting-3F">#deleting?</a> + <li ><a href="#method-i-finished_a-3F">#finished_a?</a> + <li ><a href="#method-i-finished_b-3F">#finished_b?</a> + <li ><a href="#method-i-inspect">#inspect</a> + <li ><a href="#method-i-to_a">#to_a</a> + <li ><a href="#method-i-to_ary">#to_ary</a> + <li ><a href="#method-i-unchanged-3F">#unchanged?</a> + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-LCS::Change"> + <h1 id="class-LCS::Change" class="class"> + class LCS::Change + </h1> + + <section class="description"> + +<p>Represents a simplistic (non-contextual) change. Represents the removal or addition of an element from either the old or the new sequenced enumerable.</p> + + </section> + + <section id="5Buntitled-5D" class="documentation-section"> + + + <section class="constants-list"> + <header> + <h3>Constants</h3> + </header> + <dl> + <dt id="IntClass">IntClass + <dd> + <dt id="VALID_ACTIONS">VALID_ACTIONS + <dd><p>The only actions valid for changes are '+' (add), '-' (delete), '=' (no change), '!' (changed), '<' (tail changes from first sequence), or '>' (tail changes from second sequence). The last two ('<>') are only found with <a href="../LCS.html#method-c-diff"><code>Diff::LCS::diff</code></a> and <a href="../LCS.html#method-c-sdiff"><code>Diff::LCS::sdiff</code></a>.</p> + </dl> + </section> + + <section class="attribute-method-details" class="method-section"> + <header> + <h3>Attributes</h3> + </header> + + <div id="attribute-i-action" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">action</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + <p>Returns the action this <a href="Change.html"><code>Change</code></a> represents.</p> + </div> + </div> + <div id="attribute-i-element" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">element</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + <p>Returns the sequence element of the <a href="Change.html"><code>Change</code></a>.</p> + </div> + </div> + <div id="attribute-i-position" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">position</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + <p>Returns the position of the <a href="Change.html"><code>Change</code></a>.</p> + </div> + </div> + </section> + + + <section id="public-class-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Class Methods</h3> + </header> + + <div id="method-c-from_a" class="method-detail "> + <div class="method-heading"> + <span class="method-name">from_a</span><span + class="method-args">(arr)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="from_a-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 44</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">from_a</span>(<span class="ruby-identifier">arr</span>) + <span class="ruby-identifier">arr</span> = <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">flatten</span>(<span class="ruby-value">1</span>) + <span class="ruby-keyword">case</span> <span class="ruby-identifier">arr</span>.<span class="ruby-identifier">size</span> + <span class="ruby-keyword">when</span> <span class="ruby-value">5</span> + <span class="ruby-constant">Diff</span><span class="ruby-operator">::</span><span class="ruby-constant">LCS</span><span class="ruby-operator">::</span><span class="ruby-constant">ContextChange</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span>(<span class="ruby-identifier">arr</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-value">5</span>])) + <span class="ruby-keyword">when</span> <span class="ruby-value">3</span> + <span class="ruby-constant">Diff</span><span class="ruby-operator">::</span><span class="ruby-constant">LCS</span><span class="ruby-operator">::</span><span class="ruby-constant">Change</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span>(<span class="ruby-identifier">arr</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-value">3</span>])) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">fail</span> <span class="ruby-string">'Invalid change array format provided.'</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-c-new" class="method-detail "> + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(*args)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 27</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) + <span class="ruby-ivar">@action</span>, <span class="ruby-ivar">@position</span>, <span class="ruby-ivar">@element</span> = <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> + + <span class="ruby-identifier">fail</span> <span class="ruby-node">"Invalid Change Action '#{@action}'"</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">Diff</span><span class="ruby-operator">::</span><span class="ruby-constant">LCS</span><span class="ruby-operator">::</span><span class="ruby-constant">Change</span>.<span class="ruby-identifier">valid_action?</span>(<span class="ruby-ivar">@action</span>) + <span class="ruby-identifier">fail</span> <span class="ruby-string">'Invalid Position Type'</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@position</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">IntClass</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-c-valid_action-3F" class="method-detail "> + <div class="method-heading"> + <span class="method-name">valid_action?</span><span + class="method-args">(action)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="valid_action-3F-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">valid_action?</span>(<span class="ruby-identifier">action</span>) + <span class="ruby-constant">VALID_ACTIONS</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">action</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-3C-3D-3E" class="method-detail "> + <div class="method-heading"> + <span class="method-name"><=></span><span + class="method-args">(other)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="3C-3D-3E-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 65</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><=></span>(<span class="ruby-identifier">other</span>) + <span class="ruby-identifier">r</span> = <span class="ruby-identifier">action</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">action</span> + <span class="ruby-identifier">r</span> = <span class="ruby-identifier">position</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">position</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">r</span>.<span class="ruby-identifier">zero?</span> + <span class="ruby-identifier">r</span> = <span class="ruby-identifier">element</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">element</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">r</span>.<span class="ruby-identifier">zero?</span> + <span class="ruby-identifier">r</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-i-3D-3D" class="method-detail "> + <div class="method-heading"> + <span class="method-name">==</span><span + class="method-args">(other)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="3D-3D-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 58</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>) + (<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">class</span>) <span class="ruby-keyword">and</span> + (<span class="ruby-identifier">action</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">action</span>) <span class="ruby-keyword">and</span> + (<span class="ruby-identifier">position</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">position</span>) <span class="ruby-keyword">and</span> + (<span class="ruby-identifier">element</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">element</span>) +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-i-adding-3F" class="method-detail "> + <div class="method-heading"> + <span class="method-name">adding?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="adding-3F-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 72</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">adding?</span> + <span class="ruby-ivar">@action</span> <span class="ruby-operator">==</span> <span class="ruby-string">'+'</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-i-changed-3F" class="method-detail "> + <div class="method-heading"> + <span class="method-name">changed?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="changed-3F-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 84</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">changed?</span> + <span class="ruby-ivar">@action</span> <span class="ruby-operator">==</span> <span class="ruby-string">'!'</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-i-deleting-3F" class="method-detail "> + <div class="method-heading"> + <span class="method-name">deleting?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="deleting-3F-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 76</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">deleting?</span> + <span class="ruby-ivar">@action</span> <span class="ruby-operator">==</span> <span class="ruby-string">'-'</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-i-finished_a-3F" class="method-detail "> + <div class="method-heading"> + <span class="method-name">finished_a?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="finished_a-3F-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 88</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">finished_a?</span> + <span class="ruby-ivar">@action</span> <span class="ruby-operator">==</span> <span class="ruby-string">'>'</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-i-finished_b-3F" class="method-detail "> + <div class="method-heading"> + <span class="method-name">finished_b?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="finished_b-3F-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 92</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">finished_b?</span> + <span class="ruby-ivar">@action</span> <span class="ruby-operator">==</span> <span class="ruby-string">'<'</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-i-inspect" class="method-detail "> + <div class="method-heading"> + <span class="method-name">inspect</span><span + class="method-args">(*_args)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="inspect-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 34</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">_args</span>) + <span class="ruby-node">"#<#{self.class}: #{to_a.inspect}>"</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-i-to_a" class="method-detail "> + <div class="method-heading"> + <span class="method-name">to_a</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="to_a-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 38</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_a</span> + [<span class="ruby-ivar">@action</span>, <span class="ruby-ivar">@position</span>, <span class="ruby-ivar">@element</span>] +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + <div class="aliases"> + Also aliased as: <a href="Change.html#method-i-to_ary">to_ary</a> + </div> + + </div> + + <div id="method-i-to_ary" class="method-detail method-alias"> + <div class="method-heading"> + <span class="method-name">to_ary</span><span + class="method-args">()</span> + </div> + + <div class="method-description"> + + + </div> + + + <div class="aliases"> + Alias for: <a href="Change.html#method-i-to_a">to_a</a> + </div> + </div> + + <div id="method-i-unchanged-3F" class="method-detail "> + <div class="method-heading"> + <span class="method-name">unchanged?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + + + <div class="method-source-code" id="unchanged-3F-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/change.rb, line 80</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unchanged?</span> + <span class="ruby-ivar">@action</span> <span class="ruby-operator">==</span> <span class="ruby-string">'='</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.3.3. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. +</footer> + |