Weight.cs
上传用户:zhangkuixh
上传日期:2013-09-30
资源大小:5473k
文件大小:2k
源码类别:

搜索引擎

开发平台:

C#

  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. using System;
  17. using IndexReader = Lucene.Net.Index.IndexReader;
  18. namespace Lucene.Net.Search
  19. {
  20. /// <summary>Expert: Calculate query weights and build query scorers.
  21. /// <p>
  22. /// The purpose of Weight is to make it so that searching does not modify
  23. /// a Query, so that a Query instance can be reused. <br>
  24. /// Searcher dependent state of the query should reside in the Weight. <br>
  25. /// IndexReader dependent state should reside in the Scorer.
  26. /// <p>
  27. /// A <code>Weight</code> is used in the following way:
  28. /// <ol>
  29. /// <li>A <code>Weight</code> is constructed by a top-level query,
  30. /// given a <code>Searcher</code> ({@link Query#CreateWeight(Searcher)}).
  31. /// <li>The {@link #SumOfSquaredWeights()} method is called
  32. /// on the <code>Weight</code> to compute
  33. /// the query normalization factor {@link Similarity#QueryNorm(float)}
  34. /// of the query clauses contained in the query.
  35. /// <li>The query normalization factor is passed to {@link #Normalize(float)}.
  36. /// At this point the weighting is complete.
  37. /// <li>A <code>Scorer</code> is constructed by {@link #Scorer(IndexReader)}.
  38. /// </ol>
  39. /// </summary>
  40. public interface Weight
  41. {
  42. /// <summary>The query that this concerns. </summary>
  43. Query GetQuery();
  44. /// <summary>The weight for this query. </summary>
  45. float GetValue();
  46. /// <summary>The sum of squared weights of contained query clauses. </summary>
  47. float SumOfSquaredWeights();
  48. /// <summary>Assigns the query normalization factor to this. </summary>
  49. void  Normalize(float norm);
  50. /// <summary>Constructs a scorer for this. </summary>
  51. Scorer Scorer(IndexReader reader);
  52. /// <summary>An explanation of the score computation for the named document. </summary>
  53. Explanation Explain(IndexReader reader, int doc);
  54. }
  55. }