it.unimi.dsi.fastutil.chars

Class CharArrayList

java.lang.Object

java.util.AbstractCollection<java.lang.Character>

it.unimi.dsi.fastutil.chars.AbstractCharCollection

it.unimi.dsi.fastutil.chars.AbstractCharList

it.unimi.dsi.fastutil.chars.CharArrayList

All Implemented Interfaces:

CharCollection, CharIterable, CharList, CharStack, it.unimi.dsi.fastutil.Stack<java.lang.Character>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<java.util.List<? extends java.lang.Character>>, java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.List<java.lang.Character>, java.util.RandomAccess

public class CharArrayList
extends AbstractCharList
implements java.util.RandomAccess, java.lang.Cloneable, java.io.Serializable

A type-specific array-based list; provides some additional methods that use polymorphism to avoid (un)boxing.

This class implements a lightweight, fast, open, optimized, reuse-oriented version of array-based lists. Instances of this class represent a list with an array that is enlarged as needed when new entries are created (by increasing its current length by 50%), but is never made smaller (even on a clear()). A family of trimming methods lets you control the size of the backing array; this is particularly useful if you reuse instances of this class. Range checks are equivalent to those of java.util's classes, but they are delayed as much as possible. The backing array is exposed by the elements() method.

This class implements the bulk methods removeElements(), addElements() and getElements() using high-performance system calls (e.g., System.arraycopy()) instead of expensive loops.

See Also:

ArrayList, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.chars.AbstractCharList

AbstractCharList.CharRandomAccessSubList, AbstractCharList.CharSubList

Field Summary

Fields

Modifier and Type	Field and Description
protected char[]	a The backing array.
static int	DEFAULT_INITIAL_CAPACITY The initial default capacity of an array list.
protected int	size The current actual size of the list (never greater than the backing-array length).

Constructor Summary

Constructors

Modifier	Constructor and Description
	CharArrayList() Creates a new array list with DEFAULT_INITIAL_CAPACITY capacity.
	CharArrayList(char[] a) Creates a new array list and fills it with the elements of a given array.
protected	CharArrayList(char[] a, boolean wrapped) Creates a new array list using a given array.
	CharArrayList(char[] a, int offset, int length) Creates a new array list and fills it with the elements of a given array.
	CharArrayList(CharCollection c) Creates a new array list and fills it with a given type-specific collection.
	CharArrayList(it.unimi.dsi.fastutil.chars.CharIterator i) Creates a new array list and fills it with the elements returned by a type-specific iterator..
	CharArrayList(CharList l) Creates a new array list and fills it with a given type-specific list.
	CharArrayList(java.util.Collection<? extends java.lang.Character> c) Creates a new array list and fills it with a given collection.
	CharArrayList(int capacity) Creates a new array list with given capacity.
	CharArrayList(java.util.Iterator<? extends java.lang.Character> i) Creates a new array list and fills it with the elements returned by an iterator..

Method Summary

