org.tensorflow.ndarray.impl

Class AbstractNdArray<T,U extends NdArray<T>>

java.lang.Object

org.tensorflow.ndarray.impl.AbstractNdArray<T,U>

All Implemented Interfaces:

NdArray<T>

Direct Known Subclasses:

AbstractDenseNdArray

public abstract class AbstractNdArray<T,U extends NdArray<T>>
extends Object
implements NdArray<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected DimensionalSpace	dimensions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNdArray(DimensionalSpace dimensions)

Method Summary

Modifier and Type	Method and Description
DimensionalSpace	dimensions()
boolean	equals(Object obj) Checks equality between n-dimensional arrays.
int	hashCode()
NdArraySequence<U>	scalars() Returns a sequence of all scalars in this array.
Shape	shape()
abstract U	slice(long position, DimensionalSpace dimensions)
protected void	slowCopyTo(NdArray<T> array)
protected boolean	slowEquals(NdArray<?> array)
protected int	slowHashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tensorflow.ndarray.NdArray

copyTo, elements, get, getObject, rank, read, set, setObject, size, slice, write

Field Detail

dimensions

protected final DimensionalSpace dimensions

Constructor Detail

AbstractNdArray

protected AbstractNdArray(DimensionalSpace dimensions)

Method Detail

slice

public abstract U slice(long position,
                        DimensionalSpace dimensions)

dimensions

public DimensionalSpace dimensions()

shape

public Shape shape()

Specified by:

shape in interface NdArray<T>

Returns:

the shape of this N-dimensional array

scalars

public NdArraySequence<U> scalars()

Description copied from interface: NdArray

Returns a sequence of all scalars in this array.

This is equivalent to call elements(shape().numDimensions() - 1)

Specified by:

scalars in interface NdArray<T>

Returns:

an NdArray sequence

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Description copied from interface: NdArray

Checks equality between n-dimensional arrays.

An array is equal to another object if this object is another NdArray of the same shape, type and the elements are equal and in the same order. For example:

 IntNdArray array = NdArrays.ofInts(Shape.of(2, 2))
    .set(NdArrays.vectorOf(1, 2), 0)
    .set(NdArrays.vectorOf(3, 4), 1);

 assertEquals(array, StdArrays.ndCopyOf(new int[][] {{1, 2}, {3, 4}}));  // true
 assertEquals(array, StdArrays.ndCopyOf(new Integer[][] {{1, 2}, {3, 4}}));  // true, as Integers are equal to ints
 assertNotEquals(array, NdArrays.vectorOf(1, 2, 3, 4));  // false, different shapes
 assertNotEquals(array, StdArrays.ndCopyOf(new int[][] {{3, 4}, {1, 2}}));  // false, different order
 assertNotEquals(array, StdArrays.ndCopyOf(new long[][] {{1L, 2L}, {3L, 4L}}));  // false, different types
 

Note that the computation required to verify equality between two arrays can be expensive in some cases and therefore, it is recommended to not use this method in a critical path where performances matter.

Specified by:

equals in interface NdArray<T>

Overrides:

equals in class Object

Parameters:

obj - object to compare this array with

Returns:

true if this array is equal to the provided object

slowCopyTo

protected void slowCopyTo(NdArray<T> array)

slowHashCode

protected int slowHashCode()

slowEquals

protected boolean slowEquals(NdArray<?> array)