org.nd4j.list

Class BaseNDArrayList<X extends Number>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<X>

org.nd4j.list.BaseNDArrayList<X>

All Implemented Interfaces:

Iterable<X>, Collection<X>, List<X>

Direct Known Subclasses:

FloatNDArrayList, IntNDArrayList, NDArrayList

public abstract class BaseNDArrayList<X extends Number>
extends AbstractList<X>

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

Author:

Adam Gibson

Field Summary

Fields

Modifier and Type	Field and Description
protected INDArray	container
protected int	size

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
BaseNDArrayList()
BaseNDArrayList(INDArray container) Specify the underlying ndarray for this list.

Method Summary

Modifier and Type	Method and Description
void	add(int i, X aX)
boolean	add(X aX)
boolean	addAll(Collection<? extends X> collection)
boolean	addAll(int i, Collection<? extends X> collection)
void	allocateWithSize(int size) Allocates the container and this list with the given size
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)
X	get(int i)
int	indexOf(Object o)
boolean	isEmpty()
Iterator<X>	iterator()
int	lastIndexOf(Object o)
ListIterator<X>	listIterator()
ListIterator<X>	listIterator(int i)
X	remove(int i)
boolean	remove(Object o)
boolean	removeAll(Collection<?> collection)
boolean	retainAll(Collection<?> collection)
X	set(int i, X aX)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] ts)
String	toString()

Methods inherited from class java.util.AbstractList

equals, hashCode, removeRange, subList

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

Field Detail

container

protected INDArray container

size

protected int size

Constructor Detail

BaseNDArrayList

public BaseNDArrayList()

BaseNDArrayList

public BaseNDArrayList(INDArray container)

Specify the underlying ndarray for this list.

Parameters:

container - the underlying array.

Method Detail

allocateWithSize

public void allocateWithSize(int size)

Allocates the container and this list with the given size

Parameters:

size - the size to allocate with

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)

Returns:

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

size

public int size()

Specified by:

size in interface Collection<X extends Number>

Specified by:

size in interface List<X extends Number>

Specified by:

size in class AbstractCollection<X extends Number>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<X extends Number>

Specified by:

isEmpty in interface List<X extends Number>

Overrides:

isEmpty in class AbstractCollection<X extends Number>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<X extends Number>

Specified by:

contains in interface List<X extends Number>

Overrides:

contains in class AbstractCollection<X extends Number>

iterator

public Iterator<X> iterator()

Specified by:

iterator in interface Iterable<X extends Number>

Specified by:

iterator in interface Collection<X extends Number>

Specified by:

iterator in interface List<X extends Number>

Overrides:

iterator in class AbstractList<X extends Number>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<X extends Number>

Specified by:

toArray in interface List<X extends Number>

Overrides:

toArray in class AbstractCollection<X extends Number>

toArray

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

Specified by:

toArray in interface Collection<X extends Number>

Specified by:

toArray in interface List<X extends Number>

Overrides:

toArray in class AbstractCollection<X extends Number>

add

public boolean add(X aX)

Specified by:

add in interface Collection<X extends Number>

Specified by:

add in interface List<X extends Number>

Overrides:

add in class AbstractList<X extends Number>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<X extends Number>

Specified by:

remove in interface List<X extends Number>

Overrides:

remove in class AbstractCollection<X extends Number>

containsAll

public boolean containsAll(Collection<?> collection)

Specified by:

containsAll in interface Collection<X extends Number>

Specified by:

containsAll in interface List<X extends Number>

Overrides:

containsAll in class AbstractCollection<X extends Number>

addAll

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

Specified by:

addAll in interface Collection<X extends Number>

Specified by:

addAll in interface List<X extends Number>

Overrides:

addAll in class AbstractCollection<X extends Number>

addAll

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

Specified by:

addAll in interface List<X extends Number>

Overrides:

addAll in class AbstractList<X extends Number>

removeAll

public boolean removeAll(Collection<?> collection)

Specified by:

removeAll in interface Collection<X extends Number>

Specified by:

removeAll in interface List<X extends Number>

Overrides:

removeAll in class AbstractCollection<X extends Number>

retainAll

public boolean retainAll(Collection<?> collection)

Specified by:

retainAll in interface Collection<X extends Number>

Specified by:

retainAll in interface List<X extends Number>

Overrides:

retainAll in class AbstractCollection<X extends Number>

clear

public void clear()

Specified by:

clear in interface Collection<X extends Number>

Specified by:

clear in interface List<X extends Number>

Overrides:

clear in class AbstractList<X extends Number>

get

public X get(int i)

Specified by:

get in interface List<X extends Number>

Specified by:

get in class AbstractList<X extends Number>

set

public X set(int i,
             X aX)

Specified by:

set in interface List<X extends Number>

Overrides:

set in class AbstractList<X extends Number>

add

public void add(int i,
                X aX)

Specified by:

add in interface List<X extends Number>

Overrides:

add in class AbstractList<X extends Number>

remove

public X remove(int i)

Specified by:

remove in interface List<X extends Number>

Overrides:

remove in class AbstractList<X extends Number>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<X extends Number>

Overrides:

indexOf in class AbstractList<X extends Number>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<X extends Number>

Overrides:

lastIndexOf in class AbstractList<X extends Number>

listIterator

public ListIterator<X> listIterator()

Specified by:

listIterator in interface List<X extends Number>

Overrides:

listIterator in class AbstractList<X extends Number>

listIterator

public ListIterator<X> listIterator(int i)

Specified by:

listIterator in interface List<X extends Number>

Overrides:

listIterator in class AbstractList<X extends Number>

toString

public String toString()

Overrides:

toString in class AbstractCollection<X extends Number>