FloatArrayFunctions (ZenGarden-Core 0.2.13 API)

java.lang.Object
- org.openzen.zengarden.arrays.FloatArrayFunctions

All Implemented Interfaces:: ArrayFunctions<float[]>

public class FloatArrayFunctions
extends java.lang.Object
implements ArrayFunctions<float[]>

float[] implementation of ArrayFunctions.

Field Summary

Fields
Modifier and Type Field and Description

static FloatArrayFunctions INSTANCE

Fields
Modifier and Type	Field and Description
`static FloatArrayFunctions`	`INSTANCE`

Constructor Summary

Constructors
Modifier Constructor and Description

protected FloatArrayFunctions()

Constructors
Modifier	Constructor and Description
`protected`	`FloatArrayFunctions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float[]`	`concat(float[] array1, float[] array2)` Concatenates two arrays into one and returns it.
`void`	`copyArray(float[] from, int fromOffset, float[] to, int toOffset, int length)` Copies part of the first array to the second array.
`float[]`	`copyOfRange(float[] original, int from, int to)` Copies the specified range.
`boolean`	`endsWith(float[] array, float[] subarray)` Checks if `array[length - subarray.length:] == subarray`.
`boolean`	`equals(float[] array1, float[] array2)` Checks if the two arrays have the same content.
`boolean`	`equals(float[] array1, int array1Index, float[] array2, int array2Index)` Checks if `array1[array1Index] == array2[array2Index]`.
`int`	`getCommonPrefixLength(float[] array1, float[] array2)` Determines the longest common prefix, that is, the number of items at the start of the arrays that are equal.
`int`	`getCommonSuffixLength(float[] array1, float[] array2)` Determines the longest common suffix, that is, the number of items at the end of the arrays that are equal.
`int`	`getLength(float[] value)` Gets the length of the given array.
`float[]`	`newArray(int length)` Constructs a new array of the given length.
`float[]`	`read(BytesDataInput input)` Reads an array from the given input stream.
`float[]`	`read(DataInput input)` Reads an array from the given input stream.
`float[]`	`readRaw(BytesDataInput input, int length)` Reads an array from the given input stream.
`float[]`	`readRaw(DataInput input, int length)` Reads an array from the given input stream.
`boolean`	`startsWith(float[] array, float[] subarray)` Checks if `array[:subarray.length] == subarray`.
`void`	`write(BytesDataOutput output, float[] value)` Writes the contents of the given array to the output stream.
`void`	`write(DataOutput output, float[] value)` Writes the contents of the given array to the output stream.
`void`	`writeRaw(BytesDataOutput output, float[] value)` Writes the contents of the given array to the output stream.
`void`	`writeRaw(DataOutput output, float[] value)` Writes the contents of the given array to the output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final FloatArrayFunctions INSTANCE
```
- Constructor Detail
  - FloatArrayFunctions
```
protected FloatArrayFunctions()
```
- Method Detail
  - newArray
```
public float[] newArray(int length)
```
    Description copied from interface: ArrayFunctions
    
    Constructs a new array of the given length.
    
    Specified by:
    
    newArray in interface ArrayFunctions<float[]>
    
    Parameters:
    
    length - array length
    
    Returns:
    
    newly created array
  - getLength
```
public int getLength(float[] value)
```
    Description copied from interface: ArrayFunctions
    
    Gets the length of the given array.
    
    Specified by:
    
    getLength in interface ArrayFunctions<float[]>
    
    Parameters:
    
    value - array value
    
    Returns:
    
    array length
  - equals
```
public boolean equals(float[] array1,
                      float[] array2)
```
    Description copied from interface: ArrayFunctions
    
    Checks if the two arrays have the same content.
    
    Specified by:
    
    equals in interface ArrayFunctions<float[]>
    
    Parameters:
    
    array1 - first array
    
    array2 - second array
    
    Returns:
    
    true if the arrays are equivalent, false otherwise
  - concat
```
public float[] concat(float[] array1,
                      float[] array2)
```
    Description copied from interface: ArrayFunctions
    
    Concatenates two arrays into one and returns it.
    
    Specified by:
    
    concat in interface ArrayFunctions<float[]>
    
    Parameters:
    
    array1 - first array
    
    array2 - second array
    
    Returns:
    
    concatenated array
  - startsWith
```
public boolean startsWith(float[] array,
                          float[] subarray)
```
    Description copied from interface: ArrayFunctions
    
    Checks if array[:subarray.length] == subarray.
    
    Specified by:
    
    startsWith in interface ArrayFunctions<float[]>
    
    Parameters:
    
    array - array to check
    
    subarray - array prefix to check for
    
    Returns:
    
    true if the given array starts with the given subarray
  - endsWith
```
public boolean endsWith(float[] array,
                        float[] subarray)
```
    Description copied from interface: ArrayFunctions
    
    Checks if array[length - subarray.length:] == subarray.
    
    Specified by:
    
    endsWith in interface ArrayFunctions<float[]>
    
    Parameters:
    
    array - array to check
    
    subarray - array suffix to check for
    
    Returns:
    
    true if the given array ends with the given subarray
  - getCommonSuffixLength
```
public int getCommonSuffixLength(float[] array1,
                                 float[] array2)
```
    Description copied from interface: ArrayFunctions
    
    Determines the longest common suffix, that is, the number of items at the end of the arrays that are equal.
    
    Specified by:
    
    getCommonSuffixLength in interface ArrayFunctions<float[]>
    
    Parameters:
    
    array1 - first array
    
    array2 - second array
    
    Returns:
    
    longest common suffix length
  - getCommonPrefixLength
```
public int getCommonPrefixLength(float[] array1,
                                 float[] array2)
