org.elasticsearch.tdigest.arrays.TDigestDoubleArray Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-tdigest Show documentation

Elasticsearch subproject :libs:elasticsearch-tdigest

The newest version!

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. 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.
 *
 * This project is based on a modification of https://github.com/tdunning/t-digest which is licensed under the Apache 2.0 License.
 */

package org.elasticsearch.tdigest.arrays;

import org.apache.lucene.util.Accountable;
import org.elasticsearch.core.Releasable;

/**
 * Minimal interface for DoubleArray-like classes used within TDigest.
 */
public interface TDigestDoubleArray extends Releasable, Accountable {
    int size();

    double get(int index);

    void set(int index, double value);

    void add(double value);

    void ensureCapacity(int requiredCapacity);

    /**
     * Resizes the array. If the new size is bigger than the current size, the new elements are set to 0.
     */
    void resize(int newSize);

    /**
     * Copies {@code len} elements from {@code buf} to this array.
     */
    default void set(int index, TDigestDoubleArray buf, int offset, int len) {
        assert index >= 0 && index + len <= this.size();
        assert buf != this : "This method doesn't ensure that the copy from itself will be correct";
        for (int i = len - 1; i >= 0; i--) {
            this.set(index + i, buf.get(offset + i));
        }
    }

    /**
     * Sorts the array in place in ascending order.
     */
    void sort();
}