Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
SuggestWord.cs
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 using System;
19 
20 namespace SpellChecker.Net.Search.Spell
21 {
22 
23  /// <summary> SuggestWord Class, used in suggestSimilar method in SpellChecker class.
24  ///
25  /// </summary>
26  /// <author> Nicolas Maisonneuve
27  /// </author>
28  sealed class SuggestWord
29  {
30  /// <summary> the score of the word</summary>
31  public float score;
32 
33  /// <summary> The freq of the word</summary>
34  public int freq;
35 
36  /// <summary> the suggested word</summary>
37  public System.String termString;
38 
39  public int CompareTo(SuggestWord a)
40  {
41  //first criteria: the edit distance
42  if (score > a.score)
43  {
44  return 1;
45  }
46  if (score < a.score)
47  {
48  return - 1;
49  }
50 
51  //second criteria (if first criteria is equal): the popularity
52  if (freq > a.freq)
53  {
54  return 1;
55  }
56 
57  if (freq < a.freq)
58  {
59  return - 1;
60  }
61 
62  return 0;
63  }
64  }
65 }