org.apache.lucene.util.packed

Class GrowableWriter

  • All Implemented Interfaces:
    Accountable


    public class GrowableWriter
    extends PackedInts.Mutable
    Implements PackedInts.Mutable, but grows the bit count of the underlying packed ints on-demand.

    Beware that this class will accept to set negative values but in order to do this, it will grow the number of bits per value to 64.

    @lucene.internal

    • Constructor Summary

      Constructors 
      Constructor and Description
      GrowableWriter(int startBitsPerValue, int valueCount, float acceptableOverheadRatio) 
    • Constructor Detail

      • GrowableWriter

        public GrowableWriter(int startBitsPerValue,
                              int valueCount,
                              float acceptableOverheadRatio)
        Parameters:
        startBitsPerValue - the initial number of bits per value, may grow depending on the data
        valueCount - the number of values
        acceptableOverheadRatio - an acceptable overhead ratio
    • Method Detail

      • get

        public long get(int index)
        Description copied from class: NumericDocValues
        Returns the numeric value for the specified document ID.
        Specified by:
        get in class NumericDocValues
        Parameters:
        index - document ID to lookup
        Returns:
        numeric value
      • getBitsPerValue

        public int getBitsPerValue()
        Specified by:
        getBitsPerValue in class PackedInts.Mutable
        Returns:
        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.
      • set

        public void set(int index,
                        long value)
        Description copied from class: PackedInts.Mutable
        Set the value at the given index in the array.
        Specified by:
        set in class PackedInts.Mutable
        Parameters:
        index - where the value should be positioned.
        value - a value conforming to the constraints set by the array.
      • get

        public int get(int index,
                       long[] arr,
                       int off,
                       int len)
        Description copied from class: PackedInts.Reader
        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.
        Overrides:
        get in class PackedInts.Reader
      • set

        public int set(int index,
                       long[] arr,
                       int off,
                       int len)
        Description copied from class: PackedInts.Mutable
        Bulk set: set at least one and at most len longs starting at off in arr into this mutable, starting at index. Returns the actual number of values that have been set.
        Overrides:
        set in class PackedInts.Mutable
      • fill

        public void fill(int fromIndex,
                         int toIndex,
                         long val)
        Description copied from class: PackedInts.Mutable
        Fill the mutable from fromIndex (inclusive) to toIndex (exclusive) with val.
        Overrides:
        fill in class PackedInts.Mutable
      • ramBytesUsed

        public long ramBytesUsed()
        Description copied from interface: Accountable
        Return the memory usage of this object in bytes. Negative values are illegal.