Int (boon 0.18 API)

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

```
public class Int
extends Object
```
Integer operations.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description

Int()

Constructors
Constructor and Description
`Int()`

Method Summary

Methods
Modifier and Type	Method and Description
`static int[]`	`add(int[] array, int v)` Adds an int to the array.
`static int[]`	`add(int[] array, int[] array2)` adds two array together and returns the results.
`static int[]`	`array(int... array)`
`static int[]`	`arrayOfInt(int size)` Creates an array of bytes
`static int`	`atIndex(int[] array, int index)` Returns the value at the given index.
`static void`	`atIndex(int[] array, int index, int value)` Sets the value at the given index.
`static long`	`bigSum(int[] values)` Sum Provides overflow protection.
`static long`	`bigSum(int[] values, int length)` Sum Provides overflow protection.
`static long`	`bigSum(int[] values, int start, int length)` Big Sum
`static int[]`	`compact(int[] array)` Takes out all of the 0s
`static int[]`	`copy(int[] array)` Copies an array.
`static int[]`	`endSliceOf(int[] array, int endIndex)` Grabs a slice of this array
`static boolean`	`equals(int[] expected, int[] got)` Checks to see if two arrays are equals
`static boolean`	`equals(int expected, int got)` Compares two values
`static boolean`	`equals(int start, int end, int[] expected, int[] got)` Checks to see if two arrays are equals
`static boolean`	`equalsOrDie(int[] expected, int[] got)` Checks to see if two arrays are equals
`static boolean`	`equalsOrDie(int expected, int got)` Checks to see if two values are the same
`static int[]`	`grow(int[] array)` Double the size of an array.
`static int[]`	`grow(int[] array, int size)` Grown an array
`static int`	`hashCode(int[] array)`
`static int`	`hashCode(int start, int end, int[] array)`
`static int`	`idx(int[] array, int index)` Returns the value at the given index.
`static void`	`idx(int[] array, int index, int value)` Sets the value at the given index.
`static boolean`	`in(int value, int[] array)` Checks to see if a value is in the array.
`static int[]`	`insert(int[] array, int idx, int v)` Inserts a value in the midst of another array.
`static int[]`	`insert(int[] array, int fromIndex, int[] values)` Inserts an array in the midst of another array.
`static int`	`len(int[] array)` Returns the lengthOf an array.
`static int`	`lengthOf(int[] array)` Returns the lengthOf an array.
`static int`	`max(int[] values)` max
`static int`	`max(int[] values, int length)` max
`static int`	`max(int[] values, int start, int length)` Max
`static int`	`mean(int[] values)` Average
`static int`	`mean(int[] values, int length)` Average
`static int`	`mean(int[] values, int start, int length)` Average
`static int`	`median(Collection<?> inputList, String propertyPath)` Calculate standard deviation.
`static int`	`median(int[] values)` Calculate Median
`static int`	`median(int[] values, int length)` Calculate Median
`static int`	`median(int[] values, int start, int length)` Calculate Median
`static int`	`min(int[] values)` Min
`static int`	`min(int[] values, int length)` Min
`static int`	`min(int[] values, int start, int length)` Min
`static long`	`reduceBy(int[] array, Int.ReduceBy reduceBy)` A very fast reduce by.
`static long`	`reduceBy(int[] array, int length, Int.ReduceBy reduceBy)`
`static long`	`reduceBy(int[] array, int start, int length, Int.ReduceBy reduceBy)`
`static long`	`reduceBy(int[] array, int start, int length, Object object)` Reduce By
`static long`	`reduceBy(int[] array, int length, Object object)` Reduce By
`static long`	`reduceBy(int[] array, int length, Object function, String functionName)` Reduce By
`static <T> long`	`reduceBy(int[] array, T object)` Reduce by functional support for int arrays.
`static <T> long`	`reduceBy(int[] array, T object, String methodName)` Reduce by functional support for int arrays.
`static int`	`roundUpToPowerOf2(int number)` Round up to the nearest power of 2
`static int[]`	`shrink(int[] array, int size)` Shrink an array
`static int[]`	`slc(int[] array, int startIndex)` Grabs a slice of this array
`static int[]`	`slc(int[] array, int startIndex, int endIndex)` Grabs a slice of this array
`static int[]`	`slcEnd(int[] array, int endIndex)` Grabs a slice of this array
`static int[]`	`sliceOf(int[] array, int startIndex)` Grabs a slice of this array
`static int[]`	`sliceOf(int[] array, int startIndex, int endIndex)` Grabs a slice of this array
`static double`	`standardDeviation(Collection<?> inputList, String propertyPath)` Calculate standard deviation.
`static int`	`standardDeviation(int[] values)` Calculate standard deviation.
`static int`	`standardDeviation(int[] values, int length)` Calculate standard deviation.
`static int`	`standardDeviation(int[] values, int start, int length)` Calculate standard deviation.
`static long`	`sum(Collection<?> inputList, String propertyPath)` Calculate a sum of a property from a list.
`static int`	`sum(int[] values)` Sum Provides overflow protection.
`static int`	`sum(int[] values, int length)` Sum Provides overflow protection.
`static int`	`sum(int[] values, int start, int length)` Sum Provides overflow protection.
`static double`	`variance(Collection<?> inputList, String propertyPath)`
`static int`	`variance(int[] values)` Calculate Variance.
`static int`	`variance(int[] values, int length)` Calculate Variance.
`static int`	`variance(int[] values, int start, int length)` Calculate Variance.
`static double`	`varianceDouble(int[] 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
  - Int
```
public Int()
```
- Method Detail
  - grow
```
public static int[] grow(int[] array,
         int size)
