org.magicwerk.brownies.collections.primitive

Class FloatGapList

java.lang.Object

org.magicwerk.brownies.collections.primitive.FloatGapList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FloatGapList
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

FloatGapList is a variation of GapList which uses primitive values for storage. This allows to save memory and improve execution speed. Use FloatObjGapList to combine these features with the ability to access it using the standard List interface.

Note that this implementation is not synchronized.

Version:

$Id$

Author:

Thomas Mauch

See Also:

GapList, FloatObjGapList, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FloatGapList() Construct a list with the default initial capacity.
FloatGapList(java.util.Collection<java.lang.Float> coll) Construct a list to contain the specified elements.
FloatGapList(float... elems) Construct a list to contain the specified elements.
FloatGapList(int capacity) Construct a list with specified initial capacity.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(float elem)
void	add(int index, float elem)
boolean	addAll(java.util.Collection<java.lang.Float> coll) Adds all of the elements in the specified collection into this list.
boolean	addAll(float... elems) Adds all specified elements into this list.
boolean	addAll(FloatGapList list) Adds all of the elements in the specified list into this list.
boolean	addAll(int index, java.util.Collection<java.lang.Float> coll) Inserts all of the elements in the specified collection into this list, starting at the specified position.
boolean	addAll(int index, float... elems) Inserts the specified elements into this list, starting at the specified position.
boolean	addAll(int index, FloatGapList list) Inserts all of the elements in the specified list into this list, starting at the specified position.
void	addFirst(float elem)
void	addLast(float elem)
int	binarySearch(float key) Searches the specified range for an object using the binary search algorithm.
int	binarySearch(int index, int len, float key) Searches the specified range for an object using the binary search algorithm.
int	capacity() Returns capacity of this FloatGapList.
void	clear()
java.lang.Object	clone() Returns a shallow copy of this FloatGapList instance (The elements themselves are not copied).
boolean	contains(float elem)
boolean	containsAll(java.util.Collection<java.lang.Float> coll)
boolean	containsAny(java.util.Collection<java.lang.Float> coll) Returns true if any of the elements of the specified collection is contained in the list.
FloatGapList	copy() Returns a shallow copy of this FloatGapList instance (the new list will contain the same elements as the source list, i.e. the elements themselves are not copied).
static void	copy(FloatGapList src, int srcIndex, FloatGapList dst, int dstIndex, int len) Copies elements from one FloatGapList to another.
void	copy(int srcIndex, int dstIndex, int len) Copy specified elements.
static FloatGapList	create() Create new list.
static FloatGapList	create(java.util.Collection<java.lang.Float> coll) Create new list with specified elements.
static FloatGapList	create(float... elems) Create new list with specified elements.
static FloatGapList	create(int capacity) Create new list with specified capacity.
float	element()
static FloatGapList	EMPTY()
void	ensureCapacity(int minCapacity) Increases the capacity of this FloatGapList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
boolean	equals(java.lang.Object obj)
void	fill(float elem) Fill list.
void	fill(int index, int len, float elem) Fill specified elements.
float	get(int index)
FloatGapList	getAll(int index, int len) Returns specified range of elements from list.
float[]	getArray(int index, int len) Returns specified range of elements from list.
float	getFirst()
float	getLast()
int	hashCode()
int	indexOf(float elem)
void	init() Initialize the list to be empty.
void	init(java.util.Collection<java.lang.Float> coll) Initialize the list to contain the specified elements only.
void	init(float... elems) Initialize the list to contain the specified elements only.
void	init(int capacity) Initialize the list to be empty with specified initial capacity.
void	init(int len, float elem) Initializes the list so it will afterwards have a size of len and contain only the element elem.
boolean	isEmpty()
int	lastIndexOf(float elem)
static void	move(FloatGapList src, int srcIndex, FloatGapList dst, int dstIndex, int len) Moves elements from one FloatGapList to another.
void	move(int srcIndex, int dstIndex, int len) Move specified elements.
boolean	offer(float elem)
boolean	offerFirst(float elem)
boolean	offerLast(float elem)
float	peek()
float	peekFirst()
float	peekLast()
float	poll()
float	pollFirst()
float	pollLast()
float	pop()
void	push(float elem)
float	remove()
float	remove(int index)
void	remove(int index, int len) Remove specified range of elements from list.
boolean	removeAll(java.util.Collection<java.lang.Float> coll)
boolean	removeAll(FloatGapList coll)
float	removeFirst()
boolean	removeFirstOccurrence(float elem)
float	removeLast()
boolean	removeLastOccurrence(float elem)
void	resize(int len, float elem) Resizes the list so it will afterwards have a size of len.
boolean	retainAll(java.util.Collection<java.lang.Float> coll)
boolean	retainAll(FloatGapList coll)
void	reverse() Reverses the order of all elements in the specified list.
void	reverse(int index, int len) Reverses the order of the specified elements in the list.
void	rotate(int distance) Rotate specified elements in the list.
void	rotate(int index, int len, int distance) Rotate specified elements in the list.
float	set(int index, float elem)
void	setAll(int index, java.util.Collection<java.lang.Float> coll) Replaces the specified elements.
void	setAll(int index, float... elems) Replaces the specified elements.
void	setAll(int index, FloatGapList list) Replaces the specified elements.
int	size()
void	sort() Sort elements in the list using the specified comparator.
void	sort(int index, int len) Sort specified elements in the list using the specified comparator.
static void	swap(FloatGapList src, int srcIndex, FloatGapList dst, int dstIndex, int len) Swaps elements from two GapLists.
void	swap(int index1, int index2, int len) Swap the specified elements in the list.
float[]	toArray()
float[]	toArray(float[] array)
float[]	toArray(int index, int len) Returns an array containing the specified elements in this list.
java.lang.String	toString()
void	trimToSize() Trims the capacity of this FloatGapList instance to be the list's current size.
FloatGapList	unmodifiableList() Returns an unmodifiable view of this list.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FloatGapList

