org.nd4j.list.matrix

Class MatrixBaseNDArrayList<X extends BaseNDArrayList>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<X>

org.nd4j.list.matrix.MatrixBaseNDArrayList<X>

All Implemented Interfaces:

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

Direct Known Subclasses:

FloatMatrixNDArrayList, IntMatrixNDArrayList, MatrixNDArrayList

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

An ArrayList like implementation of List using INDArray as the backing data structure. Creates an internal container of ndarray lists with a matrix shape.

Author:

Adam Gibson

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
MatrixBaseNDArrayList()

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)
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)
Number	getEntry(int i, int j) Get entry i,j in the matrix
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

Constructor Detail

MatrixBaseNDArrayList

public MatrixBaseNDArrayList()

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)

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 BaseNDArrayList>

Specified by:

size in interface List<X extends BaseNDArrayList>

Specified by:

size in class AbstractCollection<X extends BaseNDArrayList>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<X extends BaseNDArrayList>

Specified by:

isEmpty in interface List<X extends BaseNDArrayList>

Overrides:

isEmpty in class AbstractCollection<X extends BaseNDArrayList>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<X extends BaseNDArrayList>

Specified by:

contains in interface List<X extends BaseNDArrayList>

Overrides:

contains in class AbstractCollection<X extends BaseNDArrayList>

iterator

public Iterator<X> iterator()

Specified by:

iterator in interface Iterable<X extends BaseNDArrayList>

Specified by:

iterator in interface Collection<X extends BaseNDArrayList>

Specified by:

iterator in interface List<X extends BaseNDArrayList>

Overrides:

iterator in class AbstractList<X extends BaseNDArrayList>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<X extends BaseNDArrayList>

Specified by:

toArray in interface List<X extends BaseNDArrayList>

Overrides:

toArray in class AbstractCollection<X extends BaseNDArrayList>

toArray

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

Specified by:

toArray in interface Collection<X extends BaseNDArrayList>

Specified by:

toArray in interface List<X extends BaseNDArrayList>

Overrides:

toArray in class AbstractCollection<X extends BaseNDArrayList>

add

public boolean add(X aX)

Specified by:

add in interface Collection<X extends BaseNDArrayList>

Specified by:

add in interface List<X extends BaseNDArrayList>

Overrides:

add in class AbstractList<X extends BaseNDArrayList>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<X extends BaseNDArrayList>

Specified by:

remove in interface List<X extends BaseNDArrayList>

Overrides:

remove in class AbstractCollection<X extends BaseNDArrayList>

containsAll

public boolean containsAll(Collection<?> collection)

Specified by:

containsAll in interface Collection<X extends BaseNDArrayList>

Specified by:

containsAll in interface List<X extends BaseNDArrayList>

Overrides:

containsAll in class AbstractCollection<X extends BaseNDArrayList>

addAll

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

Specified by:

addAll in interface Collection<X extends BaseNDArrayList>

Specified by:

addAll in interface List<X extends BaseNDArrayList>

Overrides:

addAll in class AbstractCollection<X extends BaseNDArrayList>

addAll

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

Specified by:

addAll in interface List<X extends BaseNDArrayList>

Overrides:

addAll in class AbstractList<X extends BaseNDArrayList>

removeAll

public boolean removeAll(Collection<?> collection)

Specified by:

removeAll in interface Collection<X extends BaseNDArrayList>

Specified by:

removeAll in interface List<X extends BaseNDArrayList>

Overrides:

removeAll in class AbstractCollection<X extends BaseNDArrayList>

retainAll

public boolean retainAll(Collection<?> collection)

Specified by:

retainAll in interface Collection<X extends BaseNDArrayList>

Specified by:

retainAll in interface List<X extends BaseNDArrayList>

Overrides:

retainAll in class AbstractCollection<X extends BaseNDArrayList>

clear

public void clear()

Specified by:

clear in interface Collection<X extends BaseNDArrayList>

Specified by:

clear in interface List<X extends BaseNDArrayList>

Overrides:

clear in class AbstractList<X extends BaseNDArrayList>

get

public X get(int i)

Specified by:

get in interface List<X extends BaseNDArrayList>

Specified by:

get in class AbstractList<X extends BaseNDArrayList>

set

public X set(int i,
             X aX)

Specified by:

set in interface List<X extends BaseNDArrayList>

Overrides:

set in class AbstractList<X extends BaseNDArrayList>

add

public void add(int i,
                X aX)

Specified by:

add in interface List<X extends BaseNDArrayList>

Overrides:

add in class AbstractList<X extends BaseNDArrayList>

remove

public X remove(int i)

Specified by:

remove in interface List<X extends BaseNDArrayList>

Overrides:

remove in class AbstractList<X extends BaseNDArrayList>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<X extends BaseNDArrayList>

Overrides:

indexOf in class AbstractList<X extends BaseNDArrayList>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<X extends BaseNDArrayList>

Overrides:

lastIndexOf in class AbstractList<X extends BaseNDArrayList>

listIterator

public ListIterator<X> listIterator()

Specified by:

listIterator in interface List<X extends BaseNDArrayList>

Overrides:

listIterator in class AbstractList<X extends BaseNDArrayList>

listIterator

public ListIterator<X> listIterator(int i)

Specified by:

listIterator in interface List<X extends BaseNDArrayList>

Overrides:

listIterator in class AbstractList<X extends BaseNDArrayList>

toString

public String toString()

Overrides:

toString in class AbstractCollection<X extends BaseNDArrayList>

getEntry

public Number getEntry(int i,
                       int j)

Get entry i,j in the matrix

Parameters:

i - the row

j - the column

Returns:

the entry at i,j if it exists