org.nd4j.list

Class NDArrayList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<X>

org.nd4j.list.BaseNDArrayList<Double>

org.nd4j.list.NDArrayList

All Implemented Interfaces:

Iterable<Double>, Collection<Double>, List<Double>

public class NDArrayList
extends BaseNDArrayList<Double>

An ArrayList like implementation of List using INDArray as the backing data structure

Author:

Adam Gibson

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
NDArrayList()
NDArrayList(DataType dataType, int size)
NDArrayList(@NonNull INDArray container) Specify the underlying ndarray for this list.
NDArrayList(@NonNull INDArray container, int size) Specify the underlying ndarray for this list.
NDArrayList(int size) Initialize with the desired size.

Method Summary

Modifier and Type	Method and Description
boolean	add(Double aDouble)
void	add(int i, Double aDouble)
boolean	addAll(Collection<? extends Double> collection)
boolean	addAll(int i, Collection<? extends Double> collection)
INDArray	array() Get a view of the underlying array relative to the size of the actual array.
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> collection)
Double	get(int i)
int	indexOf(Object o)
boolean	isEmpty()
Iterator<Double>	iterator()
int	lastIndexOf(Object o)
ListIterator<Double>	listIterator()
ListIterator<Double>	listIterator(int i)
Double	remove(int i)
boolean	remove(Object o)
boolean	removeAll(Collection<?> collection)
boolean	retainAll(Collection<?> collection)
Double	set(int i, Double aDouble)
int	size()
List<Double>	subList(int i, int i1)
Object[]	toArray()
<T> T[]	toArray(T[] ts)
String	toString()

Methods inherited from class java.util.AbstractList

equals, hashCode, removeRange

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

NDArrayList

public NDArrayList(int size)

Initialize with the desired size. This will set the list.size() to be equal to the passed in size

Parameters:

size - the initial size of the array

NDArrayList

public NDArrayList(DataType dataType,
                   int size)

NDArrayList

public NDArrayList(@NonNull
                   @NonNull INDArray container,
                   int size)

Specify the underlying ndarray for this list.

Parameters:

container - the underlying array.

size - the initial size of the array. This will set list.size() to be equal to the passed in size.

NDArrayList

public NDArrayList()

NDArrayList

public NDArrayList(@NonNull
                   @NonNull INDArray container)

Specify the underlying ndarray for this list.

Parameters:

container - the underlying array.

Method Detail

array

public INDArray array()

Get a view of the underlying array relative to the size of the actual array. (Sometimes there are overflows in the internals but you want to use the internal INDArray for computing something directly, this gives you the relevant subset that reflects the content of the list)

Overrides:

array in class BaseNDArrayList<Double>

Returns:

the view of the underlying ndarray relative to the collection's real size

size

public int size()

Specified by:

size in interface Collection<Double>

Specified by:

size in interface List<Double>

Overrides:

size in class BaseNDArrayList<Double>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Double>

Specified by:

isEmpty in interface List<Double>

Overrides:

isEmpty in class BaseNDArrayList<Double>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<Double>

Specified by:

contains in interface List<Double>

Overrides:

contains in class BaseNDArrayList<Double>

iterator

public Iterator<Double> iterator()

Specified by:

iterator in interface Iterable<Double>

Specified by:

iterator in interface Collection<Double>

Specified by:

iterator in interface List<Double>

Overrides:

iterator in class BaseNDArrayList<Double>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<Double>

Specified by:

toArray in interface List<Double>

Overrides:

toArray in class BaseNDArrayList<Double>

toArray

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

Specified by:

toArray in interface Collection<Double>

Specified by:

toArray in interface List<Double>

Overrides:

toArray in class BaseNDArrayList<Double>

add

public boolean add(Double aDouble)

Specified by:

add in interface Collection<Double>

Specified by:

add in interface List<Double>

Overrides:

add in class BaseNDArrayList<Double>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<Double>

Specified by:

remove in interface List<Double>

Overrides:

remove in class BaseNDArrayList<Double>

containsAll

public boolean containsAll(Collection<?> collection)

Specified by:

containsAll in interface Collection<Double>

Specified by:

containsAll in interface List<Double>

Overrides:

containsAll in class BaseNDArrayList<Double>

addAll

public boolean addAll(Collection<? extends Double> collection)

Specified by:

addAll in interface Collection<Double>

Specified by:

addAll in interface List<Double>

Overrides:

addAll in class BaseNDArrayList<Double>

addAll

public boolean addAll(int i,
                      Collection<? extends Double> collection)

Specified by:

addAll in interface List<Double>

Overrides:

addAll in class BaseNDArrayList<Double>

removeAll

public boolean removeAll(Collection<?> collection)

Specified by:

removeAll in interface Collection<Double>

Specified by:

removeAll in interface List<Double>

Overrides:

removeAll in class BaseNDArrayList<Double>

retainAll

public boolean retainAll(Collection<?> collection)

Specified by:

retainAll in interface Collection<Double>

Specified by:

retainAll in interface List<Double>

Overrides:

retainAll in class BaseNDArrayList<Double>

clear

public void clear()

Specified by:

clear in interface Collection<Double>

Specified by:

clear in interface List<Double>

Overrides:

clear in class BaseNDArrayList<Double>

get

public Double get(int i)

Specified by:

get in interface List<Double>

Overrides:

get in class BaseNDArrayList<Double>

set

public Double set(int i,
                  Double aDouble)

Specified by:

set in interface List<Double>

Overrides:

set in class BaseNDArrayList<Double>

add

public void add(int i,
                Double aDouble)

Specified by:

add in interface List<Double>

Overrides:

add in class BaseNDArrayList<Double>

remove

public Double remove(int i)

Specified by:

remove in interface List<Double>

Overrides:

remove in class BaseNDArrayList<Double>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<Double>

Overrides:

indexOf in class BaseNDArrayList<Double>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<Double>

Overrides:

lastIndexOf in class BaseNDArrayList<Double>

listIterator

public ListIterator<Double> listIterator()

Specified by:

listIterator in interface List<Double>

Overrides:

listIterator in class BaseNDArrayList<Double>

listIterator

public ListIterator<Double> listIterator(int i)

Specified by:

listIterator in interface List<Double>

Overrides:

listIterator in class BaseNDArrayList<Double>

subList

public List<Double> subList(int i,
                            int i1)

Specified by:

subList in interface List<Double>

Overrides:

subList in class AbstractList<Double>

toString

public String toString()

Overrides:

toString in class BaseNDArrayList<Double>