Flt (boon 0.22 API)

java.lang.Object
- org.boon.primitive.Flt

```
public class Flt
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Flt.ReduceBy
Public interface for a very fast reduce by.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Flt.ReduceBy` Public interface for a very fast reduce by.

Constructor Summary

Constructors
Constructor and Description

Flt()

Constructors
Constructor and Description
`Flt()`

Method Summary

Methods
Modifier and Type	Method and Description
`static float[]`	`add(float[] array, float v)`
`static float[]`	`add(float[] array, float[] array2)`
`static float[]`	`array(float... array)`
`static float[]`	`arrayOfFloat(int size)` Creates an array of bytes
`static float`	`atIndex(float[] array, int index)`
`static void`	`atIndex(float[] array, int index, float value)`
`static double`	`bigSum(float[] values)` Sum Provides overflow protection.
`static double`	`bigSum(float[] values, int length)` Sum Provides overflow protection.
`static double`	`bigSum(float[] values, int start, int length)` Big Sum
`static float[]`	`compact(float[] array)`
`static float[]`	`copy(float[] array)`
`static float[]`	`endOfSlice(float[] array, int endIndex)`
`static boolean`	`equals(float[] expected, float[] got)` Checks to see if two arrays are equals
`static boolean`	`equals(float expected, float got)` Compares two values
`static boolean`	`equals(int start, int end, float[] expected, float[] got)` Checks to see if two arrays are equals
`static boolean`	`equalsOrDie(float[] expected, float[] got)` Checks to see if two arrays are equals
`static boolean`	`equalsOrDie(float expected, float got)` Checks to see if two values are the same
`static float[]`	`grow(float[] array)`
`static float[]`	`grow(float[] array, int size)`
`static int`	`hashCode(float[] array)`
`static int`	`hashCode(int start, int end, float[] array)`
`static float`	`idx(float[] array, int index)`
`static void`	`idx(float[] array, int index, float value)`
`static boolean`	`in(float value, float[] array)`
`static float[]`	`insert(float[] array, int idx, float v)`
`static float[]`	`insert(float[] array, int fromIndex, float[] values)`
`static int`	`len(float[] array)`
`static int`	`lengthOf(float[] array)`
`static float`	`max(float[] values)` max
`static float`	`max(float[] values, int length)` max
`static float`	`max(float[] values, int start, int length)` Max
`static float`	`mean(float[] values)` Average
`static float`	`mean(float[] values, int length)` Average
`static float`	`mean(float[] values, int start, int length)` Average
`static float`	`median(float[] values)` Calculate Median
`static float`	`median(float[] values, int length)` Calculate Median
`static float`	`median(float[] values, int start, int length)` Calculate Median
`static float`	`min(float[] values)` Min
`static float`	`min(float[] values, int length)` Min
`static float`	`min(float[] values, int start, int length)` Min
`static double`	`reduceBy(float[] array, Flt.ReduceBy reduceBy)` A very fast reduce by.
`static double`	`reduceBy(float[] array, int length, Flt.ReduceBy reduceBy)`
`static double`	`reduceBy(float[] array, int start, int length, Flt.ReduceBy reduceBy)`
`static double`	`reduceBy(float[] array, int start, int length, Object object)` Reduce By
`static double`	`reduceBy(float[] array, int length, Object object)` Reduce By
`static double`	`reduceBy(float[] array, int length, Object function, String functionName)` Reduce By
`static <T> double`	`reduceBy(float[] array, T object)` Reduce by functional support for int arrays.
`static <T> double`	`reduceBy(float[] array, T object, String methodName)` Reduce by functional support for int arrays.
`static float[]`	`shrink(float[] array, int size)`
`static float[]`	`slc(float[] array, int startIndex)`
`static float[]`	`slc(float[] array, int startIndex, int endIndex)`
`static float[]`	`slcEnd(float[] array, int endIndex)`
`static float[]`	`sliceOf(float[] array, int startIndex)`
`static float[]`	`sliceOf(float[] array, int startIndex, int endIndex)`
`static float`	`standardDeviation(float[] values)` Calculate standard deviation.
`static float`	`standardDeviation(float[] values, int length)` Calculate standard deviation.
`static float`	`standardDeviation(float[] values, int start, int length)` Calculate standard deviation.
`static double`	`sum(float[] values)` Sum Provides overflow protection.
`static float`	`sum(float[] values, int length)` Sum Provides overflow protection.
`static float`	`sum(float[] values, int start, int length)` Sum Provides overflow protection.
`static float`	`variance(float[] values)` Calculate Variance.
`static float`	`variance(float[] values, int length)` Calculate Variance.
`static float`	`variance(float[] values, int start, int length)` Calculate Variance.
`static double`	`varianceDouble(float[] values, int start, int length)` Calculate Variance.

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