Modifier and Type	Method and Description
boolean	add(char k) Ensures that this collection contains the specified element (optional operation).
void	add(int index, char k) Inserts the specified element at the specified position in this list (optional operation).
boolean	addAll(int index, CharCollection c) Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).
boolean	addAll(int index, CharList l) Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).
void	addElements(int index, char[] a, int offset, int length) Adds elements to this type-specific list using optimized system calls.
void	clear()
CharArrayList	clone()
int	compareTo(CharArrayList l) Compares this array list to another array list.
int	compareTo(java.util.List<? extends java.lang.Character> l) Compares this list to another object.
char[]	elements() Returns the backing array of this list.
void	ensureCapacity(int capacity) Ensures that this array list can contain the given number of entries without resizing.
boolean	equals(CharArrayList l) Compares this type-specific array list to another one.
boolean	equals(java.lang.Object o)
void	forEach(it.unimi.dsi.fastutil.chars.CharConsumer action) Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
char	getChar(int index) Returns the element at the specified position in this list.
void	getElements(int from, char[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.
int	indexOf(char k) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
boolean	isEmpty()
int	lastIndexOf(char k) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
CharListIterator	listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.
static CharArrayList	of() Creates a new empty array list.
static CharArrayList	of(char... init) Creates an array list using an array of elements.
boolean	rem(char k) Removes a single instance of the specified element from this collection, if it is present (optional operation).
boolean	removeAll(CharCollection c) Remove from this collection all elements in the given type-specific collection.
char	removeChar(int index) Removes the element at the specified position in this list (optional operation).
void	removeElements(int from, int to) Removes elements of this type-specific list using optimized system calls.
boolean	removeIf(CharPredicate filter) Remove from this collection all elements which satisfy the given predicate.
char	set(int index, char k) Replaces the element at the specified position in this list with the specified element (optional operation).
void	setElements(int index, char[] a, int offset, int length) Sets elements to this type-specific list using optimized system calls.
int	size()
void	size(int size) Sets the size of this list.
void	sort(it.unimi.dsi.fastutil.chars.CharComparator comp) Sort a list using a type-specific comparator.
it.unimi.dsi.fastutil.chars.CharSpliterator	spliterator() Returns a type-specific spliterator on the elements of this list.
CharList	subList(int from, int to) Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
char[]	toArray(char[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
void	trim() Trims this array list so that the capacity is equal to the size.
void	trim(int n) Trims the backing array if it is too large.
void	unstableSort(it.unimi.dsi.fastutil.chars.CharComparator comp) Sorts this list using a sort not assured to be stable.
static CharArrayList	wrap(char[] a) Wraps a given array into an array list.
static CharArrayList	wrap(char[] a, int length) Wraps a given array into an array list of given size.

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharList

addAll, addAll, addAll, addElements, contains, ensureIndex, ensureRestrictedIndex, hashCode, iterator, listIterator, peekChar, popChar, push, toCharArray, topChar, toString

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection

add, contains, containsAll, containsAll, remove, removeAll, retainAll, retainAll, toCharArray

Methods inherited from class java.util.AbstractCollection

toArray, toArray

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharList

add, add, addAll, contains, get, indexOf, lastIndexOf, of, of, of, remove, remove, replaceAll, replaceAll, replaceAll, set, setElements, setElements, sort, unstableSort

Methods inherited from interface java.util.List

containsAll, removeAll, retainAll, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection

containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeIf, removeIf, retainAll, stream, toCharArray

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable

forEach, forEach

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharStack

peek, pop, push, top

Field Detail

DEFAULT_INITIAL_CAPACITY

public static final int DEFAULT_INITIAL_CAPACITY

The initial default capacity of an array list.

See Also:

Constant Field Values

a

protected transient char[] a

The backing array.

size

protected int size

The current actual size of the list (never greater than the backing-array length).

Constructor Detail

CharArrayList

protected CharArrayList(char[] a,
                        boolean wrapped)

Creates a new array list using a given array.

This constructor is only meant to be used by the wrapping methods.

Parameters:

a - the array that will be used to back this array list.

CharArrayList

public CharArrayList(int capacity)

Creates a new array list with given capacity.

Parameters:

capacity - the initial capacity of the array list (may be 0).

CharArrayList

public CharArrayList()

Creates a new array list with DEFAULT_INITIAL_CAPACITY capacity.

CharArrayList

public CharArrayList(java.util.Collection<? extends java.lang.Character> c)

Creates a new array list and fills it with a given collection.

Parameters:

c - a collection that will be used to fill the array list.

CharArrayList

public CharArrayList(CharCollection c)

Creates a new array list and fills it with a given type-specific collection.

Parameters:

c - a type-specific collection that will be used to fill the array list.

CharArrayList

public CharArrayList(CharList l)

Creates a new array list and fills it with a given type-specific list.

Parameters:

l - a type-specific list that will be used to fill the array list.

CharArrayList

public CharArrayList(char[] a)

Creates a new array list and fills it with the elements of a given array.

Parameters:

a - an array whose elements will be used to fill the array list.

CharArrayList

public CharArrayList(char[] a,
                     int offset,
                     int length)

Creates a new array list and fills it with the elements of a given array.

Parameters:

a - an array whose elements will be used to fill the array list.

offset - the first element to use.

length - the number of elements to use.

CharArrayList

public CharArrayList(java.util.Iterator<? extends java.lang.Character> i)

Creates a new array list and fills it with the elements returned by an iterator..

Parameters:

i - an iterator whose returned elements will fill the array list.

CharArrayList

public CharArrayList(it.unimi.dsi.fastutil.chars.CharIterator i)

Creates a new array list and fills it with the elements returned by a type-specific iterator..

Parameters:

i - a type-specific iterator whose returned elements will fill the array list.

Method Detail

elements

public char[] elements()

Returns the backing array of this list.

Returns:

the backing array.

wrap

public static CharArrayList wrap(char[] a,
                                 int length)

Wraps a given array into an array list of given size.

Note it is guaranteed that the type of the array returned by elements() will be the same (see the comments in the class documentation).

Parameters:

a - an array to wrap.

length - the length of the resulting array list.

Returns:

a new array list of the given size, wrapping the given array.

wrap

public static CharArrayList wrap(char[] a)

Wraps a given array into an array list.

Note it is guaranteed that the type of the array returned by elements() will be the same (see the comments in the class documentation).

Parameters:

a - an array to wrap.

Returns:

a new array list wrapping the given array.

of

public static CharArrayList of()

Creates a new empty array list.

Specified by:

of in interface CharList

Returns:

a new empty array list.

of

public static CharArrayList of(char... init)

Creates an array list using an array of elements.

Specified by:

of in interface CharList

Parameters:

init - a the array the will become the new backing array of the array list.

Returns:

a new array list backed by the given array.

See Also:

wrap(char[], int)

ensureCapacity

public void ensureCapacity(int capacity)

Ensures that this array list can contain the given number of entries without resizing.

Parameters:

capacity - the new minimum capacity for this array list.

add

public void add(int index,
                char k)

Description copied from class: AbstractCharList

Inserts the specified element at the specified position in this list (optional operation).

Specified by:

add in interface CharList

Overrides:

add in class AbstractCharList

See Also:

List.add(int,Object)

add

public boolean add(char k)

Description copied from class: AbstractCharList

Ensures that this collection contains the specified element (optional operation).

Specified by:

add in interface CharCollection

Specified by:

add in interface CharList

Overrides:

add in class AbstractCharList

See Also:

Collection.add(Object)

getChar

public char getChar(int index)

Description copied from interface: CharList

Returns the element at the specified position in this list.

Specified by:

getChar in interface CharList

See Also:

List.get(int)

indexOf

public int indexOf(char k)

Description copied from interface: CharList

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

Specified by:

indexOf in interface CharList

Overrides:

indexOf in class AbstractCharList

See Also:

List.indexOf(Object)

lastIndexOf

public int lastIndexOf(char k)

Description copied from interface: CharList

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.

Specified by:

lastIndexOf in interface CharList

Overrides:

lastIndexOf in class AbstractCharList

See Also:

List.lastIndexOf(Object)

removeChar

public char removeChar(int index)

Description copied from class: AbstractCharList

Removes the element at the specified position in this list (optional operation).

Specified by:

removeChar in interface CharList

Overrides:

removeChar in class AbstractCharList

See Also:

List.remove(int)

rem

public boolean rem(char k)

Description copied from class: AbstractCharList

Removes a single instance of the specified element from this collection, if it is present (optional operation).

Specified by:

rem in interface CharCollection

Overrides:

rem in class AbstractCharList

See Also:

List.remove(Object)

set

public char set(int index,
                char k)

Description copied from class: AbstractCharList

Replaces the element at the specified position in this list with the specified element (optional operation).

Specified by:

set in interface CharList

Overrides:

set in class AbstractCharList

See Also:

List.set(int,Object)

clear

public void clear()

Description copied from class: AbstractCharList

Specified by:

clear in interface java.util.Collection<java.lang.Character>

Specified by:

clear in interface java.util.List<java.lang.Character>

Overrides:

clear in class AbstractCharList

size

public int size()

Specified by:

size in interface java.util.Collection<java.lang.Character>

Specified by:

size in interface java.util.List<java.lang.Character>

Specified by:

size in class java.util.AbstractCollection<java.lang.Character>

size

public void size(int size)

Description copied from interface: CharList

Sets the size of this list.

If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/null/false.

Specified by:

size in interface CharList

Overrides:

size in class AbstractCharList

Parameters:

size - the new size.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface it.unimi.dsi.fastutil.Stack<java.lang.Character>

Specified by:

isEmpty in interface java.util.Collection<java.lang.Character>

Specified by:

isEmpty in interface java.util.List<java.lang.Character>

Overrides:

isEmpty in class java.util.AbstractCollection<java.lang.Character>

trim

public void trim()

Trims this array list so that the capacity is equal to the size.

See Also:

ArrayList.trimToSize()

trim

public void trim(int n)

Trims the backing array if it is too large. If the current array length is smaller than or equal to n, this method does nothing. Otherwise, it trims the array length to the maximum between n and size().

This method is useful when reusing lists. Clearing a list leaves the array length untouched. If you are reusing a list many times, you can call this method with a typical size to avoid keeping around a very large array just because of a few large transient lists.

Parameters:

n - the threshold for the trimming.

subList

public CharList subList(int from,
                        int to)

Description copied from interface: CharList

Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.

Specified by:

subList in interface CharList

Specified by:

subList in interface java.util.List<java.lang.Character>

Overrides:

subList in class AbstractCharList

See Also:

List.subList(int,int)

getElements

public void getElements(int from,
                        char[] a,
                        int offset,
                        int length)

Copies element of this type-specific list into the given array using optimized system calls.

Specified by:

getElements in interface CharList

Overrides:

getElements in class AbstractCharList

Parameters:

from - the start index (inclusive).

a - the destination array.

offset - the offset into the destination array where to store the first element copied.

length - the number of elements to be copied.

removeElements

public void removeElements(int from,
                           int to)

Removes elements of this type-specific list using optimized system calls.

Specified by:

removeElements in interface CharList

Overrides:

removeElements in class AbstractCharList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

public void addElements(int index,
                        char[] a,
                        int offset,
                        int length)

Adds elements to this type-specific list using optimized system calls.

Specified by:

addElements in interface CharList

Overrides:

addElements in class AbstractCharList

Parameters:

index - the index at which to add elements.

a - the array containing the elements.

offset - the offset of the first element to add.

length - the number of elements to add.

setElements

public void setElements(int index,
                        char[] a,
                        int offset,
                        int length)

Sets elements to this type-specific list using optimized system calls.

Specified by:

setElements in interface CharList

Overrides:

setElements in class AbstractCharList

Parameters:

index - the index at which to start setting elements.

a - the array containing the elements.

offset - the offset of the first element to add.

length - the number of elements to add.

forEach

public void forEach(it.unimi.dsi.fastutil.chars.CharConsumer action)

Description copied from class: AbstractCharList

Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.

Specified by:

forEach in interface CharIterable

Overrides:

forEach in class AbstractCharList

Parameters:

action - the action to be performed for each element.

See Also:

Iterable.forEach(java.util.function.Consumer)

addAll

public boolean addAll(int index,
                      CharCollection c)

Description copied from interface: CharList

Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).

Specified by:

addAll in interface CharList

Overrides:

addAll in class AbstractCharList

See Also:

List.addAll(int,java.util.Collection)

addAll

public boolean addAll(int index,
                      CharList l)

Description copied from interface: CharList

Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).

Specified by:

addAll in interface CharList

See Also:

List.addAll(int,Collection)

removeAll

public boolean removeAll(CharCollection c)

Description copied from interface: CharCollection

Remove from this collection all elements in the given type-specific collection.

Specified by:

removeAll in interface CharCollection

Overrides:

removeAll in class AbstractCharCollection

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

See Also:

Collection.removeAll(Collection)

removeIf

public boolean removeIf(CharPredicate filter)

Description copied from interface: CharCollection

Remove from this collection all elements which satisfy the given predicate.

Specified by:

removeIf in interface CharCollection

Parameters:

filter - a predicate which returns true for elements to be removed.

Returns:

true if any elements were removed.

See Also:

Collection.removeIf(java.util.function.Predicate)

toArray

public char[] toArray(char[] a)

Description copied from interface: CharCollection

Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.

Specified by:

toArray in interface CharCollection

Overrides:

toArray in class AbstractCharList

Parameters:

a - if this array is big enough, it will be used to store this collection.

Returns:

a primitive type array containing the items of this collection.

See Also:

Collection.toArray(Object[])

listIterator

public CharListIterator listIterator(int index)

Description copied from class: AbstractCharList

Returns a type-specific list iterator on the list starting at a given index.

Specified by:

listIterator in interface CharList

Specified by:

listIterator in interface java.util.List<java.lang.Character>

Overrides:

listIterator in class AbstractCharList

See Also:

List.listIterator(int)

spliterator

public it.unimi.dsi.fastutil.chars.CharSpliterator spliterator()

Returns a type-specific spliterator on the elements of this list.

List spliterators must report at least Spliterator.SIZED and Spliterator.ORDERED.

See List.spliterator() for more documentation on the requirements of the returned spliterator.

The returned spliterator is late-binding; it will track structural changes after the current index, up until the first trySplit(), at which point the maximum index will be fixed.
Structural changes before the current index or after the first trySplit() will result in unspecified behavior.

Specified by:

spliterator in interface CharCollection

Specified by:

spliterator in interface CharIterable

Specified by:

spliterator in interface CharList

Specified by:

spliterator in interface java.lang.Iterable<java.lang.Character>

Specified by:

spliterator in interface java.util.Collection<java.lang.Character>

Specified by:

spliterator in interface java.util.List<java.lang.Character>

Returns:

a type-specific spliterator on the elements of this collection.

sort

public void sort(it.unimi.dsi.fastutil.chars.CharComparator comp)

Description copied from interface: CharList

Sort a list using a type-specific comparator.

Pass null to sort using natural ordering.

Specified by:

sort in interface CharList

See Also:

List.sort(java.util.Comparator)

unstableSort

public void unstableSort(it.unimi.dsi.fastutil.chars.CharComparator comp)

Description copied from interface: CharList

Sorts this list using a sort not assured to be stable.

Pass null to sort using natural ordering.

This differs from List.sort(java.util.Comparator) in that the results are not assured to be stable, but may be a bit faster.

Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.

Specified by:

unstableSort in interface CharList

clone

public CharArrayList clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(CharArrayList l)

Compares this type-specific array list to another one.

Parameters:

l - a type-specific array list.

Returns:

true if the argument contains the same elements of this type-specific array list.

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection<java.lang.Character>

Specified by:

equals in interface java.util.List<java.lang.Character>

Overrides:

equals in class AbstractCharList

compareTo

public int compareTo(CharArrayList l)

Compares this array list to another array list.

Parameters:

l - an array list.

Returns:

a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.

compareTo

public int compareTo(java.util.List<? extends java.lang.Character> l)

Description copied from class: AbstractCharList

Compares this list to another object. If the argument is a List, this method performs a lexicographical comparison; otherwise, it throws a ClassCastException.

Specified by:

compareTo in interface java.lang.Comparable<java.util.List<? extends java.lang.Character>>

Overrides:

compareTo in class AbstractCharList

Parameters:

l - a list.

Returns:

if the argument is a List, a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.