RubyGems - ruby_odeum - Versions diffs - 0.2.1 - Mend

ruby_odeum 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (88) hide show

data/COPYING +504 -0
data/LICENSE +504 -0
data/README +50 -0
data/bin/odeum_mgr +106 -0
data/doc/rdoc/classes/Odeum.html +235 -0
data/doc/rdoc/classes/Odeum.src/M000010.html +25 -0
data/doc/rdoc/classes/Odeum.src/M000011.html +22 -0
data/doc/rdoc/classes/Odeum.src/M000012.html +27 -0
data/doc/rdoc/classes/Odeum.src/M000013.html +27 -0
data/doc/rdoc/classes/Odeum.src/M000014.html +28 -0
data/doc/rdoc/classes/Odeum/Document.html +382 -0
data/doc/rdoc/classes/Odeum/Document.src/M000040.html +25 -0
data/doc/rdoc/classes/Odeum/Document.src/M000041.html +22 -0
data/doc/rdoc/classes/Odeum/Document.src/M000042.html +23 -0
data/doc/rdoc/classes/Odeum/Document.src/M000043.html +23 -0
data/doc/rdoc/classes/Odeum/Document.src/M000044.html +24 -0
data/doc/rdoc/classes/Odeum/Document.src/M000045.html +32 -0
data/doc/rdoc/classes/Odeum/Document.src/M000046.html +22 -0
data/doc/rdoc/classes/Odeum/Document.src/M000047.html +22 -0
data/doc/rdoc/classes/Odeum/Document.src/M000048.html +22 -0
data/doc/rdoc/classes/Odeum/Document.src/M000049.html +22 -0
data/doc/rdoc/classes/Odeum/Document.src/M000050.html +24 -0
data/doc/rdoc/classes/Odeum/Document.src/M000051.html +27 -0
data/doc/rdoc/classes/Odeum/Index.html +662 -0
data/doc/rdoc/classes/Odeum/Index.src/M000015.html +46 -0
data/doc/rdoc/classes/Odeum/Index.src/M000016.html +33 -0
data/doc/rdoc/classes/Odeum/Index.src/M000017.html +35 -0
data/doc/rdoc/classes/Odeum/Index.src/M000018.html +23 -0
data/doc/rdoc/classes/Odeum/Index.src/M000019.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000020.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000021.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000022.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000023.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000024.html +29 -0
data/doc/rdoc/classes/Odeum/Index.src/M000025.html +23 -0
data/doc/rdoc/classes/Odeum/Index.src/M000026.html +24 -0
data/doc/rdoc/classes/Odeum/Index.src/M000027.html +23 -0
data/doc/rdoc/classes/Odeum/Index.src/M000028.html +26 -0
data/doc/rdoc/classes/Odeum/Index.src/M000029.html +24 -0
data/doc/rdoc/classes/Odeum/Index.src/M000030.html +20 -0
data/doc/rdoc/classes/Odeum/Index.src/M000031.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000032.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000033.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000034.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000035.html +20 -0
data/doc/rdoc/classes/Odeum/Index.src/M000036.html +20 -0
data/doc/rdoc/classes/Odeum/Index.src/M000037.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000038.html +22 -0
data/doc/rdoc/classes/Odeum/Index.src/M000039.html +22 -0
data/doc/rdoc/classes/OdeumTest.html +257 -0
data/doc/rdoc/classes/OdeumTest.src/M000001.html +18 -0
data/doc/rdoc/classes/OdeumTest.src/M000002.html +19 -0
data/doc/rdoc/classes/OdeumTest.src/M000003.html +27 -0
data/doc/rdoc/classes/OdeumTest.src/M000004.html +25 -0
data/doc/rdoc/classes/OdeumTest.src/M000005.html +44 -0
data/doc/rdoc/classes/OdeumTest.src/M000006.html +20 -0
data/doc/rdoc/classes/OdeumTest.src/M000007.html +39 -0
data/doc/rdoc/classes/OdeumTest.src/M000008.html +59 -0
data/doc/rdoc/classes/OdeumTest.src/M000009.html +41 -0
data/doc/rdoc/created.rid +1 -0
data/doc/rdoc/files/COPYING.html +756 -0
data/doc/rdoc/files/LICENSE.html +756 -0
data/doc/rdoc/files/README.html +175 -0
data/doc/rdoc/files/ext/odeum_index/odeum_index_c.html +101 -0
data/doc/rdoc/files/test/test_odeum_rb.html +109 -0
data/doc/rdoc/fr_class_index.html +30 -0
data/doc/rdoc/fr_file_index.html +31 -0
data/doc/rdoc/fr_method_index.html +77 -0
data/doc/rdoc/index.html +24 -0
data/doc/rdoc/rdoc-style.css +208 -0
data/ext/odeum_index/cabin.c +2735 -0
data/ext/odeum_index/cabin.h +1040 -0
data/ext/odeum_index/curia.c +1114 -0
data/ext/odeum_index/curia.h +430 -0
data/ext/odeum_index/depot.c +1910 -0
data/ext/odeum_index/depot.h +439 -0
data/ext/odeum_index/extconf.rb +10 -0
data/ext/odeum_index/myconf.c +668 -0
data/ext/odeum_index/myconf.h +523 -0
data/ext/odeum_index/odeum.c +1743 -0
data/ext/odeum_index/odeum.h +541 -0
data/ext/odeum_index/odeum_index.c +991 -0
data/ext/odeum_index/villa.c +1923 -0
data/ext/odeum_index/villa.h +470 -0
data/ext/odeum_index/vista.c +159 -0
data/ext/odeum_index/vista.h +111 -0
data/test/test_odeum.rb +174 -0
metadata +138 -0

