github
/
ropex
mirror of https://github.com/copenhas/ropex.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

updated docs for auto rebalancing and concat api tweak

gh-pages
Sean Copenhaver 11 years ago
parent
7c5a0e853c
commit
080c2975f0
8 changed files with 39 additions and 48 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      Binary.Chars.Rope.html
  2. 8
      Enumerable.Rope.html
  3. 4
      Inspect.Rope.html
  4. 4
      README.html
  5. 61
      Rope.html
  6. 2
      css/style.css
  7. BIN
      images/bulldozer.dot.png
  8. 2
      modules_list.html

4
Binary.Chars.Rope.html
View File

@ -29,7 +29,7 @@
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L478" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L614" target="_blank" class="view_source">Source</a>
@ -61,7 +61,7 @@
<div class="docstring"><p>Converts the entire rope to a single binary string.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L482" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L618" target="_blank" class="view_source">Source</a>
</div>

8
Enumerable.Rope.html
View File

@ -37,7 +37,7 @@ of the parent/concatenation nodes.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L488" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L624" target="_blank" class="view_source">Source</a>
@ -79,7 +79,7 @@ of the parent/concatenation nodes.</p>
<div class="docstring"><p>A count of the leaf nodes in the rope. This current traverses the rope to count them.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L499" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L635" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -89,7 +89,7 @@ of the parent/concatenation nodes.</p>
<div class="docstring"><p>Searches the ropes leaves in order for a match.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L506" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L642" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -99,7 +99,7 @@ of the parent/concatenation nodes.</p>
<div class="docstring"><p>Reduces over the leaf nodes.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L524" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L660" target="_blank" class="view_source">Source</a>
</div>

4
Inspect.Rope.html
View File

@ -29,7 +29,7 @@
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L544" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L680" target="_blank" class="view_source">Source</a>
@ -63,7 +63,7 @@ algebra document. Will convert &#39;
&#39; characters into algebra document line breaks.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L549" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L685" target="_blank" class="view_source">Source</a>
</div>

4
README.html
View File

@ -34,11 +34,11 @@ on plain binary based strings. The combination of <code>slice/3</code> and <code
to a rope. The squares represent the internal record data structure for the rope. &#39;concat&#39; nodes are purely for connecting
the leaves together, while the leaves actually contain the text.</p>
<p>Worst case purely concatenation rope:</p>
<p>Straight concatenation with an auto-rebalance triggered part way:</p>
<p><img src="http://copenhas.github.io/ropex/images/bulldozer.dot.png" alt="Worst case" title="worst case"></p>
<p>The same rope rebalanced for better slice based operations:</p>
<p>The same rope explicitly rebalanced for better slice based operations:</p>
<p><img src="http://copenhas.github.io/ropex/images/bulldozerrebalanced.dot.png" alt="Worst case rebalanced" title="worst case rebalanced"></p>

61
Rope.html
View File

