Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class PackedInt32s.Reader

    A read-only random access array of positive integers.

    Note

    This API is for internal purposes only and might change in incompatible ways in the next release.

    Inheritance
    System.Object
    NumericDocValues
    PackedInt32s.Reader
    PackedInt32s.Mutable
    PackedInt32s.NullReader
    Inherited Members
    NumericDocValues.Get(Int32)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Lucene.Net.Util.Packed
    Assembly: Lucene.Net.dll
    Syntax
    public abstract class Reader : NumericDocValues

    Properties

    | Improve this Doc View Source

    BitsPerValue

    Declaration
    public abstract int BitsPerValue { get; }
    Property Value
    Type Description
    System.Int32

    The number of bits used to store any given value. Note: this does not imply that memory usage is bitsPerValue * #values as implementations are free to use non-space-optimal packing of bits.

    | Improve this Doc View Source

    Count

    The number of values.

    NOTE: This was size() in Lucene.

    Declaration
    public abstract int Count { get; }
    Property Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    HasArray

    Returns true if this implementation is backed by a native .NET array.

    Declaration
    public virtual bool HasArray { get; }
    Property Value
    Type Description
    System.Boolean
    See Also
    GetArray()

    Methods

    | Improve this Doc View Source

    Get(Int32, Int64[], Int32, Int32)

    Bulk get: read at least one and at most len longs starting from index into arr[off:off+len] and return the actual number of values that have been read.

    Declaration
    public virtual int Get(int index, long[] arr, int off, int len)
    Parameters
    Type Name Description
    System.Int32 index
    System.Int64[] arr
    System.Int32 off
    System.Int32 len
    Returns
    Type Description
    System.Int32
    | Improve this Doc View Source

    GetArray()

    Expert: if the bit-width of this reader matches one of .NET's native types, returns the underlying array (ie, byte[], short[], int[], long[]); else, returns null. Note that when accessing the array you must upgrade the type (bitwise AND with all ones), to interpret the full value as unsigned. Ie, bytes[idx]&0xFF, shorts[idx]&0xFFFF, etc.

    Declaration
    public virtual object GetArray()
    Returns
    Type Description
    System.Object
    | Improve this Doc View Source

    RamBytesUsed()

    Return the in-memory size in bytes.

    Declaration
    public abstract long RamBytesUsed()
    Returns
    Type Description
    System.Int64
    • Improve this Doc
    • View Source
    Back to top Copyright © 2021 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.