Constructor Detail
- Flt
```
public Flt()
```

Method Detail

grow

public static float[] grow(float[] array,
           int size)

grow

public static float[] grow(float[] array)

shrink

public static float[] shrink(float[] array,
             int size)

compact

public static float[] compact(float[] array)

arrayOfFloat
```
public static float[] arrayOfFloat(int size)
```
Creates an array of bytes

Parameters:
size - size of the array you want to make

Returns:

array

public static float[] array(float... array)

Parameters:: array -
Returns:

lengthOf

public static int lengthOf(float[] array)

len
```
public static int len(float[] array)
```

atIndex

public static float atIndex(float[] array,
            int index)

idx

public static float idx(float[] array,
        int index)

atIndex

public static void atIndex(float[] array,
           int index,
           float value)

idx

public static void idx(float[] array,
       int index,
       float value)

sliceOf

public static float[] sliceOf(float[] array,
              int startIndex,
              int endIndex)

slc

public static float[] slc(float[] array,
          int startIndex,
          int endIndex)

sliceOf

public static float[] sliceOf(float[] array,
              int startIndex)

slc

public static float[] slc(float[] array,
          int startIndex)

endOfSlice

public static float[] endOfSlice(float[] array,
                 int endIndex)

slcEnd

public static float[] slcEnd(float[] array,
             int endIndex)

in

public static boolean in(float value,
         float[] array)

copy

public static float[] copy(float[] array)

add

public static float[] add(float[] array,
          float v)

add

public static float[] add(float[] array,
          float[] array2)

insert

public static float[] insert(float[] array,
             int idx,
             float v)

insert

public static float[] insert(float[] array,
             int fromIndex,
             float[] values)

equalsOrDie
```
public static boolean equalsOrDie(float[] expected,
                  float[] got)
```
Checks to see if two arrays are equals

Parameters:
expected - expected array
got - got array

Returns:
true if equal or throws exception if not.

equals
```
public static boolean equals(float[] expected,
             float[] got)
```
Checks to see if two arrays are equals

Parameters:
expected - expected array
got - got array

Returns:
true if equal or false if not.

reduceBy
```
public static double reduceBy(float[] array,
              Flt.ReduceBy reduceBy)
```
A very fast reduce by. If performance is your thing, this seems to be as fast a plain for loop when benchmarking with JMH.

Parameters:
array - array of items to reduce by
reduceBy - reduceBy interface

Returns:
the final value

reduceBy
```
public static double reduceBy(float[] array,
              int start,
              int length,
              Flt.ReduceBy reduceBy)
```
Parameters:
array - array of items to reduce by
start - where to start in the array
length - where to end in the array
reduceBy - the function to do the reduce by

Returns:
the reduction

reduceBy
```
public static double reduceBy(float[] array,
              int length,
              Flt.ReduceBy reduceBy)
```
Parameters:
array - array of items to reduce by
length - where to end in the array
reduceBy - the function to do the reduce by

Returns:
the reduction

reduceBy
```
public static <T> double reduceBy(float[] array,
                  T object)
```
Reduce by functional support for int arrays.

Type Parameters:
T - the type of object
Parameters:
array - array of items to reduce by
object - object that contains the reduce by function

Returns:
the final reduction

reduceBy
```
public static <T> double reduceBy(float[] array,
                  T object,
                  String methodName)
```
Reduce by functional support for int arrays.

Type Parameters:
T - the type of object
Parameters:
array - array of items to reduce by
object - object that contains the reduce by function

Returns:
the final reduction

reduceBy
```
public static double reduceBy(float[] array,
              int length,
              Object object)
```
Reduce By

Parameters:
array - array of items to reduce by
length - where to end in the array
object - function

Returns:
reduction

reduceBy

public static double reduceBy(float[] array,
              int length,
              Object function,
              String functionName)

Reduce By

Parameters:: array - array of items to reduce by; length - where to end in the array; function - function; function - functionName
Returns:: reduction

reduceBy

public static double reduceBy(float[] array,
              int start,
              int length,
              Object object)

Reduce By

Parameters:: array - array of items to reduce by; length - where to end in the array; object - function
Returns:: reduction