```
    Description copied from interface: ArrayFunctions
    
    Determines the longest common prefix, that is, the number of items at the start of the arrays that are equal.
    
    Specified by:
    
    getCommonPrefixLength in interface ArrayFunctions<float[]>
    
    Parameters:
    
    array1 - first array
    
    array2 - second array
    
    Returns:
    
    longest common prefix length
  - copyOfRange
```
public float[] copyOfRange(float[] original,
                           int from,
                           int to)
```
    Description copied from interface: ArrayFunctions
    
    Copies the specified range. Copies the range, that is, changing the contents of the result will not change the original array.
    
    Specified by:
    
    copyOfRange in interface ArrayFunctions<float[]>
    
    Parameters:
    
    original - array to copy from
    
    from - range start index
    
    to - range end index
    
    Returns:
    
    array copy
  - copyArray
```
public void copyArray(float[] from,
                      int fromOffset,
                      float[] to,
                      int toOffset,
                      int length)
```
    Description copied from interface: ArrayFunctions
    
    Copies part of the first array to the second array.
    
    Specified by:
    
    copyArray in interface ArrayFunctions<float[]>
    
    Parameters:
    
    from - array to copy from
    
    fromOffset - offset to copy from
    
    to - array to copy tco
    
    toOffset - offset to copy to
    
    length - number of items to copy
  - equals
```
public boolean equals(float[] array1,
                      int array1Index,
                      float[] array2,
                      int array2Index)
```
    Description copied from interface: ArrayFunctions
    
    Checks if array1[array1Index] == array2[array2Index].
    
    Specified by:
    
    equals in interface ArrayFunctions<float[]>
    
    Parameters:
    
    array1 - first array
    
    array1Index - first array index
    
    array2 - second array
    
    array2Index - second array index
    
    Returns:
    
    true if the array contents at the given positions are equal
  - write
```
public void write(DataOutput output,
                  float[] value)
           throws java.io.IOException
```
    Description copied from interface: ArrayFunctions
    
    Writes the contents of the given array to the output stream. Includes the array length.
    
    Specified by:
    
    write in interface ArrayFunctions<float[]>
    
    Parameters:
    
    output - stream to write to
    
    value - array to be written
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - writeRaw
```
public void writeRaw(DataOutput output,
                     float[] value)
              throws java.io.IOException
```
    Description copied from interface: ArrayFunctions
    
    Writes the contents of the given array to the output stream. Excludes the array length.
    
    Specified by:
    
    writeRaw in interface ArrayFunctions<float[]>
    
    Parameters:
    
    output - stream to write to
    
    value - array to be written
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - write
```
public void write(BytesDataOutput output,
                  float[] value)
```
    Description copied from interface: ArrayFunctions
    
    Writes the contents of the given array to the output stream. Includes the array length.
    
    Specified by:
    
    write in interface ArrayFunctions<float[]>
    
    Parameters:
    
    output - stream to write to
    
    value - array to be written
  - writeRaw
```
public void writeRaw(BytesDataOutput output,
                     float[] value)
```
    Description copied from interface: ArrayFunctions
    
    Writes the contents of the given array to the output stream. Excludes the array length.
    
    Specified by:
    
    writeRaw in interface ArrayFunctions<float[]>
    
    Parameters:
    
    output - stream to write to
    
    value - array to be written
  - read
```
public float[] read(DataInput input)
             throws java.io.IOException
```
    Description copied from interface: ArrayFunctions
    
    Reads an array from the given input stream. The input must also contain the array length as written by the write method.
    
    Specified by:
    
    read in interface ArrayFunctions<float[]>
    
    Parameters:
    
    input - stream to read from
    
    Returns:
    
    array that has been read
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - readRaw
```
public float[] readRaw(DataInput input,
                       int length)
                throws java.io.IOException
```
    Description copied from interface: ArrayFunctions
    
    Reads an array from the given input stream. The input must not contain the array length; that is, it should use the format as used by writeRaw.
    
    Specified by:
    
    readRaw in interface ArrayFunctions<float[]>
    
    Parameters:
    
    input - stream to read from
    
    length - array length
    
    Returns:
    
    array that has been read
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - read
```
public float[] read(BytesDataInput input)
```
    Description copied from interface: ArrayFunctions
    
    Reads an array from the given input stream. The input must also contain the array length as written by the write method.
    
    Specified by:
    
    read in interface ArrayFunctions<float[]>
    
    Parameters:
    
    input - stream to read from
    
    Returns:
    
    array that has been read
  - readRaw
```
public float[] readRaw(BytesDataInput input,
                       int length)
```
    Description copied from interface: ArrayFunctions
    
    Reads an array from the given input stream. The input must not contain the array length; that is, it should use the format as used by writeRaw.
    
    Specified by:
    
    readRaw in interface ArrayFunctions<float[]>
    
    Parameters:
    
    input - stream to read from
    
    length - array length
    
    Returns:
    
    array that has been read

Class FloatArrayFunctions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INSTANCE

Constructor Detail

FloatArrayFunctions

Method Detail

newArray

getLength

equals

concat

startsWith

endsWith

getCommonSuffixLength

getCommonPrefixLength

copyOfRange

copyArray

equals

write

writeRaw

write

writeRaw

read

readRaw

read

readRaw