de.javagl.nd.arrays.j.LongArrayND Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nd-arrays Show documentation
The newest version!
/*
 * www.javagl.de - ND - Multidimensional primitive data structures
 *
 * Copyright (c) 2013-2015 Marco Hutter - http://www.javagl.de
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
package de.javagl.nd.arrays.j;

import java.util.stream.LongStream;

import de.javagl.nd.arrays.ArrayND;
import de.javagl.nd.tuples.i.IntTuple;

/**
 * Interface for multidimensional arrays of long values.
 */
public interface LongArrayND
    extends ArrayND
{
    /**
     * Returns the value at the given position.

     * 

     * This method may throw an IndexOutOfBoundsException if the indices
     * are not within the {@link #getSize() size} of this array, but
     * explicit bounds checking along each dimension is not guaranteed.
     *
     * @param indices The indices describing the position
     * @return The value at the given position.
     * @throws NullPointerException if the given indices are null
     * @throws IllegalArgumentException If the given indices do not have 
     * the same {@link IntTuple#getSize() size} as the {@link #getSize()
     * size} of this array. 
     * @throws IndexOutOfBoundsException May be thrown if the indices are
     * not valid. That is, if fromIndex < 0 or
     * toIndex > size or fromIndex > toIndex
     * for any dimension. But explicit bounds checking is not guaranteed.
     */
    long get(IntTuple indices);

    @Override
    default LongArrayND subArray(
        IntTuple fromIndices, IntTuple toIndices)
    {
        return LongArraysND.createSubArray(this, fromIndices, toIndices);
    }

    /**
     * Returns a sequential {@code LongStream} with this array as its source.
     * 
     * @return The stream
     */
    default LongStream stream()
    {
        return coordinates().mapToLong(t -> get(t));
    }

}