All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.lucene.util.packed.XAppendingPackedLongBuffer Maven / Gradle / Ivy

There is a newer version: 8.15.1
Show newest version
package org.apache.lucene.util.packed;

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


import org.apache.lucene.util.Version;
import org.elasticsearch.common.lucene.Lucene;

/**
 * Utility class to buffer a list of signed longs in memory. This class only
 * supports appending and is optimized for non-negative numbers with a uniform distribution over a fixed (limited) range
 *
 * @lucene.internal
 */
public final class XAppendingPackedLongBuffer extends XAbstractAppendingLongBuffer {

    static {
        // LUCENE MONITOR: this should be in Lucene 4.5.
        assert Lucene.VERSION == Version.LUCENE_44 : "Elasticsearch has upgraded to Lucene Version: [" + Lucene.VERSION + "] this class should be removed";
    }


    /**
     * {@link XAppendingPackedLongBuffer}
     *
     * @param initialPageCount        the initial number of pages
     * @param pageSize                the size of a single page
     * @param acceptableOverheadRatio an acceptable overhead ratio per value
     */
    public XAppendingPackedLongBuffer(int initialPageCount, int pageSize, float acceptableOverheadRatio) {
        super(initialPageCount, pageSize, acceptableOverheadRatio);
    }

    /**
     * Create an {@link XAppendingPackedLongBuffer} with initialPageCount=16,
     * pageSize=1024 and acceptableOverheadRatio={@link PackedInts#DEFAULT}
     */
    public XAppendingPackedLongBuffer() {
        this(16, 1024, PackedInts.DEFAULT);
    }

    /**
     * Create an {@link XAppendingPackedLongBuffer} with initialPageCount=16,
     * pageSize=1024
     */
    public XAppendingPackedLongBuffer(float acceptableOverheadRatio) {
        this(16, 1024, acceptableOverheadRatio);
    }

    @Override
    long get(int block, int element) {
        if (block == valuesOff) {
            return pending[element];
        } else {
            return values[block].get(element);
        }
    }

    @Override
    int get(int block, int element, long[] arr, int off, int len) {
        if (block == valuesOff) {
            int sysCopyToRead = Math.min(len, pendingOff - element);
            System.arraycopy(pending, element, arr, off, sysCopyToRead);
            return sysCopyToRead;
        } else {
      /* packed block */
            return values[block].get(element, arr, off, len);
        }
    }

    @Override
    void packPendingValues() {
        // compute max delta
        long minValue = pending[0];
        long maxValue = pending[0];
        for (int i = 1; i < pendingOff; ++i) {
            minValue = Math.min(minValue, pending[i]);
            maxValue = Math.max(maxValue, pending[i]);
        }


        // build a new packed reader
        final int bitsRequired = minValue < 0 ? 64 : PackedInts.bitsRequired(maxValue);
        final PackedInts.Mutable mutable = PackedInts.getMutable(pendingOff, bitsRequired, acceptableOverheadRatio);
        for (int i = 0; i < pendingOff; ) {
            i += mutable.set(i, pending, i, pendingOff - i);
        }
        values[valuesOff] = mutable;

    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy