org.nd4j.autodiff.samediff

Interface ArrayHolder

All Known Implementing Classes:

SingleThreadArrayHolder, ThreadSafeArrayHolder

public interface ArrayHolder

Method Summary

Modifier and Type	Method and Description
Collection<String>	arrayNames()
INDArray	getArray(String name)
boolean	hasArray(String name)
void	initFrom(ArrayHolder arrayHolder) Initialize from the specified array holder.
INDArray	removeArray(String name) Remove the array from the ArrayHolder, returning it (if it exists)
void	rename(String from, String to) Rename the entry with the specified name
void	setArray(String name, INDArray array) Set the array for the specified name (new array, or replace if it already exists)
int	size()

Method Detail

hasArray

boolean hasArray(String name)

Returns:

True if an array by that name exists

getArray

INDArray getArray(String name)

Parameters:

name - Name of the array to get

Returns:

The array, or null if no array with that name exists

setArray

void setArray(String name,
              INDArray array)

Set the array for the specified name (new array, or replace if it already exists)

Parameters:

name - Name of the array

array - Array to set

removeArray

INDArray removeArray(String name)

Remove the array from the ArrayHolder, returning it (if it exists)

Parameters:

name - Name of the array to return

Returns:

The now-removed array

size

int size()

Returns:

Number of arrays in the ArrayHolder

initFrom

void initFrom(ArrayHolder arrayHolder)

Initialize from the specified array holder. This clears all internal arrays, and adds all arrays from the specified array holder

Parameters:

arrayHolder - Array holder to initialize this based on

arrayNames

Collection<String> arrayNames()

Returns:

Names of the arrays currently in the ArrayHolder

rename

void rename(String from,
            String to)

Rename the entry with the specified name

Parameters:

from - Original name

to - New name