Examples of com.ctc.wstx.util.WordSet

com.ctc.wstx.util.WordSet

An efficient (both memory and time) implementation of a Set used to verify that a given word is contained within the set. The general usage pattern is expected to be such that most checks are positive, ie. that the word indeed is contained in the set.

Performance of the set is comparable to that of {@link java.util.TreeSet}for Strings, ie. 2-3x slower than {@link java.util.HashSet} whenusing pre-constructed Strings. This is generally result of algorithmic complexity of structures; Word and Tree sets are roughly logarithmic to the whole data, whereas Hash set is linear to the length of key. However:

WordSet can use char arrays as keys, without constructing Strings. In cases where there is no (need for) Strings, WordSet seems to be about twice as fast, even without considering additional GC caused by temporary String instances.
WordSet is more compact in its memory presentation; if Strings are shared its size is comparable to optimally filled HashSet, and if no such Strings exists, its much more compact (relatively speaking)

Although this is an efficient set for specific set of usage patterns, one restriction is that the full set of words to include has to be known before constructing the set. Also, the size of the set is limited to total word content of about 20k characters; factory method does verify the limit and indicates if an instance can not be created.

        set.add("length");
        set.add("leno");
        set.add("1");
        set.add("foobar");


        WordSet ws = WordSet.constructSet(set);


        // Let's first check if words that should be there, are:
        for (String str : set) {
            assertTrue(ws.contains(str));
            // And then, let's make sure intern()ing isn't needed:
            assertTrue(ws.contains(""+str));


            char[] strArr = str.toCharArray();
            char[] strArr2 = new char[strArr.length + 4];
            System.arraycopy(strArr, 0, strArr2, 3, strArr.length);
            assertTrue(ws.contains(strArr, 0, str.length()));
            assertTrue(ws.contains(strArr2, 3, str.length() + 3));
        }


        // And then that ones shouldn't be there aren't:
        checkNotFind(ws, "foo");

        set.add("length");
        set.add("leno");
        set.add("1");
        set.add("foobar");


        WordSet ws = WordSet.constructSet(set);
        Iterator it = set.iterator();


        // Let's first check if words that should be there, are:
        while (it.hasNext()) {
            String str = (String) it.next();


            assertTrue(ws.contains(str));
            // And then, let's make sure intern()ing isn't needed:
            assertTrue(ws.contains(""+str));


            char[] strArr = str.toCharArray();
            char[] strArr2 = new char[strArr.length + 4];
            System.arraycopy(strArr, 0, strArr2, 3, strArr.length);
            assertTrue(ws.contains(strArr, 0, str.length()));
            assertTrue(ws.contains(strArr2, 3, str.length() + 3));
        }


        // And then that ones shouldn't be there aren't:
        checkNotFind(ws, "foo");

Examples of com.ctc.wstx.util.WordSet

Related Classes of com.ctc.wstx.util.WordSet