[FOray-commit] SF.net SVN: foray:[10689] trunk/foray

[<vic...@us...>]

Revision: 10689
          http://foray.svn.sourceforge.net/foray/?rev=10689&view=rev
Author:   victormote
Date:     2009-03-15 18:30:20 +0000 (Sun, 15 Mar 2009)

Log Message:
-----------
Clean up some documentation and to-do items.

Modified Paths:
--------------
    trunk/foray/foray-common/src/java/org/foray/common/TernaryTreeMap.java
    trunk/foray/foray-hyphen/src/java/org/foray/hyphen/HyphenationTree.java

Modified: trunk/foray/foray-common/src/java/org/foray/common/TernaryTreeMap.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/TernaryTreeMap.java	2009-03-15 18:25:04 UTC (rev 10688)
+++ trunk/foray/foray-common/src/java/org/foray/common/TernaryTreeMap.java	2009-03-15 18:30:20 UTC (rev 10689)
@@ -73,8 +73,6 @@
  */
 
 public class TernaryTreeMap implements Cloneable, Serializable {
-    /* TODO: After all other API-related to-do items are cleaned up, consider moving this class
-     * to Common module. */
 
     /** Allocation size for arrays. */
     private static final int BLOCK_SIZE = 2048;

Modified: trunk/foray/foray-hyphen/src/java/org/foray/hyphen/HyphenationTree.java
===================================================================
--- trunk/foray/foray-hyphen/src/java/org/foray/hyphen/HyphenationTree.java	2009-03-15 18:25:04 UTC (rev 10688)
+++ trunk/foray/foray-hyphen/src/java/org/foray/hyphen/HyphenationTree.java	2009-03-15 18:30:20 UTC (rev 10689)
@@ -225,26 +225,9 @@
     }
 
     /**
-     * <p>Search for all possible partial matches of word starting at a given index, and update the
-     * interletter values. In other words, it
-     * does something like:</p>
-     * <code>
-     * for(i = 0; i &lt; patterns.length; i++) {
-     *     if ( word.substring(index).startsWidth(patterns[i]) )
-     *     update_interletter_values(patterns[i]);
-     * }
-     * </code>
-     * <p>But it is done in an efficient way since the patterns are
-     * stored in a ternary tree. In fact, this is the whole purpose
-     * of having the tree: doing this search without having to test
-     * every single pattern. The number of patterns for languages
-     * such as English range from 4000 to 10000. Thus, doing thousands
-     * of string comparisons for each word to hyphenate would be
-     * really slow without the tree. The tradeoff is memory, but
-     * using a ternary tree instead of a trie, almost halves the
-     * the memory used by Lout or TeX. It's also faster than using
-     * a hash table</p>
-     * @param word The null-terminated word to match.
+     * <p>Search for all possible partial matches of a given word starting at a given index, and update the
+     * interletter values accordingly.
+     * @param word The word to match.
      * @param startingWordIndex The starting index in word that should be tested.
      * @param il The interletter values array that should be updated.
      */


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.