net.algart.arrays.MutableByteArray 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.

There is a newer version: 1.4.23

Show 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;

/*Repeat(INCLUDE_FROM_FILE, MutableFloatArray.java, all)
  PFloating ==> PInteger ;;
  Float(?!ing) ==> Byte ;;
  float ==> byte
     !! Auto-generated: NOT EDIT !! */

import java.util.Objects;

/**
 * Resizable AlgART array of byte values.
 *
 * @author Daniel Alievsky
 */
public interface MutableByteArray extends ByteStack, UpdatableByteArray, MutablePIntegerArray {
    MutableByteArray setData(long arrayPos, Object srcArray, int srcArrayOffset, int count);

    MutableByteArray setData(long arrayPos, Object srcArray);

    MutableByteArray copy(Array src);

    MutableByteArray swap(UpdatableArray another);

    MutableByteArray length(long newLength);

    MutableByteArray ensureCapacity(long minCapacity);

    MutableByteArray trim();

    MutableByteArray append(Array appendedArray);

    MutableByteArray asCopyOnNextWrite();

    MutableByteArray shallowClone();
    /**
     * Equivalent to {@link MemoryModel#newEmptyByteArray()
     * memoryModel.newEmptyByteArray()}.
     *
     * @param memoryModel the memory model, used for allocation new array.
     * @return created empty AlgART array.
     * @throws NullPointerException            if memoryModel argument is {@code null}.
     * @throws UnsupportedElementTypeException if byte element type
     *                                         is not supported by this memory model.
     */
    static MutableByteArray newArray(MemoryModel memoryModel) {
        Objects.requireNonNull(memoryModel, "Null memory model");
        return memoryModel.newEmptyByteArray();
    }

    /**
     * Equivalent to {@link Arrays#SMM Arrays.SMM}.{@link MemoryModel#newEmptyByteArray()
     * newEmptyByteArray()}.
     *
     * @return created empty AlgART array.
     */
    static MutableByteArray newArray() {
        return Arrays.SMM.newEmptyByteArray();
    }
    /*Repeat.IncludeEnd*/
}