org.magicwerk.brownies.collections.primitive

Class ShortBigList

java.lang.Object

org.magicwerk.brownies.collections.primitive.IShortList

org.magicwerk.brownies.collections.primitive.ShortBigList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ShortBigList
extends IShortList

ShortBigList is a list optimized for storing large number of elements. It stores the elements in fixed size blocks and the blocks itself are maintained in a tree for fast access. It also offers specialized methods for bulk processing of elements. Also copying a ShortBigList is efficiently possible as its implemented using a copy-on-write approach.

Note that this implementation is not synchronized. Due to data caching used for exploiting locality of reference, performance can decrease if ShortBigList is accessed by several threads at different positions.

Note that the iterators provided are not fail-fast.

Version:

$Id: ShortBigList.java 2531 2014-10-24 13:04:07Z origo $

Author:

Thomas Mauch

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShortBigList.ShortBlock A block stores in maximum blockSize number of elements.

Constructor Summary

Constructors

Constructor and Description
ShortBigList() Default constructor.
ShortBigList(java.util.Collection<java.lang.Short> coll) Create new list with specified elements.
ShortBigList(int blockSize) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	binarySearch(int index, int len, short key) Searches the specified range for an object using the binary search algorithm.
int	blockSize() Returns block size used for this ShortBigList.
int	capacity() Returns capacity of this list.
java.lang.Object	clone() Returns a shallow copy of this ShortBigList instance The copy is realized by a copy-on-write approach so also really large lists can efficiently be copied.
ShortBigList	copy() Returns a copy of this ShortBigList instance.
static ShortBigList	create() Create new list.
static ShortBigList	create(java.util.Collection<java.lang.Short> coll) Create new list with specified elements.
static ShortBigList	create(short... elems) Create new list with specified elements.
static ShortBigList	EMPTY()
short	getDefaultElem()
void	init() Initialize the list to be empty.
void	init(java.util.Collection<java.lang.Short> that) Initialize the list to have all elements in the specified collection.
void	init(short... elems) Initialize the list to have the specified elements.
static IShortList	of(java.util.List<java.lang.Short> values)
static IShortList	of(short[] values)
static IShortList	of(java.lang.Short[] values)
int	size()
void	sort(int index, int len) Sort specified elements in the list using the specified comparator.
void	trimToSize() Pack as many elements in the blocks as allowed.
ShortBigList	unmodifiableList() Returns an unmodifiable view of this list.

Methods inherited from class org.magicwerk.brownies.collections.primitive.IShortList

add, add, addAll, addAll, addAll, addAll, addAll, addAll, addFirst, addIfAbsent, addLast, binarySearch, clear, contains, containsAll, containsAny, copy, copy, drag, element, ensureCapacity, equals, extract, fill, fill, filter, get, getAll, getAll, getArray, getCount, getDistinct, getFirst, getLast, hashCode, indexOf, init, isEmpty, lastIndexOf, mappedList, merge, move, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeAll, removeAll, removeAll, removeElem, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, resize, retainAll, retainAll, reverse, reverse, rotate, rotate, set, setAll, setAll, setAll, sort, swap, swap, toArray, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShortBigList

public ShortBigList()

Default constructor. The default block size is used.

ShortBigList

public ShortBigList(int blockSize)

Constructor.

Parameters:

blockSize - block size

ShortBigList

public ShortBigList(java.util.Collection<java.lang.Short> coll)

Create new list with specified elements.

Parameters:

coll - collection with element

type - of elements stored in the list

Method Detail

of

public static IShortList of(short[] values)

of

public static IShortList of(java.lang.Short[] values)

of

public static IShortList of(java.util.List<java.lang.Short> values)

EMPTY

public static ShortBigList EMPTY()

Returns:

unmodifiable empty instance

create

public static ShortBigList create()

Create new list.

Parameters:

type - of elements stored in the list

Returns:

created list

create

public static ShortBigList create(java.util.Collection<java.lang.Short> 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 ShortBigList create(short... 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.

init

public void init(short... elems)

Initialize the list to have the specified elements.

Parameters:

elems - elements

init

public void init(java.util.Collection<java.lang.Short> that)

Initialize the list to have all elements in the specified collection.

Parameters:

that - collection

blockSize

public int blockSize()

Returns block size used for this ShortBigList.

Returns:

block size used for this ShortBigList

copy

public ShortBigList copy()

Returns a copy of this ShortBigList instance. The copy is realized by a copy-on-write approach so also really large lists can efficiently be copied. This method is identical to clone() except that the result is casted to ShortBigList.

Overrides:

copy in class IShortList

Returns:

a copy of this ShortBigList instance

See Also:

IShortList.clone()

clone

public java.lang.Object clone()

Returns a shallow copy of this ShortBigList instance The copy is realized by a copy-on-write approach so also really large lists can efficiently be copied.

Overrides:

clone in class IShortList

Returns:

a copy of this ShortBigList instance

See Also:

Cloneable

getDefaultElem

public short getDefaultElem()

size

public int size()

Specified by:

size in class IShortList

capacity

public int capacity()

Returns capacity of this list. Note that two lists are considered equal even if they have a distinct capacity. Also the capacity can be changed by operations like clone() etc. For ShortBigList, always -1 is returned.

Specified by:

capacity in class IShortList

Returns:

capacity of this list

unmodifiableList

public ShortBigList unmodifiableList()

Description copied from class: IShortList

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.

Specified by:

unmodifiableList in class IShortList

Returns:

an unmodifiable view of the specified list

trimToSize

public void trimToSize()

Pack as many elements in the blocks as allowed. An application can use this operation to minimize the storage of an instance.

Specified by:

trimToSize in class IShortList

sort

public void sort(int index,
        int len)

Description copied from class: IShortList

Sort specified elements in the list using the specified comparator.

Specified by:

sort in class IShortList

Parameters:

index - index of first element to sort

len - number of elements to sort

See Also:

Arrays.sort(long[])

binarySearch

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

Description copied from class: IShortList

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

Specified by:

binarySearch in class IShortList

Parameters:

index - index of first element to search

len - number of elements to search

key - the value to be searched for

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)