CompactHeapStringList (nd4j-common 1.0.0-beta2 API)

java.lang.Object
- org.nd4j.linalg.collection.CompactHeapStringList

All Implemented Interfaces:

Iterable<String>, Collection<String>, List<String>
```
public class CompactHeapStringList
extends Object
implements List<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

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)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, String element)`
`boolean`	`add(String s)`
`boolean`	`addAll(Collection<? extends String> c)`
`boolean`	`addAll(int index, Collection<? extends String> c)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`boolean`	`equals(Object o)`
`String`	`get(int index)`
`int`	`indexOf(Object o)`
`boolean`	`isEmpty()`
`Iterator<String>`	`iterator()`
`int`	`lastIndexOf(Object o)`
`ListIterator<String>`	`listIterator()`
`ListIterator<String>`	`listIterator(int index)`
`String`	`remove(int index)`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`String`	`set(int index, String element)`
`int`	`size()`
`List<String>`	`subList(int fromIndex, int toIndex)`
`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 Collection<String>
    
    Specified by:
    
    size in interface List<String>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<String>
    
    Specified by:
    
    isEmpty in interface List<String>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<String>
    
    Specified by:
    
    contains in interface List<String>
  - iterator
```
public Iterator<String> iterator()
```
    Specified by:
    
    iterator in interface Iterable<String>
    
    Specified by:
    
    iterator in interface Collection<String>
    
    Specified by:
    
    iterator in interface List<String>
  - toArray
```
public String[] toArray()
```
    Specified by:
    
    toArray in interface Collection<String>
    
    Specified by:
    
    toArray in interface List<String>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<String>
    
    Specified by:
    
    toArray in interface List<String>
  - add
```
public boolean add(String s)
```
    Specified by:
    
    add in interface Collection<String>
    
    Specified by:
    
    add in interface List<String>
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<String>
    
    Specified by:
    
    remove in interface List<String>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<String>
    
    Specified by:
    
    containsAll in interface List<String>
  - addAll
```
public boolean addAll(Collection<? extends String> c)
```
    Specified by:
    
    addAll in interface Collection<String>
    
    Specified by:
    
    addAll in interface List<String>
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends String> c)
```
    Specified by:
    
    addAll in interface List<String>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<String>
    
    Specified by:
    
    removeAll in interface List<String>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<String>
    
    Specified by:
    
    retainAll in interface List<String>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<String>
    
    Specified by:
    
    clear in interface List<String>
  - get
```
public String get(int index)
```
    Specified by:
    
    get in interface List<String>
  - set
```
public String set(int index,
                  String element)
```
    Specified by:
    
    set in interface List<String>
  - add
```
public void add(int index,
                String element)
```
    Specified by:
    
    add in interface List<String>
  - remove
```
public String remove(int index)
```
    Specified by:
    
    remove in interface List<String>
  - indexOf
```
public int indexOf(Object o)
```
    Specified by:
    
    indexOf in interface List<String>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<String>
  - listIterator
```
public ListIterator<String> listIterator()
```
    Specified by:
    
    listIterator in interface List<String>
  - listIterator
```
public ListIterator<String> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<String>
  - subList
```
public List<String> subList(int fromIndex,
                            int toIndex)
```
    Specified by:
    
    subList in interface List<String>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Collection<String>
    
    Specified by:
    
    equals in interface List<String>
    
    Overrides:
    
    equals in class Object

Class CompactHeapStringList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

DEFAULT_REALLOCATION_BLOCK_SIZE_BYTES

DEFAULT_INTEGER_REALLOCATION_BLOCK_SIZE_BYTES

Constructor Detail

CompactHeapStringList

CompactHeapStringList

Method Detail

size

isEmpty

contains

iterator

toArray

toArray

add

remove

containsAll

addAll

addAll

removeAll

retainAll

clear

get

set

add

remove

indexOf

lastIndexOf

listIterator

listIterator

subList

equals