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

fleshed out more of the docs, got source links working

gh-pages
Sean Copenhaver 11 years ago
parent
c3df8006b4
commit
56b1856df4
10 changed files with 195 additions and 47 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. 8
      Binary.Chars.Rope.html
  2. 32
      Enumerable.Rope.html
  3. 10
      Inspect.Rope.html
  4. 32
      README.html
  5. 129
      Rope.html
  6. 1
      css/full_list.css
  7. 2
      index.html
  8. 14
      modules_list.html
  9. 7
      protocols_list.html
  10. 7
      records_list.html

8
Binary.Chars.Rope.html
View File

@ -27,7 +27,7 @@
<a href="" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L391" target="_blank" class="view_source">Source</a>
@ -56,9 +56,13 @@
<p class="signature" id="to_binary/1">
<strong>to_binary(rope)</strong>
</p>
<div class="docstring"></div>
<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#L395" target="_blank" class="view_source">Source</a>
</div>
</div>

32
Enumerable.Rope.html
View File

@ -26,8 +26,16 @@
</h1>
<div id="moduledoc" class="docstring">
<p>A convenience implementation that enumerates over the leaves of the rope but none
of the parent/concatenation nodes.</p>
<a href="" target="_blank" class="view_source">Source</a>
<p>Refer to the Rope module documentation for leaf vs parent/concat node.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L401" target="_blank" class="view_source">Source</a>
@ -66,21 +74,33 @@
<p class="signature" id="count/1">
<strong>count(rope)</strong>
</p>
<div class="docstring"></div>
<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#L412" target="_blank" class="view_source">Source</a>
</div><div class="detail">
</div>
<div class="detail">
<p class="signature" id="member?/2">
<strong>member?(rope, value)</strong>
</p>
<div class="docstring"></div>
<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#L419" target="_blank" class="view_source">Source</a>
</div><div class="detail">
</div>
<div class="detail">
<p class="signature" id="reduce/3">
<strong>reduce(rope, acc, fun)</strong>
</p>
<div class="docstring"></div>
<div class="docstring"><p>Reduces over the leaf nodes.</p>
</div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L437" target="_blank" class="view_source">Source</a>
</div>
</div>

10
Inspect.Rope.html
View File

@ -27,7 +27,7 @@
<a href="" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L457" target="_blank" class="view_source">Source</a>
@ -56,9 +56,15 @@
<p class="signature" id="inspect/2">
<strong>inspect(rope, _opts)</strong>
</p>
<div class="docstring"></div>
<div class="docstring"><p>Traveres the leaf nodes and converts the chunks of binary data into a single
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#L464" target="_blank" class="view_source">Source</a>
</div>
</div>

32
README.html
View File

@ -0,0 +1,32 @@
<!DOCTYPE html>
<html>
<head>
<title>README</title>
<meta charset="utf-8">
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="content">
<h1>Rope</h1>
<p>Implementing the rope data structure to play around with Elixir some... and to do something kind of computer sciencey again.</p>
<p>It will attempt to provide an API similar to the Elixir String module.</p>
</div>
</body>
</html>

129
Rope.html
View File

