org.dayflower.pathtracer.util

Class Arrays2

java.lang.Object

org.dayflower.pathtracer.util.Arrays2

public final class Arrays2
extends java.lang.Object

A class that consists exclusively of static methods that operates on or returns arrays of various types.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
static float[]	readFloatArray(java.io.DataInputStream dataInputStream) Reads float values from dataInputStream and adds them to a float[].
static float[]	readFloatArray(java.io.DataInputStream dataInputStream, float[] array) Reads float values from dataInputStream and adds them to array.
static int[]	readIntArray(java.io.DataInputStream dataInputStream) Reads int values from dataInputStream and adds them to an int[].
static <T> float[]	toFloatArray(java.util.List<T> list, java.util.function.Function<T,float[]> function) Returns a larger float[] by merging smaller float[] together.
static <T> float[]	toFloatArray(java.util.List<T> list, java.util.function.Function<T,float[]> function, int minimumLength) Returns a larger float[] by merging smaller float[] together.
static <T> int[]	toIntArray(java.util.List<T> list, java.util.function.Function<T,int[]> function) Returns a larger int[] by merging smaller int[] together.
static <T> int[]	toIntArray(java.util.List<T> list, java.util.function.Function<T,int[]> function, int minimumLength) Returns a larger int[] by merging smaller int[] together.
static void	writeFloatArray(java.io.DataOutputStream dataOutputStream, float[] array) Writes the float values of array into dataOutputStream.
static void	writeIntArray(java.io.DataOutputStream dataOutputStream, int[] array) Writes the int values of array into dataOutputStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

readFloatArray

public static float[] readFloatArray(java.io.DataInputStream dataInputStream)
                              throws java.io.IOException

Reads float values from dataInputStream and adds them to a float[].

Returns the float[].

If dataInputStream is null, a NullPointerException will be thrown.

If an I/O error occurs, an IOException will be thrown.

Parameters:

dataInputStream - the DataInputStream to read from

Returns:

the float[]

Throws:

java.io.IOException - thrown if, and only if, an I/O error occurs

java.lang.NullPointerException - thrown if, and only if, dataInputStream is null

readFloatArray

public static float[] readFloatArray(java.io.DataInputStream dataInputStream,
                                     float[] array)
                              throws java.io.IOException

Reads float values from dataInputStream and adds them to array.

Returns array.

If dataInputStream is null, a NullPointerException will be thrown.

If an I/O error occurs, an IOException will be thrown.

If array.length is less than the length read from dataInputStream, an ArrayIndexOutOfBoundsException will be thrown.

Parameters:

dataInputStream - the DataInputStream to read from

array - the float array to write to and return

Returns:

array

Throws:

java.lang.ArrayIndexOutOfBoundsException - thrown if, and only if, array.length is less than the length read from dataInputStream

java.io.IOException - thrown if, and only if, an I/O error occurs

java.lang.NullPointerException - thrown if, and only if, dataInputStream is null

toFloatArray

public static <T> float[] toFloatArray(java.util.List<T> list,
                                       java.util.function.Function<T,float[]> function)

Returns a larger float[] by merging smaller float[] together.

Calling this method is equivalent to toFloatArray(list, function, 0).

If either list or function are null, or function returns null, a NullPointerException will be thrown.

If an element in list is null, a NullPointerException might be thrown. But no guarantees can be made. This is up to function.

Type Parameters:

T - the generic type to use

Parameters:

list - a List

function - a Function mapping Lists elements to float[]

Returns:

a larger float[] by merging smaller float[] together

Throws:

java.lang.NullPointerException - thrown if, and only if, either list or function are null, or function returns null

toFloatArray

public static <T> float[] toFloatArray(java.util.List<T> list,
                                       java.util.function.Function<T,float[]> function,
                                       int minimumLength)

Returns a larger float[] by merging smaller float[] together.

If either list or function are null, or function returns null, a NullPointerException will be thrown.

If an element in list is null, a NullPointerException might be thrown. But no guarantees can be made. This is up to function.

If the length of the larger float[] is less than minimumLength, a new empty float[] with minimumLength as length will be returned.

Type Parameters:

T - the generic type to use

Parameters:

list - a List

function - a Function mapping Lists elements to float[]

minimumLength - the minimum length of the float[] to return

Returns:

a larger float[] by merging smaller float[] together

Throws:

java.lang.NullPointerException - thrown if, and only if, either list or function are null, or function returns null

readIntArray

public static int[] readIntArray(java.io.DataInputStream dataInputStream)
                          throws java.io.IOException

Reads int values from dataInputStream and adds them to an int[].

Returns the int[].

If dataInputStream is null, a NullPointerException will be thrown.

If an I/O error occurs, an IOException will be thrown.

Parameters:

dataInputStream - the DataInputStream to read from

Returns:

the int[]

Throws:

java.io.IOException - thrown if, and only if, an I/O error occurs

java.lang.NullPointerException - thrown if, and only if, dataInputStream is null

toIntArray

public static <T> int[] toIntArray(java.util.List<T> list,
                                   java.util.function.Function<T,int[]> function)

Returns a larger int[] by merging smaller int[] together.

Calling this method is equivalent to toIntArray(list, function, 0).

If either list or function are null, or function returns null, a NullPointerException will be thrown.

If an element in list is null, a NullPointerException might be thrown. But no guarantees can be made. This is up to function.

Type Parameters:

T - the generic type to use

Parameters:

list - a List

function - a Function mapping Lists elements to int[]

Returns:

a larger int[] by merging smaller int[] together

Throws:

java.lang.NullPointerException - thrown if, and only if, either list or function are null, or function returns null

toIntArray

public static <T> int[] toIntArray(java.util.List<T> list,
                                   java.util.function.Function<T,int[]> function,
                                   int minimumLength)

Returns a larger int[] by merging smaller int[] together.

If either list or function are null, or function returns null, a NullPointerException will be thrown.

If an element in list is null, a NullPointerException might be thrown. But no guarantees can be made. This is up to function.

If the length of the larger int[] is less than minimumLength, a new empty int[] with minimumLength as length will be returned.

Type Parameters:

T - the generic type to use

Parameters:

list - a List

function - a Function mapping Lists elements to int[]

minimumLength - the minimum length of the int[] to return

Returns:

a larger int[] by merging smaller int[] together

Throws:

java.lang.NullPointerException - thrown if, and only if, either list or function are null, or function returns null

writeFloatArray

public static void writeFloatArray(java.io.DataOutputStream dataOutputStream,
                                   float[] array)
                            throws java.io.IOException

Writes the float values of array into dataOutputStream.

If either dataOutputStream or array are null, a NullPointerException will be thrown.

If an I/O error occurs, an IOException will be thrown.

Parameters:

dataOutputStream - the DataOutputStream to write to

array - the float[] with the float values to write to dataOutputStream

Throws:

java.io.IOException - thrown if, and only if, an I/O error occurs

java.lang.NullPointerException - thrown if, and only if, either dataOutputStream or array are null

writeIntArray

public static void writeIntArray(java.io.DataOutputStream dataOutputStream,
                                 int[] array)
                          throws java.io.IOException

Writes the int values of array into dataOutputStream.

If either dataOutputStream or array are null, a NullPointerException will be thrown.

If an I/O error occurs, an IOException will be thrown.

Parameters:

dataOutputStream - the DataOutputStream to write to

array - the int[] with the int values to write to dataOutputStream

Throws:

java.io.IOException - thrown if, and only if, an I/O error occurs

java.lang.NullPointerException - thrown if, and only if, either dataOutputStream or array are null