jsat.utils

Class IntList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Integer>

jsat.utils.IntList

All Implemented Interfaces:

Serializable, Iterable<Integer>, Collection<Integer>, List<Integer>

public class IntList
extends AbstractList<Integer>
implements Serializable

Provides a modifiable implementation of a List using a int array. This provides considerable memory efficency improvements over using an ArrayList to store integers. Null is not allowed into the list.

Author:

Edward Raff

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
IntList() Creates a new IntList
IntList(Collection<Integer> c)
IntList(int capacity) Creates a new IntList with the given initial capacity

Method Summary

Modifier and Type	Method and Description
boolean	add(int e) Operates exactly as add(java.lang.Integer)
boolean	add(Integer e)
void	add(int index, int element) Operates exactly as add(int, java.lang.Integer)
void	add(int index, Integer element)
boolean	addAll(Collection<? extends Integer> c)
void	clear()
Integer	get(int index)
int	getI(int index) Operates exactly as get(int)
Integer	remove(int index)
int	set(int index, int element) Operates exactly as set(int, java.lang.Integer)
Integer	set(int index, Integer element)
int	size()
void	sort() Efficiently sorts this list of integers using Arrays.sort(int[]).
static List<Integer>	unmodifiableView(int[] array, int length) Creates and returns an unmodifiable view of the given int array that requires only a small object allocation.
static IntList	view(int[] array, int length) Creates and returns a view of the given int array that requires only a small object allocation.

Methods inherited from class java.util.AbstractList

addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

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

contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

IntList

public IntList()

Creates a new IntList

IntList

public IntList(int capacity)

Creates a new IntList with the given initial capacity

Parameters:

capacity - the starting internal storage space size

IntList

public IntList(Collection<Integer> c)

Method Detail

clear

public void clear()

Specified by:

clear in interface Collection<Integer>

Specified by:

clear in interface List<Integer>

Overrides:

clear in class AbstractList<Integer>

set

public int set(int index,
               int element)

Operates exactly as set(int, java.lang.Integer)

Parameters:

index - the index to set

element - the value to set

Returns:

the previous value at the index

set

public Integer set(int index,
                   Integer element)

Specified by:

set in interface List<Integer>

Overrides:

set in class AbstractList<Integer>

add

public void add(int index,
                int element)

Operates exactly as add(int, java.lang.Integer)

Parameters:

index - the index to add the value into

element - the value to add

add

public void add(int index,
                Integer element)

Specified by:

add in interface List<Integer>

Overrides:

add in class AbstractList<Integer>

add

public boolean add(int e)

Operates exactly as add(java.lang.Integer)

Parameters:

e - the value to add

Returns:

true if it was added, false otherwise

add

public boolean add(Integer e)

Specified by:

add in interface Collection<Integer>

Specified by:

add in interface List<Integer>

Overrides:

add in class AbstractList<Integer>

getI

public int getI(int index)

Operates exactly as get(int)

Parameters:

index - the index of the value to get

Returns:

the value at the index

get

public Integer get(int index)

Specified by:

get in interface List<Integer>

Specified by:

get in class AbstractList<Integer>

size

public int size()

Specified by:

size in interface Collection<Integer>

Specified by:

size in interface List<Integer>

Specified by:

size in class AbstractCollection<Integer>

addAll

public boolean addAll(Collection<? extends Integer> c)

Specified by:

addAll in interface Collection<Integer>

Specified by:

addAll in interface List<Integer>

Overrides:

addAll in class AbstractCollection<Integer>

remove

public Integer remove(int index)

Specified by:

remove in interface List<Integer>

Overrides:

remove in class AbstractList<Integer>

sort

public void sort()

Efficiently sorts this list of integers using Arrays.sort(int[]).

unmodifiableView

public static List<Integer> unmodifiableView(int[] array,
                                             int length)

Creates and returns an unmodifiable view of the given int array that requires only a small object allocation.

Parameters:

array - the array to wrap into an unmodifiable list

length - the number of values of the array to use, starting from zero

Returns:

an unmodifiable list view of the array

view

public static IntList view(int[] array,
                           int length)

Creates and returns a view of the given int array that requires only a small object allocation. Changes to the list will be reflected in the array up to a point. If the modification would require increasing the capacity of the array, a new array will be allocated - at which point operations will no longer be reflected in the original array.

Parameters:

array - the array to wrap by an IntList object

length - the initial length of the list

Returns:

an IntList backed by the given array, unless modified to the point of requiring the allocation of a new array