data/doc/rdoc/classes/Odeum.src/M000013.html ADDED

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>normalizeword (Odeum)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>/**
+ * call-seq:
+ *   Odeum::normalizeword(asis) -&gt; normal
+ *
+ * Given a word from breaktext (which is considered &quot;as-is&quot;)
+ * it will &quot;normalize&quot; it in a consistent way which is suitable
+ * for searching.  The normalization effectively strips puntuation
+ * and spacing, and then lowercases the word.  If there is nothing
+ * but &quot;removed&quot; chars in the asis string then the return is empty.
+ * Check for this so you don't try to search for nothing.
+ */
+VALUE Odeum_normalizeword(VALUE self, VALUE asis) {
+</pre>
+</body>
+</html>

data/doc/rdoc/classes/Odeum.src/M000014.html ADDED

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>settuning (Odeum)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>/**
+ * call-seq:
+ *   Odeum::settuning(ibnum, idnum, cbnum, csiz) -&gt; nil
+ *
+ * ibnum=32749: Number of buckets for inverted indexes.
+ * idnum=7: Division number of inverted index.
+ * cbnum=262139:  Number of buckets for dirty buffers.
+ * csiz=8388608: Maximum bytes to use memory for dirty buffers.
+ *
+ * This is set globally for all Indexes.  Not sure what would happen
+ * if you changed this mid-stream, so don't.  Make sure everything is closed.
+ */
+VALUE Odeum_settuning(VALUE self, VALUE ibnum, VALUE idnum, VALUE cbnum, VALUE csiz) {
+</pre>
+</body>
+</html>

data/doc/rdoc/classes/Odeum/Document.html ADDED

@@ -0,0 +1,382 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Odeum::Document</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Odeum::Document</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/ext/odeum_index/odeum_index_c.html">
+                ext/odeum_index/odeum_index.c
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000042">[]</a>&nbsp;&nbsp;
+      <a href="#M000041">[]=</a>&nbsp;&nbsp;
+      <a href="#M000045">add_content</a>&nbsp;&nbsp;
+      <a href="#M000044">add_word_list</a>&nbsp;&nbsp;
+      <a href="#M000043">addword</a>&nbsp;&nbsp;
+      <a href="#M000049">asis_words</a>&nbsp;&nbsp;
+      <a href="#M000051">close</a>&nbsp;&nbsp;
+      <a href="#M000046">id</a>&nbsp;&nbsp;
+      <a href="#M000040">new</a>&nbsp;&nbsp;
+      <a href="#M000048">normal_words</a>&nbsp;&nbsp;
+      <a href="#M000050">scores</a>&nbsp;&nbsp;
+      <a href="#M000047">uri</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000040" class="method-detail">
+        <a name="M000040"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000040.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000040.html');return false;">
+          <span class="method-name">Document.new uri &rarr; Document<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+The uri should be specified if you&#8217;re calling this. Internally the
+Ruby/<a href="../Odeum.html">Odeum</a> library kind of &quot;cheats&quot;
+and passes a Qnil for the uri so that the ODDOC can be assigned externally.
+You should not (and probably cannot) do this from Ruby.
+</p>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000042" class="method-detail">
+        <a name="M000042"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000042.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000042.html');return false;">
+          <span class="method-name">document[name] &rarr; String<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Gets the meta-data attribute for the given name. The name must be a String.
+</p>
+        </div>
+      </div>
+      <div id="method-M000041" class="method-detail">
+        <a name="M000041"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000041.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000041.html');return false;">
+          <span class="method-name">doc[attr] = value<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Adds meta-data to the document. They should be Strings only.
+</p>
+        </div>
+      </div>
+      <div id="method-M000045" class="method-detail">
+        <a name="M000045"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000045.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000045.html');return false;">
+          <span class="method-name">document.add_content(content) &rarr; document<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Takes the contents, breaks the words up, and then puts them in the document
+in normalized form. This is the common pattern that people use a <a
+href="Document.html">Document</a> with. You may also use <a
+href="Document.html#M000043">Document.addword</a> to add one word a time,
+and <a href="Document.html#M000044">Document.add_word_list</a> to add a
+list of words.
+</p>
+<p>
+It uses the default Odeum::breaktext method to break up the text, so
+don&#8217;t use this if you need specialized stuffs.
+</p>
+<p>
+If the process of normalizing a word creates an empty word, then it is not
+added to the document&#8217;s words. This usually happens for punctation
+that isn&#8217;t usualy searched for anyway.
+</p>
+        </div>
+      </div>
+      <div id="method-M000044" class="method-detail">
+        <a name="M000044"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000044.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000044.html');return false;">
+          <span class="method-name">document.add_word_list(asis) &rarr; document<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Takes an array of &quot;as-is&quot; words, normalizes them, and puts them
+in the document. It assumes that the array is composed of asis words and
+normalizes them before putting them in the document.
+</p>
+        </div>
+      </div>
+      <div id="method-M000043" class="method-detail">
+        <a name="M000043"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000043.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000043.html');return false;">
+          <span class="method-name">document.addword(normal, asis)<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+The basic call to add a normal and asis version of a word to the document
+for indexing.
+</p>
+        </div>
+      </div>
+      <div id="method-M000049" class="method-detail">
+        <a name="M000049"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000049.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000049.html');return false;">
+          <span class="method-name">document.asis_words &rarr; [word1, word2, ...]<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns all of the asis or &quot;appearance form&quot; words in the
+document.
+</p>
+        </div>
+      </div>
+      <div id="method-M000051" class="method-detail">
+        <a name="M000051"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000051.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000051.html');return false;">
+          <span class="method-name">doc.close &rarr; nil<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Explicitly closes a document. Because of what I can only decide is a bug in
+how an each iterator works, you must explicitly close a document if you are
+not storing it and you are in an each. There are probably subtle things
+about Ruby memory management I&#8217;m missing, but my tests show that all
+<a href="Document.html">Document</a> objects created with <a
+href="Index.html#M000020">Index.get</a> do not get garbage collected until
+they exit a block.
+</p>
+        </div>
+      </div>
+      <div id="method-M000046" class="method-detail">
+        <a name="M000046"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000046.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000046.html');return false;">
+          <span class="method-name">document.id &rarr; Fixnum<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Gives you the <a href="Index.html">Odeum::Index</a> id used to for the
+document.
+</p>
+        </div>
+      </div>
+      <div id="method-M000048" class="method-detail">
+        <a name="M000048"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000048.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000048.html');return false;">
+          <span class="method-name">document.normal_words &rarr; [word1, word2, ... ]<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the list of &quot;normal&quot; words in this document.
+</p>
+        </div>
+      </div>
+      <div id="method-M000050" class="method-detail">
+        <a name="M000050"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000050.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000050.html');return false;">
+          <span class="method-name">document.scores(max, index) &rarr; { word => score, word => score, ...}<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Get the normalized words and their scores in the document. The strange
+thing is that the scores are returned as Strings, but they are decimal
+strings.
+</p>
+        </div>
+      </div>
+      <div id="method-M000047" class="method-detail">
+        <a name="M000047"></a>
+        <div class="method-heading">
+          <a href="Document.src/M000047.html" target="Code" class="method-signature"
+            onclick="popupCode('Document.src/M000047.html');return false;">
+          <span class="method-name">document.uri &rarr; String<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Gets the uri that this document represents.
+</p>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/rdoc/classes/Odeum/Document.src/M000040.html ADDED

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>new (Odeum::Document)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>/**
+ * call-seq:
+ *   Document.new uri -&gt; Document
+ *
+ * The uri should be specified if you're calling this.  Internally the
+ * Ruby/Odeum library kind of &quot;cheats&quot; and passes a Qnil for the uri
+ * so that the ODDOC can be assigned externally.  You should not
+ * (and probably cannot) do this from Ruby.
+ */
+VALUE Document_initialize(VALUE self, VALUE uri) {
+</pre>
+</body>
+</html>