net.algart.arrays.ArrayComparator32 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of algart Show documentation
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 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 ArrayComparator} for a case of 32-bit indexes (int instead of long).
*
* @author Daniel Alievsky
*/
@FunctionalInterface
public interface ArrayComparator32 extends ArrayComparator {
/**
* This method, implemented in this interface, just calls another less method
* with int indexes:
*
* {@link #less(int, int) less}((int) first, (int) second);
*
* Note: for maximal performance, it does not check that the passed indexes are really 32-bit.
* While using with arrays, containing 231 elements or more, this comparator will work incorrectly.
*
* @param first index of the first compared element.
* @param second index of the second compared element.
* @return true if, and only if, the element #first is "less"
* than the element #second.
*/
default boolean less(long first, long second) {
return less((int) first, (int) second);
}
/**
* Should return true if, and only if, the element at position first
* in the sorted array is "less" than the element at position second.
* ("Less" element will have less index in the sorted array.)
* The result of this comparison must be fully defined by the values of the elements
* of the sorted array.
*
* @param first index of the first compared element.
* @param second index of the second compared element.
* @return true if, and only if, the element #first is "less"
* than the element #second.
*/
boolean less(int first, int second);
}