net.algart.arrays.PNumberArray Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of algart Show documentation
Open-source Java libraries, supporting generalized smart arrays and matrices with elements of any types, including a wide set of 2D-, 3D- and multidimensional image processing and other algorithms, working with arrays and matrices.
The newest version!
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2007-2024 Daniel Alievsky, AlgART Laboratory (http://algart.net)
 *
 * 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 net.algart.arrays;

import java.util.Objects;

/**
 * AlgART array of any primitive numeric elements (byte, short, int, long, float or double),
 * read-only access.
 *
 * Any class implementing this interface must implement one of
 * {@link ByteArray}, {@link ShortArray},
 * {@link IntArray}, {@link LongArray},
 * {@link FloatArray}, {@link DoubleArray} subinterfaces.
 *
 * @author Daniel Alievsky
 */
public interface PNumberArray extends PArray {
    Class type();

    Class updatableType();

    Class mutableType();

    default Matrix matrix(long... dim) {
        return Matrices.matrix(this, dim);
    }

    /**
     * Equivalent to (UpdatablePNumberArray) {@link MemoryModel#newUnresizableArray(Class, long)
     * memoryModel.newUnresizableArray(elementType, length)}, but with throwing
     * IllegalArgumentException in a case when the type casting to {@link UpdatablePNumberArray}
     * is impossible (non-primitive element type, boolean or char).
     *
     * @param memoryModel the memory model, used for allocation new array.
     * @param elementType the type of array elements.
     * @param length      the length and capacity of the array.
     * @return created unresizable AlgART array.
     * @throws NullPointerException            if one of the arguments is {@code null}.
     * @throws IllegalArgumentException        if elementType is not  byte.class,
     *                                         short.class, int.class,
     *                                         long.class,
     *                                         float.class or double.class,
     *                                         or if the specified length is negative.
     * @throws UnsupportedElementTypeException if elementType is not supported by this memory model.
     * @throws TooLargeArrayException          if the specified length is too large for this memory model.
     */
    static UpdatablePNumberArray newArray(MemoryModel memoryModel, Class elementType, long length) {
        Objects.requireNonNull(memoryModel, "Null memory model");
        Objects.requireNonNull(elementType, "Null element type");
        if (!Arrays.isNumberElementType(elementType)) {
            throw new IllegalArgumentException("Not a numeric primitive type: " + elementType);
        }
        return (UpdatablePNumberArray) memoryModel.newUnresizableArray(elementType, length);
    }

    /**
     * Equivalent to {@link #newArray(MemoryModel, Class, long)
     * newArray}({@link Arrays#SMM Arrays.SMM}, elementType, length).
     *
     * @param elementType the type of array elements.
     * @param length      the length and capacity of the array.
     * @return created unresizable AlgART array.
     * @throws NullPointerException     if one of the arguments is {@code null}.
     * @throws IllegalArgumentException if elementType is not  byte.class,
     *                                  short.class, int.class,
     *                                  long.class,
     *                                  float.class or double.class,
     *                                  or if the specified length is negative.
     * @throws TooLargeArrayException   if the specified length is too large for {@link SimpleMemoryModel}.
     */
    static UpdatablePNumberArray newArray(Class elementType, long length) {
        return newArray(Arrays.SMM, elementType, length);
    }

    /**
     * Equivalent to {@link SimpleMemoryModel#asUpdatablePNumberArray(Object)
     * SimpleMemoryModel.asUpdatablePNumberArray}(array).
     *
     * @param array the source Java array.
     * @return an unresizable AlgART array backed by the specified Java array.
     * @throws NullPointerException     if array argument is {@code null}.
     * @throws IllegalArgumentException if array argument is not an array,
     *                                  or boolean[] array,
     *                                  or char[] array, or Objects[] array.
     */
    static UpdatablePNumberArray as(Object array) {
        return SimpleMemoryModel.asUpdatablePNumberArray(array);
    }
}