Return-Path:
X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io
Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io
Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183])
by cust-asf2.ponee.io (Postfix) with ESMTP id 1B5A4200B94
for ; Sun, 2 Oct 2016 16:35:30 +0200 (CEST)
Received: by cust-asf.ponee.io (Postfix)
id 1A080160AC7; Sun, 2 Oct 2016 14:35:30 +0000 (UTC)
Delivered-To: archive-asf-public@cust-asf.ponee.io
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
by cust-asf.ponee.io (Postfix) with SMTP id 5A15A160AED
for ; Sun, 2 Oct 2016 16:35:27 +0200 (CEST)
Received: (qmail 94983 invoked by uid 500); 2 Oct 2016 14:35:20 -0000
Mailing-List: contact commits-help@lucenenet.apache.org; run by ezmlm
Precedence: bulk
List-Help:
List-Unsubscribe:
List-Post:
List-Id:
Reply-To: lucene-net-dev@lucenenet.apache.org
Delivered-To: mailing list commits@lucenenet.apache.org
Received: (qmail 94218 invoked by uid 99); 2 Oct 2016 14:35:20 -0000
Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23)
by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 02 Oct 2016 14:35:20 +0000
Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33)
id EFD9EE97F4; Sun, 2 Oct 2016 14:35:19 +0000 (UTC)
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
From: synhershko@apache.org
To: commits@lucenenet.apache.org
Date: Sun, 02 Oct 2016 14:35:42 -0000
Message-Id: <1d7bae4f46714da29e4c327bf0d7eab3@git.apache.org>
In-Reply-To: <6014ffb9c2e748049fcffef430b6e351@git.apache.org>
References: <6014ffb9c2e748049fcffef430b6e351@git.apache.org>
X-Mailer: ASF-Git Admin Mailer
Subject: [24/50] [abbrv] lucenenet git commit: Updated Suggest documentation
links to code elements and made corrections.
archived-at: Sun, 02 Oct 2016 14:35:30 -0000
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/Analyzing/FuzzySuggester.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Analyzing/FuzzySuggester.cs b/src/Lucene.Net.Suggest/Suggest/Analyzing/FuzzySuggester.cs
index 3dd4b90..a01da75 100644
--- a/src/Lucene.Net.Suggest/Suggest/Analyzing/FuzzySuggester.cs
+++ b/src/Lucene.Net.Suggest/Suggest/Analyzing/FuzzySuggester.cs
@@ -26,24 +26,23 @@ namespace Lucene.Net.Search.Suggest.Analyzing
*/
///
- /// Implements a fuzzy . The similarity measurement is
+ /// Implements a fuzzy . The similarity measurement is
/// based on the Damerau-Levenshtein (optimal string alignment) algorithm, though
- /// you can explicitly choose classic Levenshtein by passing false
- /// for the transpositions parameter.
+ /// you can explicitly choose classic Levenshtein by passing false
+ /// for the parameter.
///
- /// At most, this query will match terms up to
- /// {@value org.apache.lucene.util.automaton.LevenshteinAutomata#MAXIMUM_SUPPORTED_DISTANCE}
+ /// At most, this query will match terms up to
/// edits. Higher distances are not supported. Note that the
/// fuzzy distance is measured in "byte space" on the bytes
- /// returned by the 's {@link
- /// TermToBytesRefAttribute}, usually UTF8. By default
- /// the analyzed bytes must be at least 3 {@link
- /// #DEFAULT_MIN_FUZZY_LENGTH} bytes before any edits are
- /// considered. Furthermore, the first 1 {@link
- /// #DEFAULT_NON_FUZZY_PREFIX} byte is not allowed to be
- /// edited. We allow up to 1 (@link
- /// #DEFAULT_MAX_EDITS} edit.
- /// If parameter in the constructor is set to true, maxEdits,
+ /// returned by the 's ,
+ /// usually UTF8. By default
+ /// the analyzed bytes must be at least 3
+ /// bytes before any edits are
+ /// considered. Furthermore, the first 1
+ /// byte is not allowed to be
+ /// edited. We allow up to 1
+ /// edit.
+ /// If parameter in the constructor is set to true, maxEdits,
/// minFuzzyLength, transpositions and nonFuzzyPrefix are measured in Unicode code
/// points (actual letters) instead of bytes.
///
@@ -72,15 +71,16 @@ namespace Lucene.Net.Search.Suggest.Analyzing
private readonly bool unicodeAware;
///
- /// Measure maxEdits, minFuzzyLength, transpositions and nonFuzzyPrefix
- /// parameters in Unicode code points (actual letters)
- /// instead of bytes.
+ /// Measure , ,
+ /// , and
+ /// parameters in Unicode code points (actual letters)
+ /// instead of bytes.
///
public const bool DEFAULT_UNICODE_AWARE = false;
///
- /// The default minimum length of the key passed to {@link
- /// #lookup} before any edits are allowed.
+ /// The default minimum length of the key passed to
+ /// before any edits are allowed.
///
public const int DEFAULT_MIN_FUZZY_LENGTH = 3;
@@ -96,39 +96,39 @@ namespace Lucene.Net.Search.Suggest.Analyzing
public const int DEFAULT_MAX_EDITS = 1;
///
- /// The default transposition value passed to
+ /// The default transposition value passed to
///
public const bool DEFAULT_TRANSPOSITIONS = true;
///
- /// Creates a instance initialized with default values.
+ /// Creates a instance initialized with default values.
///
- /// the analyzer used for this suggester
+ /// The used for this suggester.
public FuzzySuggester(Analyzer analyzer)
: this(analyzer, analyzer)
{
}
///
- /// Creates a instance with an index & a query analyzer initialized with default values.
+ /// Creates a instance with an index & a query analyzer initialized with default values.
///
///
- /// Analyzer that will be used for analyzing suggestions while building the index.
+ /// that will be used for analyzing suggestions while building the index.
///
- /// Analyzer that will be used for analyzing query text during lookup
+ /// that will be used for analyzing query text during lookup
public FuzzySuggester(Analyzer indexAnalyzer, Analyzer queryAnalyzer)
: this(indexAnalyzer, queryAnalyzer, EXACT_FIRST | PRESERVE_SEP, 256, -1, true, DEFAULT_MAX_EDITS, DEFAULT_TRANSPOSITIONS, DEFAULT_NON_FUZZY_PREFIX, DEFAULT_MIN_FUZZY_LENGTH, DEFAULT_UNICODE_AWARE)
{
}
///
- /// Creates a instance.
+ /// Creates a instance.
///
- /// Analyzer that will be used for
+ /// The that will be used for
/// analyzing suggestions while building the index.
- /// Analyzer that will be used for
+ /// The that will be used for
/// analyzing query text during lookup
- /// see ,
+ /// see ,
/// Maximum number of
/// surface forms to keep for a single analyzed form.
/// When there are too many surface forms we discard the
@@ -137,12 +137,12 @@ namespace Lucene.Net.Search.Suggest.Analyzing
/// to expand from the analyzed form. Set this to -1 for
/// no limit.
/// Whether position holes should appear in the automaton
- /// must be >= 0 and <= .
- /// true if transpositions should be treated as a primitive
+ /// must be >= 0 and <= .
+ /// true if transpositions should be treated as a primitive
/// edit operation. If this is false, comparisons will implement the classic
/// Levenshtein algorithm.
- /// length of common (non-fuzzy) prefix (see default
- /// minimum length of lookup key before any edits are allowed (see default )
+ /// length of common (non-fuzzy) prefix (see default
+ /// minimum length of lookup key before any edits are allowed (see default )
/// operate Unicode code points instead of bytes.
public FuzzySuggester(Analyzer indexAnalyzer, Analyzer queryAnalyzer, int options, int maxSurfaceFormsPerAnalyzedForm, int maxGraphExpansions, bool preservePositionIncrements, int maxEdits, bool transpositions, int nonFuzzyPrefix, int minFuzzyLength, bool unicodeAware)
: base(indexAnalyzer, queryAnalyzer, options, maxSurfaceFormsPerAnalyzedForm, maxGraphExpansions, preservePositionIncrements)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/Analyzing/SuggestStopFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Analyzing/SuggestStopFilter.cs b/src/Lucene.Net.Suggest/Suggest/Analyzing/SuggestStopFilter.cs
index 6e8c08b..59d7836 100644
--- a/src/Lucene.Net.Suggest/Suggest/Analyzing/SuggestStopFilter.cs
+++ b/src/Lucene.Net.Suggest/Suggest/Analyzing/SuggestStopFilter.cs
@@ -23,17 +23,18 @@ namespace Lucene.Net.Search.Suggest.Analyzing
*/
///
- /// Like except it will not remove the
- /// last token if that token was not followed by some token
- /// separator. For example, a query 'find the' would
- /// preserve the 'the' since it was not followed by a space or
- /// punctuation or something, and mark it KEYWORD so future
- /// stemmers won't touch it either while a query like "find
- /// the popsicle' would remove 'the' as a stopword.
+ /// Like except it will not remove the
+ /// last token if that token was not followed by some token
+ /// separator. For example, a query 'find the' would
+ /// preserve the 'the' since it was not followed by a space or
+ /// punctuation or something, and mark it KEYWORD so future
+ /// stemmers won't touch it either while a query like "find
+ /// the popsicle' would remove 'the' as a stopword.
///
- /// Normally you'd use the ordinary
- /// in your indexAnalyzer and then this class in your
- /// queryAnalyzer, when using one of the analyzing suggesters.
+ ///
+ /// Normally you'd use the ordinary
+ /// in your indexAnalyzer and then this class in your
+ /// queryAnalyzer, when using one of the analyzing suggesters.
///
///
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/BufferedInputIterator.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/BufferedInputIterator.cs b/src/Lucene.Net.Suggest/Suggest/BufferedInputIterator.cs
index 7518591..71590d8 100644
--- a/src/Lucene.Net.Suggest/Suggest/BufferedInputIterator.cs
+++ b/src/Lucene.Net.Suggest/Suggest/BufferedInputIterator.cs
@@ -40,7 +40,7 @@ namespace Lucene.Net.Search.Suggest
/// current buffer position
protected internal int curPos = -1;
///
- /// buffered weights, parallel with
+ /// buffered weights, parallel with
protected internal long[] freqs = new long[1];
private readonly BytesRef spare = new BytesRef();
private readonly BytesRef payloadSpare = new BytesRef();
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/BufferingTermFreqIteratorWrapper.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/BufferingTermFreqIteratorWrapper.cs b/src/Lucene.Net.Suggest/Suggest/BufferingTermFreqIteratorWrapper.cs
index deaeca4..fa929be 100644
--- a/src/Lucene.Net.Suggest/Suggest/BufferingTermFreqIteratorWrapper.cs
+++ b/src/Lucene.Net.Suggest/Suggest/BufferingTermFreqIteratorWrapper.cs
@@ -35,7 +35,7 @@ namespace Lucene.Net.Search.Suggest
/// current buffer position
protected internal int curPos = -1;
///
- /// buffered weights, parallel with
+ /// buffered weights, parallel with
protected internal long[] freqs = new long[1];
private readonly BytesRef spare = new BytesRef();
private readonly IComparer comp;
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/DocumentDictionary.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/DocumentDictionary.cs b/src/Lucene.Net.Suggest/Suggest/DocumentDictionary.cs
index ee7ddc4..ff7bc3d 100644
--- a/src/Lucene.Net.Suggest/Suggest/DocumentDictionary.cs
+++ b/src/Lucene.Net.Suggest/Suggest/DocumentDictionary.cs
@@ -30,27 +30,27 @@ namespace Lucene.Net.Search.Suggest
/// information taken from stored/indexed fields in a Lucene index.
///
/// NOTE:
- ///
- ///
+ ///
+ ///
/// The term and (optionally) payload fields have to be
/// stored
- ///
- ///
- /// The weight field can be stored or can be a .
- /// If the weight field is not defined, the value of the weight is 0
- ///
- ///
+ ///
+ ///
+ /// The weight field can be stored or can be a .
+ /// If the weight field is not defined, the value of the weight is 0
+ ///
+ ///
/// if any of the term or (optionally) payload fields supplied
/// do not have a value for a document, then the document is
/// skipped by the dictionary
- ///
- ///
+ ///
+ ///
///
public class DocumentDictionary : IDictionary
{
///
- /// to load documents from
+ /// to load documents from
protected internal readonly IndexReader reader;
///
@@ -63,8 +63,8 @@ namespace Lucene.Net.Search.Suggest
private readonly string weightField;
///
- /// Creates a new dictionary with the contents of the fields named field
- /// for the terms and weightField for the weights that will be used for
+ /// Creates a new dictionary with the contents of the fields named
+ /// for the terms and for the weights that will be used for
/// the corresponding terms.
///
public DocumentDictionary(IndexReader reader, string field, string weightField)
@@ -73,9 +73,9 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// Creates a new dictionary with the contents of the fields named field
- /// for the terms, weightField for the weights that will be used for the
- /// the corresponding terms and payloadField for the corresponding payloads
+ /// Creates a new dictionary with the contents of the fields named
+ /// for the terms, for the weights that will be used for the
+ /// the corresponding terms and for the corresponding payloads
/// for the entry.
///
public DocumentDictionary(IndexReader reader, string field, string weightField, string payloadField)
@@ -84,10 +84,10 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// Creates a new dictionary with the contents of the fields named field
- /// for the terms, weightField for the weights that will be used for the
- /// the corresponding terms, payloadField for the corresponding payloads
- /// for the entry and contextsFeild for associated contexts.
+ /// Creates a new dictionary with the contents of the fields named
+ /// for the terms, for the weights that will be used for the
+ /// the corresponding terms, for the corresponding payloads
+ /// for the entry and for associated contexts.
///
public DocumentDictionary(IndexReader reader, string field, string weightField, string payloadField, string contextsField)
{
@@ -107,7 +107,7 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// Implements from stored fields.
+ /// Implements from stored fields.
protected internal class DocumentInputIterator : IInputIterator
{
private readonly DocumentDictionary outerInstance;
@@ -127,7 +127,7 @@ namespace Lucene.Net.Search.Suggest
///
/// Creates an iterator over term, weight and payload fields from the lucene
- /// index. setting withPayload to false, implies an iterator
+ /// index. setting to false, implies an iterator
/// over only term and weight.
///
public DocumentInputIterator(DocumentDictionary outerInstance, bool hasPayloads, bool hasContexts)
@@ -223,9 +223,9 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// Returns the value of the weightField for the current document.
- /// Retrieves the value for the weightField if its stored (using doc)
- /// or if its indexed as (using docId) for the document.
+ /// Returns the value of the property for the current document.
+ /// Retrieves the value for the property if its stored (using )
+ /// or if its indexed as (using ) for the document.
/// If no value is found, then the weight is 0.
///
protected internal virtual long GetWeight(Document doc, int docId)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/DocumentValueSourceDictionary.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/DocumentValueSourceDictionary.cs b/src/Lucene.Net.Suggest/Suggest/DocumentValueSourceDictionary.cs
index 0c0165e..b8252ec 100644
--- a/src/Lucene.Net.Suggest/Suggest/DocumentValueSourceDictionary.cs
+++ b/src/Lucene.Net.Suggest/Suggest/DocumentValueSourceDictionary.cs
@@ -28,32 +28,32 @@ namespace Lucene.Net.Search.Suggest
///
/// Dictionary with terms and optionally payload information
/// taken from stored fields in a Lucene index. Similar to
- /// , except it obtains the weight
- /// of the terms in a document based on a .
+ /// , except it obtains the weight
+ /// of the terms in a document based on a .
///
/// NOTE:
- ///
- ///
+ ///
+ ///
/// The term and (optionally) payload fields have to be
/// stored
- ///
- ///
+ ///
+ ///
/// if the term or (optionally) payload fields supplied
/// do not have a value for a document, then the document is
/// rejected by the dictionary
- ///
- ///
+ ///
+ ///
///
- /// In practice the will likely be obtained
+ /// In practice the will likely be obtained
/// using the lucene expression module. The following example shows
- /// how to create a from a simple addition of two
+ /// how to create a from a simple addition of two
/// fields:
///
- /// Expression expression = JavascriptCompiler.compile("f1 + f2");
+ /// Expression expression = JavascriptCompiler.Compile("f1 + f2");
/// SimpleBindings bindings = new SimpleBindings();
- /// bindings.add(new SortField("f1", SortField.Type.LONG));
- /// bindings.add(new SortField("f2", SortField.Type.LONG));
- /// ValueSource valueSource = expression.getValueSource(bindings);
+ /// bindings.Add(new SortField("f1", SortField.Type_e.LONG));
+ /// bindings.Add(new SortField("f2", SortField.Type_e.LONG));
+ /// ValueSource valueSource = expression.GetValueSource(bindings);
///
///
///
@@ -64,9 +64,9 @@ namespace Lucene.Net.Search.Suggest
private readonly ValueSource weightsValueSource;
///
- /// Creates a new dictionary with the contents of the fields named field
- /// for the terms, payload for the corresponding payloads, contexts
- /// for the associated contexts and uses the weightsValueSource supplied
+ /// Creates a new dictionary with the contents of the fields named
+ /// for the terms, for the corresponding payloads,
+ /// for the associated contexts and uses the supplied
/// to determine the score.
///
public DocumentValueSourceDictionary(IndexReader reader, string field, ValueSource weightsValueSource, string payload, string contexts)
@@ -75,9 +75,9 @@ namespace Lucene.Net.Search.Suggest
this.weightsValueSource = weightsValueSource;
}
///
- /// Creates a new dictionary with the contents of the fields named field
- /// for the terms, payloadField for the corresponding payloads
- /// and uses the weightsValueSource supplied to determine the
+ /// Creates a new dictionary with the contents of the fields named
+ /// for the terms, for the corresponding payloads
+ /// and uses the supplied to determine the
/// score.
///
public DocumentValueSourceDictionary(IndexReader reader, string field, ValueSource weightsValueSource, string payload)
@@ -87,8 +87,8 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// Creates a new dictionary with the contents of the fields named field
- /// for the terms and uses the weightsValueSource supplied to determine the
+ /// Creates a new dictionary with the contents of the fields named
+ /// for the terms and uses the supplied to determine the
/// score.
///
public DocumentValueSourceDictionary(IndexReader reader, string field, ValueSource weightsValueSource)
@@ -136,9 +136,8 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// Returns the weight for the current docId as computed
- /// by the weightsValueSource
- ///
+ /// Returns the weight for the current as computed
+ /// by the
///
protected internal override long GetWeight(Document doc, int docId)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs b/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs
index a43cb37..9db60c8 100644
--- a/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs
+++ b/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs
@@ -27,29 +27,29 @@ namespace Lucene.Net.Search.Suggest
///
/// Dictionary represented by a text file.
///
- /// Format allowed: 1 entry per line:
- /// An entry can be:
- ///
- /// where the default fieldDelimiter is {@value #DEFAULT_FIELD_DELIMITER}
- ///
+ /// Format allowed: 1 entry per line:
+ /// An entry can be:
+ ///
+ /// suggestion
+ /// suggestion weight
+ /// suggestion weight payload
+ ///
+ /// where the default is (a tab)
+ ///
/// NOTE:
- ///
- ///
In order to have payload enabled, the first entry has to have a payload
- ///
If the weight for an entry is not specified then a value of 1 is used
- ///
A payload cannot be specified without having the weight specified for an entry
- ///
If the payload for an entry is not specified (assuming payload is enabled)
- /// then an empty payload is returned
- ///
An entry cannot have more than two fieldDelimiter
- ///
- ///
- /// Example:
- /// word1 word2 TAB 100 TAB payload1
- /// word3 TAB 101
- /// word4 word3 TAB 102
+ ///
+ /// In order to have payload enabled, the first entry has to have a payload
+ /// If the weight for an entry is not specified then a value of 1 is used
+ /// A payload cannot be specified without having the weight specified for an entry
+ /// If the payload for an entry is not specified (assuming payload is enabled)
+ /// then an empty payload is returned
+ /// An entry cannot have more than two s
+ ///
+ ///
+ /// Example:
+ /// word1 word2 TAB 100 TAB payload1
+ /// word3 TAB 101
+ /// word4 word3 TAB 102
///
public class FileDictionary : IDictionary
{
@@ -65,7 +65,7 @@ namespace Lucene.Net.Search.Suggest
///
/// Creates a dictionary based on an inputstream.
- /// Using as the
+ /// Using as the
/// field seperator in a line.
///
/// NOTE: content is treated as UTF-8
@@ -78,7 +78,7 @@ namespace Lucene.Net.Search.Suggest
///
/// Creates a dictionary based on a reader.
- /// Using as the
+ /// Using as the
/// field seperator in a line.
///
public FileDictionary(TextReader reader)
@@ -88,7 +88,7 @@ namespace Lucene.Net.Search.Suggest
///
/// Creates a dictionary based on a reader.
- /// Using fieldDelimiter to seperate out the
+ /// Using to seperate out the
/// fields in a line.
///
public FileDictionary(TextReader reader, string fieldDelimiter)
@@ -99,7 +99,7 @@ namespace Lucene.Net.Search.Suggest
///
/// Creates a dictionary based on an inputstream.
- /// Using fieldDelimiter to seperate out the
+ /// Using to seperate out the
/// fields in a line.
///
/// NOTE: content is treated as UTF-8
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/Fst/BytesRefSorter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Fst/BytesRefSorter.cs b/src/Lucene.Net.Suggest/Suggest/Fst/BytesRefSorter.cs
index dbf4361..2d7c952 100644
--- a/src/Lucene.Net.Suggest/Suggest/Fst/BytesRefSorter.cs
+++ b/src/Lucene.Net.Suggest/Suggest/Fst/BytesRefSorter.cs
@@ -21,7 +21,7 @@ namespace Lucene.Net.Search.Suggest.Fst
*/
///
- /// Collects and then allows one to iterate over their sorted order. Implementations
+ /// Collects and then allows one to iterate over their sorted order. Implementations
/// of this interface will be called in a single-threaded scenario.
///
public interface IBytesRefSorter
@@ -29,16 +29,16 @@ namespace Lucene.Net.Search.Suggest.Fst
///
/// Adds a single suggestion entry (possibly compound with its bucket).
///
- /// If an I/O exception occurs.
- /// If an addition attempt is performed after
- /// a call to has been made.
+ /// If an I/O exception occurs.
+ /// If an addition attempt is performed after
+ /// a call to has been made.
void Add(BytesRef utf8);
///
- /// Sorts the entries added in and returns
- /// an iterator over all sorted entries.
+ /// Sorts the entries added in and returns
+ /// an enumerator over all sorted entries.
///
- /// If an I/O exception occurs.
+ /// If an I/O exception occurs.
BytesRefIterator GetEnumerator();
///
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletion.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletion.cs b/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletion.cs
index 954a7cc..aba5fdd 100644
--- a/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletion.cs
+++ b/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletion.cs
@@ -30,8 +30,8 @@ namespace Lucene.Net.Search.Suggest.Fst
///
/// Finite state automata based implementation of "autocomplete" functionality.
///
- ///
+ ///
+ /// @lucene.experimental
// TODO: we could store exact weights as outputs from the FST (int4 encoded
// floats). This would provide exact outputs from this method and to some
@@ -77,7 +77,7 @@ namespace Lucene.Net.Search.Suggest.Fst
public const int DEFAULT_BUCKETS = 10;
///
- /// An empty result. Keep this an to keep all the returned
+ /// An empty result. Keep this an to keep all the returned
/// lists of single type (monomorphic calls).
///
private static readonly IList EMPTY_RESULT = new List();
@@ -106,10 +106,10 @@ namespace Lucene.Net.Search.Suggest.Fst
///
/// Constructs an FSTCompletion, specifying higherWeightsFirst and exactFirst.
///
- /// Automaton with completions. See .
+ /// Automaton with completions. See .
///
/// Return most popular suggestions first. This is the default
- /// behavior for this implementation. Setting it to false
+ /// behavior for this implementation. Setting it to false
/// has no effect (use constant term weights to sort alphabetically
/// only).
///
@@ -132,7 +132,7 @@ namespace Lucene.Net.Search.Suggest.Fst
///
/// Defaults to higher weights first and exact first.
- ///
+ ///
public FSTCompletion(FST
///
- /// If true, the routine terminates immediately when
- /// num suggestions have been collected. If
- /// false, it will collect suggestions from all weight
- /// arcs (needed for .
+ /// If true, the routine terminates immediately when
+ /// suggestions have been collected. If
+ /// false, it will collect suggestions from all weight
+ /// arcs (needed for .
private IList LookupSortedByWeight(BytesRef key, int num, bool collectAll)
{
// Don't overallocate the results buffers. This also serves the purpose of
@@ -334,13 +333,15 @@ namespace Lucene.Net.Search.Suggest.Fst
///
/// Checks if the list of
- /// s already has a
- /// key. If so, reorders that
- /// to the first
+ /// s already has a
+ /// . If so, reorders that
+ /// to the first
/// position.
///
- /// Returns true if and only if list contained
- /// key.
+ ///
+ /// Returns true if and only if contained
+ /// .
+ ///
private bool CheckExistingAndReorder(List list, BytesRef key)
{
// We assume list does not have duplicates (because of how the FST is created).
@@ -367,15 +368,15 @@ namespace Lucene.Net.Search.Suggest.Fst
}
///
- /// Descend along the path starting at arc and going through bytes
+ /// Descend along the path starting at and going through bytes
/// in the argument.
///
///
/// The starting arc. This argument is modified in-place.
///
/// The term to descend along.
- /// If true, arc will be set to the arc
- /// matching last byte of term. false is
+ /// If true, will be set to the arc
+ /// matching last byte of . false is
/// returned if no such prefix exists.
private bool DescendWithPrefix(FST.Arc
- ///
+ ///
+ /// @lucene.experimental
public class FSTCompletionBuilder
{
///
@@ -139,7 +139,7 @@ namespace Lucene.Net.Search.Suggest.Fst
private readonly IBytesRefSorter sorter;
///
- /// Scratch buffer for .
+ /// Scratch buffer for .
///
private readonly BytesRef scratch = new BytesRef();
@@ -149,9 +149,9 @@ namespace Lucene.Net.Search.Suggest.Fst
private readonly int shareMaxTailLength;
///
- /// Creates an with default options: 10 buckets, exact match
- /// promoted to first position and with a comparator obtained from
- /// .
+ /// Creates an with default options: 10 buckets, exact match
+ /// promoted to first position and with a comparator obtained from
+ /// .
///
public FSTCompletionBuilder()
: this(DEFAULT_BUCKETS, new InMemorySorter(BytesRef.UTF8SortedAsUnicodeComparer), int.MaxValue)
@@ -162,22 +162,22 @@ namespace Lucene.Net.Search.Suggest.Fst
/// Creates an FSTCompletion with the specified options.
///
/// The number of buckets for weight discretization. Buckets are used
- /// in and must be smaller than the number
+ /// in and must be smaller than the number
/// given here.
///
///
- /// used for re-sorting input for the automaton.
+ /// used for re-sorting input for the automaton.
/// For large inputs, use on-disk sorting implementations. The sorter
- /// is closed automatically in if it implements
- /// .
+ /// is closed automatically in if it implements
+ /// .
///
///
/// Max shared suffix sharing length.
///
- /// See the description of this parameter in 's constructor.
+ /// See the description of this parameter in 's constructor.
/// In general, for very large inputs you'll want to construct a non-minimal
/// automaton which will be larger, but the construction will take far less ram.
- /// For minimal automata, set it to .
+ /// For minimal automata, set it to .
public FSTCompletionBuilder(int buckets, IBytesRefSorter sorter, int shareMaxTailLength)
{
if (buckets < 1 || buckets > 255)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs b/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs
index ae71771..6cbb8ae 100644
--- a/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs
+++ b/src/Lucene.Net.Suggest/Suggest/Fst/FSTCompletionLookup.cs
@@ -26,12 +26,12 @@ namespace Lucene.Net.Search.Suggest.Fst
*/
///
- /// An adapter from API to .
+ /// An adapter from API to .
///
- /// This adapter differs from in that it attempts
- /// to discretize any "weights" as passed from in
+ /// This adapter differs from in that it attempts
+ /// to discretize any "weights" as passed from in
/// to match the number of buckets. For the rationale for bucketing, see
- /// .
+ /// .
///
///
/// Note:Discretization requires an additional sorting pass.
@@ -48,25 +48,25 @@ namespace Lucene.Net.Search.Suggest.Fst
///
///
/// For fine-grained control over which weights are assigned to which buckets,
- /// use directly or , for example.
+ /// use directly or , for example.
///
///
///
- ///
+ ///
+ /// @lucene.experimental
public class FSTCompletionLookup : Lookup
{
///
/// An invalid bucket count if we're creating an object
/// of this class from an existing FST.
///
- ///
+ ///
private static int INVALID_BUCKETS_COUNT = -1;
///
/// Shared tail length for conflating in the created automaton. Setting this
- /// to larger values () will create smaller (or minimal)
- /// automata at the cost of RAM for keeping nodes hash in the .
+ /// to larger values () will create smaller (or minimal)
+ /// automata at the cost of RAM for keeping nodes hash in the .
///
/// Empirical pick.
///
@@ -92,8 +92,8 @@ namespace Lucene.Net.Search.Suggest.Fst
///
/// This constructor prepares for creating a suggested FST using the
- /// method. The number of weight
- /// discretization buckets is set to and
+ /// method. The number of weight
+ /// discretization buckets is set to and
/// exact matches are promoted to the top of the suggestions list.
///
public FSTCompletionLookup()
@@ -103,14 +103,14 @@ namespace Lucene.Net.Search.Suggest.Fst
///
/// This constructor prepares for creating a suggested FST using the
- /// method.
+ /// method.
///
///
/// The number of weight discretization buckets (see
- /// for details).
+ /// for details).
///
///
- /// If true exact matches are promoted to the top of the
+ /// If true exact matches are promoted to the top of the
/// suggestions list. Otherwise they appear in the order of
/// discretized weight and alphabetical within the bucket.
public FSTCompletionLookup(int buckets, bool exactMatchFirst)
@@ -123,7 +123,7 @@ namespace Lucene.Net.Search.Suggest.Fst
/// This constructor takes a pre-built automaton.
///
///
- /// An instance of .
+ /// An instance of .
///
/// If true exact matches are promoted to the top of the
/// suggestions list. Otherwise they appear in the order of
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/Fst/WFSTCompletionLookup.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Fst/WFSTCompletionLookup.cs b/src/Lucene.Net.Suggest/Suggest/Fst/WFSTCompletionLookup.cs
index 40defba..7186ad5 100644
--- a/src/Lucene.Net.Suggest/Suggest/Fst/WFSTCompletionLookup.cs
+++ b/src/Lucene.Net.Suggest/Suggest/Fst/WFSTCompletionLookup.cs
@@ -31,7 +31,7 @@ namespace Lucene.Net.Search.Suggest.Fst
/// suggestions.
///
/// NOTE:
- /// Input weights must be between 0 and , any
+ /// Input weights must be between 0 and , any
/// other values will be rejected.
///
/// @lucene.experimental
@@ -57,7 +57,7 @@ namespace Lucene.Net.Search.Suggest.Fst
private long count = 0;
///
- /// Calls
+ /// Calls WFSTCompletionLookup(true)
///
public WFSTCompletionLookup()
: this(true)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/InMemorySorter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/InMemorySorter.cs b/src/Lucene.Net.Suggest/Suggest/InMemorySorter.cs
index 9ec4e6e..f5de243 100644
--- a/src/Lucene.Net.Suggest/Suggest/InMemorySorter.cs
+++ b/src/Lucene.Net.Suggest/Suggest/InMemorySorter.cs
@@ -23,7 +23,7 @@ namespace Lucene.Net.Search.Suggest
*/
///
- /// An that keeps all the entries in memory.
+ /// An that keeps all the entries in memory.
/// @lucene.experimental
/// @lucene.internal
///
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/InputIterator.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/InputIterator.cs b/src/Lucene.Net.Suggest/Suggest/InputIterator.cs
index 45b64e3..9e460d2 100644
--- a/src/Lucene.Net.Suggest/Suggest/InputIterator.cs
+++ b/src/Lucene.Net.Suggest/Suggest/InputIterator.cs
@@ -22,8 +22,8 @@ namespace Lucene.Net.Search.Suggest
///
/// Interface for enumerating term,weight,payload triples for suggester consumption;
- /// currently only ,
- /// and support payloads.
+ /// currently only ,
+ /// and support payloads.
///
public interface IInputIterator : BytesRefIterator
{
@@ -34,8 +34,8 @@ namespace Lucene.Net.Search.Suggest
///
/// An arbitrary byte[] to record per suggestion. See
- /// to retrieve the payload
- /// for each suggestion.
+ /// to retrieve the payload
+ /// for each suggestion.
///
BytesRef Payload { get; }
@@ -55,7 +55,7 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// Singleton IInputIterator that iterates over 0 BytesRefs.
+ /// Singleton that iterates over 0 BytesRefs.
///
public static class EmptyInputIterator
{
@@ -63,8 +63,8 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// Wraps a BytesRefIterator as a suggester IInputIterator, with all weights
- /// set to 1 and carries no payload
+ /// Wraps a as a suggester , with all weights
+ /// set to 1 and carries no payload
///
public class InputIteratorWrapper : IInputIterator
{
@@ -72,7 +72,7 @@ namespace Lucene.Net.Search.Suggest
///
/// Creates a new wrapper, wrapping the specified iterator and
- /// specifying a weight value of 1 for all terms
+ /// specifying a weight value of 1 for all terms
/// and nullifies associated payloads.
///
public InputIteratorWrapper(BytesRefIterator wrapped)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellLookup.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellLookup.cs b/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellLookup.cs
index a272add..d5a32fd 100644
--- a/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellLookup.cs
+++ b/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellLookup.cs
@@ -26,7 +26,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// Suggest implementation based on
/// JaSpell.
///
- ///
+ ///
public class JaspellLookup : Lookup
{
internal JaspellTernarySearchTrie trie = new JaspellTernarySearchTrie();
@@ -38,9 +38,9 @@ namespace Lucene.Net.Search.Suggest.Jaspell
private long count = 0;
///
- /// Creates a new empty trie
- ///
+ /// Creates a new empty trie
+ ///
+ ///
public JaspellLookup()
{
}
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs b/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs
index 7bc7995..ef67e00 100644
--- a/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs
+++ b/src/Lucene.Net.Suggest/Suggest/Jaspell/JaspellTernarySearchTrie.cs
@@ -38,7 +38,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
{
///
/// Implementation of a Ternary Search Trie, a data structure for storing
- /// String objects that combines the compact size of a binary search
+ /// s that combines the compact size of a binary search
/// tree with the speed of a digital search trie, and is therefore ideal for
/// practical use in sorting and searching data.
///
@@ -166,14 +166,14 @@ namespace Lucene.Net.Search.Suggest.Jaspell
*/
///
- /// The default number of values returned by the matchAlmost
+ /// The default number of values returned by the
/// method.
///
private int defaultNumReturnValues = -1;
///
- /// the number of differences allowed in a call to the
- /// matchAlmostKey method.
+ /// the number of differences allowed in a call to the
+ /// .
///
private int matchAlmostDiff;
@@ -215,13 +215,13 @@ namespace Lucene.Net.Search.Suggest.Jaspell
///
- /// Constructs a Ternary Search Trie and loads data from a File
+ /// Constructs a Ternary Search Trie and loads data from a
/// into the Trie. The file is a normal text document, where each line is of
/// the form word TAB float.
///
///
- /// The File with the data to load into the Trie.
- ///
+ /// The with the data to load into the Trie.
+ ///
/// A problem occured while reading the data.
public JaspellTernarySearchTrie(FileInfo file)
: this(file, false)
@@ -229,16 +229,16 @@ namespace Lucene.Net.Search.Suggest.Jaspell
}
///
- /// Constructs a Ternary Search Trie and loads data from a File
+ /// Constructs a Ternary Search Trie and loads data from a
/// into the Trie. The file is a normal text document, where each line is of
/// the form "word TAB float".
///
///
- /// The File with the data to load into the Trie.
+ /// The with the data to load into the Trie.
///
/// If true, the file is compressed with the GZIP algorithm, and if
/// false, the file is a normal text document.
- ///
+ ///
/// A problem occured while reading the data.
public JaspellTernarySearchTrie(FileInfo file, bool compression)
: this()
@@ -339,11 +339,11 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// method, then pass the node returned by this method into this method (make
/// sure you don't delete the data of any of the nodes returned from this
/// method!) and continue in this fashion until the node returned by this
- /// method is null.
+ /// method is null.
///
/// The TSTNode instance returned by this method will be next node to be
- /// operated on by deleteNodeRecursion (This emulates recursive
- /// method call while avoiding the JVM overhead normally associated with a
+ /// operated on by (This emulates recursive
+ /// method call while avoiding the overhead normally associated with a
/// recursive method.)
///
///
@@ -445,7 +445,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// Retrieve the object indexed by a key.
///
///
- /// A String index.
+ /// A index.
/// The object retrieved from the Ternary Search Trie.
public virtual object Get(string key)
{
@@ -462,7 +462,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// and store the new Float.
///
///
- /// A String index.
+ /// A index.
/// The Float retrieved from the Ternary Search Trie.
public virtual float? GetAndIncrement(string key)
{
@@ -490,7 +490,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
///
///
/// The node whose index is to be calculated.
- /// The String that indexes the node argument.
+ /// The that indexes the node argument.
protected internal virtual string GetKey(TSTNode node)
{
StringBuilder getKeyBuffer = new StringBuilder();
@@ -510,34 +510,34 @@ namespace Lucene.Net.Search.Suggest.Jaspell
currentNode = currentNode.relatives[TSTNode.PARENT];
}
- // LUCENENET NOTE: Reverse doesn't happen in place in .NET,
+ // LUCENENET NOTE: Reverse doesn't happen in place in a .NET StringBuilder,
// so we need to return the reversed result.
return getKeyBuffer.Reverse().ToString();
}
///
- /// Returns the node indexed by key, or null if that node doesn't
+ /// Returns the node indexed by key, or null if that node doesn't
/// exist. Search begins at root node.
///
///
- /// A String that indexes the node that is returned.
+ /// A that indexes the node that is returned.
/// The node object indexed by key. This object is an instance of an
- /// inner class named TernarySearchTrie.TSTNode.
+ /// inner class named .
public virtual TSTNode GetNode(string key)
{
return GetNode(key, rootNode);
}
///
- /// Returns the node indexed by key, or null if that node doesn't
+ /// Returns the node indexed by key, or null if that node doesn't
/// exist. The search begins at root node.
///
///
- /// A String that indexes the node that is returned.
+ /// A that indexes the node that is returned.
///
/// The top node defining the subtrie to be searched.
/// The node object indexed by key. This object is an instance of an
- /// inner class named TernarySearchTrie.TSTNode.
+ /// inner class named .
protected internal virtual TSTNode GetNode(string key, TSTNode startNode)
{
if (key == null || startNode == null || key.Length == 0)
@@ -578,13 +578,13 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// and creating any required intermediate nodes if they don't exist.
///
///
- /// A String that indexes the node that is returned.
+ /// A that indexes the node that is returned.
/// The node object indexed by key. This object is an instance of an
- /// inner class named TernarySearchTrie.TSTNode.
- ///
- /// If the key is null.
- ///
- /// If the key is an empty String.
+ /// inner class named .
+ ///
+ /// If the key is null.
+ ///
+ /// If the key is an empty .
protected internal virtual TSTNode GetOrCreateNode(string key)
{
if (key == null)
@@ -637,33 +637,33 @@ namespace Lucene.Net.Search.Suggest.Jaspell
}
///
- /// Returns a List of keys that almost match the argument key.
+ /// Returns a of keys that almost match the argument key.
/// Keys returned will have exactly diff characters that do not match the
- /// target key, where diff is equal to the last value passed in as an argument
- /// to the setMatchAlmostDiff method.
+ /// target key, where diff is equal to the last value set
+ /// to the property.
///
- /// If the matchAlmost method is called before the
- /// setMatchAlmostDiff method has been called for the first time,
+ /// If the method is called before the
+ /// property has been called for the first time,
/// then diff = 0.
///
///
///
///
/// The target key.
- /// A List with the results.
+ /// A with the results.
public virtual IList MatchAlmost(string key)
{
return MatchAlmost(key, defaultNumReturnValues);
}
///
- /// Returns a List of keys that almost match the argument key.
+ /// Returns a of keys that almost match the argument key.
/// Keys returned will have exactly diff characters that do not match the
- /// target key, where diff is equal to the last value passed in as an argument
- /// to the setMatchAlmostDiff method.
+ /// target key, where diff is equal to the last value set
+ /// to the property.
///
- /// If the matchAlmost method is called before the
- /// setMatchAlmostDiff method has been called for the first time,
+ /// If the method is called before the
+ /// property has been called for the first time,
/// then diff = 0.
///
///
@@ -672,7 +672,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// The target key.
///
/// The maximum number of values returned by this method.
- /// A List with the results
+ /// A with the results
public virtual IList MatchAlmost(string key, int numReturnValues)
{
return MatchAlmostRecursion(rootNode, 0, matchAlmostDiff, key, ((numReturnValues < 0) ? -1 : numReturnValues), new List(), false);
@@ -689,18 +689,18 @@ namespace Lucene.Net.Search.Suggest.Jaspell
///
/// The number of differences so far.
///
- /// The maximum number of values in the result List.
+ /// The maximum number of values in the result .
///
/// The results so far.
///
- /// If true all keys having up to and including matchAlmostDiff
+ /// If true all keys having up to and including
/// mismatched letters will be included in the result (including a key
/// that is exactly the same as the target string) otherwise keys will
/// be included in the result only if they have exactly
- /// matchAlmostDiff number of mismatched letters.
+ /// number of mismatched letters.
///
/// The key being searched.
- /// A List with the results.
+ /// A with the results.
private IList MatchAlmostRecursion(TSTNode currentNode, int charIndex, int d, string matchAlmostKey, int matchAlmostNumReturnValues, IList matchAlmostResult2, bool upTo)
{
if ((currentNode == null) || (matchAlmostNumReturnValues != -1 && matchAlmostResult2.Count >= matchAlmostNumReturnValues) || (d < 0) || (charIndex >= matchAlmostKey.Length))
@@ -728,30 +728,30 @@ namespace Lucene.Net.Search.Suggest.Jaspell
}
///
- /// Returns an alphabetical List of all keys in the trie that
+ /// Returns an alphabetical of all keys in the trie that
/// begin with a given prefix. Only keys for nodes having non-null data are
- /// included in the List.
+ /// included in the .
///
///
/// Each key returned from this method will begin with the characters
/// in prefix.
- /// A List with the results.
+ /// A with the results.
public virtual IList MatchPrefix(string prefix)
{
return MatchPrefix(prefix, defaultNumReturnValues);
}
///
- /// Returns an alphabetical List of all keys in the trie that
+ /// Returns an alphabetical of all keys in the trie that
/// begin with a given prefix. Only keys for nodes having non-null data are
- /// included in the List.
+ /// included in the .
///
///
/// Each key returned from this method will begin with the characters
/// in prefix.
///
/// The maximum number of values returned from this method.
- /// A List with the results
+ /// A with the results
public virtual IList MatchPrefix(string prefix, int numReturnValues)
{
List sortKeysResult = new List();
@@ -814,7 +814,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// Stores a value in the trie. The value may be retrieved using the key.
///
///
- /// A String that indexes the object to be stored.
+ /// A that indexes the object to be stored.
///
/// The object to be stored in the Trie.
public virtual void Put(string key, object value)
@@ -828,7 +828,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
///
/// The current node.
///
- /// If true we check the data to be different of null.
+ /// If true we check the data to be different of null.
///
/// The number of nodes so far.
/// The number of nodes accounted.
@@ -860,7 +860,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// unnecessary by the removal of this data.
///
///
- /// A string that indexes the object to be removed from
+ /// A that indexes the object to be removed from
/// the Trie.
public virtual void Remove(string key)
{
@@ -869,7 +869,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
///
/// Sets the number of characters by which words can differ from target word
- /// when calling the matchAlmost method.
+ /// when calling the method.
///
/// Arguments less than 0 will set the char difference to 0, and arguments
/// greater than 3 will set the char difference to 3.
@@ -900,13 +900,12 @@ namespace Lucene.Net.Search.Suggest.Jaspell
///
/// Sets the default maximum number of values returned from the
- /// matchPrefix and matchAlmost methods.
+ /// and methods.
///
/// The value should be set this to -1 to get an unlimited number of return
/// values. note that the methods mentioned above provide overloaded versions
/// that allow you to specify the maximum number of return values, in which
/// case this value is temporarily overridden.
- ///
///
///
/// **
@@ -933,7 +932,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// The top node defining the subtrie to be searched.
///
/// The maximum number of values returned from this method.
- /// A List with the results.
+ /// A with the results.
protected internal virtual IList SortKeys(TSTNode startNode, int numReturnValues)
{
return SortKeysRecursion(startNode, ((numReturnValues < 0) ? -1 : numReturnValues), new List());
@@ -943,9 +942,9 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// Returns keys sorted in alphabetical order. This includes the current Node
/// and all nodes connected to the current Node.
///
- /// Sorted keys will be appended to the end of the resulting List.
+ /// Sorted keys will be appended to the end of the resulting .
/// The result may be empty when this method is invoked, but may not be
- /// null.
+ /// null.
///
///
///
@@ -955,7 +954,7 @@ namespace Lucene.Net.Search.Suggest.Jaspell
/// The maximum number of values in the result.
///
/// The results so far.
- /// A List with the results.
+ /// A with the results.
private IList SortKeysRecursion(TSTNode currentNode, int sortKeysNumReturnValues, IList sortKeysResult2)
{
if (currentNode == null)
@@ -976,7 +975,8 @@ namespace Lucene.Net.Search.Suggest.Jaspell
}
///
- /// Return an approximate memory usage for this trie.
+ /// Return an approximate memory usage for this trie.
+ ///
public virtual long GetSizeInBytes()
{
long mem = RamUsageEstimator.ShallowSizeOf(this);
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/Lookup.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Lookup.cs b/src/Lucene.Net.Suggest/Suggest/Lookup.cs
index 7cdb951..50867c8 100644
--- a/src/Lucene.Net.Suggest/Suggest/Lookup.cs
+++ b/src/Lucene.Net.Suggest/Suggest/Lookup.cs
@@ -25,7 +25,7 @@ namespace Lucene.Net.Search.Suggest
*/
///
- /// Simple Lookup interface for suggestions.
+ /// Simple Lookup interface for suggestions.
/// @lucene.experimental
///
public abstract class Lookup
@@ -43,7 +43,7 @@ namespace Lucene.Net.Search.Suggest
///
/// Expert: custom Object to hold the result of a
- /// highlighted suggestion.
+ /// highlighted suggestion.
///
public readonly object highlightKey;
@@ -125,7 +125,7 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// A simple char-by-char comparator for
+ /// A simple char-by-char comparator for
///
public static readonly IComparer CHARSEQUENCE_COMPARATOR = new CharSequenceComparator();
@@ -153,7 +153,7 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// A collecting a fixed size of high priority
+ /// A collecting a fixed size of high priority s.
///
public sealed class LookupPriorityQueue : PriorityQueue
{
@@ -200,8 +200,8 @@ namespace Lucene.Net.Search.Suggest
///
/// Build lookup from a dictionary. Some implementations may require sorted
/// or unsorted keys from the dictionary's iterator - use
- /// or
- /// in such case.
+ /// or
+ /// in such case.
///
public virtual void Build(IDictionary dict)
{
@@ -209,8 +209,8 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// Calls after converting
- /// to
+ /// Calls after converting
+ /// to
///
public virtual bool Load(Stream input)
{
@@ -226,8 +226,8 @@ namespace Lucene.Net.Search.Suggest
}
///
- /// Calls after converting
- /// to
+ /// Calls after converting
+ /// to
///
public virtual bool Store(Stream output)
{
@@ -248,7 +248,7 @@ namespace Lucene.Net.Search.Suggest
public abstract long Count { get; }
///
- /// Builds up a new internal representation based on the given .
+ /// Builds up a new internal representation based on the given .
/// The implementation might re-sort the data internally.
///
public abstract void Build(IInputIterator inputIterator);
@@ -277,17 +277,17 @@ namespace Lucene.Net.Search.Suggest
///
/// Persist the constructed lookup data to a directory. Optional operation.
- /// to write the data to.
+ /// to write the data to.
/// true if successful, false if unsuccessful or not supported.
- /// when fatal IO error occurs.
+ /// when fatal IO error occurs.
public abstract bool Store(DataOutput output);
///
/// Discard current lookup data and load it from a previously saved copy.
/// Optional operation.
- /// the to load the lookup data.
+ /// the to load the lookup data.
/// true if completed successfully, false if unsuccessful or not supported.
- /// when fatal IO error occurs.
+ /// when fatal IO error occurs.
public abstract bool Load(DataInput input);
///
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/SortedInputIterator.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/SortedInputIterator.cs b/src/Lucene.Net.Suggest/Suggest/SortedInputIterator.cs
index c6d730e..8e2e8dc 100644
--- a/src/Lucene.Net.Suggest/Suggest/SortedInputIterator.cs
+++ b/src/Lucene.Net.Suggest/Suggest/SortedInputIterator.cs
@@ -46,9 +46,8 @@ namespace Lucene.Net.Search.Suggest
private ISet contexts = null;
///
- /// Creates a new sorted wrapper, using {@link
- /// BytesRef#getUTF8SortedAsUnicodeComparator} for
- /// sorting.
+ /// Creates a new sorted wrapper, using
+ /// for sorting.
///
public SortedInputIterator(IInputIterator source)
: this(source, BytesRef.UTF8SortedAsUnicodeComparer)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/SortedTermFreqIteratorWrapper.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/SortedTermFreqIteratorWrapper.cs b/src/Lucene.Net.Suggest/Suggest/SortedTermFreqIteratorWrapper.cs
index cf54a57..a9b8efc 100644
--- a/src/Lucene.Net.Suggest/Suggest/SortedTermFreqIteratorWrapper.cs
+++ b/src/Lucene.Net.Suggest/Suggest/SortedTermFreqIteratorWrapper.cs
@@ -42,9 +42,8 @@ namespace Lucene.Net.Search.Suggest
private readonly BytesRef scratch = new BytesRef();
///
- /// Creates a new sorted wrapper, using {@link
- /// BytesRef#getUTF8SortedAsUnicodeComparator} for
- /// sorting.
+ /// Creates a new sorted wrapper, using
+ /// for sorting.
///
public SortedTermFreqIteratorWrapper(ITermFreqIterator source)
: this(source, BytesRef.UTF8SortedAsUnicodeComparer)
@@ -139,7 +138,6 @@ namespace Lucene.Net.Search.Suggest
{
return cmp;
}
- //return long.Compare(leftCost, rightCost);
return leftCost.CompareTo(rightCost);
}
}
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9a6f9734/src/Lucene.Net.Suggest/Suggest/Tst/TSTAutocomplete.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Suggest/Suggest/Tst/TSTAutocomplete.cs b/src/Lucene.Net.Suggest/Suggest/Tst/TSTAutocomplete.cs
index 9f1f6c9..f4a6137 100644
--- a/src/Lucene.Net.Suggest/Suggest/Tst/TSTAutocomplete.cs
+++ b/src/Lucene.Net.Suggest/Suggest/Tst/TSTAutocomplete.cs
@@ -22,7 +22,7 @@ namespace Lucene.Net.Search.Suggest.Tst
///
/// Ternary Search Trie implementation.
///
- ///
+ ///
public class TSTAutocomplete
{
@@ -66,7 +66,7 @@ namespace Lucene.Net.Search.Suggest.Tst
/// key to be inserted in TST.
///
/// index of character in key to be inserted currently.
- /// currentNode The new reference to root node of TST
+ /// The new reference to root node of TST
public virtual TernaryTreeNode Insert(TernaryTreeNode currentNode, string s, object val, int x)
{
if (s == null || s.Length <= x)