```
    Grown an array
    
    Parameters:
    array - array of items to grow
    size - size you would like to grow the array to
    
    Returns:
    the new array
  - grow
```
public static int[] grow(int[] array)
```
    Double the size of an array.
    
    Parameters:
    array - the array you are going to double
    
    Returns:
    the new array with the old values copied in
  - shrink
```
public static int[] shrink(int[] array,
           int size)
```
    Shrink an array
    
    Parameters:
    array - the array you want to shrink
    size - what size do you want the new array
    
    Returns:
    the new array
  - compact
```
public static int[] compact(int[] array)
```
    Takes out all of the 0s
    
    Parameters:
    array - array to compact
    
    Returns:
    return value
  - arrayOfInt
```
public static int[] arrayOfInt(int size)
```
    Creates an array of bytes
    
    Parameters:
    size - size of the array you want to make
    
    Returns:
  - array
```
public static int[] array(int... array)
```
    Parameters:
    array -
    
    Returns:
  - lengthOf
```
public static int lengthOf(int[] array)
```
    Returns the lengthOf an array.
    
    Parameters:
    array - the array you are getting the length from.
    
    Returns:
    array length
  - len
```
public static int len(int[] array)
```
    Returns the lengthOf an array.
    
    Parameters:
    array - the array you are getting the length from.
    
    Returns:
    array length
  - idx
```
public static int idx(int[] array,
      int index)
```
    Returns the value at the given index.
    
    Parameters:
    array - the array you are getting the from.
    
    Returns:
    the value
  - atIndex
```
public static int atIndex(int[] array,
          int index)
```
    Returns the value at the given index.
    
    Parameters:
    array - the array you are getting the from.
    
    Returns:
    the value
  - idx
```
public static void idx(int[] array,
       int index,
       int value)
```
    Sets the value at the given index.
    
    Parameters:
    array - the array you are getting the from.
  - atIndex
```
public static void atIndex(int[] array,
           int index,
           int value)
```
    Sets the value at the given index.
    
    Parameters:
    array - the array you are setting the value to.
    value - the new value.
  - slc
```
public static int[] slc(int[] array,
        int startIndex,
        int endIndex)
```
    Grabs a slice of this array
    
    Parameters:
    array - the array you are getting slice from
    startIndex - the start index of the slice
    endIndex - the end index of the slice
    
    Returns:
    the new slice
  - sliceOf
```
public static int[] sliceOf(int[] array,
            int startIndex,
            int endIndex)
```
    Grabs a slice of this array
    
    Parameters:
    array - the array you are getting slice from
    startIndex - the start index of the slice
    endIndex - the end index of the slice
    
    Returns:
    the new slice
  - slc
```
public static int[] slc(int[] array,
        int startIndex)
