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/Document.src/M000041.html ADDED

@@ -0,0 +1,22 @@
+<?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>[]= (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:
+ *   doc[attr] = value
+ *
+ * Adds meta-data to the document.  They should be Strings only.
+ */
+VALUE Document_addattr(VALUE self, VALUE name, VALUE value) {
+</pre>
+</body>
+</html>

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

@@ -0,0 +1,23 @@
+<?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>[] (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[name] -&gt; String
+ *
+ * Gets the meta-data attribute for the given name.  The name must
+ * be a String.
+ */
+VALUE Document_getattr(VALUE self, VALUE name) {
+</pre>
+</body>
+</html>

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

@@ -0,0 +1,23 @@
+<?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>addword (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.addword(normal, asis)
+ *
+ * The basic call to add a normal and asis version of a word to the
+ * document for indexing.
+ */
+VALUE Document_addword(VALUE self, VALUE normal, VALUE asis) {
+</pre>
+</body>
+</html>

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

@@ -0,0 +1,24 @@
+<?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>add_word_list (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.add_word_list(asis) -&gt; document
+ *
+ * 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.
+ */
+VALUE Document_add_word_list(VALUE self, VALUE asis) {
+</pre>
+</body>
+</html>

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

@@ -0,0 +1,32 @@
+<?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>add_content (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.add_content(content) -&gt; document
+ *
+ * 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 Document
+ * with.  You may also use Document.addword to add one word a time, and
+ * Document.add_word_list to add a list of words.
+ *
+ * It uses the default Odeum::breaktext method to break up the text,
+ * so don't use this if you need specialized stuffs.
+ *
+ * If the process of normalizing a word creates an empty word, then it
+ * is not added to the document's words.  This usually happens for
+ * punctation that isn't usualy searched for anyway.
+ */
+VALUE Document_add_content(VALUE self, VALUE content) {
+</pre>
+</body>
+</html>

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

@@ -0,0 +1,22 @@
+<?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>id (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.id -&gt; Fixnum
+ *
+ * Gives you the Odeum::Index id used to for the document.
+ */
+VALUE Document_id(VALUE self) {
+</pre>
+</body>
+</html>

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

@@ -0,0 +1,22 @@
+<?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>uri (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.uri -&gt; String
+ *
+ * Gets the uri that this document represents.
+ */
+VALUE Document_uri(VALUE self) {
+</pre>
+</body>
+</html>

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

@@ -0,0 +1,22 @@
+<?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>normal_words (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.normal_words -&gt; [word1, word2, ... ]
+ *
+ * Returns the list of &quot;normal&quot; words in this document.
+ */
+VALUE Document_normal_words(VALUE self) {
+</pre>
+</body>
+</html>

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

@@ -0,0 +1,22 @@
+<?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>asis_words (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.asis_words -&gt; [word1, word2, ...]
+ *
+ * Returns all of the asis or &quot;appearance form&quot; words in the document.
+ */
+VALUE Document_asis_words(VALUE self) {
+</pre>
+</body>
+</html>

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

@@ -0,0 +1,24 @@
+<?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>scores (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.scores(max, index) -&gt; { word =&gt; score, word =&gt; score, ...}
+ *
+ * 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.
+ */
+VALUE Document_scores(VALUE self, VALUE max, VALUE odeum_obj) {
+</pre>
+</body>
+</html>

data/doc/rdoc/classes/Odeum/Document.src/M000051.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>close (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:
+ *   doc.close -&gt; nil
+ *
+ * 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'm missing, but my tests
+ * show that all Document objects created with Index.get do not get
+ * garbage collected until they exit a block.
+ */
+VALUE Document_close(VALUE self) {
+</pre>
+</body>
+</html>

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

@@ -0,0 +1,662 @@
+<?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::Index</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::Index</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="#M000032">bucket_count</a>&nbsp;&nbsp;
+      <a href="#M000033">buckets_used</a>&nbsp;&nbsp;
+      <a href="#M000023">check</a>&nbsp;&nbsp;
+      <a href="#M000016">close</a>&nbsp;&nbsp;
+      <a href="#M000018">delete</a>&nbsp;&nbsp;
+      <a href="#M000019">delete_by_id</a>&nbsp;&nbsp;
+      <a href="#M000034">doc_count</a>&nbsp;&nbsp;
+      <a href="#M000037">fatal_error</a>&nbsp;&nbsp;
+      <a href="#M000020">get</a>&nbsp;&nbsp;
+      <a href="#M000021">get_by_id</a>&nbsp;&nbsp;
+      <a href="#M000022">get_id_by_uri</a>&nbsp;&nbsp;
+      <a href="#M000038">inode</a>&nbsp;&nbsp;
+      <a href="#M000026">iterator</a>&nbsp;&nbsp;
+      <a href="#M000039">mtime</a>&nbsp;&nbsp;
+      <a href="#M000030">name</a>&nbsp;&nbsp;
+      <a href="#M000015">new</a>&nbsp;&nbsp;
+      <a href="#M000027">next</a>&nbsp;&nbsp;
+      <a href="#M000029">optimize</a>&nbsp;&nbsp;
+      <a href="#M000017">put</a>&nbsp;&nbsp;
+      <a href="#M000024">search</a>&nbsp;&nbsp;
+      <a href="#M000025">search_doc_count</a>&nbsp;&nbsp;
+      <a href="#M000031">size</a>&nbsp;&nbsp;
+      <a href="#M000028">sync</a>&nbsp;&nbsp;
+      <a href="#M000035">word_count</a>&nbsp;&nbsp;
+      <a href="#M000036">writable</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-M000015" class="method-detail">
+        <a name="M000015"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000015.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000015.html');return false;">
+          <span class="method-name">Index.new(name, mode) &rarr; Index<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Creates an <a href="Index.html">Index</a> with the given name according to
+mode. The name will be used as the basis for a local directory which will
+contain the database for the documents.
+</p>
+<p>
+Possible modes might be:
+</p>
+<ul>
+<li>Odeum::OWRITER &#8212; Opens as a writer.
+</li>
+<li>Odeum::OREADER &#8212; Read-only.
+</li>
+<li>Odeum::OCREAT &#8212; Or&#8216;d in to OWRITER to indicate that you want it
+created if not existing.
+</li>
+<li>Odeum::ONOLOCK &#8212; Opens without locking on the directory.
+</li>
+</ul>
+<p>
+Opening as OWRITER creates an exclusive lock on the database dir, but
+OREADER opens with a shared lock. A thread will block until the lock is
+achieved, but none of this has been tested in Ruby with Ruby&#8217;s
+in-process threads.
+</p>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000032" class="method-detail">
+        <a name="M000032"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000032.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000032.html');return false;">
+          <span class="method-name">index.bucket_count &rarr; Fixnum<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the total number of elements of the bucket arrays, or -1 on
+failure.
+</p>
+        </div>
+      </div>
+      <div id="method-M000033" class="method-detail">
+        <a name="M000033"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000033.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000033.html');return false;">
+          <span class="method-name">index.buckets_used &rarr; Fixnum<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+The total number of used elements of the bucket arrays, or -1 if failure.
+</p>
+        </div>
+      </div>
+      <div id="method-M000023" class="method-detail">
+        <a name="M000023"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000023.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000023.html');return false;">
+          <span class="method-name">index.check(id)<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Checks if a document with the given id is in the database.
+</p>
+        </div>
+      </div>
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000016.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000016.html');return false;">
+          <span class="method-name">Index.close &rarr; true/false<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Closes the <a href="Index.html">Index</a> explicitly. It will be closed by
+the GC when Index_free is finally called, but don&#8217;t rely on this as
+it is not reliable enough. Don&#8216;t use the index after this, it will
+throw an exception or possibly crash.
+</p>
+        </div>
+      </div>
+      <div id="method-M000018" class="method-detail">
+        <a name="M000018"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000018.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000018.html');return false;">
+          <span class="method-name">index.delete(uri) &rarr; true/false<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Deletes the document given by the uri. The <a href="Index.html">Index</a>
+must be opened as a writer, and the call will return false if no such
+document exists.
+</p>
+        </div>
+      </div>
+      <div id="method-M000019" class="method-detail">
+        <a name="M000019"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000019.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000019.html');return false;">
+          <span class="method-name">index.delete_by_id(id) &rarr; true/false<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Deletes a document based on its id.
+</p>
+        </div>
+      </div>
+      <div id="method-M000034" class="method-detail">
+        <a name="M000034"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000034.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000034.html');return false;">
+          <span class="method-name">index.doc_count &rarr; Fixnum<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Number of documents stored in the database, or -1 on failure.
+</p>
+        </div>
+      </div>
+      <div id="method-M000037" class="method-detail">
+        <a name="M000037"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000037.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000037.html');return false;">
+          <span class="method-name">index.fatal_error &rarr; Fixnum<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns true if there&#8217;s a fatal error or false otherwise.
+</p>
+        </div>
+      </div>
+      <div id="method-M000020" class="method-detail">
+        <a name="M000020"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000020.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000020.html');return false;">
+          <span class="method-name">index.get(uri) &rarr; Document<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Gets a <a href="Document.html">Document</a> based on the uri, or returns
+nil.
+</p>
+        </div>
+      </div>
+      <div id="method-M000021" class="method-detail">
+        <a name="M000021"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000021.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000021.html');return false;">
+          <span class="method-name">index.get_by_id(id) &rarr; Document<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Gets a <a href="Document.html">Document</a> based on its id, or nil if that
+document isn&#8217;t there.
+</p>
+        </div>
+      </div>
+      <div id="method-M000022" class="method-detail">
+        <a name="M000022"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000022.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000022.html');return false;">
+          <span class="method-name">index.get_id_by_uri(id)<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns just the id of the document with the given uri.
+</p>
+        </div>
+      </div>
+      <div id="method-M000038" class="method-detail">
+        <a name="M000038"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000038.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000038.html');return false;">
+          <span class="method-name">index.inode &rarr; Fixnum<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+The inode number of the database directory.
+</p>
+        </div>
+      </div>
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000026.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000026.html');return false;">
+          <span class="method-name">index.iterator &rarr; true/false<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Begins an iterator loop to process documents in the system. An
+iterator/next pattern is used due to the difficulty of getting memory
+collection correct inside an each/block design.
+</p>
+        </div>
+      </div>
+      <div id="method-M000039" class="method-detail">
+        <a name="M000039"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000039.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000039.html');return false;">
+          <span class="method-name">index.mtime &rarr; Fixnum<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+The mtime of the database directory.
+</p>
+        </div>
+      </div>
+      <div id="method-M000030" class="method-detail">
+        <a name="M000030"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000030.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000030.html');return false;">
+          <span class="method-name">name</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+call-seq:
+</p>
+<pre>
+   index.name -&gt; String
+</pre>
+        </div>
+      </div>
+      <div id="method-M000027" class="method-detail">
+        <a name="M000027"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000027.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000027.html');return false;">
+          <span class="method-name">index.next &rarr; Document<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the next document or nil if there was an error. Must call <a
+href="Index.html#M000026">Index.iterator</a> first.
+</p>
+        </div>
+      </div>
+      <div id="method-M000029" class="method-detail">
+        <a name="M000029"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000029.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000029.html');return false;">
+          <span class="method-name">index.optimize &rarr; true/false<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Purges deleted documents from the index. I found that if you call this
+while you are updating documents then it stops adding documents after the
+optimize call.
+</p>
+        </div>
+      </div>
+      <div id="method-M000017" class="method-detail">
+        <a name="M000017"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000017.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000017.html');return false;">
+          <span class="method-name">index.put(doc, wmax, over) &rarr; true/false<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Puts the <a href="Document.html">Document</a> doc into the <a
+href="Index.html">Index</a>, and indexes a maximum of wmax words in the
+document. If over is true than the document is overwritten in the database.
+Otherwise, if the document already exists in the database and over==
+nil/false then the method will return false as an error.
+</p>
+        </div>
+      </div>
+      <div id="method-M000024" class="method-detail">
+        <a name="M000024"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000024.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000024.html');return false;">
+          <span class="method-name">index.search(word, max) &rarr; [[id,score], ... ]<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+The big payoff method which actually searches for the documents that have
+the given word mentioned. The result of the search is an array of
+&quot;tuples&quot; with [id, score] and sorted in score order from
+descending order of their scores. If there are no results then it returns
+an empty array.
+</p>
+<p>
+If the search attempt fails for some reason then an exception is thrown,
+but an empty result is NOT a failure (that returns an empty hash).
+</p>
+        </div>
+      </div>
+      <div id="method-M000025" class="method-detail">
+        <a name="M000025"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000025.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000025.html');return false;">
+          <span class="method-name">index.search_doc_count(word) &rarr; Fixnum<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the number of document matching the given word. If the word does
+not match anything then it returns -1.
+</p>
+        </div>
+      </div>
+      <div id="method-M000031" class="method-detail">
+        <a name="M000031"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000031.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000031.html');return false;">
+          <span class="method-name">index.size &rarr; Fixnum<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the size of the database files or -1 if there&#8217;s a failure.
+</p>
+        </div>
+      </div>
+      <div id="method-M000028" class="method-detail">
+        <a name="M000028"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000028.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000028.html');return false;">
+          <span class="method-name">index.sync &rarr; true/false<br />
+</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Synchronizes any changes you have made with the database. If you
+don&#8217;t do this every once in a while then the memory load will get to
+great. I found that every 1000 documents or so is a good trade-off.
+</p>
+<p>
+Returns true if everything worked, or false otherwise.
+</p>
+        </div>
+      </div>
+      <div id="method-M000035" class="method-detail">
+        <a name="M000035"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000035.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000035.html');return false;">
+          <span class="method-name">word_count</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+call-seq:
+</p>
+<pre>
+  index.word_count -&gt; Fixnum
+</pre>
+        </div>
+      </div>
+      <div id="method-M000036" class="method-detail">
+        <a name="M000036"></a>
+        <div class="method-heading">
+          <a href="Index.src/M000036.html" target="Code" class="method-signature"
+            onclick="popupCode('Index.src/M000036.html');return false;">
+          <span class="method-name">writable</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+call-seq:
+</p>
+<pre>
+  index.writable -&gt; true/false
+</pre>
+        </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>