Dbl (boon 0.30 API)

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

public class Dbl
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description

Dbl()

Constructors
Constructor and Description
`Dbl()`

Method Summary

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

Method Detail

grow

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

grow

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

shrink

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

compact

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

arrayOfDouble
```
public static double[] arrayOfDouble(int size)
```
Creates an array of bytes

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

Returns:

array

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

Parameters:: array -
Returns:

len

public static int len(double[] array)

idx

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

idx

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

sliceOf

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

slc

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

slc

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

endSliceOf

public static double[] endSliceOf(double[] array,
                  int endIndex)

slcEnd

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

in

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

copy

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

add

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

add

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

insert

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

insert

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

equalsOrDie
```
public static boolean equalsOrDie(double[] expected,
                  double[] 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(double[] expected,
             double[] 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(double[] array,
              Dbl.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(double[] array,
              int start,
              int length,
              Dbl.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(double[] array,
              int length,
              Dbl.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(double[] 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(double[] array,
                  T object,
                  java.lang.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(double[] array,
              int length,
              java.lang.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(double[] array,
              int length,
              java.lang.Object function,
              java.lang.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(double[] array,
              int start,
              int length,
              java.lang.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(double expected,
                  double 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(double expected,
             double got)
```
Compares two values

Parameters:
expected - expected value
got - got value

Returns:
true or false

sum
```
public static double sum(double[] values)
```
Sum

Parameters:
values - values in int

Returns:
sum

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

Parameters:
values - values in int

Returns:
sum

sum

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

Sum Provides overflow protection.

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

max

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

Max

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

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

Parameters:
values - values in int

Returns:
max

max

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

max

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

min

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

Min

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

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

Parameters:
values - values in int

Returns:
min

min

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

Min

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

mean

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

Average

Parameters:: values - values
Returns:: average

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

Parameters:
values - values in int

Returns:
average

variance

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

Calculate Variance.

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

varianceDouble

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

Calculate Variance.

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

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

Parameters:
values - values
length - length

Returns:
variance

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

Parameters:
values - values

Returns:
variance

standardDeviation

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

Calculate standard deviation.

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

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

Parameters:
values - values
length - length

Returns:
standard deviation

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

Parameters:
values - values

Returns:
standard deviation

median

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

Calculate Median

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

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

Parameters:
values - values
length - length

Returns:
median

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

Parameters:
values - values

Returns:
median

equals
```
public static boolean equals(int start,
             int end,
             double[] expected,
             double[] 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(double[] array)

hashCode

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

Class Dbl

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Dbl

Method Detail

grow

grow

shrink

compact

arrayOfDouble

array

len

idx

idx

sliceOf

slc

slc

endSliceOf

slcEnd

in

copy

add

add

insert

insert

equalsOrDie

equals

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

equalsOrDie

equals

sum

sum

sum

max

max

max

min

min

min

mean

mean

variance

varianceDouble

variance

variance

standardDeviation

standardDeviation

standardDeviation

median

median

median

equals

hashCode

hashCode