equalsOrDie
```
public static boolean equalsOrDie(float expected,
                  float got)
```
Checks to see if two values are the same

Parameters:
expected - expected value
got - got value

Returns:
true if equal throws exception if not equal

equals
```
public static boolean equals(float expected,
             float got)
```
Compares two values

Parameters:
expected - expected value
got - got value

Returns:
true or false

sum
```
public static double sum(float[] values)
```
Sum Provides overflow protection.

Parameters:
values - values in int

Returns:
sum

sum
```
public static float sum(float[] values,
        int length)
```
Sum Provides overflow protection.

Parameters:
values - values in int

Returns:
sum

sum

public static float sum(float[] values,
        int start,
        int length)

Sum Provides overflow protection.

Parameters:: values - values in int
Returns:: sum

bigSum
```
public static double bigSum(float[] values)
```
Sum Provides overflow protection.

Parameters:
values - values in int

Returns:
sum

bigSum
```
public static double bigSum(float[] values,
            int length)
```
Sum Provides overflow protection.

Parameters:
values - values in int

Returns:
sum

bigSum

public static double bigSum(float[] values,
            int start,
            int length)

Big Sum

Parameters:: values - values in int
Returns:: sum

max

public static float max(float[] values,
        int start,
        int length)

Max

Parameters:: values - values in int
Returns:: max

max
```
public static float max(float[] values)
```
max

Parameters:
values - values in int

Returns:
max

max

public static float max(float[] values,
        int length)

max

Parameters:: values - values in int
Returns:: max

min

public static float min(float[] values,
        int start,
        int length)

Min

Parameters:: values - values in int
Returns:: min

min
```
public static float min(float[] values)
```
Min

Parameters:
values - values in int

Returns:
min

min

public static float min(float[] values,
        int length)

Min

Parameters:: values - values in int
Returns:: min

mean

public static float mean(float[] values,
         int start,
         int length)

Average

Parameters:: values - values in int
Returns:: average

mean

public static float mean(float[] values,
         int length)

Average

Parameters:: values - values in int
Returns:: average

mean
```
public static float mean(float[] values)
```
Average

Parameters:
values - values in int

Returns:
average

variance

public static float variance(float[] values,
             int start,
             int length)

Calculate Variance.

Parameters:: values - values; start - start; length - length
Returns:: variance

varianceDouble

public static double varianceDouble(float[] values,
                    int start,
                    int length)

Calculate Variance.

Parameters:: values - values; start - start; length - length
Returns:: variance

variance
```
public static float variance(float[] values,
             int length)
```
Calculate Variance.

Parameters:
values - values
length - length

Returns:
variance

variance
```
public static float variance(float[] values)
```
Calculate Variance.

Parameters:
values - values

Returns:
variance

standardDeviation

public static float standardDeviation(float[] values,
                      int start,
                      int length)

Calculate standard deviation.

Parameters:: values - values; start - start; length - length
Returns:: standard deviation

standardDeviation
```
public static float standardDeviation(float[] values,
                      int length)
```
Calculate standard deviation.

Parameters:
values - values
length - length

Returns:
standard deviation

standardDeviation
```
public static float standardDeviation(float[] values)
```
Calculate standard deviation.

Parameters:
values - values

Returns:
standard deviation

median

public static float median(float[] values,
           int start,
           int length)

Calculate Median

Parameters:: start - start; values - values; length - length
Returns:: median

median
```
public static float median(float[] values,
           int length)
```
Calculate Median

Parameters:
values - values
length - length

Returns:
median

median
```
public static float median(float[] values)
```
Calculate Median

Parameters:
values - values

Returns:
median

equals
```
public static boolean equals(int start,
             int end,
             float[] expected,
             float[] got)
```
Checks to see if two arrays are equals

Parameters:
expected - expected array
got - got array

Returns:
true if equal or false if not.

hashCode

public static int hashCode(float[] array)

hashCode

public static int hashCode(int start,
           int end,
           float[] array)

Class Flt

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Flt

Method Detail

grow

grow

shrink

compact

arrayOfFloat

array

lengthOf

len

atIndex

idx

atIndex

idx

sliceOf

slc

sliceOf

slc

endOfSlice

slcEnd

in

copy

add

add

insert

insert

equalsOrDie

equals

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

equalsOrDie

equals

sum

sum

sum

bigSum

bigSum

bigSum

max

max

max

min

min

min

mean

mean

mean

variance

varianceDouble

variance

variance

standardDeviation

standardDeviation

standardDeviation

median

median

median

equals

hashCode

hashCode