public FloatGapList()

Construct a list with the default initial capacity.

FloatGapList

public FloatGapList(int capacity)

Construct a list with specified initial capacity.

Parameters:

capacity - capacity

FloatGapList

public FloatGapList(java.util.Collection<java.lang.Float> coll)

Construct a list to contain the specified elements. The list will have an initial capacity to hold these elements.

Parameters:

coll - collection with elements

FloatGapList

public FloatGapList(float... elems)

Construct a list to contain the specified elements. The list will have an initial capacity to hold these elements.

Parameters:

elems - array with elements

Method Detail

EMPTY

public static FloatGapList EMPTY()

Returns:

unmodifiable empty instance

create

public static FloatGapList create()

Create new list.

Parameters:

type - of elements stored in the list

Returns:

created list

create

public static FloatGapList create(int capacity)

Create new list with specified capacity.

Parameters:

capacity - capacity

type - of elements stored in the list

Returns:

created list

create

public static FloatGapList create(java.util.Collection<java.lang.Float> coll)

Create new list with specified elements.

Parameters:

coll - collection with element

type - of elements stored in the list

Returns:

created list

create

public static FloatGapList create(float... elems)

Create new list with specified elements.

Parameters:

elems - array with elements

type - of elements stored in the list

Returns:

created list

init

public void init()

Initialize the list to be empty. The list will have the default initial capacity.

init

public void init(int capacity)

Initialize the list to be empty with specified initial capacity.

Parameters:

capacity - capacity

init

public void init(java.util.Collection<java.lang.Float> coll)

Initialize the list to contain the specified elements only. The list will have an initial capacity to hold these elements.

Parameters:

coll - collection with elements

init

public void init(float... elems)

Initialize the list to contain the specified elements only. The list will have an initial capacity to hold these elements.

Parameters:

elems - array with elements

copy

public FloatGapList copy()

Returns a shallow copy of this FloatGapList instance (the new list will contain the same elements as the source list, i.e. the elements themselves are not copied). This method is identical to clone() except that the result is casted to FloatGapList.

Returns:

a clone of this instance

See Also:

clone()

unmodifiableList

public FloatGapList unmodifiableList()

Returns an unmodifiable view of this list. This method allows modules to provide users with "read-only" access to internal lists. Query operations on the returned list "read through" to the specified list, and attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException.

Returns:

an unmodifiable view of the specified list

clone

public java.lang.Object clone()

Returns a shallow copy of this FloatGapList instance (The elements themselves are not copied). The capacity of the list will be set to the number of elements, so after calling clone(), size and capacity are equal.

Overrides:

clone in class java.lang.Object

Returns:

a clone of this FloatGapList instance

clear

public void clear()

size

public int size()

capacity

public int capacity()

Returns capacity of this FloatGapList. Note that two GapLists are considered equal even if they have a distinct capacity. Also the capacity can be changed by operations like clone() etc.

Returns:

capacity of this FloatGapList

get

public float get(int index)

set

public float set(int index,
        float elem)

add

public boolean add(float elem)

add

public void add(int index,
       float elem)

remove

public float remove(int index)

ensureCapacity

public void ensureCapacity(int minCapacity)

Increases the capacity of this FloatGapList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.

Parameters:

minCapacity - the desired minimum capacity

trimToSize

public void trimToSize()

Trims the capacity of this FloatGapList instance to be the list's current size. An application can use this operation to minimize the storage of an FloatGapList instance.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isEmpty

public boolean isEmpty()

