org.nd4j.linalg.collection

Class CompactHeapStringList

java.lang.Object

org.nd4j.linalg.collection.CompactHeapStringList

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>, java.util.Collection<java.lang.String>, java.util.List<java.lang.String>

public class CompactHeapStringList
extends java.lang.Object
implements java.util.List<java.lang.String>

A List<String> that stores all contents in a single char[], to avoid the GC load for a large number of String objects.

Some restrictions to be aware of with the current implementation:
- The list is intended to be write-once (append only), except for clear() operations. That is: new Strings can be added at the end, but they cannot be replaced or removed.
- There is a limit of a maximum of Integer.MAX_VALUE/2 = 1073741823 Strings
- There is a limit of the maximum total characters of Integer.MAX_VALUE (i.e., 2147483647 chars). This corresponds to a maximum of approximately 4GB of Strings.

Author:

Alex Black

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INTEGER_REALLOCATION_BLOCK_SIZE_BYTES
static int	DEFAULT_REALLOCATION_BLOCK_SIZE_BYTES

Constructor Summary

Constructors

Constructor and Description
CompactHeapStringList()
CompactHeapStringList(int reallocationBlockSizeBytes, int intReallocationBlockSizeBytes)

Method Summary

Modifier and Type	Method and Description
void	add(int index, java.lang.String element)
boolean	add(java.lang.String s)
boolean	addAll(java.util.Collection<? extends java.lang.String> c)
boolean	addAll(int index, java.util.Collection<? extends java.lang.String> c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
boolean	equals(java.lang.Object o)
java.lang.String	get(int index)
int	indexOf(java.lang.Object o)
boolean	isEmpty()
java.util.Iterator<java.lang.String>	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator<java.lang.String>	listIterator()
java.util.ListIterator<java.lang.String>	listIterator(int index)
java.lang.String	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
java.lang.String	set(int index, java.lang.String element)
int	size()
java.util.List<java.lang.String>	subList(int fromIndex, int toIndex)
java.lang.String[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

DEFAULT_REALLOCATION_BLOCK_SIZE_BYTES

public static final int DEFAULT_REALLOCATION_BLOCK_SIZE_BYTES

See Also:

Constant Field Values

DEFAULT_INTEGER_REALLOCATION_BLOCK_SIZE_BYTES

public static final int DEFAULT_INTEGER_REALLOCATION_BLOCK_SIZE_BYTES

See Also:

Constant Field Values

Constructor Detail

CompactHeapStringList

public CompactHeapStringList()

CompactHeapStringList

public CompactHeapStringList(int reallocationBlockSizeBytes,
                             int intReallocationBlockSizeBytes)

Parameters:

reallocationBlockSizeBytes - Number of bytes by which to increase the char[], when allocating a new storage array

intReallocationBlockSizeBytes - Number of bytes by which to increase the int[], when allocating a new storage array

Method Detail

size

public int size()

Specified by:

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

Specified by:

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

isEmpty

public boolean isEmpty()

Specified by:

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

Specified by:

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

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<java.lang.String>

Specified by:

contains in interface java.util.List<java.lang.String>

iterator

public java.util.Iterator<java.lang.String> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

Specified by:

iterator in interface java.util.Collection<java.lang.String>

Specified by:

iterator in interface java.util.List<java.lang.String>

toArray

public java.lang.String[] toArray()

Specified by:

toArray in interface java.util.Collection<java.lang.String>

Specified by:

toArray in interface java.util.List<java.lang.String>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<java.lang.String>

Specified by:

toArray in interface java.util.List<java.lang.String>

add

public boolean add(java.lang.String s)

Specified by:

add in interface java.util.Collection<java.lang.String>

Specified by:

add in interface java.util.List<java.lang.String>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<java.lang.String>

Specified by:

remove in interface java.util.List<java.lang.String>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<java.lang.String>

Specified by:

containsAll in interface java.util.List<java.lang.String>

addAll

public boolean addAll(java.util.Collection<? extends java.lang.String> c)

Specified by:

addAll in interface java.util.Collection<java.lang.String>

Specified by:

addAll in interface java.util.List<java.lang.String>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends java.lang.String> c)

Specified by:

addAll in interface java.util.List<java.lang.String>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<java.lang.String>

Specified by:

removeAll in interface java.util.List<java.lang.String>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<java.lang.String>

Specified by:

retainAll in interface java.util.List<java.lang.String>

clear

public void clear()

Specified by:

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

Specified by:

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

get

public java.lang.String get(int index)

Specified by:

get in interface java.util.List<java.lang.String>

set

public java.lang.String set(int index,
                            java.lang.String element)

Specified by:

set in interface java.util.List<java.lang.String>

add

public void add(int index,
                java.lang.String element)

Specified by:

add in interface java.util.List<java.lang.String>

remove

public java.lang.String remove(int index)

Specified by:

remove in interface java.util.List<java.lang.String>

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<java.lang.String>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<java.lang.String>

listIterator

public java.util.ListIterator<java.lang.String> listIterator()

Specified by:

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

listIterator

public java.util.ListIterator<java.lang.String> listIterator(int index)

Specified by:

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

subList

public java.util.List<java.lang.String> subList(int fromIndex,
                                                int toIndex)

Specified by:

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

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Specified by:

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

Overrides:

equals in class java.lang.Object