From 267b26e182f641656a5c0c0b2e5a6e98352dc9da Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Fri, 18 Jan 2013 14:20:46 +0000 Subject: [PATCH] javadocs git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1435157 13f79535-47bb-0310-9956-ffa450edef68 --- .../lucene/codecs/memory/MemoryPostingsFormat.java | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/memory/MemoryPostingsFormat.java b/lucene/codecs/src/java/org/apache/lucene/codecs/memory/MemoryPostingsFormat.java index 4e707a32a10..8c2550aa051 100644 --- a/lucene/codecs/src/java/org/apache/lucene/codecs/memory/MemoryPostingsFormat.java +++ b/lucene/codecs/src/java/org/apache/lucene/codecs/memory/MemoryPostingsFormat.java @@ -70,10 +70,6 @@ import org.apache.lucene.util.packed.PackedInts; * queries that rely on advance will (AND BooleanQuery, * PhraseQuery) will be relatively slow! * - *

NOTE: this codec cannot address more than ~2.1 GB - * of postings, because the underlying FST uses an int - * to address the underlying byte[]. - * * @lucene.experimental */ // TODO: Maybe name this 'Cached' or something to reflect @@ -88,6 +84,13 @@ public final class MemoryPostingsFormat extends PostingsFormat { this(false, PackedInts.DEFAULT); } + /** + * Create MemoryPostingsFormat, specifying advanced FST options. + * @param doPackFST true if a packed FST should be built. + * NOTE: packed FSTs are limited to ~2.1 GB of postings. + * @param acceptableOverheadRatio allowable overhead for packed ints + * during FST construction. + */ public MemoryPostingsFormat(boolean doPackFST, float acceptableOverheadRatio) { super("Memory"); this.doPackFST = doPackFST;