org.boon.collections

Class FloatList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Float>

org.boon.collections.FloatList

All Implemented Interfaces:

Iterable<Float>, Collection<Float>, List<Float>

public class FloatList
extends AbstractList<Float>

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
FloatList() Create a new list with exactly 10 items in it.
FloatList(float[] values) Create a new list with this many items in it.
FloatList(int capacity) Create a new list with this many items in it.

Method Summary

Methods

Modifier and Type	Method and Description
FloatList	add(float integer) Add a new value to the list but don't employ a wrapper.
boolean	add(Float integer) Add a new value to the list.
boolean	addArray(float... integers) Add a new array to the list.
boolean	addFloat(float value) Add a new value to the list but don't employ a wrapper.
float	atIndex(int index) Get the value at index
float	atIndex(int index, float element) Set a value in the list.
void	clear()
boolean	equals(Object o)
Float	get(int index) Get the value at index
float	getFloat(int index) Get the value at index but don't use a wrapper
int	hashCode()
float	idx(int index) Get the value at index
float	idx(int index, float element) Set a value in the list.
float	max() max
float	mean() Mean
float	median() median
float	min() min
double	reduceBy(Flt.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
Float	set(int index, Float element) Set a value in the list.
float	setFloat(int index, float element) Set in a new value no wrapper
int	size() Return the current size.
void	sort() sort
float	standardDeviation() standardDeviation
float	sum() Sums the values with bounds checking.
static FloatList	toFloatList(Collection<?> inputList, String propertyPath) Creates a primitive list based on an input list and a property path
float[]	toValueArray() Get a copy of the array up to the end element.
float	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

FloatList

public FloatList(int capacity)

Create a new list with this many items in it.

FloatList

public FloatList()

Create a new list with exactly 10 items in it.

FloatList

public FloatList(float[] values)

Create a new list with this many items in it.

Method Detail

toFloatList

public static FloatList toFloatList(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 Float get(int index)

Get the value at index

Specified by:

get in interface List<Float>

Specified by:

get in class AbstractList<Float>

Parameters:

index - index

Returns:

value

idx

public float idx(int index)

Get the value at index

Parameters:

index - index

Returns:

value

atIndex

public float atIndex(int index)

Get the value at index

Parameters:

index - index

Returns:

value

getFloat

public final float getFloat(int index)

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

Parameters:

index - index

Returns:

value

add

public boolean add(Float integer)

Add a new value to the list.

Specified by:

add in interface Collection<Float>

Specified by:

add in interface List<Float>

Overrides:

add in class AbstractList<Float>

Parameters:

integer - new value

Returns:

was able to add.

addFloat

public boolean addFloat(float 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 FloatList add(float 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(float... integers)

Add a new array to the list.

Returns:

was able to add.

set

public Float set(int index,
        Float element)

Set a value in the list.

Specified by:

set in interface List<Float>

Overrides:

set in class AbstractList<Float>

Parameters:

index - index

element - new value

Returns:

old value at this index

idx

public float idx(int index,
        float element)

Set a value in the list.

Parameters:

index - index

element - new value

Returns:

old value at this index

atIndex

public float atIndex(int index,
            float element)

Set a value in the list.

Parameters:

index - index

element - new value

Returns:

old value at this index

setFloat

public float setFloat(int index,
             float 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<Float>

Specified by:

size in interface List<Float>

Specified by:

size in class AbstractCollection<Float>

Returns:

sum

public float sum()

Sums the values with bounds checking.

toValueArray

public float[] 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(Flt.ReduceBy reduceBy)

Parameters:

reduceBy - reduceBy function

Returns:

the reduction

mean

public float mean()

Mean

Returns:

mean

standardDeviation

public float standardDeviation()

standardDeviation

Returns:

standardDeviation

variance

public float variance()

variance

Returns:

variance

max

public float max()

max

Returns:

max

min

public float min()

min

Returns:

min

median

public float median()

median

Returns:

median

sort

public void sort()

sort

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Float>

Specified by:

equals in interface List<Float>

Overrides:

equals in class AbstractList<Float>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<Float>

Specified by:

hashCode in interface List<Float>

Overrides:

hashCode in class AbstractList<Float>

clear

public void clear()

Specified by:

clear in interface Collection<Float>

Specified by:

clear in interface List<Float>

Overrides:

clear in class AbstractList<Float>