de.javagl.nd.arrays.i.IntArraysND Maven / Gradle / Ivy
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.i;
import java.util.Objects;
import java.util.function.ToIntFunction;
import java.util.stream.Stream;
import de.javagl.nd.arrays.Coordinates;
import de.javagl.nd.arrays.Utils;
import de.javagl.nd.tuples.i.IntTuple;
import de.javagl.nd.tuples.i.MutableIntTuple;
import de.javagl.nd.tuples.i.IntTuple;
import de.javagl.nd.tuples.i.IntTupleFunctions;
import de.javagl.nd.tuples.i.IntTuples;
import de.javagl.nd.tuples.i.MutableIntTuple;
import de.javagl.nd.iteration.tuples.i.IntTupleIterables;
/**
* Methods related to {@link IntArrayND} instances
*/
public class IntArraysND
{
/**
* Creates a new {@link MutableIntArrayND} with the specified size
*
* @param size The size
* @return The new array
* @throws NullPointerException If the given size is null
* @throws IllegalArgumentException If the given size is negative
* along any dimension
*/
public static MutableIntArrayND create(IntTuple size)
{
return new DefaultIntArrayND(size);
}
/**
* Creates a new {@link MutableIntArrayND} with the specified size
*
* @param size The size
* @return The new array
* @throws NullPointerException If the given size is null
* @throws IllegalArgumentException If the given size is negative
* along any dimension
*/
public static MutableIntArrayND create(int ... size)
{
return create(IntTuples.wrap(size));
}
/**
* Creates a view on the given array as a
* {@link MutableIntArrayND}. Changes in the given array
* will be visible in the returned array, and vice versa.
*
* The given array is assumed to be rectangular (and to not contain
* null elements).
*
* @param array The backing array
* @return The view on the array
* @throws NullPointerException If the given array is null
*/
public static MutableIntArrayND wrap(int array[][])
{
return new ArrayIntArray2D(array);
}
/**
* Creates a view on the given tuple as a {@link IntArrayND}.
* Changes in the given tuple will be visible in the returned array.
*
* @param t The tuple
* @param size The size of the array
* @return The view on the tuple
* @throws NullPointerException If any argument is null
* @throws IllegalArgumentException If the
* {@link IntTuple#getSize() size} of the tuple does not match the
* given array size (that is, the product of all elements of the given
* tuple).
*/
public static IntArrayND wrap(IntTuple t, IntTuple size)
{
Objects.requireNonNull(t, "The tuple is null");
Objects.requireNonNull(size, "The size is null");
int totalSize = IntTupleFunctions.reduce(size, 1, (a, b) -> a * b);
if (t.getSize() != totalSize)
{
throw new IllegalArgumentException(
"The tuple has a size of " + t.getSize() + ", the expected " +
"array size is " + size + " (total: " + totalSize + ")");
}
return new TupleIntArrayND(t, size);
}
/**
* Creates a view on the given tuple as a {@link IntArrayND}.
* Changes in the given tuple will be visible in the returned array,
* and vice versa.
*
* @param t The tuple
* @param size The size of the array
* @return The view on the tuple
* @throws NullPointerException If any argument is null
* @throws IllegalArgumentException If the
* {@link IntTuple#getSize() size} of the tuple does not match the
* given array size (that is, the product of all elements of the given
* tuple).
*/
public static MutableIntArrayND wrap(
MutableIntTuple t, IntTuple size)
{
Objects.requireNonNull(t, "The tuple is null");
Objects.requireNonNull(size, "The size is null");
int totalSize = IntTupleFunctions.reduce(size, 1, (a, b) -> a * b);
if (t.getSize() != totalSize)
{
throw new IllegalArgumentException(
"The tuple has a size of " + t.getSize() + ", the expected " +
"array size is " + size + " (total: " + totalSize + ")");
}
return new MutableTupleIntArrayND(t, size);
}
/**
* Returns a view on the given {@link IntArrayND} as a function
* that maps coordinates to array entry values. This function may
* throw an IndexOutOfBoundsException when the given 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.
*
* @param array The array
* @return The function
* @throws NullPointerException If the given array is null
*/
public static ToIntFunction asFunction(
final IntArrayND array)
{
Objects.requireNonNull(array, "The array is null");
return new ToIntFunction()
{
@Override
public int applyAsInt(IntTuple s)
{
return array.get(s);
}
};
}
/**
* Creates a new array that is a view on the specified portion
* of the given parent. Changes in the parent will be visible in the
* returned array.
*
* @param parent The parent array
* @param fromIndices The start indices in the parent, inclusive
* @param toIndices The end indices in the parent, exclusive
* @throws NullPointerException If any argument is null
* @throws IllegalArgumentException If the indices are not valid. This
* is the case when the {@link IntTuple#getSize() size} of the start- or
* end indices is different than the parent size, or when
* fromIndex < 0 or
* toIndex > parentSize(i)
* or fromIndex > toIndex for any dimension.
* @return The new array
*/
public static IntArrayND createSubArray(
IntArrayND parent, IntTuple fromIndices, IntTuple toIndices)
{
return new SubIntArrayND(
parent, fromIndices, toIndices);
}
/**
* Creates a new array that is a view on the specified portion
* of the given parent. Changes in the parent will be visible in the
* returned array, and vice versa. The returned array will use
* lexicographical iteration order.
*
* @param parent The parent array
* @param fromIndices The start indices in the parent, inclusive
* @param toIndices The end indices in the parent, exclusive
* @throws NullPointerException If the given parent or any of the
* given tuples is null
* @throws IllegalArgumentException If the indices are not valid. This
* is the case when the {@link IntTuple#getSize() size} of the start- or
* end indices is different than the parent size, or when
* fromIndex < 0 or
* toIndex > parentSize(i)
* or fromIndex > toIndex for any dimension.
* @return The new array
*/
public static MutableIntArrayND createSubArray(
MutableIntArrayND parent, IntTuple fromIndices, IntTuple toIndices)
{
return new MutableSubIntArrayND(
parent, fromIndices, toIndices);
}
/**
* Returns the minimum value in the given array, or
* Integer.MAX_VALUE if the given array
* has a size of 0.
*
* @param array The array
* @return The minimum value
*/
public static int min(IntArrayND array)
{
return array.stream().parallel().reduce(
Integer.MAX_VALUE, Math::min);
}
/**
* Returns the maximum value in the given array, or
* Integer.MIN_VALUE if the given array
* has a size of 0.
*
* @param array The array
* @return The maximum value
*/
public static int max(IntArrayND array)
{
return array.stream().parallel().reduce(
Integer.MIN_VALUE, Math::max);
}
/**
* Returns a default string representation of the given array.
* Since arrays tend to be large (and multidimensional), this
* string will not contain the contents of
* the array, but only its size.
*
* @param array The array
* @return The string
*/
static String toString(IntArrayND array)
{
if (array == null)
{
return "null";
}
return array.getClass().getSimpleName() +
"[size=" + array.getSize() + "]";
}
/**
* Computes the hash code of the given array. This method will
* return a hash code that solely depends on the contents of
* the given array, regardless of its preferred iteration order.
*
* @param array The array
* @return The hash code
*/
static int hashCode(IntArrayND array)
{
if (array == null)
{
return 0;
}
return array.stream().parallel().sum();
}
/**
* Returns whether the given {@link IntArrayND} equals the
* given object
*
* @param array The array
* @param object The object
* @return Whether the array equals the object
*/
static boolean equals(IntArrayND array, Object object)
{
if (array == object)
{
return true;
}
if (object == null)
{
return false;
}
if (!(object instanceof IntArrayND))
{
return false;
}
IntArrayND other = (IntArrayND) object;
if (!array.getSize().equals(other.getSize()))
{
return false;
}
Stream coordinates =
Coordinates.coordinates(
array.getPreferredIterationOrder(), array.getSize());
Iterable iterable = () -> coordinates.iterator();
for (IntTuple coordinate : iterable)
{
int arrayValue = array.get(coordinate);
int otherValue = other.get(coordinate);
if (arrayValue != otherValue)
{
return false;
}
}
return true;
}
/**
* Creates a formatted representation of the given array. After each
* dimension, a newline character will be inserted.
*
* @param array The array
* @return The hash code
*/
public static String toFormattedString(IntArrayND array)
{
return toFormattedString(array, "%f");
}
/**
* Creates a formatted representation of the given array. After each
* dimension, a newline character will be inserted.
*
* @param array The array
* @param format The format for the array entries
* @return The hash code
*/
public static String toFormattedString(IntArrayND array, String format)
{
if (array == null)
{
return "null";
}
StringBuilder sb = new StringBuilder();
Iterable iterable =
IntTupleIterables.lexicographicalIterable(array.getSize());
IntTuple previous = null;
for (IntTuple coordinates : iterable)
{
if (previous != null)
{
int c = Utils.countDifferences(previous, coordinates);
for (int i=0; i © 2015 - 2025 Weber Informatics LLC | Privacy Policy