@ -31,7 +31,7 @@
<h2>Ropes</h2>
<p>A rope provides a scalable way to represent and manipulation strings
<p>A rope provides a tree based scalable way to represent and manipulation strings
from small to huge. They provide the following characteristics:</p>
<ol>
@ -41,6 +41,28 @@ from small to huge. They provide the following characteristics:</p>
<li>Should be able to handle alternate representations (ex: IO stream) - we&#39;ll see</li>
</ol>
<p>A rope is build up of leaf and parent/concatenation nodes. Leaf nodes contain the
chunks of binary strings that are concatenated or inserted into the rope. The
parent/concatentation nodes are purely used to link the various leaf nodes together.
The concatentation nodes contain basic tree information.</p>
<h2>Ropes as strings</h2>
<p>Although they can not be swapped in, this rope implementation supports the
Kernel.Inspect and Binary.Chars protocols.</p>
<h2>Ropes as enumerations</h2>
<p>An implmentation of the Enumerable protocol has been provided to enumerate
over the leaf nodes which contain the chunks of binary data. The parent/concat
nodes are skipped.</p>
<h2>Notes</h2>
<p>Current implementation is mostly focused on operations that work well at larger
scales. Performance should hopefully improve over time but don&#39;t expect a fully
String module compatible API.</p>
<h2>Links</h2>
<ul>
@ -51,7 +73,7 @@ from small to huge. They provide the following characteristics:</p>
</div>
<a href="" target="_blank" class="view_source">Source</a>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L1" target="_blank" class="view_source">Source</a>
@ -70,11 +92,6 @@ from small to huge. They provide the following characteristics:</p>
<a href="#depth/1">depth/1</a>
</span>
</li>
<li>
<span class="summary_signature">
<a href="#do_replace/3">do_replace/3</a>
</span>
</li>
<li>
<span class="summary_signature">
<a href="#find/2">find/2</a>
@ -135,30 +152,53 @@ from small to huge. They provide the following characteristics:</p>
<p class="signature" id="concat/2">
<strong>concat(rope, rope)</strong>
</p>
<div class="docstring"><p>Concatenates two ropes together producing a new single rope.</p>
<div class="docstring"><p>Concatenates two ropes together producing a new single rope. Accepts
ropes or strings as arguments.</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 silence&quot;) |&gt; Rope.to_binary
&quot;terrible ghastly silence&quot;
</code></pre>
</div>
</div><div class="detail">
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L89" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
<p class="signature" id="depth/1">
<strong>depth(rope)</strong>
</p>
<div class="docstring"><p>Returns the depth of the rope tree.</p>
<div class="docstring"><p>Returns the depth of the rope tree. Only particularly of interest to
the curious, or those wanting to calculate for themselves when to
rebalance.</p>
<p>Concatenation nodes have a depth of 1 and leaf nodes have a depth of 0.</p>
<h2>Examples</h2>
<pre><code>iex&gt; Rope.depth(Rope.concat(Rope.new(&quot;terrible&quot;), &quot; ghastly silence&quot;))
1
</code></pre>
</div>
</div><div class="detail">
<p class="signature" id="do_replace/3">
<strong>do_replace(rope, pattern, replacement)</strong>
</p>
<div class="docstring"></div>
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L208" target="_blank" class="view_source">Source</a>
</div><div class="detail">
</div>
<div class="detail">
<p class="signature" id="find/2">
<strong>find(rope, term)</strong>
</p>
<div class="docstring"><p>Returns the index of the first match or -1 if no match was found.</p>
</div>
</div><div class="detail">
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L240" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
<p class="signature" id="find_all/2">
<strong>find_all(rope, term)</strong>
</p>
@ -167,7 +207,10 @@ or an empty list if no matches were found. The list is in order
from first to last match.</p>
</div>
</div><div class="detail">
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L270" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
<p class="signature" id="insert_at/3">
<strong>insert_at(rope, index, str)</strong>
</p>
@ -175,21 +218,43 @@ from first to last match.</p>
This wraps around so negative indexes will start from the end.</p>
</div>
</div><div class="detail">
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L221" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
<p class="signature" id="length/1">
<strong>length(rope)</strong>
</p>
<div class="docstring"><p>Retrieve the length in ut8 characters in the rope.</p>
<h2>Examples</h2>
<pre><code>iex&gt; Rope.length(Rope.concat(Rope.new(&quot;terrible&quot;), &quot; ghastly silence&quot;))
24
</code></pre>
</div>
</div><div class="detail">
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L186" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
<p class="signature" id="new/1">
<strong>new(str)</strong>
</p>
<div class="docstring"><p>Creates a new rope with the string provided</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>
<h2>Examples</h2>
<pre><code>iex&gt; Rope.new(&quot;Don&#39;t panic&quot;) |&gt; Rope.to_binary
&quot;Don&#39;t panic&quot;
</code></pre>
</div>
</div><div class="detail">
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L68" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
<p class="signature" id="rebalance/1">
<strong>rebalance(rope)</strong>
</p>
@ -198,7 +263,10 @@ efficient. This is a pretty greedy rebalancing and should produce
a fully balanced rope.</p>
</div>
</div><div class="detail">
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L165" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
<p class="signature" id="replace/4">
<strong>replace(rope, pattern, replacement, opts // [])</strong>
</p>
@ -208,24 +276,33 @@ By default, it replaces all entries, except if the global option
is set to false.</p>
</div>
</div><div class="detail">
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L281" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
<p class="signature" id="slice/3">
<strong>slice(rope, start, len)</strong>
</p>
<div class="docstring"><p>Returns a sub-rope starting at the offset given by the first, and a length given by
the second. If the offset is greater than string length, than it returns nil.</p>
<p>Similar to String.slice/3</p>
<p>Similar to String.slice/3, check the tests for some examples of usage.</p>
</div>
</div><div class="detail">
<a href="https://github.com/copenhas/ropex/blob/master/lib/rope.ex#L120" target="_blank" class="view_source">Source</a>
</div>
<div class="detail">
<p class="signature" id="to_binary/1">
<strong>to_binary(rope)</strong>
</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#L295" target="_blank" class="view_source">Source</a>
</div>
</div>

1
css/full_list.css
View File

@ -7,6 +7,7 @@ body {
}
h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
h2#readme { padding: 6px 10px; padding-bottom: 0; margin: 0; font-size: 1.1em; }
.clear { clear: both; }
#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }

2
index.html
View File

@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>ropex v0.0.1 Documentation</title>
<title>ropex vmaster Documentation</title>
</head>
<frameset cols="20%,*">
<frame name="list" src="modules_list.html" />

14
modules_list.html
View File

@ -16,8 +16,13 @@
</script>
<div id="content">
<h1 id="full_list_header">
<a href="/" target="_blank">ropex v0.0.1</a>
<a href="/" target="_blank">ropex vmaster</a>
</h1>
<h2 id="readme">
<a href="README.html">README</a>
</h2>
<div id="nav">
<span class="selected"><a target="_self" href="modules_list.html">
Modules
@ -125,13 +130,6 @@
<small class="search_info">Rope</small>
</li>
<li>
<span class="object_link">
<a href="Rope.html#do_replace/3">do_replace/3</a>
</span>
<small class="search_info">Rope</small>
</li>
<li>
<span class="object_link">
<a href="Rope.html#find/2">find/2</a>

7
protocols_list.html
View File

@ -16,8 +16,13 @@
</script>
<div id="content">
<h1 id="full_list_header">
<a href="/" target="_blank">ropex v0.0.1</a>
<a href="/" target="_blank">ropex vmaster</a>
</h1>
<h2 id="readme">
<a href="README.html">README</a>
</h2>
<div id="nav">
<span class=""><a target="_self" href="modules_list.html">
Modules

7
records_list.html
View File

@ -16,8 +16,13 @@
</script>
<div id="content">
<h1 id="full_list_header">
<a href="/" target="_blank">ropex v0.0.1</a>
<a href="/" target="_blank">ropex vmaster</a>
</h1>
<h2 id="readme">
<a href="README.html">README</a>
</h2>
<div id="nav">
<span class=""><a target="_self" href="modules_list.html">
Modules

Write Preview
Loading…
Cancel
Save