indexOf

public int indexOf(float elem)

lastIndexOf

public int lastIndexOf(float elem)

contains

public boolean contains(float elem)

containsAny

public boolean containsAny(java.util.Collection<java.lang.Float> coll)

Returns true if any of the elements of the specified collection is contained in the list.

Parameters:

coll - collection with elements to be contained

Returns:

true if any element is contained, false otherwise

containsAll

public boolean containsAll(java.util.Collection<java.lang.Float> coll)

removeAll

public boolean removeAll(java.util.Collection<java.lang.Float> coll)

removeAll

public boolean removeAll(FloatGapList coll)

See Also:

removeAll(Collection)

retainAll

public boolean retainAll(java.util.Collection<java.lang.Float> coll)

retainAll

public boolean retainAll(FloatGapList coll)

See Also:

retainAll(Collection)

toArray

public float[] toArray()

toArray

public float[] toArray(int index,
              int len)

Returns an array containing the specified elements in this list.

Parameters:

index - index of first element to copy

len - number of elements to copy

Returns:

array the specified elements

toArray

public float[] toArray(float[] array)

addAll

public boolean addAll(java.util.Collection<java.lang.Float> coll)

Adds all of the elements in the specified collection into this list. The new elements will appear in the list in the order that they are returned by the specified collection's iterator.

Parameters:

coll - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.NullPointerException - if the specified collection is (float)0

addAll

public boolean addAll(int index,
             java.util.Collection<java.lang.Float> coll)

Inserts all of the elements in the specified collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified collection's iterator.

Parameters:

index - index at which to insert the first element from the specified collection

coll - collection containing elements to be inserted into this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.IndexOutOfBoundsException - if the index is invalid

java.lang.NullPointerException - if the specified collection is (float)0

addAll

public boolean addAll(float... elems)

Adds all specified elements into this list.

Parameters:

elems - elements to be added to this list

Returns:

true if this list changed as a result of the call

addAll

public boolean addAll(int index,
             float... elems)

Inserts the specified elements into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices).

Parameters:

index - index at which to insert the first element from the specified collection

elems - elements to be inserted into this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.IndexOutOfBoundsException - if the index is invalid

addAll

public boolean addAll(FloatGapList list)

Adds all of the elements in the specified list into this list.

Parameters:

list - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.NullPointerException - if the specified list is (float)0

addAll

public boolean addAll(int index,
             FloatGapList list)

Inserts all of the elements in the specified list into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices).

Parameters:

index - index at which to insert the first element from the specified collection

list - list containing elements to be inserted into this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.IndexOutOfBoundsException - if the index is invalid

java.lang.NullPointerException - if the specified collection is (float)0

peek

public float peek()

element

public float element()

poll

public float poll()

remove

public float remove()

offer

public boolean offer(float elem)

getFirst

public float getFirst()

getLast

public float getLast()

addFirst

public void addFirst(float elem)

addLast

public void addLast(float elem)

removeFirst

public float removeFirst()

removeLast

public float removeLast()

offerFirst

public boolean offerFirst(float elem)

offerLast

public boolean offerLast(float elem)

peekFirst

public float peekFirst()

peekLast

public float peekLast()

pollFirst

public float pollFirst()

pollLast

public float pollLast()

pop

public float pop()

push

public void push(float elem)

removeFirstOccurrence

public boolean removeFirstOccurrence(float elem)

removeLastOccurrence

public boolean removeLastOccurrence(float elem)

move

public static void move(FloatGapList src,
        int srcIndex,
        FloatGapList dst,
        int dstIndex,
        int len)

Moves elements from one FloatGapList to another.

Parameters:

src - source list

srcIndex - index of first element in source list

dst - destination list

dstIndex - index of first element in source list

len - number of elements to move

type - of elements stored in the list

Throws:

java.lang.IndexOutOfBoundsException - if the ranges are invalid

copy

public static void copy(FloatGapList src,
        int srcIndex,
        FloatGapList dst,
        int dstIndex,
        int len)

Copies elements from one FloatGapList to another.

Parameters:

src - source list

srcIndex - index of first element in source list

dst - destination list

dstIndex - index of first element in source list

len - number of elements to copy

type - of elements stored in the list

Throws:

java.lang.IndexOutOfBoundsException - if the ranges are invalid

swap

public static void swap(FloatGapList src,
        int srcIndex,
        FloatGapList dst,
        int dstIndex,
        int len)

Swaps elements from two GapLists.

Parameters:

src - first list

srcIndex - index of first element in first list

dst - second list

dstIndex - index of first element in second list

len - number of elements to swap

type - of elements stored in the list

Throws:

java.lang.IndexOutOfBoundsException - if the ranges are invalid

getAll