@ -84,7 +84,7 @@ String module compatible API.</p>
<ul class="summary">
<li>
<span class="summary_signature">
<a href="#concat/1">concat/1</a>
<a href="#balanced?/1">balanced?/1</a>
</span>
</li>
<li>
@ -159,42 +159,35 @@ String module compatible API.</p>
<div id="functions_details" class="details_list">
<h2>Functions</h2>
<div class="detail">
<p class="signature" id="concat/1">
<strong>concat(list1)</strong>
<p class="signature" id="balanced?/1">
<strong>balanced?(rope)</strong>
</p>
<div class="docstring"><p>Concatenates the list of ropes or strings together into a single new rope. </p>
<h2>Examples</h2>
<pre><code>iex&gt; Rope.concat([&quot;Time is&quot;, &quot; an illusion.&quot;]) |&gt; Rope.to_binary
&quot;Time is an illusion.&quot;
iex&gt; Rope.concat([Rope.new(&quot;terrible&quot;), &quot; ghastly&quot;, &quot; silence&quot;]) |&gt; Rope.to_binary
&quot;terrible ghastly silence&quot;
</code></pre>
<div class="docstring"><p>Checks if the rope is considered balanced based on comparing total length
and depth verses the fibanocci sequence.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L128" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L164" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
<p class="signature" id="concat/2">
<strong>concat(rope, rope)</strong>
<strong>concat(list1, opts // [])</strong>
</p>
<div class="docstring"><p>Concatenates two ropes together producing a new single rope. Accepts
ropes or strings as arguments.</p>
<div class="docstring"><p>Concatenates the list of ropes or strings together into a single new rope.
Accepts ropes or strings as arguments. Additionally you can override the
auto-rebalancing behavior with a <code>rebalance: false</code> option.</p>
<h2>Examples</h2>
<pre><code>iex&gt; Rope.concat(&quot;Time is&quot;, &quot; an illusion.&quot;) |&gt; Rope.to_binary
<pre><code>iex&gt; Rope.concat([&quot;Time is&quot;, &quot; an illusion.&quot;]) |&gt; Rope.to_binary
&quot;Time is an illusion.&quot;
iex&gt; Rope.concat(Rope.new(&quot;terrible&quot;), &quot; ghastly silence&quot;) |&gt; Rope.to_binary
iex&gt; Rope.concat([Rope.new(&quot;terrible&quot;), &quot; ghastly&quot;, &quot; silence&quot;]) |&gt; Rope.to_binary
&quot;terrible ghastly silence&quot;
</code></pre>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L89" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L95" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -209,7 +202,7 @@ rebalance.</p>
<h2>Examples</h2>
<pre><code>iex&gt; Rope.depth(Rope.concat(Rope.new(&quot;terrible&quot;), &quot; ghastly silence&quot;))
<pre><code>iex&gt; Rope.depth(Rope.concat([Rope.new(&quot;terrible&quot;), &quot; ghastly silence&quot;]))
1
iex&gt; Rope.depth(Rope.concat([Rope.new(&quot;terrible&quot;), &quot; ghastly&quot;, &quot; silence&quot;]))
@ -217,7 +210,7 @@ iex&gt; Rope.depth(Rope.concat([Rope.new(&quot;terrible&quot;), &quot; ghastly&q
</code></pre>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L243" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L227" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -236,7 +229,7 @@ iex&gt; Rope.find(Rope.concat([&quot;loathe it&quot;, &quot; or ignore it,&quot;
</code></pre>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L320" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L304" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -257,7 +250,7 @@ iex&gt; Rope.find_all(Rope.concat([&quot;loathe it&quot;, &quot; or ignore it,&q
</code></pre>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L358" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L355" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -277,7 +270,7 @@ iex&gt; Rope.insert_at(Rope.concat([&quot;infinite &quot;, &quot;number &quot;,
</code></pre>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L264" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L248" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -288,12 +281,12 @@ iex&gt; Rope.insert_at(Rope.concat([&quot;infinite &quot;, &quot;number &quot;,
<h2>Examples</h2>
<pre><code>iex&gt; Rope.length(Rope.concat(Rope.new(&quot;terrible&quot;), &quot; ghastly silence&quot;))
<pre><code>iex&gt; Rope.length(Rope.concat([Rope.new(&quot;terrible&quot;), &quot; ghastly silence&quot;]))
24
</code></pre>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L218" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L202" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -301,7 +294,7 @@ iex&gt; Rope.insert_at(Rope.concat([&quot;infinite &quot;, &quot;number &quot;,
<strong>new(str)</strong>
</p>
<div class="docstring"><p>Creates a new rope with the string provided. Not needed since
concat/2 supports strings and ropes as arguments.</p>
<a href="#concat/2"><code>concat/2</code></a> supports strings and ropes as arguments.</p>
<h2>Examples</h2>
@ -310,7 +303,7 @@ concat/2 supports strings and ropes as arguments.</p>
</code></pre>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L68" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L73" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -322,7 +315,7 @@ efficient. This is a pretty greedy rebalancing and should produce
a fully balanced rope.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L197" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L181" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -343,7 +336,7 @@ iex&gt; Rope.remove_at(Rope.concat([&quot;infinite &quot;, &quot;number of &quot
</code></pre>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L293" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L277" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -356,7 +349,7 @@ By default, it replaces all entries, except if the global option
is set to false.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L369" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L390" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -369,7 +362,7 @@ the second. If the offset is greater than string length, than it returns nil.</p
<p>Similar to String.slice/3, check the tests for some examples of usage.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L143" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L111" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
@ -379,7 +372,7 @@ the second. If the offset is greater than string length, than it returns nil.</p
<div class="docstring"><p>Converts the entire rope to a single binary.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L383" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L404" target="_blank" class="view_source">Source</a>
</div>

2
css/style.css
View File

@ -19,8 +19,6 @@ h2 {
.clear { clear: both; }
img { max-width: 650px; }
li.r1 { background: #f0f0f0; }
li.r2 { background: #fafafa; }

BIN
images/bulldozer.dot.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 234 KiB

After

Width:  |  Height:  |  Size: 154 KiB

2
modules_list.html
View File

@ -50,7 +50,7 @@
<li>
<span class="object_link">
<a href="Rope.html#concat/1">concat/1</a>
<a href="Rope.html#balanced?/1">balanced?/1</a>
</span>
<small class="search_info">Rope</small>
</li>

Write Preview
Loading…
Cancel
Save