forked from apache/lucenenet
-
Notifications
You must be signed in to change notification settings - Fork 3
/
TermStatistics.cs
70 lines (63 loc) · 2.3 KB
/
TermStatistics.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
using System.Diagnostics;
namespace Lucene.Net.Search
{
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using BytesRef = Lucene.Net.Util.BytesRef;
/// <summary>
/// Contains statistics for a specific term
/// <para/>
/// @lucene.experimental
/// </summary>
public class TermStatistics
{
private readonly BytesRef term;
private readonly long docFreq;
private readonly long totalTermFreq;
/// <summary>
/// Sole constructor.
/// </summary>
public TermStatistics(BytesRef term, long docFreq, long totalTermFreq)
{
Debug.Assert(docFreq >= 0);
Debug.Assert(totalTermFreq == -1 || totalTermFreq >= docFreq); // #positions must be >= #postings
this.term = term;
this.docFreq = docFreq;
this.totalTermFreq = totalTermFreq;
}
/// <summary>
/// Returns the term text </summary>
public BytesRef Term
{
get { return term; }
}
/// <summary>
/// Returns the number of documents this term occurs in </summary>
/// <seealso cref="Index.TermsEnum.DocFreq"/>
public long DocFreq
{
get { return docFreq; }
}
/// <summary>
/// Returns the total number of occurrences of this term </summary>
/// <seealso cref="Index.TermsEnum.TotalTermFreq"/>
public long TotalTermFreq
{
get { return totalTermFreq; }
}
}
}