```
    Grabs a slice of this array
    
    Parameters:
    array - the array you are getting slice from
    startIndex - the start index of the slice
    
    Returns:
    the new slice
  - sliceOf
```
public static int[] sliceOf(int[] array,
            int startIndex)
```
    Grabs a slice of this array
    
    Parameters:
    array - the array you are getting slice from
    startIndex - the start index of the slice
    
    Returns:
    the new slice
  - slcEnd
```
public static int[] slcEnd(int[] array,
           int endIndex)
```
    Grabs a slice of this array
    
    Parameters:
    array - the array you are getting slice from
    endIndex - the end index of the slice
    
    Returns:
    the new slice
  - endSliceOf
```
public static int[] endSliceOf(int[] array,
               int endIndex)
```
    Grabs a slice of this array
    
    Parameters:
    array - the array you are getting slice from
    endIndex - the end index of the slice
    
    Returns:
    the new slice
  - in
```
public static boolean in(int value,
         int[] array)
```
    Checks to see if a value is in the array.
    
    Parameters:
    array - the array you are getting slice from
    
    Returns:
    true if the value is in the array
  - copy
```
public static int[] copy(int[] array)
```
    Copies an array.
    
    Parameters:
    array - the array you want to copy
    
    Returns:
    the copied array
  - add
```
public static int[] add(int[] array,
        int v)
```
    Adds an int to the array. Grows the array by one and adds the int to the end.
    
    Parameters:
    array - the array
    v - the value you are adding to the end.
    
    Returns:
    the new array
  - add
```
public static int[] add(int[] array,
        int[] array2)
```
    adds two array together and returns the results.
    
    Parameters:
    array - first array
    array2 - second array
    
    Returns:
  - insert
```
public static int[] insert(int[] array,
           int idx,
           int v)
```
    Inserts a value in the midst of another array.
    
    Parameters:
    array -
    idx -
    v -
    
    Returns:
  - insert
```
public static int[] insert(int[] array,
           int fromIndex,
           int[] values)