public FloatGapList getAll(int index,
                  int len)

Returns specified range of elements from list.

Parameters:

index - index of first element to retrieve

len - number of elements to retrieve

Returns:

FloatGapList containing the specified range of elements from list

getArray

public float[] getArray(int index,
               int len)

Returns specified range of elements from list.

Parameters:

index - index of first element to retrieve

len - number of elements to retrieve

Returns:

FloatGapList containing the specified range of elements from list

setAll

public void setAll(int index,
          FloatGapList list)

Replaces the specified elements.

Parameters:

index - index of first element to set

list - list with elements to set

setAll

public void setAll(int index,
          java.util.Collection<java.lang.Float> coll)

Replaces the specified elements.

Parameters:

index - index of first element to set

coll - collection with elements to set

setAll

public void setAll(int index,
          float... elems)

Replaces the specified elements.

Parameters:

index - index of first element to set

elems - elements to set

remove

public void remove(int index,
          int len)

Remove specified range of elements from list.

Parameters:

index - index of first element to remove

len - number of elements to remove

init

public void init(int len,
        float elem)

Initializes the list so it will afterwards have a size of len and contain only the element elem. The list will grow or shrink as needed.

Parameters:

len - length of list

elem - element which the list will contain

resize

public void resize(int len,
          float elem)

Resizes the list so it will afterwards have a size of len. If the list must grow, the specified element elem will be used for filling.

Parameters:

len - length of list

elem - element which will be used for extending the list

fill

public void fill(float elem)

Fill list.

Parameters:

elem - element used for filling

fill

public void fill(int index,
        int len,
        float elem)

Fill specified elements.

Parameters:

index - index of first element to fill

len - number of elements to fill

elem - element used for filling

copy

public void copy(int srcIndex,
        int dstIndex,
        int len)

Copy specified elements. Source and destination ranges may overlap.

Parameters:

srcIndex - index of first source element to copy

dstIndex - index of first destination element to copy

len - number of elements to copy

move

public void move(int srcIndex,
        int dstIndex,
        int len)

Move specified elements. The elements which are moved away are set to (float)0. Source and destination ranges may overlap.

Parameters:

srcIndex - index of first source element to move

dstIndex - index of first destination element to move

len - number of elements to move

reverse

public void reverse()

Reverses the order of all elements in the specified list.

reverse

public void reverse(int index,
           int len)

Reverses the order of the specified elements in the list.

Parameters:

index - index of first element to reverse

len - number of elements to reverse

swap

public void swap(int index1,
        int index2,
        int len)

Swap the specified elements in the list.

Parameters:

index1 - index of first element in first range to swap

index2 - index of first element in second range to swap

len - number of elements to swap

Throws:

java.lang.IndexOutOfBoundsException - if the ranges overlap

rotate

public void rotate(int distance)

Rotate specified elements in the list. The distance argument can be positive or negative: If it is positive, the elements are moved towards the end, if negative, the elements are moved toward the beginning, if distance is 0, the list is not changed.

Parameters:

distance - distance to move the elements

rotate

public void rotate(int index,
          int len,
          int distance)

Rotate specified elements in the list. The distance argument can be positive or negative: If it is positive, the elements are moved towards the end, if negative, the elements are moved toward the beginning, if distance is 0, the list is not changed.

Parameters:

index - index of first element to rotate

len - number of elements to rotate

distance - distance to move the elements

sort

public void sort()

Sort elements in the list using the specified comparator.

Parameters:

comparator - comparator to use for sorting ((float)0 means the elements natural ordering should be used)

See Also:

Arrays.sort(int[])

sort

public void sort(int index,
        int len)

Sort specified elements in the list using the specified comparator.

Parameters:

index - index of first element to sort

len - number of elements to sort

comparator - comparator to use for sorting ((float)0 means the elements natural ordering should be used)

See Also:

Arrays.sort(int[])

binarySearch

public int binarySearch(float key)

Searches the specified range for an object using the binary search algorithm.

Parameters:

key - the value to be searched for

comparator - the comparator by which the list is ordered. A (float)0 value indicates that the elements' natural ordering should be used.

Returns:

index of the search key, if it is contained in the array; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element greater than the key, or a.length if all elements in the array are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.

See Also:

Arrays.binarySearch(long[], long)

binarySearch

public int binarySearch(int index,
               int len,
               float key)

Searches the specified range for an object using the binary search algorithm.

Parameters:

index - index of first element to search

len - number of elements to search

key - the value to be searched for

comparator - the comparator by which the list is ordered. A (float)0 value indicates that the elements' natural ordering should be used.

Returns:

index of the search key, if it is contained in the array; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element greater than the key, or a.length if all elements in the array are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.

See Also:

Arrays.binarySearch(long[], long)