Author: buildbot
Date: Tue Dec 2 17:54:11 2014
New Revision: 931398
Log:
Staging update by buildbot for lucy
Modified:
websites/staging/lucy/trunk/content/ (props changed)
websites/staging/lucy/trunk/content/docs/c/cfish.html
websites/staging/lucy/trunk/content/docs/c/cfish_Err.html
websites/staging/lucy/trunk/content/docs/c/cfish_Obj.html
websites/staging/lucy/trunk/content/docs/c/lucy.html
websites/staging/lucy/trunk/content/docs/c/lucy_ANDQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_Analyzer.html
websites/staging/lucy/trunk/content/docs/c/lucy_Architecture.html
websites/staging/lucy/trunk/content/docs/c/lucy_BackgroundMerger.html
websites/staging/lucy/trunk/content/docs/c/lucy_BitCollector.html
websites/staging/lucy/trunk/content/docs/c/lucy_BitVector.html
websites/staging/lucy/trunk/content/docs/c/lucy_BlobType.html
websites/staging/lucy/trunk/content/docs/c/lucy_CaseFolder.html
websites/staging/lucy/trunk/content/docs/c/lucy_Collector.html
websites/staging/lucy/trunk/content/docs/c/lucy_Compiler.html
websites/staging/lucy/trunk/content/docs/c/lucy_DataReader.html
websites/staging/lucy/trunk/content/docs/c/lucy_DataWriter.html
websites/staging/lucy/trunk/content/docs/c/lucy_DeletionsWriter.html
websites/staging/lucy/trunk/content/docs/c/lucy_Doc.html
websites/staging/lucy/trunk/content/docs/c/lucy_DocReader.html
websites/staging/lucy/trunk/content/docs/c/lucy_EasyAnalyzer.html
websites/staging/lucy/trunk/content/docs/c/lucy_FSFolder.html
websites/staging/lucy/trunk/content/docs/c/lucy_FieldType.html
websites/staging/lucy/trunk/content/docs/c/lucy_Folder.html
websites/staging/lucy/trunk/content/docs/c/lucy_FullTextType.html
websites/staging/lucy/trunk/content/docs/c/lucy_Highlighter.html
websites/staging/lucy/trunk/content/docs/c/lucy_HitDoc.html
websites/staging/lucy/trunk/content/docs/c/lucy_Hits.html
websites/staging/lucy/trunk/content/docs/c/lucy_IndexManager.html
websites/staging/lucy/trunk/content/docs/c/lucy_IndexReader.html
websites/staging/lucy/trunk/content/docs/c/lucy_IndexSearcher.html
websites/staging/lucy/trunk/content/docs/c/lucy_Indexer.html
websites/staging/lucy/trunk/content/docs/c/lucy_LeafQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_Lexicon.html
websites/staging/lucy/trunk/content/docs/c/lucy_LexiconReader.html
websites/staging/lucy/trunk/content/docs/c/lucy_Lock.html
websites/staging/lucy/trunk/content/docs/c/lucy_LockErr.html
websites/staging/lucy/trunk/content/docs/c/lucy_LockFactory.html
websites/staging/lucy/trunk/content/docs/c/lucy_MatchAllQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_Matcher.html
websites/staging/lucy/trunk/content/docs/c/lucy_NOTQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_NoMatchQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_Normalizer.html
websites/staging/lucy/trunk/content/docs/c/lucy_ORQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_PhraseQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_PolyAnalyzer.html
websites/staging/lucy/trunk/content/docs/c/lucy_PolyQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_PolyReader.html
websites/staging/lucy/trunk/content/docs/c/lucy_PolySearcher.html
websites/staging/lucy/trunk/content/docs/c/lucy_PostingList.html
websites/staging/lucy/trunk/content/docs/c/lucy_PostingListReader.html
websites/staging/lucy/trunk/content/docs/c/lucy_ProximityQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_Query.html
websites/staging/lucy/trunk/content/docs/c/lucy_QueryParser.html
websites/staging/lucy/trunk/content/docs/c/lucy_RAMFolder.html
websites/staging/lucy/trunk/content/docs/c/lucy_RangeQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_RegexTokenizer.html
websites/staging/lucy/trunk/content/docs/c/lucy_RequiredOptionalQuery.html
websites/staging/lucy/trunk/content/docs/c/lucy_Schema.html
websites/staging/lucy/trunk/content/docs/c/lucy_Searcher.html
websites/staging/lucy/trunk/content/docs/c/lucy_SegReader.html
websites/staging/lucy/trunk/content/docs/c/lucy_SegWriter.html
websites/staging/lucy/trunk/content/docs/c/lucy_Segment.html
websites/staging/lucy/trunk/content/docs/c/lucy_Similarity.html
websites/staging/lucy/trunk/content/docs/c/lucy_Snapshot.html
websites/staging/lucy/trunk/content/docs/c/lucy_SnowballStemmer.html
websites/staging/lucy/trunk/content/docs/c/lucy_SnowballStopFilter.html
websites/staging/lucy/trunk/content/docs/c/lucy_SortRule.html
websites/staging/lucy/trunk/content/docs/c/lucy_SortSpec.html
websites/staging/lucy/trunk/content/docs/c/lucy_Span.html
websites/staging/lucy/trunk/content/docs/c/lucy_StandardTokenizer.html
websites/staging/lucy/trunk/content/docs/c/lucy_StringType.html
websites/staging/lucy/trunk/content/docs/c/lucy_TermQuery.html
Propchange: websites/staging/lucy/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Dec 2 17:54:11 2014
@@ -1 +1 @@
-1641232
+1642966
Modified: websites/staging/lucy/trunk/content/docs/c/cfish.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/cfish.html (original)
+++ websites/staging/lucy/trunk/content/docs/c/cfish.html Tue Dec 2 17:54:11
2014
@@ -1,29 +1,73 @@
<!DOCTYPE html>
<html>
<head>
+<meta charset="utf-8">
+<!--
+***********************************************
+
+!!!! DO NOT EDIT !!!!
+
+This file was auto-generated by cfc.
+
+***********************************************
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
<meta name="viewport" content="width=device-width" />
+<title>Clownfish â C API Index</title>
<style type="text/css">
body {
- font-family: sans-serif;
- font-size: 0.85em;
- max-width: 640px;
+ max-width: 48em;
+ font: 0.85em/1.4 sans-serif;
+}
+a {
+ color: #23b;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 0;
+}
+td.label {
+ padding-right: 2em;
+ font-weight: bold;
}
dt {
font-weight: bold;
}
pre {
- border: 1px solid #000;
+ border: 1px solid #ccc;
padding: 0.2em 0.4em;
background: #f6f6f6;
- font-size: 1.2em;
+ font-size: 0.92em;
+}
+pre a {
+ text-decoration: none;
}
-code {
+pre, code {
font-family: "Consolas", "Menlo", monospace;
}
+span.prefix, span.comment {
+ color: #888;
+}
</style>
</head>
<body>
-<h1>C API documentation for Clownfish</h1>
+<h1>Clownfish â C API Index</h1>
<ul>
<li><a href="cfish_Err.html">Clownfish::Err</a></li>
<li><a href="cfish_Obj.html">Clownfish::Obj</a></li>
Modified: websites/staging/lucy/trunk/content/docs/c/cfish_Err.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/cfish_Err.html (original)
+++ websites/staging/lucy/trunk/content/docs/c/cfish_Err.html Tue Dec 2
17:54:11 2014
@@ -1,31 +1,97 @@
<!DOCTYPE html>
<html>
<head>
+<meta charset="utf-8">
+<!--
+***********************************************
+
+!!!! DO NOT EDIT !!!!
+
+This file was auto-generated by cfc.
+
+***********************************************
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
<meta name="viewport" content="width=device-width" />
+<title>Clownfish::Err â C API Documentation</title>
<style type="text/css">
body {
- font-family: sans-serif;
- font-size: 0.85em;
- max-width: 640px;
+ max-width: 48em;
+ font: 0.85em/1.4 sans-serif;
+}
+a {
+ color: #23b;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 0;
+}
+td.label {
+ padding-right: 2em;
+ font-weight: bold;
}
dt {
font-weight: bold;
}
pre {
- border: 1px solid #000;
+ border: 1px solid #ccc;
padding: 0.2em 0.4em;
background: #f6f6f6;
- font-size: 1.2em;
+ font-size: 0.92em;
+}
+pre a {
+ text-decoration: none;
}
-code {
+pre, code {
font-family: "Consolas", "Menlo", monospace;
}
+span.prefix, span.comment {
+ color: #888;
+}
</style>
</head>
<body>
<h1>Clownfish::Err</h1>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="cfish.html">Clownfish</a></td>
+</tr>
+<tr>
+<td class="label">class name</td>
+<td>Clownfish::Err</td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td>Err</td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code>CFISH_ERR</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code>cfish_Err</code></td>
+</tr>
+</table>
<h2>Name</h2>
-<p>Clownfish::Err - Exception.</p>
+<p>Clownfish::Err â Exception.</p>
<h2>Description</h2>
<p>Clownfish::Err is the base class for exceptions in the Clownfish object
hierarchy.</p>
@@ -35,26 +101,26 @@ temporarily, so that calling code may ch
error condition.</p>
<h2>Functions</h2>
<dl>
-<dt>set_error</dt>
+<dt id="func_set_error">set_error</dt>
<dd>
<pre><code>void
-<strong>cfish_Err_set_error</strong>(
- cfish_Err* <strong>error</strong> // decremented
+<span class="prefix">cfish_</span><strong>Err_set_error</strong>(
+ <span class="prefix">cfish_</span>Err* <strong>error</strong> <span
class="comment">// decremented</span>
);
</code></pre>
<p>Set the value of "error", a per-thread Err shared variable.</p>
</dd>
-<dt>get_error</dt>
+<dt id="func_get_error">get_error</dt>
<dd>
-<pre><code>cfish_Err*
-<strong>cfish_Err_get_error</strong>(void);
+<pre><code><span class="prefix">cfish_</span>Err*
+<span class="prefix">cfish_</span><strong>Err_get_error</strong>(void);
</code></pre>
<p>Retrieve per-thread Err shared variable "error".</p>
</dd>
-<dt>trap</dt>
+<dt id="func_trap">trap</dt>
<dd>
-<pre><code>cfish_Err* // incremented
-<strong>cfish_Err_trap</strong>(
+<pre><code><span class="prefix">cfish_</span>Err* <span class="comment">//
incremented</span>
+<span class="prefix">cfish_</span><strong>Err_trap</strong>(
CFISH_Err_Attempt_t <strong>routine</strong>,
void* <strong>context</strong>
);
@@ -67,23 +133,23 @@ Err so that it can be handled by Clownfi
</dd>
</dl>
<h2>Methods</h2>
-<h3>Novel methods</h3>
+<h3>Novel methods</h3
<dl>
-<dt>Cat_Mess</dt>
+<dt id="func_Cat_Mess">Cat_Mess</dt>
<dd>
<pre><code>void
-<strong>CFISH_Err_Cat_Mess</strong>(
- cfish_Err* <strong>self</strong>,
- <a href="cfish_String.html">cfish_String*</a> <strong>mess</strong>
+<span class="prefix">CFISH_</span><strong>Err_Cat_Mess</strong>(
+ <span class="prefix">cfish_</span>Err* <strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a>
<strong>mess</strong>
);
</code></pre>
<p>Concatenate the supplied argument onto the internal "mess".</p>
</dd>
-<dt>Get_Mess</dt>
+<dt id="func_Get_Mess">Get_Mess</dt>
<dd>
-<pre><code><a href="cfish_String.html">cfish_String*</a>
-<strong>CFISH_Err_Get_Mess</strong>(
- cfish_Err* <strong>self</strong>
+<pre><code><span class="prefix">cfish_</span><a
href="cfish_String.html">String*</a>
+<span class="prefix">CFISH_</span><strong>Err_Get_Mess</strong>(
+ <span class="prefix">cfish_</span>Err* <strong>self</strong>
);
</code></pre>
</dd>
Modified: websites/staging/lucy/trunk/content/docs/c/cfish_Obj.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/cfish_Obj.html (original)
+++ websites/staging/lucy/trunk/content/docs/c/cfish_Obj.html Tue Dec 2
17:54:11 2014
@@ -1,67 +1,159 @@
<!DOCTYPE html>
<html>
<head>
+<meta charset="utf-8">
+<!--
+***********************************************
+
+!!!! DO NOT EDIT !!!!
+
+This file was auto-generated by cfc.
+
+***********************************************
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
<meta name="viewport" content="width=device-width" />
+<title>Clownfish::Obj â C API Documentation</title>
<style type="text/css">
body {
- font-family: sans-serif;
- font-size: 0.85em;
- max-width: 640px;
+ max-width: 48em;
+ font: 0.85em/1.4 sans-serif;
+}
+a {
+ color: #23b;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 0;
+}
+td.label {
+ padding-right: 2em;
+ font-weight: bold;
}
dt {
font-weight: bold;
}
pre {
- border: 1px solid #000;
+ border: 1px solid #ccc;
padding: 0.2em 0.4em;
background: #f6f6f6;
- font-size: 1.2em;
+ font-size: 0.92em;
}
-code {
+pre a {
+ text-decoration: none;
+}
+pre, code {
font-family: "Consolas", "Menlo", monospace;
}
+span.prefix, span.comment {
+ color: #888;
+}
</style>
</head>
<body>
<h1>Clownfish::Obj</h1>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="cfish.html">Clownfish</a></td>
+</tr>
+<tr>
+<td class="label">class name</td>
+<td>Clownfish::Obj</td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td>Obj</td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code>CFISH_OBJ</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code>cfish_Obj</code></td>
+</tr>
+</table>
<h2>Name</h2>
-<p>Clownfish::Obj - Base class for all objects.</p>
+<p>Clownfish::Obj â Base class for all objects.</p>
<h2>Functions</h2>
<dl>
-<dt>init</dt>
+<dt id="func_init">init</dt>
<dd>
-<pre><code>cfish_Obj*
-<strong>cfish_Obj_init</strong>(
- cfish_Obj* <strong>self</strong>
+<pre><code><span class="prefix">cfish_</span>Obj*
+<span class="prefix">cfish_</span><strong>Obj_init</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>
);
</code></pre>
<p>Abstract initializer.</p>
</dd>
</dl>
<h2>Methods</h2>
-<h3>Abstract methods</h3>
+<h3>Novel methods</h3
<dl>
-<dt>Clone</dt>
+<dt id="func_Clone">Clone <span class="comment">(abstract)</span></dt>
<dd>
-<pre><code>cfish_Obj* // incremented
-<strong>CFISH_Obj_Clone</strong>(
- cfish_Obj* <strong>self</strong>
+<pre><code><span class="prefix">cfish_</span>Obj* <span class="comment">//
incremented</span>
+<span class="prefix">CFISH_</span><strong>Obj_Clone</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>
);
</code></pre>
<p>Return a clone of the object.</p>
</dd>
-<dt>Compare_To</dt>
+<dt id="func_Destroy">Destroy</dt>
+<dd>
+<pre><code>void
+<span class="prefix">CFISH_</span><strong>Obj_Destroy</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>
+);
+</code></pre>
+<p>Generic destructor. Frees the struct itself but not any complex
+member elements.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">CFISH_</span><strong>Obj_Equals</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>,
+ <span class="prefix">cfish_</span>Obj* <strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether two objects are the same. By default, compares the
+memory address.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another Obj.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Compare_To">Compare_To <span
class="comment">(abstract)</span></dt>
<dd>
<pre><code>int32_t
-<strong>CFISH_Obj_Compare_To</strong>(
- cfish_Obj* <strong>self</strong>,
- cfish_Obj* <strong>other</strong>
+<span class="prefix">CFISH_</span><strong>Obj_Compare_To</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>,
+ <span class="prefix">cfish_</span>Obj* <strong>other</strong>
);
</code></pre>
<p>Indicate whether one object is less than, equal to, or greater than
another.</p>
<dl>
-<dt><emph>other</emph></dt>
+<dt>other</dt>
<dd><p>Another Obj.</p>
</dd>
</dl>
@@ -69,119 +161,90 @@ another.</p>
<code>self</code> is less than <code>other</code>, and a positive
number if <code>self</code> is greater than <code>other</code>.</p>
</dd>
-<dt>To_I64</dt>
-<dd>
-<pre><code>int64_t
-<strong>CFISH_Obj_To_I64</strong>(
- cfish_Obj* <strong>self</strong>
-);
-</code></pre>
-<p>Convert the object to a 64-bit integer.</p>
-</dd>
-<dt>To_F64</dt>
+<dt id="func_Hash_Sum">Hash_Sum</dt>
<dd>
-<pre><code>double
-<strong>CFISH_Obj_To_F64</strong>(
- cfish_Obj* <strong>self</strong>
+<pre><code>int32_t
+<span class="prefix">CFISH_</span><strong>Obj_Hash_Sum</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>
);
</code></pre>
-<p>Convert the object to a double precision floating point number.</p>
+<p>Return a hash code for the object -- by default, the memory address.</p>
</dd>
-<dt>Mimic</dt>
+<dt id="func_Get_Class">Get_Class</dt>
<dd>
-<pre><code>void
-<strong>CFISH_Obj_Mimic</strong>(
- cfish_Obj* <strong>self</strong>,
- cfish_Obj* <strong>other</strong>
+<pre><code><span class="prefix">cfish_</span><a
href="cfish_Class.html">Class*</a>
+<span class="prefix">CFISH_</span><strong>Obj_Get_Class</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>
);
</code></pre>
-<p>Update the internal state of the object to mimic that of
-<code>other</code>.</p>
+<p>Return the object's Class.</p>
</dd>
-</dl>
-<h3>Novel methods</h3>
-<dl>
-<dt>Destroy</dt>
+<dt id="func_Get_Class_Name">Get_Class_Name</dt>
<dd>
-<pre><code>void
-<strong>CFISH_Obj_Destroy</strong>(
- cfish_Obj* <strong>self</strong>
+<pre><code><span class="prefix">cfish_</span><a
href="cfish_String.html">String*</a>
+<span class="prefix">CFISH_</span><strong>Obj_Get_Class_Name</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>
);
</code></pre>
-<p>Generic destructor. Frees the struct itself but not any complex
-member elements.</p>
+<p>Return the name of the class that the object belongs to.</p>
</dd>
-<dt>Equals</dt>
+<dt id="func_Is_A">Is_A</dt>
<dd>
<pre><code>bool
-<strong>CFISH_Obj_Equals</strong>(
- cfish_Obj* <strong>self</strong>,
- cfish_Obj* <strong>other</strong>
+<span class="prefix">CFISH_</span><strong>Obj_Is_A</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="cfish_Class.html">Class*</a>
<strong>ancestor</strong>
);
</code></pre>
-<p>Indicate whether two objects are the same. By default, compares the
-memory address.</p>
-<dl>
-<dt><emph>other</emph></dt>
-<dd><p>Another Obj.</p>
-</dd>
-</dl>
+<p>Indicate whether the object is a descendent of <code>ancestor</code>.</p>
</dd>
-<dt>Hash_Sum</dt>
+<dt id="func_To_String">To_String</dt>
<dd>
-<pre><code>int32_t
-<strong>CFISH_Obj_Hash_Sum</strong>(
- cfish_Obj* <strong>self</strong>
+<pre><code><span class="prefix">cfish_</span><a
href="cfish_String.html">String*</a> <span class="comment">// incremented</span>
+<span class="prefix">CFISH_</span><strong>Obj_To_String</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>
);
</code></pre>
-<p>Return a hash code for the object -- by default, the memory address.</p>
+<p>Generic stringification: "ClassName@hex_mem_address".</p>
</dd>
-<dt>Get_Class</dt>
+<dt id="func_To_I64">To_I64 <span class="comment">(abstract)</span></dt>
<dd>
-<pre><code><a href="cfish_Class.html">cfish_Class*</a>
-<strong>CFISH_Obj_Get_Class</strong>(
- cfish_Obj* <strong>self</strong>
+<pre><code>int64_t
+<span class="prefix">CFISH_</span><strong>Obj_To_I64</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>
);
</code></pre>
-<p>Return the object's Class.</p>
+<p>Convert the object to a 64-bit integer.</p>
</dd>
-<dt>Get_Class_Name</dt>
+<dt id="func_To_F64">To_F64 <span class="comment">(abstract)</span></dt>
<dd>
-<pre><code><a href="cfish_String.html">cfish_String*</a>
-<strong>CFISH_Obj_Get_Class_Name</strong>(
- cfish_Obj* <strong>self</strong>
+<pre><code>double
+<span class="prefix">CFISH_</span><strong>Obj_To_F64</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>
);
</code></pre>
-<p>Return the name of the class that the object belongs to.</p>
+<p>Convert the object to a double precision floating point number.</p>
</dd>
-<dt>Is_A</dt>
+<dt id="func_To_Bool">To_Bool</dt>
<dd>
<pre><code>bool
-<strong>CFISH_Obj_Is_A</strong>(
- cfish_Obj* <strong>self</strong>,
- <a href="cfish_Class.html">cfish_Class*</a> <strong>ancestor</strong>
-);
-</code></pre>
-<p>Indicate whether the object is a descendent of <code>ancestor</code>.</p>
-</dd>
-<dt>To_String</dt>
-<dd>
-<pre><code><a href="cfish_String.html">cfish_String*</a> // incremented
-<strong>CFISH_Obj_To_String</strong>(
- cfish_Obj* <strong>self</strong>
+<span class="prefix">CFISH_</span><strong>Obj_To_Bool</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>
);
</code></pre>
-<p>Generic stringification: "ClassName@hex_mem_address".</p>
+<p>Evaluate the object in a boolean context. By default, invokes
+<a href="cfish_Obj.html#func_To_I64">To_I64()</a> and returns true if it is
non-zero.</p>
</dd>
-<dt>To_Bool</dt>
+<dt id="func_Mimic">Mimic <span class="comment">(abstract)</span></dt>
<dd>
-<pre><code>bool
-<strong>CFISH_Obj_To_Bool</strong>(
- cfish_Obj* <strong>self</strong>
+<pre><code>void
+<span class="prefix">CFISH_</span><strong>Obj_Mimic</strong>(
+ <span class="prefix">cfish_</span>Obj* <strong>self</strong>,
+ <span class="prefix">cfish_</span>Obj* <strong>other</strong>
);
</code></pre>
-<p>Evaluate the object in a boolean context. By default, invokes
-To_I64() and returns true if it is non-zero.</p>
+<p>Update the internal state of the object to mimic that of
+<code>other</code>.</p>
</dd>
</dl>
</body>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/lucy.html (original)
+++ websites/staging/lucy/trunk/content/docs/c/lucy.html Tue Dec 2 17:54:11
2014
@@ -1,29 +1,73 @@
<!DOCTYPE html>
<html>
<head>
+<meta charset="utf-8">
+<!--
+***********************************************
+
+!!!! DO NOT EDIT !!!!
+
+This file was auto-generated by cfc.
+
+***********************************************
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
<meta name="viewport" content="width=device-width" />
+<title>Lucy â C API Index</title>
<style type="text/css">
body {
- font-family: sans-serif;
- font-size: 0.85em;
- max-width: 640px;
+ max-width: 48em;
+ font: 0.85em/1.4 sans-serif;
+}
+a {
+ color: #23b;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 0;
+}
+td.label {
+ padding-right: 2em;
+ font-weight: bold;
}
dt {
font-weight: bold;
}
pre {
- border: 1px solid #000;
+ border: 1px solid #ccc;
padding: 0.2em 0.4em;
background: #f6f6f6;
- font-size: 1.2em;
+ font-size: 0.92em;
+}
+pre a {
+ text-decoration: none;
}
-code {
+pre, code {
font-family: "Consolas", "Menlo", monospace;
}
+span.prefix, span.comment {
+ color: #888;
+}
</style>
</head>
<body>
-<h1>C API documentation for Lucy</h1>
+<h1>Lucy â C API Index</h1>
<ul>
<li><a href="lucy_Analyzer.html">Lucy::Analysis::Analyzer</a></li>
<li><a href="lucy_CaseFolder.html">Lucy::Analysis::CaseFolder</a></li>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy_ANDQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/lucy_ANDQuery.html (original)
+++ websites/staging/lucy/trunk/content/docs/c/lucy_ANDQuery.html Tue Dec 2
17:54:11 2014
@@ -1,143 +1,211 @@
<!DOCTYPE html>
<html>
<head>
+<meta charset="utf-8">
+<!--
+***********************************************
+
+!!!! DO NOT EDIT !!!!
+
+This file was auto-generated by cfc.
+
+***********************************************
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
<meta name="viewport" content="width=device-width" />
+<title>Lucy::Search::ANDQuery â C API Documentation</title>
<style type="text/css">
body {
- font-family: sans-serif;
- font-size: 0.85em;
- max-width: 640px;
+ max-width: 48em;
+ font: 0.85em/1.4 sans-serif;
+}
+a {
+ color: #23b;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 0;
+}
+td.label {
+ padding-right: 2em;
+ font-weight: bold;
}
dt {
font-weight: bold;
}
pre {
- border: 1px solid #000;
+ border: 1px solid #ccc;
padding: 0.2em 0.4em;
background: #f6f6f6;
- font-size: 1.2em;
+ font-size: 0.92em;
}
-code {
+pre a {
+ text-decoration: none;
+}
+pre, code {
font-family: "Consolas", "Menlo", monospace;
}
+span.prefix, span.comment {
+ color: #888;
+}
</style>
</head>
<body>
<h1>Lucy::Search::ANDQuery</h1>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class name</td>
+<td>Lucy::Search::ANDQuery</td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td>ANDQuery</td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code>LUCY_ANDQUERY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code>lucy_ANDQuery</code></td>
+</tr>
+</table>
<h2>Name</h2>
-<p>Lucy::Search::ANDQuery - Intersect multiple result sets.</p>
+<p>Lucy::Search::ANDQuery â Intersect multiple result sets.</p>
<h2>Description</h2>
<p>ANDQuery is a composite <a href="lucy_Query.html">Query</a> which matches
only when all of its children match, so its result set is the intersection
of their result sets. Documents which match receive a summed score.</p>
<h2>Functions</h2>
<dl>
-<dt>init</dt>
+<dt id="func_init">init</dt>
<dd>
-<pre><code>lucy_ANDQuery*
-<strong>lucy_ANDQuery_init</strong>(
- lucy_ANDQuery* <strong>self</strong>,
- <a href="cfish_VArray.html">cfish_VArray*</a> <strong>children</strong>
+<pre><code><span class="prefix">lucy_</span>ANDQuery*
+<span class="prefix">lucy_</span><strong>ANDQuery_init</strong>(
+ <span class="prefix">lucy_</span>ANDQuery* <strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a>
<strong>children</strong>
);
</code></pre>
<dl>
-<dt><emph>children</emph></dt>
+<dt>children</dt>
<dd><p>An array of child Queries.</p>
</dd>
</dl>
</dd>
</dl>
<h2>Methods</h2>
-<h3>Methods inherited from Lucy::Search::PolyQuery</h3><dl>
-<dt>Add_Child</dt>
+<h3>Methods inherited from Lucy::Search::PolyQuery</h3>
+<dl>
+<dt id="func_Add_Child">Add_Child</dt>
<dd>
<pre><code>void
-<strong>LUCY_PolyQuery_Add_Child</strong>(
- lucy_PolyQuery* <strong>self</strong>,
- <a href="lucy_Query.html">lucy_Query*</a> <strong>query</strong>
+<span class="prefix">LUCY_</span><strong>PolyQuery_Add_Child</strong>(
+ <span class="prefix">lucy_</span>PolyQuery* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a>
<strong>query</strong>
);
</code></pre>
<p>Add a child Query node.</p>
</dd>
</dl>
-<h3>Methods inherited from Lucy::Search::Query</h3><dl>
-<dt>Make_Compiler</dt>
+<h3>Methods inherited from Lucy::Search::Query</h3>
+<dl>
+<dt id="func_Make_Compiler">Make_Compiler <span
class="comment">(abstract)</span></dt>
<dd>
-<pre><code><a href="lucy_Compiler.html">lucy_Compiler*</a> // incremented
-<strong>LUCY_Query_Make_Compiler</strong>(
- lucy_Query* <strong>self</strong>,
- <a href="lucy_Searcher.html">lucy_Searcher*</a> <strong>searcher</strong>,
+<pre><code><span class="prefix">lucy_</span><a
href="lucy_Compiler.html">Compiler*</a> <span class="comment">//
incremented</span>
+<span class="prefix">LUCY_</span><strong>Query_Make_Compiler</strong>(
+ <span class="prefix">lucy_</span>Query* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_Searcher.html">Searcher*</a> <strong>searcher</strong>,
float <strong>boost</strong>,
bool <strong>subordinate</strong>
);
</code></pre>
<p>Abstract factory method returning a Compiler derived from this Query.</p>
<dl>
-<dt><emph>searcher</emph></dt>
+<dt>searcher</dt>
<dd><p>A Searcher.</p>
</dd>
-<dt><emph>boost</emph></dt>
+<dt>boost</dt>
<dd><p>A scoring multiplier.</p>
</dd>
-<dt><emph>subordinate</emph></dt>
+<dt>subordinate</dt>
<dd><p>Indicates whether the Query is a subquery (as
opposed to a top-level query). If false, the implementation must
-invoke Normalize() on the newly minted Compiler object before returning
+invoke <a href="lucy_Compiler.html#func_Normalize">Normalize()</a> on the
newly minted Compiler object before returning
it.</p>
</dd>
</dl>
</dd>
-<dt>Set_Boost</dt>
+<dt id="func_Set_Boost">Set_Boost</dt>
<dd>
<pre><code>void
-<strong>LUCY_Query_Set_Boost</strong>(
- lucy_Query* <strong>self</strong>,
+<span class="prefix">LUCY_</span><strong>Query_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>Query* <strong>self</strong>,
float <strong>boost</strong>
);
</code></pre>
<p>Set the Query's boost.</p>
</dd>
-<dt>Get_Boost</dt>
+<dt id="func_Get_Boost">Get_Boost</dt>
<dd>
<pre><code>float
-<strong>LUCY_Query_Get_Boost</strong>(
- lucy_Query* <strong>self</strong>
+<span class="prefix">LUCY_</span><strong>Query_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>Query* <strong>self</strong>
);
</code></pre>
<p>Get the Query's boost.</p>
</dd>
-<dt>Serialize</dt>
+<dt id="func_Serialize">Serialize</dt>
<dd>
<pre><code>void
-<strong>LUCY_Query_Serialize</strong>(
- lucy_Query* <strong>self</strong>,
- <a href="lucy_OutStream.html">lucy_OutStream*</a>
<strong>outstream</strong>
+<span class="prefix">LUCY_</span><strong>Query_Serialize</strong>(
+ <span class="prefix">lucy_</span>Query* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_OutStream.html">OutStream*</a> <strong>outstream</strong>
);
</code></pre>
</dd>
-<dt>Deserialize</dt>
+<dt id="func_Deserialize">Deserialize</dt>
<dd>
-<pre><code>lucy_Query* // incremented
-<strong>LUCY_Query_Deserialize</strong>(
- lucy_Query* <strong>self</strong>, // decremented
- <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong>
+<pre><code><span class="prefix">lucy_</span>Query* <span class="comment">//
incremented</span>
+<span class="prefix">LUCY_</span><strong>Query_Deserialize</strong>(
+ <span class="prefix">lucy_</span>Query* <strong>self</strong>, <span
class="comment">// decremented</span>
+ <span class="prefix">lucy_</span><a
href="lucy_InStream.html">InStream*</a> <strong>instream</strong>
);
</code></pre>
</dd>
-<dt>Dump</dt>
+<dt id="func_Dump">Dump</dt>
<dd>
-<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented
-<strong>LUCY_Query_Dump</strong>(
- lucy_Query* <strong>self</strong>
+<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a>
<span class="comment">// incremented</span>
+<span class="prefix">LUCY_</span><strong>Query_Dump</strong>(
+ <span class="prefix">lucy_</span>Query* <strong>self</strong>
);
</code></pre>
</dd>
-<dt>Load</dt>
+<dt id="func_Load">Load</dt>
<dd>
-<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented
-<strong>LUCY_Query_Load</strong>(
- lucy_Query* <strong>self</strong>,
- <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong>
+<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a>
<span class="comment">// incremented</span>
+<span class="prefix">LUCY_</span><strong>Query_Load</strong>(
+ <span class="prefix">lucy_</span>Query* <strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a>
<strong>dump</strong>
);
</code></pre>
</dd>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Analyzer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/lucy_Analyzer.html (original)
+++ websites/staging/lucy/trunk/content/docs/c/lucy_Analyzer.html Tue Dec 2
17:54:11 2014
@@ -1,31 +1,97 @@
<!DOCTYPE html>
<html>
<head>
+<meta charset="utf-8">
+<!--
+***********************************************
+
+!!!! DO NOT EDIT !!!!
+
+This file was auto-generated by cfc.
+
+***********************************************
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
<meta name="viewport" content="width=device-width" />
+<title>Lucy::Analysis::Analyzer â C API Documentation</title>
<style type="text/css">
body {
- font-family: sans-serif;
- font-size: 0.85em;
- max-width: 640px;
+ max-width: 48em;
+ font: 0.85em/1.4 sans-serif;
+}
+a {
+ color: #23b;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 0;
+}
+td.label {
+ padding-right: 2em;
+ font-weight: bold;
}
dt {
font-weight: bold;
}
pre {
- border: 1px solid #000;
+ border: 1px solid #ccc;
padding: 0.2em 0.4em;
background: #f6f6f6;
- font-size: 1.2em;
+ font-size: 0.92em;
}
-code {
+pre a {
+ text-decoration: none;
+}
+pre, code {
font-family: "Consolas", "Menlo", monospace;
}
+span.prefix, span.comment {
+ color: #888;
+}
</style>
</head>
<body>
<h1>Lucy::Analysis::Analyzer</h1>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class name</td>
+<td>Lucy::Analysis::Analyzer</td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td>Analyzer</td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code>LUCY_ANALYZER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code>lucy_Analyzer</code></td>
+</tr>
+</table>
<h2>Name</h2>
-<p>Lucy::Analysis::Analyzer - Tokenize/modify/filter text.</p>
+<p>Lucy::Analysis::Analyzer â Tokenize/modify/filter text.</p>
<h2>Description</h2>
<p>An Analyzer is a filter which processes text, transforming it from one form
into another. For instance, an analyzer might break up a long text into
@@ -34,70 +100,67 @@ might perform case folding to facilitate
(<a href="lucy_Normalizer.html">Normalizer</a>).</p>
<h2>Functions</h2>
<dl>
-<dt>init</dt>
+<dt id="func_init">init</dt>
<dd>
-<pre><code>lucy_Analyzer*
-<strong>lucy_Analyzer_init</strong>(
- lucy_Analyzer* <strong>self</strong>
+<pre><code><span class="prefix">lucy_</span>Analyzer*
+<span class="prefix">lucy_</span><strong>Analyzer_init</strong>(
+ <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>
);
</code></pre>
</dd>
</dl>
<h2>Methods</h2>
-<h3>Abstract methods</h3>
+<h3>Novel methods</h3
<dl>
-<dt>Transform</dt>
+<dt id="func_Transform">Transform <span class="comment">(abstract)</span></dt>
<dd>
-<pre><code><a href="lucy_Inversion.html">lucy_Inversion*</a> // incremented
-<strong>LUCY_Analyzer_Transform</strong>(
- lucy_Analyzer* <strong>self</strong>,
- <a href="lucy_Inversion.html">lucy_Inversion*</a>
<strong>inversion</strong>
+<pre><code><span class="prefix">lucy_</span><a
href="lucy_Inversion.html">Inversion*</a> <span class="comment">//
incremented</span>
+<span class="prefix">LUCY_</span><strong>Analyzer_Transform</strong>(
+ <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_Inversion.html">Inversion*</a> <strong>inversion</strong>
);
</code></pre>
<p>Take a single <a href="lucy_Inversion.html">Inversion</a> as input
and returns an Inversion, either the same one (presumably transformed
in some way), or a new one.</p>
</dd>
-</dl>
-<h3>Novel methods</h3>
-<dl>
-<dt>Transform_Text</dt>
+<dt id="func_Transform_Text">Transform_Text</dt>
<dd>
-<pre><code><a href="lucy_Inversion.html">lucy_Inversion*</a> // incremented
-<strong>LUCY_Analyzer_Transform_Text</strong>(
- lucy_Analyzer* <strong>self</strong>,
- <a href="cfish_String.html">cfish_String*</a> <strong>text</strong>
+<pre><code><span class="prefix">lucy_</span><a
href="lucy_Inversion.html">Inversion*</a> <span class="comment">//
incremented</span>
+<span class="prefix">LUCY_</span><strong>Analyzer_Transform_Text</strong>(
+ <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a>
<strong>text</strong>
);
</code></pre>
<p>Kick off an analysis chain, creating an Inversion from string input.
The default implementation simply creates an initial Inversion with a
-single Token, then calls Transform(), but occasionally subclasses will
+single Token, then calls <a
href="lucy_Analyzer.html#func_Transform">Transform()</a>, but occasionally
subclasses will
provide an optimized implementation which minimizes string copies.</p>
</dd>
-<dt>Split</dt>
+<dt id="func_Split">Split</dt>
<dd>
-<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> // incremented
-<strong>LUCY_Analyzer_Split</strong>(
- lucy_Analyzer* <strong>self</strong>,
- <a href="cfish_String.html">cfish_String*</a> <strong>text</strong>
+<pre><code><span class="prefix">cfish_</span><a
href="cfish_VArray.html">VArray*</a> <span class="comment">// incremented</span>
+<span class="prefix">LUCY_</span><strong>Analyzer_Split</strong>(
+ <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a>
<strong>text</strong>
);
</code></pre>
<p>Analyze text and return an array of token texts.</p>
</dd>
-<dt>Dump</dt>
+<dt id="func_Dump">Dump</dt>
<dd>
-<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented
-<strong>LUCY_Analyzer_Dump</strong>(
- lucy_Analyzer* <strong>self</strong>
+<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a>
<span class="comment">// incremented</span>
+<span class="prefix">LUCY_</span><strong>Analyzer_Dump</strong>(
+ <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>
);
</code></pre>
</dd>
-<dt>Load</dt>
+<dt id="func_Load">Load</dt>
<dd>
-<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented
-<strong>LUCY_Analyzer_Load</strong>(
- lucy_Analyzer* <strong>self</strong>,
- <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong>
+<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a>
<span class="comment">// incremented</span>
+<span class="prefix">LUCY_</span><strong>Analyzer_Load</strong>(
+ <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a>
<strong>dump</strong>
);
</code></pre>
</dd>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Architecture.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/lucy_Architecture.html (original)
+++ websites/staging/lucy/trunk/content/docs/c/lucy_Architecture.html Tue Dec
2 17:54:11 2014
@@ -1,31 +1,97 @@
<!DOCTYPE html>
<html>
<head>
+<meta charset="utf-8">
+<!--
+***********************************************
+
+!!!! DO NOT EDIT !!!!
+
+This file was auto-generated by cfc.
+
+***********************************************
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
<meta name="viewport" content="width=device-width" />
+<title>Lucy::Plan::Architecture â C API Documentation</title>
<style type="text/css">
body {
- font-family: sans-serif;
- font-size: 0.85em;
- max-width: 640px;
+ max-width: 48em;
+ font: 0.85em/1.4 sans-serif;
+}
+a {
+ color: #23b;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 0;
+}
+td.label {
+ padding-right: 2em;
+ font-weight: bold;
}
dt {
font-weight: bold;
}
pre {
- border: 1px solid #000;
+ border: 1px solid #ccc;
padding: 0.2em 0.4em;
background: #f6f6f6;
- font-size: 1.2em;
+ font-size: 0.92em;
+}
+pre a {
+ text-decoration: none;
}
-code {
+pre, code {
font-family: "Consolas", "Menlo", monospace;
}
+span.prefix, span.comment {
+ color: #888;
+}
</style>
</head>
<body>
<h1>Lucy::Plan::Architecture</h1>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class name</td>
+<td>Lucy::Plan::Architecture</td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td>Arch</td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code>LUCY_ARCHITECTURE</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code>lucy_Architecture</code></td>
+</tr>
+</table>
<h2>Name</h2>
-<p>Lucy::Plan::Architecture - Configure major components of an index.</p>
+<p>Lucy::Plan::Architecture â Configure major components of an index.</p>
<h2>Description</h2>
<p>By default, a Lucy index consists of several main parts: lexicon,
postings, stored documents, deletions, and highlight data. The readers and
@@ -35,260 +101,260 @@ at the segment level; Architecture's fac
<a href="lucy_SegReader.html">SegReader</a>.</p>
<h2>Functions</h2>
<dl>
-<dt>new</dt>
+<dt id="func_new">new</dt>
<dd>
-<pre><code>lucy_Architecture* // incremented
-<strong>lucy_Arch_new</strong>(void);
+<pre><code><span class="prefix">lucy_</span>Architecture* <span
class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Arch_new</strong>(void);
</code></pre>
</dd>
-<dt>init</dt>
+<dt id="func_init">init</dt>
<dd>
-<pre><code>lucy_Architecture*
-<strong>lucy_Arch_init</strong>(
- lucy_Architecture* <strong>self</strong>
+<pre><code><span class="prefix">lucy_</span>Architecture*
+<span class="prefix">lucy_</span><strong>Arch_init</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>
);
</code></pre>
<p>Constructor. Takes no arguments.</p>
</dd>
</dl>
<h2>Methods</h2>
-<h3>Novel methods</h3>
+<h3>Novel methods</h3
<dl>
-<dt>Init_Seg_Writer</dt>
+<dt id="func_Init_Seg_Writer">Init_Seg_Writer</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Init_Seg_Writer</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegWriter.html">lucy_SegWriter*</a> <strong>writer</strong>
+<span class="prefix">LUCY_</span><strong>Arch_Init_Seg_Writer</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegWriter.html">SegWriter*</a> <strong>writer</strong>
);
</code></pre>
<p>Initialize a SegWriter, adding DataWriter components.</p>
<dl>
-<dt><emph>writer</emph></dt>
+<dt>writer</dt>
<dd><p>A SegWriter.</p>
</dd>
</dl>
</dd>
-<dt>Register_Lexicon_Writer</dt>
+<dt id="func_Register_Lexicon_Writer">Register_Lexicon_Writer</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Lexicon_Writer</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegWriter.html">lucy_SegWriter*</a> <strong>writer</strong>
+<span class="prefix">LUCY_</span><strong>Arch_Register_Lexicon_Writer</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegWriter.html">SegWriter*</a> <strong>writer</strong>
);
</code></pre>
-<p>Spawn a LexiconWriter and Register() it with the supplied SegWriter,
+<p>Spawn a LexiconWriter and <a
href="lucy_SegWriter.html#func_Register">Register()</a> it with the supplied
SegWriter,
but don't add it to the SegWriter's writer stack.</p>
<dl>
-<dt><emph>writer</emph></dt>
+<dt>writer</dt>
<dd><p>A SegWriter.</p>
</dd>
</dl>
</dd>
-<dt>Register_Posting_List_Writer</dt>
+<dt id="func_Register_Posting_List_Writer">Register_Posting_List_Writer</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Posting_List_Writer</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegWriter.html">lucy_SegWriter*</a> <strong>writer</strong>
+<span
class="prefix">LUCY_</span><strong>Arch_Register_Posting_List_Writer</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegWriter.html">SegWriter*</a> <strong>writer</strong>
);
</code></pre>
-<p>Spawn a PostingListWriter and Register() it with the supplied
+<p>Spawn a PostingListWriter and <a
href="lucy_SegWriter.html#func_Register">Register()</a> it with the supplied
SegWriter, adding it to the SegWriter's writer stack. The SegWriter
must contain a previously registered LexiconWriter.</p>
<dl>
-<dt><emph>writer</emph></dt>
+<dt>writer</dt>
<dd><p>A SegWriter.</p>
</dd>
</dl>
</dd>
-<dt>Register_Doc_Writer</dt>
+<dt id="func_Register_Doc_Writer">Register_Doc_Writer</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Doc_Writer</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegWriter.html">lucy_SegWriter*</a> <strong>writer</strong>
+<span class="prefix">LUCY_</span><strong>Arch_Register_Doc_Writer</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegWriter.html">SegWriter*</a> <strong>writer</strong>
);
</code></pre>
-<p>Spawn a DataWriter and Register() it with the supplied SegWriter,
+<p>Spawn a DataWriter and <a
href="lucy_SegWriter.html#func_Register">Register()</a> it with the supplied
SegWriter,
adding it to the SegWriter's writer stack.</p>
<dl>
-<dt><emph>writer</emph></dt>
+<dt>writer</dt>
<dd><p>A SegWriter.</p>
</dd>
</dl>
</dd>
-<dt>Register_Sort_Writer</dt>
+<dt id="func_Register_Sort_Writer">Register_Sort_Writer</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Sort_Writer</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegWriter.html">lucy_SegWriter*</a> <strong>writer</strong>
+<span class="prefix">LUCY_</span><strong>Arch_Register_Sort_Writer</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegWriter.html">SegWriter*</a> <strong>writer</strong>
);
</code></pre>
-<p>Spawn a SortWriter and Register() it with the supplied SegWriter,
+<p>Spawn a SortWriter and <a
href="lucy_SegWriter.html#func_Register">Register()</a> it with the supplied
SegWriter,
adding it to the SegWriter's writer stack.</p>
<dl>
-<dt><emph>writer</emph></dt>
+<dt>writer</dt>
<dd><p>A SegWriter.</p>
</dd>
</dl>
</dd>
-<dt>Register_Highlight_Writer</dt>
+<dt id="func_Register_Highlight_Writer">Register_Highlight_Writer</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Highlight_Writer</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegWriter.html">lucy_SegWriter*</a> <strong>writer</strong>
+<span
class="prefix">LUCY_</span><strong>Arch_Register_Highlight_Writer</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegWriter.html">SegWriter*</a> <strong>writer</strong>
);
</code></pre>
-<p>Spawn a HighlightWriter and Register() it with the supplied SegWriter,
+<p>Spawn a HighlightWriter and <a
href="lucy_SegWriter.html#func_Register">Register()</a> it with the supplied
SegWriter,
adding it to the SegWriter's writer stack.</p>
<dl>
-<dt><emph>writer</emph></dt>
+<dt>writer</dt>
<dd><p>A SegWriter.</p>
</dd>
</dl>
</dd>
-<dt>Register_Deletions_Writer</dt>
+<dt id="func_Register_Deletions_Writer">Register_Deletions_Writer</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Deletions_Writer</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegWriter.html">lucy_SegWriter*</a> <strong>writer</strong>
+<span
class="prefix">LUCY_</span><strong>Arch_Register_Deletions_Writer</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegWriter.html">SegWriter*</a> <strong>writer</strong>
);
</code></pre>
-<p>Spawn a DeletionsWriter and Register() it with the supplied SegWriter,
-also calling Set_Del_Writer().</p>
+<p>Spawn a DeletionsWriter and <a
href="lucy_SegWriter.html#func_Register">Register()</a> it with the supplied
SegWriter,
+also calling <a
href="lucy_SegWriter.html#func_Set_Del_Writer">Set_Del_Writer()</a>.</p>
<dl>
-<dt><emph>writer</emph></dt>
+<dt>writer</dt>
<dd><p>A SegWriter.</p>
</dd>
</dl>
</dd>
-<dt>Init_Seg_Reader</dt>
+<dt id="func_Init_Seg_Reader">Init_Seg_Reader</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Init_Seg_Reader</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong>
+<span class="prefix">LUCY_</span><strong>Arch_Init_Seg_Reader</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong>
);
</code></pre>
<p>Initialize a SegReader, registering DataReaders.</p>
</dd>
-<dt>Register_Doc_Reader</dt>
+<dt id="func_Register_Doc_Reader">Register_Doc_Reader</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Doc_Reader</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong>
+<span class="prefix">LUCY_</span><strong>Arch_Register_Doc_Reader</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong>
);
</code></pre>
-<p>Spawn a DocReader and Register() it with the supplied SegReader.</p>
+<p>Spawn a DocReader and <a
href="lucy_SegReader.html#func_Register">Register()</a> it with the supplied
SegReader.</p>
<dl>
-<dt><emph>reader</emph></dt>
+<dt>reader</dt>
<dd><p>A SegReader.</p>
</dd>
</dl>
</dd>
-<dt>Register_Posting_List_Reader</dt>
+<dt id="func_Register_Posting_List_Reader">Register_Posting_List_Reader</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Posting_List_Reader</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong>
+<span
class="prefix">LUCY_</span><strong>Arch_Register_Posting_List_Reader</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong>
);
</code></pre>
-<p>Spawn a PostingListReader and Register() it with the supplied SegReader.</p>
+<p>Spawn a PostingListReader and <a
href="lucy_SegReader.html#func_Register">Register()</a> it with the supplied
SegReader.</p>
<dl>
-<dt><emph>reader</emph></dt>
+<dt>reader</dt>
<dd><p>A SegReader.</p>
</dd>
</dl>
</dd>
-<dt>Register_Sort_Reader</dt>
+<dt id="func_Register_Sort_Reader">Register_Sort_Reader</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Sort_Reader</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong>
+<span class="prefix">LUCY_</span><strong>Arch_Register_Sort_Reader</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong>
);
</code></pre>
-<p>Spawn a SortReader and Register() it with the supplied SegReader.</p>
+<p>Spawn a SortReader and <a
href="lucy_SegReader.html#func_Register">Register()</a> it with the supplied
SegReader.</p>
<dl>
-<dt><emph>reader</emph></dt>
+<dt>reader</dt>
<dd><p>A SegReader.</p>
</dd>
</dl>
</dd>
-<dt>Register_Highlight_Reader</dt>
+<dt id="func_Register_Highlight_Reader">Register_Highlight_Reader</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Highlight_Reader</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong>
+<span
class="prefix">LUCY_</span><strong>Arch_Register_Highlight_Reader</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong>
);
</code></pre>
-<p>Spawn a HighlightReader and Register() it with the supplied
+<p>Spawn a HighlightReader and <a
href="lucy_SegReader.html#func_Register">Register()</a> it with the supplied
SegReader.</p>
<dl>
-<dt><emph>reader</emph></dt>
+<dt>reader</dt>
<dd><p>A SegReader.</p>
</dd>
</dl>
</dd>
-<dt>Register_Lexicon_Reader</dt>
+<dt id="func_Register_Lexicon_Reader">Register_Lexicon_Reader</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Lexicon_Reader</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong>
+<span class="prefix">LUCY_</span><strong>Arch_Register_Lexicon_Reader</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong>
);
</code></pre>
-<p>Spawn a LexiconReader and Register() it with the supplied SegReader.</p>
+<p>Spawn a LexiconReader and <a
href="lucy_SegReader.html#func_Register">Register()</a> it with the supplied
SegReader.</p>
<dl>
-<dt><emph>reader</emph></dt>
+<dt>reader</dt>
<dd><p>A SegReader.</p>
</dd>
</dl>
</dd>
-<dt>Register_Deletions_Reader</dt>
+<dt id="func_Register_Deletions_Reader">Register_Deletions_Reader</dt>
<dd>
<pre><code>void
-<strong>LUCY_Arch_Register_Deletions_Reader</strong>(
- lucy_Architecture* <strong>self</strong>,
- <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong>
+<span
class="prefix">LUCY_</span><strong>Arch_Register_Deletions_Reader</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong>
);
</code></pre>
-<p>Spawn a DeletionsReader and Register() it with the supplied SegReader.</p>
+<p>Spawn a DeletionsReader and <a
href="lucy_SegReader.html#func_Register">Register()</a> it with the supplied
SegReader.</p>
<dl>
-<dt><emph>reader</emph></dt>
+<dt>reader</dt>
<dd><p>A SegReader.</p>
</dd>
</dl>
</dd>
-<dt>Make_Similarity</dt>
+<dt id="func_Make_Similarity">Make_Similarity</dt>
<dd>
-<pre><code><a href="lucy_Similarity.html">lucy_Similarity*</a> // incremented
-<strong>LUCY_Arch_Make_Similarity</strong>(
- lucy_Architecture* <strong>self</strong>
+<pre><code><span class="prefix">lucy_</span><a
href="lucy_Similarity.html">Similarity*</a> <span class="comment">//
incremented</span>
+<span class="prefix">LUCY_</span><strong>Arch_Make_Similarity</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>
);
</code></pre>
<p>Factory method for creating a new Similarity object.</p>
</dd>
-<dt>Index_Interval</dt>
+<dt id="func_Index_Interval">Index_Interval</dt>
<dd>
<pre><code>int32_t
-<strong>LUCY_Arch_Index_Interval</strong>(
- lucy_Architecture* <strong>self</strong>
+<span class="prefix">LUCY_</span><strong>Arch_Index_Interval</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>
);
</code></pre>
</dd>
-<dt>Skip_Interval</dt>
+<dt id="func_Skip_Interval">Skip_Interval</dt>
<dd>
<pre><code>int32_t
-<strong>LUCY_Arch_Skip_Interval</strong>(
- lucy_Architecture* <strong>self</strong>
+<span class="prefix">LUCY_</span><strong>Arch_Skip_Interval</strong>(
+ <span class="prefix">lucy_</span>Architecture* <strong>self</strong>
);
</code></pre>
</dd>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy_BackgroundMerger.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/lucy_BackgroundMerger.html
(original)
+++ websites/staging/lucy/trunk/content/docs/c/lucy_BackgroundMerger.html Tue
Dec 2 17:54:11 2014
@@ -1,31 +1,97 @@
<!DOCTYPE html>
<html>
<head>
+<meta charset="utf-8">
+<!--
+***********************************************
+
+!!!! DO NOT EDIT !!!!
+
+This file was auto-generated by cfc.
+
+***********************************************
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
<meta name="viewport" content="width=device-width" />
+<title>Lucy::Index::BackgroundMerger â C API Documentation</title>
<style type="text/css">
body {
- font-family: sans-serif;
- font-size: 0.85em;
- max-width: 640px;
+ max-width: 48em;
+ font: 0.85em/1.4 sans-serif;
+}
+a {
+ color: #23b;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 0;
+}
+td.label {
+ padding-right: 2em;
+ font-weight: bold;
}
dt {
font-weight: bold;
}
pre {
- border: 1px solid #000;
+ border: 1px solid #ccc;
padding: 0.2em 0.4em;
background: #f6f6f6;
- font-size: 1.2em;
+ font-size: 0.92em;
+}
+pre a {
+ text-decoration: none;
}
-code {
+pre, code {
font-family: "Consolas", "Menlo", monospace;
}
+span.prefix, span.comment {
+ color: #888;
+}
</style>
</head>
<body>
<h1>Lucy::Index::BackgroundMerger</h1>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class name</td>
+<td>Lucy::Index::BackgroundMerger</td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td>BGMerger</td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code>LUCY_BACKGROUNDMERGER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code>lucy_BackgroundMerger</code></td>
+</tr>
+</table>
<h2>Name</h2>
-<p>Lucy::Index::BackgroundMerger - Consolidate index segments in the
background.</p>
+<p>Lucy::Index::BackgroundMerger â Consolidate index segments in the
background.</p>
<h2>Description</h2>
<p>Adding documents to an index is usually fast, but every once in a while the
index must be compacted and an update takes substantially longer to
@@ -35,30 +101,30 @@ this class to control worst-case index u
L<Lucy::Docs::FileLocking> if your index is on a shared volume.</p>
<h2>Functions</h2>
<dl>
-<dt>new</dt>
+<dt id="func_new">new</dt>
<dd>
-<pre><code>lucy_BackgroundMerger* // incremented
-<strong>lucy_BGMerger_new</strong>(
- <a href="cfish_Obj.html">cfish_Obj*</a> <strong>index</strong>,
- <a href="lucy_IndexManager.html">lucy_IndexManager*</a>
<strong>manager</strong>
+<pre><code><span class="prefix">lucy_</span>BackgroundMerger* <span
class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>BGMerger_new</strong>(
+ <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a>
<strong>index</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong>
);
</code></pre>
</dd>
-<dt>init</dt>
+<dt id="func_init">init</dt>
<dd>
-<pre><code>lucy_BackgroundMerger*
-<strong>lucy_BGMerger_init</strong>(
- lucy_BackgroundMerger* <strong>self</strong>,
- <a href="cfish_Obj.html">cfish_Obj*</a> <strong>index</strong>,
- <a href="lucy_IndexManager.html">lucy_IndexManager*</a>
<strong>manager</strong>
+<pre><code><span class="prefix">lucy_</span>BackgroundMerger*
+<span class="prefix">lucy_</span><strong>BGMerger_init</strong>(
+ <span class="prefix">lucy_</span>BackgroundMerger* <strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a>
<strong>index</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong>
);
</code></pre>
<p>Open a new BackgroundMerger.</p>
<dl>
-<dt><emph>index</emph></dt>
+<dt>index</dt>
<dd><p>Either a string filepath or a Folder.</p>
</dd>
-<dt><emph>manager</emph></dt>
+<dt>manager</dt>
<dd><p>An IndexManager. If not supplied, an IndexManager with
a 10-second write lock timeout will be created.</p>
</dd>
@@ -66,40 +132,40 @@ a 10-second write lock timeout will be c
</dd>
</dl>
<h2>Methods</h2>
-<h3>Novel methods</h3>
+<h3>Novel methods</h3
<dl>
-<dt>Optimize</dt>
+<dt id="func_Optimize">Optimize</dt>
<dd>
<pre><code>void
-<strong>LUCY_BGMerger_Optimize</strong>(
- lucy_BackgroundMerger* <strong>self</strong>
+<span class="prefix">LUCY_</span><strong>BGMerger_Optimize</strong>(
+ <span class="prefix">lucy_</span>BackgroundMerger* <strong>self</strong>
);
</code></pre>
<p>Optimize the index for search-time performance. This may take a
while, as it can involve rewriting large amounts of data.</p>
</dd>
-<dt>Commit</dt>
+<dt id="func_Commit">Commit</dt>
<dd>
<pre><code>void
-<strong>LUCY_BGMerger_Commit</strong>(
- lucy_BackgroundMerger* <strong>self</strong>
+<span class="prefix">LUCY_</span><strong>BGMerger_Commit</strong>(
+ <span class="prefix">lucy_</span>BackgroundMerger* <strong>self</strong>
);
</code></pre>
<p>Commit any changes made to the index. Until this is called, none of
the changes made during an indexing session are permanent.</p>
-<p>Calls Prepare_Commit() implicitly if it has not already been called.</p>
+<p>Calls <a
href="lucy_BackgroundMerger.html#func_Prepare_Commit">Prepare_Commit()</a>
implicitly if it has not already been called.</p>
</dd>
-<dt>Prepare_Commit</dt>
+<dt id="func_Prepare_Commit">Prepare_Commit</dt>
<dd>
<pre><code>void
-<strong>LUCY_BGMerger_Prepare_Commit</strong>(
- lucy_BackgroundMerger* <strong>self</strong>
+<span class="prefix">LUCY_</span><strong>BGMerger_Prepare_Commit</strong>(
+ <span class="prefix">lucy_</span>BackgroundMerger* <strong>self</strong>
);
</code></pre>
-<p>Perform the expensive setup for Commit() in advance, so that Commit()
+<p>Perform the expensive setup for <a
href="lucy_BackgroundMerger.html#func_Commit">Commit()</a> in advance, so that
<a href="lucy_BackgroundMerger.html#func_Commit">Commit()</a>
completes quickly.</p>
-<p>Towards the end of Prepare_Commit(), the BackgroundMerger attempts to
-re-acquire the write lock, which is then held until Commit() finishes
+<p>Towards the end of <a
href="lucy_BackgroundMerger.html#func_Prepare_Commit">Prepare_Commit()</a>, the
BackgroundMerger attempts to
+re-acquire the write lock, which is then held until <a
href="lucy_BackgroundMerger.html#func_Commit">Commit()</a> finishes
and releases it.</p>
</dd>
</dl>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy_BitCollector.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/lucy_BitCollector.html (original)
+++ websites/staging/lucy/trunk/content/docs/c/lucy_BitCollector.html Tue Dec
2 17:54:11 2014
@@ -1,107 +1,174 @@
<!DOCTYPE html>
<html>
<head>
+<meta charset="utf-8">
+<!--
+***********************************************
+
+!!!! DO NOT EDIT !!!!
+
+This file was auto-generated by cfc.
+
+***********************************************
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
<meta name="viewport" content="width=device-width" />
+<title>Lucy::Search::Collector::BitCollector â C API Documentation</title>
<style type="text/css">
body {
- font-family: sans-serif;
- font-size: 0.85em;
- max-width: 640px;
+ max-width: 48em;
+ font: 0.85em/1.4 sans-serif;
+}
+a {
+ color: #23b;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 0;
+}
+td.label {
+ padding-right: 2em;
+ font-weight: bold;
}
dt {
font-weight: bold;
}
pre {
- border: 1px solid #000;
+ border: 1px solid #ccc;
padding: 0.2em 0.4em;
background: #f6f6f6;
- font-size: 1.2em;
+ font-size: 0.92em;
+}
+pre a {
+ text-decoration: none;
}
-code {
+pre, code {
font-family: "Consolas", "Menlo", monospace;
}
+span.prefix, span.comment {
+ color: #888;
+}
</style>
</head>
<body>
<h1>Lucy::Search::Collector::BitCollector</h1>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class name</td>
+<td>Lucy::Search::Collector::BitCollector</td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td>BitColl</td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code>LUCY_BITCOLLECTOR</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code>lucy_BitCollector</code></td>
+</tr>
+</table>
<h2>Name</h2>
-<p>Lucy::Search::Collector::BitCollector - Collector which records doc nums in
a BitVector.</p>
+<p>Lucy::Search::Collector::BitCollector â Collector which records doc nums
in a BitVector.</p>
<h2>Description</h2>
<p>BitCollector is a Collector which saves matching document ids in a
<a href="lucy_BitVector.html">BitVector</a>. It is useful for recording the
entire set of documents which matches a query.</p>
<h2>Functions</h2>
<dl>
-<dt>init</dt>
+<dt id="func_init">init</dt>
<dd>
-<pre><code>lucy_BitCollector*
-<strong>lucy_BitColl_init</strong>(
- lucy_BitCollector* <strong>self</strong>,
- <a href="lucy_BitVector.html">lucy_BitVector*</a>
<strong>bit_vector</strong>
+<pre><code><span class="prefix">lucy_</span>BitCollector*
+<span class="prefix">lucy_</span><strong>BitColl_init</strong>(
+ <span class="prefix">lucy_</span>BitCollector* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_BitVector.html">BitVector*</a> <strong>bit_vector</strong>
);
</code></pre>
<dl>
-<dt><emph>bit_vector</emph></dt>
+<dt>bit_vector</dt>
<dd><p>A Lucy::Object::BitVector.</p>
</dd>
</dl>
</dd>
</dl>
<h2>Methods</h2>
-<h3>Methods inherited from Lucy::Search::Collector</h3><dl>
-<dt>Collect</dt>
+<h3>Methods inherited from Lucy::Search::Collector</h3>
+<dl>
+<dt id="func_Collect">Collect <span class="comment">(abstract)</span></dt>
<dd>
<pre><code>void
-<strong>LUCY_Coll_Collect</strong>(
- lucy_Collector* <strong>self</strong>,
+<span class="prefix">LUCY_</span><strong>Coll_Collect</strong>(
+ <span class="prefix">lucy_</span>Collector* <strong>self</strong>,
int32_t <strong>doc_id</strong>
);
</code></pre>
<p>Do something with a doc id. (For instance, keep track of the docs
with the ten highest scores.)</p>
<dl>
-<dt><emph>doc_id</emph></dt>
+<dt>doc_id</dt>
<dd><p>A segment document id.</p>
</dd>
</dl>
</dd>
-<dt>Set_Reader</dt>
+<dt id="func_Set_Reader">Set_Reader</dt>
<dd>
<pre><code>void
-<strong>LUCY_Coll_Set_Reader</strong>(
- lucy_Collector* <strong>self</strong>,
- <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong>
+<span class="prefix">LUCY_</span><strong>Coll_Set_Reader</strong>(
+ <span class="prefix">lucy_</span>Collector* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a
href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong>
);
</code></pre>
<p>Setter for "reader".</p>
</dd>
-<dt>Set_Base</dt>
+<dt id="func_Set_Base">Set_Base</dt>
<dd>
<pre><code>void
-<strong>LUCY_Coll_Set_Base</strong>(
- lucy_Collector* <strong>self</strong>,
+<span class="prefix">LUCY_</span><strong>Coll_Set_Base</strong>(
+ <span class="prefix">lucy_</span>Collector* <strong>self</strong>,
int32_t <strong>base</strong>
);
</code></pre>
<p>Set the "base" document id, an offset which must be added to the
-<code>doc_id</code> supplied via Collect() to get the doc id for the
+<code>doc_id</code> supplied via <a
href="lucy_Collector.html#func_Collect">Collect()</a> to get the doc id for the
larger index.</p>
</dd>
-<dt>Need_Score</dt>
+<dt id="func_Need_Score">Need_Score <span
class="comment">(abstract)</span></dt>
<dd>
<pre><code>bool
-<strong>LUCY_Coll_Need_Score</strong>(
- lucy_Collector* <strong>self</strong>
+<span class="prefix">LUCY_</span><strong>Coll_Need_Score</strong>(
+ <span class="prefix">lucy_</span>Collector* <strong>self</strong>
);
</code></pre>
-<p>Indicate whether the Collector will call Score() on its Matcher.</p>
+<p>Indicate whether the Collector will call <a
href="lucy_Matcher.html#func_Score">Score()</a> on its Matcher.</p>
</dd>
-<dt>Set_Matcher</dt>
+<dt id="func_Set_Matcher">Set_Matcher</dt>
<dd>
<pre><code>void
-<strong>LUCY_Coll_Set_Matcher</strong>(
- lucy_Collector* <strong>self</strong>,
- <a href="lucy_Matcher.html">lucy_Matcher*</a> <strong>matcher</strong>
+<span class="prefix">LUCY_</span><strong>Coll_Set_Matcher</strong>(
+ <span class="prefix">lucy_</span>Collector* <strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="lucy_Matcher.html">Matcher*</a>
<strong>matcher</strong>
);
</code></pre>
<p>Setter for "matcher".</p>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy_BitVector.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/lucy_BitVector.html (original)
+++ websites/staging/lucy/trunk/content/docs/c/lucy_BitVector.html Tue Dec 2
17:54:11 2014
@@ -1,45 +1,111 @@
<!DOCTYPE html>
<html>
<head>
+<meta charset="utf-8">
+<!--
+***********************************************
+
+!!!! DO NOT EDIT !!!!
+
+This file was auto-generated by cfc.
+
+***********************************************
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
<meta name="viewport" content="width=device-width" />
+<title>Lucy::Object::BitVector â C API Documentation</title>
<style type="text/css">
body {
- font-family: sans-serif;
- font-size: 0.85em;
- max-width: 640px;
+ max-width: 48em;
+ font: 0.85em/1.4 sans-serif;
+}
+a {
+ color: #23b;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 0;
+}
+td.label {
+ padding-right: 2em;
+ font-weight: bold;
}
dt {
font-weight: bold;
}
pre {
- border: 1px solid #000;
+ border: 1px solid #ccc;
padding: 0.2em 0.4em;
background: #f6f6f6;
- font-size: 1.2em;
+ font-size: 0.92em;
+}
+pre a {
+ text-decoration: none;
}
-code {
+pre, code {
font-family: "Consolas", "Menlo", monospace;
}
+span.prefix, span.comment {
+ color: #888;
+}
</style>
</head>
<body>
<h1>Lucy::Object::BitVector</h1>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class name</td>
+<td>Lucy::Object::BitVector</td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td>BitVec</td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code>LUCY_BITVECTOR</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code>lucy_BitVector</code></td>
+</tr>
+</table>
<h2>Name</h2>
-<p>Lucy::Object::BitVector - An array of bits.</p>
+<p>Lucy::Object::BitVector â An array of bits.</p>
<h2>Description</h2>
<p>BitVector is a growable array of bits. All bits are initially zero.</p>
<h2>Functions</h2>
<dl>
-<dt>init</dt>
+<dt id="func_init">init</dt>
<dd>
-<pre><code>lucy_BitVector*
-<strong>lucy_BitVec_init</strong>(
- lucy_BitVector* <strong>self</strong>,
+<pre><code><span class="prefix">lucy_</span>BitVector*
+<span class="prefix">lucy_</span><strong>BitVec_init</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
uint32_t <strong>capacity</strong>
);
</code></pre>
<dl>
-<dt><emph>capacity</emph></dt>
+<dt>capacity</dt>
<dd><p>The number of bits that the initial array should be
able to hold.</p>
</dd>
@@ -47,13 +113,13 @@ able to hold.</p>
</dd>
</dl>
<h2>Methods</h2>
-<h3>Novel methods</h3>
+<h3>Novel methods</h3
<dl>
-<dt>Get</dt>
+<dt id="func_Get">Get</dt>
<dd>
<pre><code>bool
-<strong>LUCY_BitVec_Get</strong>(
- lucy_BitVector* <strong>self</strong>,
+<span class="prefix">LUCY_</span><strong>BitVec_Get</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
uint32_t <strong>tick</strong>
);
</code></pre>
@@ -61,188 +127,188 @@ able to hold.</p>
hasn't (regardless of whether it lies within the bounds of the
object's capacity).</p>
<dl>
-<dt><emph>tick</emph></dt>
+<dt>tick</dt>
<dd><p>The requested bit.</p>
</dd>
</dl>
</dd>
-<dt>Set</dt>
+<dt id="func_Set">Set</dt>
<dd>
<pre><code>void
-<strong>LUCY_BitVec_Set</strong>(
- lucy_BitVector* <strong>self</strong>,
+<span class="prefix">LUCY_</span><strong>BitVec_Set</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
uint32_t <strong>tick</strong>
);
</code></pre>
<p>Set the bit at <code>tick</code> to 1.</p>
<dl>
-<dt><emph>tick</emph></dt>
+<dt>tick</dt>
<dd><p>The bit to be set.</p>
</dd>
</dl>
</dd>
-<dt>Next_Hit</dt>
+<dt id="func_Next_Hit">Next_Hit</dt>
<dd>
<pre><code>int32_t
-<strong>LUCY_BitVec_Next_Hit</strong>(
- lucy_BitVector* <strong>self</strong>,
+<span class="prefix">LUCY_</span><strong>BitVec_Next_Hit</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
uint32_t <strong>tick</strong>
);
</code></pre>
<p>Returns the next set bit equal to or greater than <code>tick</code>,
or -1 if no such bit exists.</p>
</dd>
-<dt>Clear</dt>
+<dt id="func_Clear">Clear</dt>
<dd>
<pre><code>void
-<strong>LUCY_BitVec_Clear</strong>(
- lucy_BitVector* <strong>self</strong>,
+<span class="prefix">LUCY_</span><strong>BitVec_Clear</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
uint32_t <strong>tick</strong>
);
</code></pre>
<p>Clear the indicated bit. (i.e. set it to 0).</p>
<dl>
-<dt><emph>tick</emph></dt>
+<dt>tick</dt>
<dd><p>The bit to be cleared.</p>
</dd>
</dl>
</dd>
-<dt>Clear_All</dt>
+<dt id="func_Clear_All">Clear_All</dt>
<dd>
<pre><code>void
-<strong>LUCY_BitVec_Clear_All</strong>(
- lucy_BitVector* <strong>self</strong>
+<span class="prefix">LUCY_</span><strong>BitVec_Clear_All</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>
);
</code></pre>
<p>Clear all bits.</p>
</dd>
-<dt>Grow</dt>
+<dt id="func_Grow">Grow</dt>
<dd>
<pre><code>void
-<strong>LUCY_BitVec_Grow</strong>(
- lucy_BitVector* <strong>self</strong>,
+<span class="prefix">LUCY_</span><strong>BitVec_Grow</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
uint32_t <strong>capacity</strong>
);
</code></pre>
<p>If the BitVector does not already have enough room to hold the
indicated number of bits, allocate more memory so that it can.</p>
<dl>
-<dt><emph>capacity</emph></dt>
+<dt>capacity</dt>
<dd><p>Least number of bits the BitVector should accomodate.</p>
</dd>
</dl>
</dd>
-<dt>And</dt>
+<dt id="func_And">And</dt>
<dd>
<pre><code>void
-<strong>LUCY_BitVec_And</strong>(
- lucy_BitVector* <strong>self</strong>,
- const lucy_BitVector* <strong>other</strong>
+<span class="prefix">LUCY_</span><strong>BitVec_And</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
+ <span class="prefix">lucy_BitVec</span>BitVector* <strong>other</strong>
);
</code></pre>
<p>Modify the BitVector so that only bits which remain set are those
which 1) were already set in this BitVector, and 2) were also set in
the other BitVector.</p>
<dl>
-<dt><emph>other</emph></dt>
+<dt>other</dt>
<dd><p>Another BitVector.</p>
</dd>
</dl>
</dd>
-<dt>Or</dt>
+<dt id="func_Or">Or</dt>
<dd>
<pre><code>void
-<strong>LUCY_BitVec_Or</strong>(
- lucy_BitVector* <strong>self</strong>,
- const lucy_BitVector* <strong>other</strong>
+<span class="prefix">LUCY_</span><strong>BitVec_Or</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
+ <span class="prefix">lucy_BitVec</span>BitVector* <strong>other</strong>
);
</code></pre>
<p>Modify the BitVector, setting all bits which are set in the other
BitVector if they were not already set.</p>
<dl>
-<dt><emph>other</emph></dt>
+<dt>other</dt>
<dd><p>Another BitVector.</p>
</dd>
</dl>
</dd>
-<dt>Xor</dt>
+<dt id="func_Xor">Xor</dt>
<dd>
<pre><code>void
-<strong>LUCY_BitVec_Xor</strong>(
- lucy_BitVector* <strong>self</strong>,
- const lucy_BitVector* <strong>other</strong>
+<span class="prefix">LUCY_</span><strong>BitVec_Xor</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
+ <span class="prefix">lucy_BitVec</span>BitVector* <strong>other</strong>
);
</code></pre>
<p>Modify the BitVector, performing an XOR operation against the other.</p>
<dl>
-<dt><emph>other</emph></dt>
+<dt>other</dt>
<dd><p>Another BitVector.</p>
</dd>
</dl>
</dd>
-<dt>And_Not</dt>
+<dt id="func_And_Not">And_Not</dt>
<dd>
<pre><code>void
-<strong>LUCY_BitVec_And_Not</strong>(
- lucy_BitVector* <strong>self</strong>,
- const lucy_BitVector* <strong>other</strong>
+<span class="prefix">LUCY_</span><strong>BitVec_And_Not</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
+ <span class="prefix">lucy_BitVec</span>BitVector* <strong>other</strong>
);
</code></pre>
<p>Modify the BitVector, clearing all bits which are set in the other.</p>
<dl>
-<dt><emph>other</emph></dt>
+<dt>other</dt>
<dd><p>Another BitVector.</p>
</dd>
</dl>
</dd>
-<dt>Flip</dt>
+<dt id="func_Flip">Flip</dt>
<dd>
<pre><code>void
-<strong>LUCY_BitVec_Flip</strong>(
- lucy_BitVector* <strong>self</strong>,
+<span class="prefix">LUCY_</span><strong>BitVec_Flip</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
uint32_t <strong>tick</strong>
);
</code></pre>
<p>Invert the value of a bit.</p>
<dl>
-<dt><emph>tick</emph></dt>
+<dt>tick</dt>
<dd><p>The bit to invert.</p>
</dd>
</dl>
</dd>
-<dt>Flip_Block</dt>
+<dt id="func_Flip_Block">Flip_Block</dt>
<dd>
<pre><code>void
-<strong>LUCY_BitVec_Flip_Block</strong>(
- lucy_BitVector* <strong>self</strong>,
+<span class="prefix">LUCY_</span><strong>BitVec_Flip_Block</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>,
uint32_t <strong>offset</strong>,
uint32_t <strong>length</strong>
);
</code></pre>
<p>Invert each bit within a contiguous block.</p>
<dl>
-<dt><emph>offset</emph></dt>
+<dt>offset</dt>
<dd><p>Lower bound.</p>
</dd>
-<dt><emph>length</emph></dt>
+<dt>length</dt>
<dd><p>The number of bits to flip.</p>
</dd>
</dl>
</dd>
-<dt>Count</dt>
+<dt id="func_Count">Count</dt>
<dd>
<pre><code>uint32_t
-<strong>LUCY_BitVec_Count</strong>(
- lucy_BitVector* <strong>self</strong>
+<span class="prefix">LUCY_</span><strong>BitVec_Count</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>
);
</code></pre>
<p>Return a count of the number of set bits.</p>
</dd>
-<dt>To_Array</dt>
+<dt id="func_To_Array">To_Array</dt>
<dd>
-<pre><code><a href="lucy_I32Array.html">lucy_I32Array*</a> // incremented
-<strong>LUCY_BitVec_To_Array</strong>(
- lucy_BitVector* <strong>self</strong>
+<pre><code><span class="prefix">lucy_</span><a
href="lucy_I32Array.html">I32Array*</a> <span class="comment">//
incremented</span>
+<span class="prefix">LUCY_</span><strong>BitVec_To_Array</strong>(
+ <span class="prefix">lucy_</span>BitVector* <strong>self</strong>
);
</code></pre>
<p>Return an array where each element represents a set bit.</p>
