org.boon.collections

Class DoubleList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Double>

org.boon.collections.DoubleList

All Implemented Interfaces:

Iterable<Double>, Collection<Double>, List<Double>

public class DoubleList
extends AbstractList<Double>

Holds primitive values in a list like object for ints.

Has sum, mean, median, standardDeviation, reduceBy, variance.

Author:

Rick Hightower

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
DoubleList() Create a new list with exactly 10 items in it.
DoubleList(double[] values) Create a new list with this many items in it.
DoubleList(int capacity) Create a new list with this many items in it.

Method Summary

Methods

Modifier and Type	Method and Description
DoubleList	add(double integer) Add a new value to the list but don't employ a wrapper.
boolean	add(Double integer) Add a new value to the list.
boolean	addArray(double... integers) Add a new array to the list.
boolean	addFloat(double value) Add a new value to the list but don't employ a wrapper.
double	atIndex(int index) Get the value at index
double	atIndex(int index, double element) Set a value in the list.
void	clear()
boolean	equals(Object o)
Double	get(int index) Get the value at index
double	getFloat(int index) Get the value at index but don't use a wrapper
int	hashCode()
double	idx(int index) Get the value at index
double	idx(int index, double element) Set a value in the list.
double	max() max
double	mean() Mean
double	median() median
double	min() min
double	reduceBy(Dbl.ReduceBy reduceBy)
double	reduceBy(Object function) This would be a good opportunity to reintroduce dynamic invoke
double	reduceBy(Object function, String name) This would be a good opportunity to reintroduce dynamic invoke
Double	set(int index, Double element) Set a value in the list.
double	setFloat(int index, double element) Set in a new value no wrapper
int	size() Return the current size.
void	sort() sort
double	standardDeviation() standardDeviation
double	sum() Sums the values with bounds checking.
static DoubleList	toDoubleList(Collection<?> inputList, String propertyPath) Creates a primitive list based on an input list and a property path
double[]	toValueArray() Get a copy of the array up to the end element.
double	variance() variance

Methods inherited from class java.util.AbstractList

add, addAll, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Constructor Detail

DoubleList

public DoubleList(int capacity)

Create a new list with this many items in it.

DoubleList

public DoubleList()

Create a new list with exactly 10 items in it.

DoubleList

public DoubleList(double[] values)

Create a new list with this many items in it.

Method Detail

toDoubleList

public static DoubleList toDoubleList(Collection<?> inputList,
                      String propertyPath)

Creates a primitive list based on an input list and a property path

Parameters:

inputList - input list

propertyPath - property path

Returns:

primitive list

get

public Double get(int index)

Get the value at index

Specified by:

get in interface List<Double>

Specified by:

get in class AbstractList<Double>

Parameters:

index - index

Returns:

value

idx

public double idx(int index)

Get the value at index

Parameters:

index - index

Returns:

value

atIndex

public double atIndex(int index)

Get the value at index

Parameters:

index - index

Returns:

value

getFloat

public final double getFloat(int index)

Get the value at index but don't use a wrapper

Parameters:

index - index

Returns:

value

add

public boolean add(Double integer)

Add a new value to the list.

Specified by:

add in interface Collection<Double>

Specified by:

add in interface List<Double>

Overrides:

add in class AbstractList<Double>

Parameters:

integer - new value

Returns:

was able to add.

addFloat

public boolean addFloat(double value)

Add a new value to the list but don't employ a wrapper.

Parameters:

value - new value

Returns:

was able to add.

add

public DoubleList add(double integer)

Add a new value to the list but don't employ a wrapper.

Parameters:

integer - new value

Returns:

was able to add.

addArray

public boolean addArray(double... integers)

Add a new array to the list.

Returns:

was able to add.

set

public Double set(int index,
         Double element)

Set a value in the list.

Specified by:

set in interface List<Double>

Overrides:

set in class AbstractList<Double>

Parameters:

index - index

element - new value

Returns:

old value at this index

idx

public double idx(int index,
         double element)

Set a value in the list.

Parameters:

index - index

element - new value

Returns:

old value at this index

atIndex

public double atIndex(int index,
             double element)

Set a value in the list.

Parameters:

index - index

element - new value

Returns:

old value at this index

setFloat

public double setFloat(int index,
              double element)

Set in a new value no wrapper

Parameters:

index - index

element - new value

Returns:

old value at this index

size

public int size()

Return the current size.

Specified by:

size in interface Collection<Double>

Specified by:

size in interface List<Double>

Specified by:

size in class AbstractCollection<Double>

Returns:

sum

public double sum()

Sums the values with bounds checking.

toValueArray

public double[] toValueArray()

Get a copy of the array up to the end element.

Returns:

reduceBy

public double reduceBy(Object function)

This would be a good opportunity to reintroduce dynamic invoke

Parameters:

function - function

Returns:

reduceBy

public double reduceBy(Object function,
              String name)

This would be a good opportunity to reintroduce dynamic invoke

Parameters:

function - function

Returns:

reduceBy

public double reduceBy(Dbl.ReduceBy reduceBy)

Parameters:

reduceBy - reduceBy function

Returns:

the reduction

mean

public double mean()

Mean

Returns:

mean

standardDeviation

public double standardDeviation()

standardDeviation

Returns:

standardDeviation

variance

public double variance()

variance

Returns:

variance

max

public double max()

max

Returns:

max

min

public double min()

min

Returns:

min

median

public double median()

median

Returns:

median

sort

public void sort()

sort

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Double>

Specified by:

equals in interface List<Double>

Overrides:

equals in class AbstractList<Double>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<Double>

Specified by:

hashCode in interface List<Double>

Overrides:

hashCode in class AbstractList<Double>

clear

public void clear()

Specified by:

clear in interface Collection<Double>

Specified by:

clear in interface List<Double>

Overrides:

clear in class AbstractList<Double>