Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class ScoreDoc

    Holds one hit in TopDocs.

    Inheritance
    object
    ScoreDoc
    FieldDoc
    FieldValueHitQueue.Entry
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Search
    Assembly: Lucene.Net.dll
    Syntax
    public class ScoreDoc

    Constructors

    ScoreDoc(int, float)

    Constructs a ScoreDoc.

    Declaration
    public ScoreDoc(int doc, float score)
    Parameters
    Type Name Description
    int doc
    float score

    ScoreDoc(int, float, int)

    Constructs a ScoreDoc.

    Declaration
    public ScoreDoc(int doc, float score, int shardIndex)
    Parameters
    Type Name Description
    int doc
    float score
    int shardIndex

    Properties

    Doc

    A hit document's number.

    Declaration
    public int Doc { get; set; }
    Property Value
    Type Description
    int
    See Also
    Doc(int)

    Score

    The score of this document for the query.

    Declaration
    public float Score { get; set; }
    Property Value
    Type Description
    float

    ShardIndex

    Only set by Merge(Sort?, int, int, TopDocs[])

    Declaration
    public int ShardIndex { get; set; }
    Property Value
    Type Description
    int

    Methods

    ToString()

    A convenience method for debugging.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.