beagled/Lucene.Net/Search/ScoreDoc.cs

   1 /*
   2  * Copyright 2004 The Apache Software Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18
  19 namespace Lucene.Net.Search
  20 {
  21
  22         /// <summary>Expert: Returned by low-level search implementations.</summary>
  23         /// <seealso cref="TopDocs">
  24         /// </seealso>
  25         [Serializable]
  26         public class ScoreDoc
  27         {
  28                 /// <summary>Expert: The score of this document for the query. </summary>
  29                 public float score;
  30
  31                 /// <summary>Expert: A hit document's number.</summary>
  32                 /// <seealso cref="Searcher.Doc(int)">
  33                 /// </seealso>
  34                 public int doc;
  35
  36                 /// <summary>Expert: Constructs a ScoreDoc. </summary>
  37                 public ScoreDoc(int doc, float score)
  38                 {
  39                         this.doc = doc;
  40                         this.score = score;
  41                 }
  42         }
  43 }