[lucy-commits] [54/54] [abbrv] git commit: refs/heads/sortex_ptr_only - Update SortExternal docs.

[ma...@apache.org]

Update SortExternal docs.

Modify summary to reflect the fact that SortExternal now only sorts
objects rather than arbitrary data.


Project: http://git-wip-us.apache.org/repos/asf/lucy/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy/commit/c1590935
Tree: http://git-wip-us.apache.org/repos/asf/lucy/tree/c1590935
Diff: http://git-wip-us.apache.org/repos/asf/lucy/diff/c1590935

Branch: refs/heads/sortex_ptr_only
Commit: c15909359dcb1cce9ea1f5b2ba0f0e10f0114784
Parents: 00181bd
Author: Marvin Humphrey <ma...@rectangular.com>
Authored: Tue Jan 22 14:06:43 2013 -0800
Committer: Marvin Humphrey <ma...@rectangular.com>
Committed: Sat Apr 26 16:06:30 2014 -0700

----------------------------------------------------------------------
 core/Lucy/Util/SortExternal.cfh | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucy/blob/c1590935/core/Lucy/Util/SortExternal.cfh
----------------------------------------------------------------------
diff --git a/core/Lucy/Util/SortExternal.cfh b/core/Lucy/Util/SortExternal.cfh
index 5ffb44c..7e8439b 100644
--- a/core/Lucy/Util/SortExternal.cfh
+++ b/core/Lucy/Util/SortExternal.cfh
@@ -18,22 +18,22 @@ parcel Lucy;
 
 /** Abstract external sorter.
  *
- * SortExternal objects are sort pools which allow you to sort large amounts
- * of data.  To achieve this, you Feed() all values into the SortExternal
- * object, Flip() the object from write mode to read mode, then Fetch() the
- * values one at a time in sorted order.
+ * SortExternal objects are sort pools which allow you to sort huge
+ * collections of elements.  To achieve this, you Feed() all items into the
+ * SortExternal object, Flip() it from write mode to read mode, then Fetch()
+ * the elements one at a time in sorted order.
  *
- * It's expected that the total memory footprint of the sortable objects will
- * eventually exceed a specified threshold; at that point, the SortExternal
- * object will call the abstract method Flush().  It's expected that Flush()
- * implementations will empty out the current sort buffer, write a sorted "run"
- * to external storage, and add a new child SortExternal object to the top
- * level object's "runs" array to represent the flushed content.
+ * It's expected that the total memory footprint of the buffered sortable
+ * items will eventually exceed a specified threshold; at that point, the
+ * SortExternal object will call the abstract method Flush().  It's expected
+ * that Flush() implementations will empty out the current buffer, write a
+ * sorted "run" to external storage, and add a new child SortExternal object
+ * to the top level object's "runs" array to represent the flushed content.
  *
- * During the read phase, the child objects retrieve values from external
- * storage by calling the abstract method Refill().  The top-level
+ * During the read phase, the child sortex objects retrieve elements from
+ * external storage by calling the abstract method Refill().  The top-level
  * SortExternal object then interleaves multiple sorted streams to produce a
- * single unified stream of sorted values.
+ * single unified stream of sorted items.
  */
 abstract class Lucy::Util::SortExternal nickname SortEx
     inherits Clownfish::Obj {
@@ -63,7 +63,7 @@ abstract class Lucy::Util::SortExternal nickname SortEx
      *
      * Presumably this entails sorting everything, writing the sorted elements
      * to disk, spawning a child object to represent those elements, and
-     * adding that child to the top level object via Add_Run().
+     * adding that child to the top-level object via Add_Run().
      */
     abstract void
     Flush(SortExternal *self);
@@ -100,8 +100,8 @@ abstract class Lucy::Util::SortExternal nickname SortEx
     void
     Shrink(SortExternal *self);
 
-    /** Refill the buffer of a run.  Will only be called on child objects, not
-     * the main object.
+    /** Refill the buffer of a run.  Will only be called on child sortex
+     * objects, not the main object.
      */
     abstract uint32_t
     Refill(SortExternal *self);