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

Go to download
/*
 * 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;

/**
 * Version of {@link ArrayExchanger} for a case of 32-bit indexes (int instead of long).
 *
 * @author Daniel Alievsky
 */
@FunctionalInterface
public interface ArrayExchanger32 extends ArrayExchanger {
    /**
     * This method, implemented in this interface, just calls another
     * swap method with int indexes:
     * 
     *     {@link #swap(int, int) swap}((int) first, (int) second);
     * 
     * Note: for maximal performance, it does not check that the passed intexes are really 32-bit.
     * While using with arrays, containing 2³¹ elements or more, this comparator will work incorrectly.
     *
     * @param first  index of the first exchanged element.
     * @param second index of the second exchanged element.
     */
    default void swap(long first, long second) {
        swap((int) first, (int) second);
    }

    /**
     * Should exchange the elements at position first and second in the data array.
     *
     * @param first  index of the first exchanged element.
     * @param second index of the second exchanged element.
     */
    void swap(int first, int second);
}