```
    Inserts an array in the midst of another array.
    
    Parameters:
    array -
    
    Returns:
  - reduceBy
```
public static long reduceBy(int[] array,
            Int.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 long reduceBy(int[] array,
            int start,
            int length,
            Int.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 long reduceBy(int[] array,
            int length,
            Int.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> long reduceBy(int[] 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> long reduceBy(int[] 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 long reduceBy(int[] 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 long reduceBy(int[] 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 long reduceBy(int[] 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(int expected,
                  int 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
  - equalsOrDie
```
public static boolean equalsOrDie(int[] expected,
                  int[] 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(int expected,
             int got)
```
    Compares two values
    
    Parameters:
    expected - expected value
    got - got value
    
    Returns:
    true or false
  - equals
```
public static boolean equals(int[] expected,
             int[] got)
```
    Checks to see if two arrays are equals
    
    Parameters:
    expected - expected array
    got - got array
    
    Returns:
    true if equal or false if not.
  - sum
```
public static int sum(int[] values)
```
    Sum Provides overflow protection.
    
    Parameters:
    values - values in int
    
    Returns:
    sum
  - sum
```
public static int sum(int[] values,
      int length)
```
    Sum Provides overflow protection.
    
    Parameters:
    values - values in int
    
    Returns:
    sum
  - sum
```
public static int sum(int[] values,
      int start,
      int length)
```
    Sum Provides overflow protection.
    
    Parameters:
    values - values in int
    
    Returns:
    sum
  - bigSum
```
public static long bigSum(int[] values)
```
    Sum Provides overflow protection.
    
    Parameters:
    values - values in int
    
    Returns:
    sum
  - bigSum
```
public static long bigSum(int[] values,
          int length)
```
    Sum Provides overflow protection.
    
    Parameters:
    values - values in int
    
    Returns:
    sum
  - bigSum
```
public static long bigSum(int[] values,
          int start,
          int length)
```
    Big Sum
    
    Parameters:
    values - values in int
    
    Returns:
    sum
  - max
```
public static int max(int[] values,
      int start,
      int length)
```
    Max
    
    Parameters:
    values - values in int
    
    Returns:
    max
  - max
```
public static int max(int[] values)
```
    max
    
    Parameters:
    values - values in int
    
    Returns:
    max
  - max
```
public static int max(int[] values,
      int length)
```
    max
    
    Parameters:
    values - values in int
    
    Returns:
    max
  - min
```
public static int min(int[] values,
      int start,
      int length)
```
    Min
    
    Parameters:
    values - values in int
    
    Returns:
    min
  - min
```
public static int min(int[] values)
```
    Min
    
    Parameters:
    values - values in int
    
    Returns:
    min
  - min
```
public static int min(int[] values,
      int length)
```
    Min
    
    Parameters:
    values - values in int
    
    Returns:
    min
  - mean
```
public static int mean(int[] values,
       int start,
       int length)
```
    Average
    
    Parameters:
    values - values in int
    
    Returns:
    average
  - mean
```
public static int mean(int[] values,
       int length)
```
    Average
    
    Parameters:
    values - values in int
    
    Returns:
    average
  - mean
```
public static int mean(int[] values)
```
    Average
    
    Parameters:
    values - values in int
    
    Returns:
    average
  - variance
```
public static int variance(int[] values,
           int start,
           int length)
```
    Calculate Variance.
    
    Parameters:
    values - values
    start - start
    length - length
    
    Returns:
    variance
  - varianceDouble
```
public static double varianceDouble(int[] values,
                    int start,
                    int length)
```
    Calculate Variance.
    
    Parameters:
    values - values
    start - start
    length - length
    
    Returns:
    variance
  - variance
```
public static int variance(int[] values,
           int length)
```
    Calculate Variance.
    
    Parameters:
    values - values
    length - length
    
    Returns:
    variance
  - variance
```
public static int variance(int[] values)
```
    Calculate Variance.
    
    Parameters:
    values - values
    
    Returns:
    variance
  - standardDeviation
```
public static int standardDeviation(int[] values,
                    int start,
                    int length)
```
    Calculate standard deviation.
    
    Parameters:
    values - values
    start - start
    length - length
    
    Returns:
    standard deviation
  - standardDeviation
```
public static int standardDeviation(int[] values,
                    int length)
```
    Calculate standard deviation.
    
    Parameters:
    values - values
    length - length
    
    Returns:
    standard deviation
  - standardDeviation
```
public static int standardDeviation(int[] values)
```
    Calculate standard deviation.
    
    Parameters:
    values - values
    
    Returns:
    standard deviation
  - median
```
public static int median(int[] values,
         int start,
         int length)
```
    Calculate Median
    
    Parameters:
    start - start
    values - values
    length - length
    
    Returns:
    median
  - median
```
public static int median(int[] values,
         int length)
```
    Calculate Median
    
    Parameters:
    values - values
    length - length
    
    Returns:
    median
  - median
```
public static int median(int[] values)
```
    Calculate Median
    
    Parameters:
    values - values
    
    Returns:
    median
  - equals
```
public static boolean equals(int start,
             int end,
             int[] expected,
             int[] 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(int[] array)
```
  - hashCode
```
public static int hashCode(int start,
           int end,
           int[] array)
```
  - sum
```
public static long sum(Collection<?> inputList,
       String propertyPath)
```
    Calculate a sum of a property from a list.
    
    Parameters:
    inputList -
    propertyPath - to item we want to sum
    
    Returns:
    sum
  - variance
```
public static double variance(Collection<?> inputList,
              String propertyPath)
```
  - standardDeviation
```
public static double standardDeviation(Collection<?> inputList,
                       String propertyPath)
```
    Calculate standard deviation.
    
    Returns:
    standard deviation
  - median
```
public static int median(Collection<?> inputList,
         String propertyPath)
```
    Calculate standard deviation.
    
    Returns:
    standard deviation
  - roundUpToPowerOf2
```
public static int roundUpToPowerOf2(int number)
```
    Round up to the nearest power of 2
    
    Parameters:
    number - number you want to round up to.
    
    Returns:
    rounded up to the power of 2.

Class Int

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Int

Method Detail

grow

grow

shrink

compact

arrayOfInt

array

lengthOf

len

idx

atIndex

idx

atIndex

slc

sliceOf

slc

sliceOf

slcEnd

endSliceOf

in

copy

add

add

insert

insert

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

reduceBy

equalsOrDie

equalsOrDie

equals

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

sum

variance

standardDeviation

median

roundUpToPowerOf2