org.elasticsearch.common.util.DoubleArray Maven / Gradle / Ivy

Go to download

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

Elasticsearch - Open Source, Distributed, RESTful Search Engine

There is a newer version: 9.0.0-beta1

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.common.util;

import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.Writeable;

import java.io.IOException;

/**
 * Abstraction of an array of double values.
 */
public interface DoubleArray extends BigArray, Writeable {

    static DoubleArray readFrom(StreamInput in) throws IOException {
        return new ReleasableDoubleArray(in);
    }

    /**
     * Get an element given its index.
     */
    double get(long index);

    /**
     * Set a value at the given index and return the previous value.
     */
    double set(long index, double value);

    /**
     * Increment value at the given index by inc and return the value.
     */
    double increment(long index, double inc);

    /**
     * Fill slots between fromIndex inclusive to toIndex exclusive with value.
     */
    void fill(long fromIndex, long toIndex, double value);

    /**
     * Bulk set.
     */
    void set(long index, byte[] buf, int offset, int len);
}