|
Colt 1.2.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object cern.colt.PersistentObject cern.colt.list.AbstractCollection cern.colt.list.AbstractList cern.colt.list.ObjectArrayList
Resizable list holding Object
elements; implemented with arrays.
First see the package summary and javadoc tree view to get the broad picture.
Field Summary |
Fields inherited from class cern.colt.PersistentObject |
serialVersionUID |
Constructor Summary | |
ObjectArrayList()
Constructs an empty list. |
|
ObjectArrayList(int initialCapacity)
Constructs an empty list with the specified initial capacity. |
|
ObjectArrayList(Object[] elements)
Constructs a list containing the specified elements. |
Method Summary | |
void |
add(Object element)
Appends the specified element to the end of this list. |
void |
addAllOfFromTo(ObjectArrayList other,
int from,
int to)
Appends the part of the specified list between from (inclusive) and to (inclusive) to the receiver. |
void |
beforeInsert(int index,
Object element)
Inserts the specified element before the specified position into the receiver. |
void |
beforeInsertAllOfFromTo(int index,
ObjectArrayList other,
int from,
int to)
Inserts the part of the specified list between otherFrom (inclusive) and otherTo (inclusive) before the specified position into the receiver. |
int |
binarySearch(Object key)
Searches the receiver for the specified value using the binary search algorithm. |
int |
binarySearchFromTo(Object key,
int from,
int to)
Searches the receiver for the specified value using the binary search algorithm. |
int |
binarySearchFromTo(Object key,
int from,
int to,
Comparator comparator)
Searches the receiver for the specified value using the binary search algorithm. |
Object |
clone()
Returns a copy of the receiver such that the copy and the receiver share the same elements, but do not share the same array to index them; So modifying an object in the copy modifies the object in the receiver and vice versa; However, structurally modifying the copy (for example changing its size, setting other objects at indexes, etc.) does not affect the receiver and vice versa. |
boolean |
contains(Object elem,
boolean testForEquality)
Returns true if the receiver contains the specified element. |
ObjectArrayList |
copy()
Returns a copy of the receiver; call clone() and casts the result. |
void |
delete(Object element,
boolean testForEquality)
Deletes the first element from the receiver that matches the specified element. |
Object[] |
elements()
Returns the elements currently stored, including invalid elements between size and capacity, if any. |
ObjectArrayList |
elements(Object[] elements)
Sets the receiver's elements to be the specified array (not a copy of it). |
void |
ensureCapacity(int minCapacity)
Ensures that the receiver can hold at least the specified number of elements without needing to allocate new internal memory. |
boolean |
equals(Object otherObj)
Compares the specified Object with the receiver for equality. |
boolean |
equals(Object otherObj,
boolean testForEquality)
Compares the specified Object with the receiver for equality. |
void |
fillFromToWith(int from,
int to,
Object val)
Sets the specified range of elements in the specified array to the specified value. |
boolean |
forEach(ObjectProcedure procedure)
Applies a procedure to each element of the receiver, if any. |
Object |
get(int index)
Returns the element at the specified position in the receiver. |
Object |
getQuick(int index)
Returns the element at the specified position in the receiver; WARNING: Does not check preconditions. |
int |
indexOf(Object element,
boolean testForEquality)
Returns the index of the first occurrence of the specified element. |
int |
indexOfFromTo(Object element,
int from,
int to,
boolean testForEquality)
Returns the index of the first occurrence of the specified element. |
boolean |
isSortedFromTo(int from,
int to)
Determines whether the receiver is sorted ascending, according to the natural ordering of its elements. |
int |
lastIndexOf(Object element,
boolean testForEquality)
Returns the index of the last occurrence of the specified element. |
int |
lastIndexOfFromTo(Object element,
int from,
int to,
boolean testForEquality)
Returns the index of the last occurrence of the specified element. |
void |
mergeSortFromTo(int from,
int to)
Sorts the specified range of the receiver into ascending order, according to the natural ordering of its elements. |
void |
mergeSortFromTo(int from,
int to,
Comparator c)
Sorts the receiver according to the order induced by the specified comparator. |
ObjectArrayList |
partFromTo(int from,
int to)
Returns a new list of the part of the receiver between from , inclusive, and to , inclusive. |
void |
quickSortFromTo(int from,
int to)
Sorts the specified range of the receiver into ascending order, according to the natural ordering of its elements. |
void |
quickSortFromTo(int from,
int to,
Comparator c)
Sorts the receiver according to the order induced by the specified comparator. |
boolean |
removeAll(ObjectArrayList other,
boolean testForEquality)
Removes from the receiver all elements that are contained in the specified list. |
void |
removeFromTo(int from,
int to)
Removes from the receiver all elements whose index is between from , inclusive and to , inclusive. |
void |
replaceFromToWithFrom(int from,
int to,
ObjectArrayList other,
int otherFrom)
Replaces a number of elements in the receiver with the same number of elements of another list. |
void |
replaceFromToWithFromTo(int from,
int to,
ObjectArrayList other,
int otherFrom,
int otherTo)
Replaces the part between from (inclusive) and to (inclusive) with the other list's
part between otherFrom and otherTo . |
void |
replaceFromWith(int from,
Collection other)
Replaces the part of the receiver starting at from (inclusive) with all the elements of the specified collection. |
boolean |
retainAll(ObjectArrayList other,
boolean testForEquality)
Retains (keeps) only the elements in the receiver that are contained in the specified other list. |
void |
reverse()
Reverses the elements of the receiver. |
void |
set(int index,
Object element)
Replaces the element at the specified position in the receiver with the specified element. |
void |
setQuick(int index,
Object element)
Replaces the element at the specified position in the receiver with the specified element; WARNING: Does not check preconditions. |
void |
shuffleFromTo(int from,
int to)
Randomly permutes the part of the receiver between from (inclusive) and to (inclusive). |
int |
size()
Returns the number of elements contained in the receiver. |
ObjectArrayList |
times(int times)
Returns a list which is a concatenation of times times the receiver. |
Object[] |
toArray(Object[] array)
Returns an array containing all of the elements in the receiver in the correct order. |
ArrayList |
toList()
Returns a java.util.ArrayList containing all the elements in the receiver. |
String |
toString()
Returns a string representation of the receiver, containing the String representation of each element. |
void |
trimToSize()
Trims the capacity of the receiver to be the receiver's current size. |
Methods inherited from class cern.colt.list.AbstractList |
addAllOf, beforeInsertAllOf, clear, mergeSort, quickSort, remove, setSize, shuffle, sort, sortFromTo |
Methods inherited from class cern.colt.list.AbstractCollection |
isEmpty |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ObjectArrayList()
public ObjectArrayList(Object[] elements)
elements
- the array to be backed by the the constructed listpublic ObjectArrayList(int initialCapacity)
initialCapacity
- the number of elements the receiver can hold without auto-expanding itself by allocating new internal memory.Method Detail |
public void add(Object element)
element
- element to be appended to this list.public void addAllOfFromTo(ObjectArrayList other, int from, int to)
from
(inclusive) and to
(inclusive) to the receiver.
other
- the list to be added to the receiver.from
- the index of the first element to be appended (inclusive).to
- the index of the last element to be appended (inclusive).
IndexOutOfBoundsException
- index is out of range (other.size()>0 && (from<0 || from>to || to>=other.size())).public void beforeInsert(int index, Object element)
index
- index before which the specified element is to be inserted (must be in [0,size]).element
- element to be inserted.
IndexOutOfBoundsException
- index is out of range (index < 0 || index > size()).public void beforeInsertAllOfFromTo(int index, ObjectArrayList other, int from, int to)
otherFrom
(inclusive) and otherTo
(inclusive) before the specified position into the receiver.
Shifts the element currently at that position (if any) and
any subsequent elements to the right.
index
- index before which to insert first element from the specified list (must be in [0,size])..other
- list of which a part is to be inserted into the receiver.from
- the index of the first element to be inserted (inclusive).to
- the index of the last element to be inserted (inclusive).
IndexOutOfBoundsException
- index is out of range (other.size()>0 && (from<0 || from>to || to>=other.size())).
IndexOutOfBoundsException
- index is out of range (index < 0 || index > size()).public int binarySearch(Object key)
key
- the value to be searched for.
Comparable
,
Arrays
public int binarySearchFromTo(Object key, int from, int to)
key
- the value to be searched for.from
- the leftmost search position, inclusive.to
- the rightmost search position, inclusive.
Comparable
,
Arrays
public int binarySearchFromTo(Object key, int from, int to, Comparator comparator)
If the receiver is not sorted, the results are undefined: in particular, the call may enter an infinite loop. If the receiver contains multiple elements equal to the specified object, there is no guarantee which instance will be found.
key
- the value to be searched for.from
- the leftmost search position, inclusive.to
- the rightmost search position, inclusive.comparator
- the comparator by which the receiver is sorted.
ClassCastException
- if the receiver contains elements that are not
mutually comparable using the specified comparator.Sorting
,
Arrays
,
Comparator
public Object clone()
clone
in class PersistentObject
public boolean contains(Object elem, boolean testForEquality)
testForEquality
- if true -> test for equality, otherwise for identity.public ObjectArrayList copy()
clone()
and casts the result.
Returns a copy such that the copy and the receiver share the same elements, but do not share the same array to index them;
So modifying an object in the copy modifies the object in the receiver and vice versa;
However, structurally modifying the copy (for example changing its size, setting other objects at indexes, etc.) does not affect the receiver and vice versa.
public void delete(Object element, boolean testForEquality)
testForEquality
- if true -> tests for equality, otherwise for identity.element
- the element to be deleted.public Object[] elements()
public ObjectArrayList elements(Object[] elements)
elements
- the new elements to be stored.
public void ensureCapacity(int minCapacity)
minCapacity
- the desired minimum capacity.public boolean equals(Object otherObj)
otherObj
- the Object to be compared for equality with the receiver.
public boolean equals(Object otherObj, boolean testForEquality)
otherObj
- the Object to be compared for equality with the receiver.testForEquality
- if true -> tests for equality, otherwise for identity.
public void fillFromToWith(int from, int to, Object val)
from
- the index of the first element (inclusive) to be filled with the specified value.to
- the index of the last element (inclusive) to be filled with the specified value.val
- the value to be stored in the specified elements of the receiver.public boolean forEach(ObjectProcedure procedure)
procedure
- the procedure to be applied. Stops iteration if the procedure returns false, otherwise continues.
public Object get(int index)
index
- index of element to return.
IndexOutOfBoundsException
- index is out of range (index < 0 || index >= size()).public Object getQuick(int index)
index
- index of element to return.public int indexOf(Object element, boolean testForEquality)
-1
if the receiver does not contain this element.
Tests for equality or identity as specified by testForEquality.
testForEquality
- if true
-> test for equality, otherwise for identity.
-1
if the element is not found.public int indexOfFromTo(Object element, int from, int to, boolean testForEquality)
-1
if the receiver does not contain this element.
Searches between from
, inclusive and to
, inclusive.
Tests for equality or identity as specified by testForEquality
.
element
- element to search for.from
- the leftmost search position, inclusive.to
- the rightmost search position, inclusive.testForEquality
- if true -> test for equality, otherwise for identity.
-1
if the element is not found.
IndexOutOfBoundsException
- index is out of range (size()>0 && (from<0 || from>to || to>=size())).public boolean isSortedFromTo(int from, int to)
from
- the index of the first element (inclusive) to be sorted.to
- the index of the last element (inclusive) to be sorted.
IndexOutOfBoundsException
- index is out of range (size()>0 && (from<0 || from>to || to>=size())).public int lastIndexOf(Object element, boolean testForEquality)
-1
if the receiver does not contain this element.
Tests for equality or identity as specified by testForEquality
.
element
- the element to be searched for.testForEquality
- if true
-> test for equality, otherwise for identity.
-1
if the element is not found.public int lastIndexOfFromTo(Object element, int from, int to, boolean testForEquality)
-1
if the receiver does not contain this element.
Searches beginning at to
, inclusive until from
, inclusive.
Tests for equality or identity as specified by testForEquality
.
element
- element to search for.from
- the leftmost search position, inclusive.to
- the rightmost search position, inclusive.testForEquality
- if true
-> test for equality, otherwise for identity.
-1
if the element is not found.
IndexOutOfBoundsException
- index is out of range (size()>0 && (from<0 || from>to || to>=size())).public void mergeSortFromTo(int from, int to)
This sort is guaranteed to be stable: equal elements will not be reordered as a result of the sort.
The sorting algorithm is a modified mergesort (in which the merge is omitted if the highest element in the low sublist is less than the lowest element in the high sublist). This algorithm offers guaranteed n*log(n) performance, and can approach linear performance on nearly sorted lists.
You should never call this method unless you are sure that this particular sorting algorithm is the right one for your data set. It is generally better to call sort() or sortFromTo(...) instead, because those methods automatically choose the best sorting algorithm.
mergeSortFromTo
in class AbstractList
from
- the index of the first element (inclusive) to be sorted.to
- the index of the last element (inclusive) to be sorted.
IndexOutOfBoundsException
- index is out of range (size()>0 && (from<0 || from>to || to>=size())).public void mergeSortFromTo(int from, int to, Comparator c)
This sort is guaranteed to be stable: equal elements will not be reordered as a result of the sort.
The sorting algorithm is a modified mergesort (in which the merge is omitted if the highest element in the low sublist is less than the lowest element in the high sublist). This algorithm offers guaranteed n*log(n) performance, and can approach linear performance on nearly sorted lists.
from
- the index of the first element (inclusive) to be
sorted.to
- the index of the last element (inclusive) to be sorted.c
- the comparator to determine the order of the receiver.
ClassCastException
- if the array contains elements that are not
mutually comparable using the specified comparator.
IllegalArgumentException
- if fromIndex > toIndex
ArrayIndexOutOfBoundsException
- if fromIndex < 0 or
toIndex > a.length
IndexOutOfBoundsException
- index is out of range (size()>0 && (from<0 || from>to || to>=size())).Comparator
public ObjectArrayList partFromTo(int from, int to)
from
, inclusive, and to
, inclusive.
from
- the index of the first element (inclusive).to
- the index of the last element (inclusive).
IndexOutOfBoundsException
- index is out of range (size()>0 && (from<0 || from>to || to>=size())).public void quickSortFromTo(int from, int to)
The sorting algorithm is a tuned quicksort, adapted from Jon L. Bentley and M. Douglas McIlroy's "Engineering a Sort Function", Software-Practice and Experience, Vol. 23(11) P. 1249-1265 (November 1993). This algorithm offers n*log(n) performance on many data sets that cause other quicksorts to degrade to quadratic performance.
You should never call this method unless you are sure that this particular sorting algorithm is the right one for your data set. It is generally better to call sort() or sortFromTo(...) instead, because those methods automatically choose the best sorting algorithm.
quickSortFromTo
in class AbstractList
from
- the index of the first element (inclusive) to be sorted.to
- the index of the last element (inclusive) to be sorted.
IndexOutOfBoundsException
- index is out of range (size()>0 && (from<0 || from>to || to>=size())).public void quickSortFromTo(int from, int to, Comparator c)
The sorting algorithm is a tuned quicksort, adapted from Jon L. Bentley and M. Douglas McIlroy's "Engineering a Sort Function", Software-Practice and Experience, Vol. 23(11) P. 1249-1265 (November 1993). This algorithm offers n*log(n) performance on many data sets that cause other quicksorts to degrade to quadratic performance.
from
- the index of the first element (inclusive) to be sorted.to
- the index of the last element (inclusive) to be sorted.c
- the comparator to determine the order of the receiver.
ClassCastException
- if the array contains elements that are not
mutually comparable using the specified comparator.
IllegalArgumentException
- if fromIndex > toIndex
ArrayIndexOutOfBoundsException
- if fromIndex < 0 or
toIndex > a.length
IndexOutOfBoundsException
- index is out of range (size()>0 && (from<0 || from>to || to>=size())).Comparator
public boolean removeAll(ObjectArrayList other, boolean testForEquality)
testForEquality
.
other
- the other list.testForEquality
- if true
-> test for equality, otherwise for identity.
true
if the receiver changed as a result of the call.public void removeFromTo(int from, int to)
from
, inclusive and to
, inclusive. Shifts any succeeding
elements to the left (reduces their index).
This call shortens the list by (to - from + 1) elements.
removeFromTo
in class AbstractList
from
- index of first element to be removed.to
- index of last element to be removed.
IndexOutOfBoundsException
- index is out of range (size()>0 && (from<0 || from>to || to>=size())).public void replaceFromToWithFrom(int from, int to, ObjectArrayList other, int otherFrom)
from
(inclusive) and to
(inclusive),
with elements of other
, starting from otherFrom
(inclusive).
from
- the position of the first element to be replaced in the receiverto
- the position of the last element to be replaced in the receiverother
- list holding elements to be copied into the receiver.otherFrom
- position of first element within other list to be copied.public void replaceFromToWithFromTo(int from, int to, ObjectArrayList other, int otherFrom, int otherTo)
from
(inclusive) and to
(inclusive) with the other list's
part between otherFrom
and otherTo
.
Powerful (and tricky) method!
Both parts need not be of the same size (part A can both be smaller or larger than part B).
Parts may overlap.
Receiver and other list may (but most not) be identical.
If from > to
, then inserts other part before from
.
from
- the first element of the receiver (inclusive)to
- the last element of the receiver (inclusive)other
- the other list (may be identical with receiver)otherFrom
- the first element of the other list (inclusive)otherTo
- the last element of the other list (inclusive)
Examples:
a=[0, 1, 2, 3, 4, 5, 6, 7] b=[50, 60, 70, 80, 90] a.R(...)=a.replaceFromToWithFromTo(...) a.R(3,5,b,0,4)-->[0, 1, 2, 50, 60, 70, 80, 90, 6, 7] a.R(1,6,b,0,4)-->[0, 50, 60, 70, 80, 90, 7] a.R(0,6,b,0,4)-->[50, 60, 70, 80, 90, 7] a.R(3,5,b,1,2)-->[0, 1, 2, 60, 70, 6, 7] a.R(1,6,b,1,2)-->[0, 60, 70, 7] a.R(0,6,b,1,2)-->[60, 70, 7] a.R(5,3,b,0,4)-->[0, 1, 2, 3, 4, 50, 60, 70, 80, 90, 5, 6, 7] a.R(5,0,b,0,4)-->[0, 1, 2, 3, 4, 50, 60, 70, 80, 90, 5, 6, 7] a.R(5,3,b,1,2)-->[0, 1, 2, 3, 4, 60, 70, 5, 6, 7] a.R(5,0,b,1,2)-->[0, 1, 2, 3, 4, 60, 70, 5, 6, 7] Extreme cases: a.R(5,3,b,0,0)-->[0, 1, 2, 3, 4, 50, 5, 6, 7] a.R(5,3,b,4,4)-->[0, 1, 2, 3, 4, 90, 5, 6, 7] a.R(3,5,a,0,1)-->[0, 1, 2, 0, 1, 6, 7] a.R(3,5,a,3,5)-->[0, 1, 2, 3, 4, 5, 6, 7] a.R(3,5,a,4,4)-->[0, 1, 2, 4, 6, 7] a.R(5,3,a,0,4)-->[0, 1, 2, 3, 4, 0, 1, 2, 3, 4, 5, 6, 7] a.R(0,-1,b,0,4)-->[50, 60, 70, 80, 90, 0, 1, 2, 3, 4, 5, 6, 7] a.R(0,-1,a,0,4)-->[0, 1, 2, 3, 4, 0, 1, 2, 3, 4, 5, 6, 7] a.R(8,0,a,0,4)-->[0, 1, 2, 3, 4, 5, 6, 7, 0, 1, 2, 3, 4]
public void replaceFromWith(int from, Collection other)
from
(inclusive) with all the elements of the specified collection.
Does not alter the size of the receiver.
Replaces exactly Math.max(0,Math.min(size()-from, other.size())) elements.
replaceFromWith
in class AbstractList
from
- the index at which to copy the first element from the specified collection.other
- Collection to replace part of the receiver
IndexOutOfBoundsException
- index is out of range (index < 0 || index >= size()).public boolean retainAll(ObjectArrayList other, boolean testForEquality)
testForEquality
.
other
- the other list to test against.testForEquality
- if true
-> test for equality, otherwise for identity.
true
if the receiver changed as a result of the call.public void reverse()
reverse
in class AbstractList
public void set(int index, Object element)
index
- index of element to replace.element
- element to be stored at the specified position.
IndexOutOfBoundsException
- index is out of range (index
< 0 || index >= size()).public void setQuick(int index, Object element)
index
- index of element to replace.element
- element to be stored at the specified position.public void shuffleFromTo(int from, int to)
from
(inclusive) and to
(inclusive).
shuffleFromTo
in class AbstractList
from
- the index of the first element (inclusive) to be permuted.to
- the index of the last element (inclusive) to be permuted.
IndexOutOfBoundsException
- index is out of range (size()>0 && (from<0 || from>to || to>=size())).public int size()
size
in class AbstractCollection
public ObjectArrayList times(int times)
times
times the receiver.
times
- the number of times the receiver shall be copied.public Object[] toArray(Object[] array)
If the receiver fits in the specified array with room to spare (i.e., the array has more elements than the receiver), the element in the array immediately following the end of the receiver is set to null. This is useful in determining the length of the receiver only if the caller knows that the receiver does not contain any null elements.
array
- the array into which the elements of the receiver are to
be stored, if it is big enough; otherwise, a new array of the
same runtime type is allocated for this purpose.
ArrayStoreException
- the runtime type of array is not a supertype
of the runtime type of every element in the receiver.public ArrayList toList()
java.util.ArrayList
containing all the elements in the receiver.
toList
in class AbstractCollection
public String toString()
toString
in class AbstractCollection
public void trimToSize()
trimToSize
in class AbstractList
|
Colt 1.2.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |