io.improbable.keanu.tensor.jvm

Class JVMTensor<T,TENSOR extends Tensor<T,TENSOR>,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>>

java.lang.Object

io.improbable.keanu.tensor.jvm.JVMTensor<T,TENSOR,B>

All Implemented Interfaces:

Tensor<T,TENSOR>

Direct Known Subclasses:

GenericTensor, JVMBooleanTensor, JVMNumberTensor

public abstract class JVMTensor<T,TENSOR extends Tensor<T,TENSOR>,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>>
extends java.lang.Object
implements Tensor<T,TENSOR>

Nested Class Summary

Nested classes/interfaces inherited from interface io.improbable.keanu.tensor.Tensor

Tensor.FlattenedView<N>

Field Summary

Fields

Modifier and Type	Field and Description
protected B	buffer
protected long[]	shape
protected long[]	stride

Fields inherited from interface io.improbable.keanu.tensor.Tensor

ONE_BY_ONE_SHAPE, SCALAR_SHAPE, SCALAR_STRIDE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JVMTensor(B buffer, long[] shape, long[] stride)

Method Summary

Modifier and Type	Method and Description
static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> int	argCompare(B buffer, java.util.function.BiFunction<T,T,java.lang.Boolean> compareOp)
int	argCompare(java.util.function.BiFunction<T,T,java.lang.Boolean> compareOp)
IntegerTensor	argCompare(java.util.function.BiFunction<T,T,java.lang.Boolean> compareOp, int axis)
static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> IntegerTensor	argCompare(JVMBuffer.ArrayWrapperFactory<T,B> factory, B buffer, java.util.function.BiFunction<T,T,java.lang.Boolean> compareOp, long[] shape, long[] stride, int axis)
TENSOR	broadcast(long... toShape)
protected TENSOR	broadcastableBinaryOpWithAutoBroadcast(java.util.function.BiFunction<T,T,T> op, JVMTensor<T,TENSOR,B> right)
static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> ResultWrapper<T,B>	concat(JVMBuffer.ArrayWrapperFactory<T,B> factory, Tensor[] tensors, int dimension, java.util.List<B> toConcat)
static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> B	concatOnDimensionZero(JVMBuffer.ArrayWrapperFactory<T,B> factory, long[] concatShape, java.util.List<B> toConcat)
protected abstract TENSOR	create(B buffer, long[] shape, long[] stride)
TENSOR	diag()
static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> ResultWrapper<T,B>	diag(int rank, long[] shape, B buffer, JVMBuffer.ArrayWrapperFactory<T,B> factory)
boolean	equals(java.lang.Object o)
TENSOR	get(BooleanTensor booleanIndex)
protected abstract JVMBuffer.ArrayWrapperFactory<T,B>	getFactory()
long	getLength()
int	getRank()
long[]	getShape()
long[]	getStride() Returns the stride for each dimension of the tensor (based on C ordering).
int	hashCode()
BooleanTensor	isApply(java.util.function.Function<T,java.lang.Boolean> op)
TENSOR	permute(int... rearrange)
static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> ResultWrapper<T,B>	permute(JVMBuffer.ArrayWrapperFactory<T,B> factory, B buffer, long[] shape, long[] stride, int... rearrange)
TENSOR	reshape(long... newShape)
protected abstract TENSOR	set(B buffer, long[] shape, long[] stride)
TENSOR	slice(int dimension, long index)
static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> ResultWrapper<T,B>	slice(JVMBuffer.ArrayWrapperFactory<T,B> factory, B buffer, IndexMapper indexMapper)
TENSOR	slice(Slicer slicer)
java.util.List<TENSOR>	split(int dimension, long... splitAtIndices)
static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> java.util.List<ResultWrapper<T,B>>	split(JVMBuffer.ArrayWrapperFactory<T,B> factory, B fromBuffer, long[] shape, long[] stride, int dimension, long... splitAtIndices)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.improbable.keanu.tensor.Tensor

asFlatArray, asFlatList, create, createFilled, duplicate, elementwiseEquals, elementwiseEquals, elementwiseEquals, expandDims, getFlattenedView, getValue, hasSameShapeAs, hasSameShapeAs, isLengthOne, isMatrix, isScalar, isVector, moveAxis, scalar, scalar, setValue, slice, sliceAlongDimension, squeeze, swapAxis, take, transpose

Field Detail

buffer

protected B extends JVMBuffer.PrimitiveArrayWrapper<T,B> buffer

shape

protected long[] shape

stride

protected long[] stride

Constructor Detail

JVMTensor

protected JVMTensor(B buffer,
                    long[] shape,
                    long[] stride)

Method Detail

getRank

public int getRank()

Specified by:

getRank in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

getShape

public long[] getShape()

Specified by:

getShape in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

getStride

public long[] getStride()

Description copied from interface: Tensor

Returns the stride for each dimension of the tensor (based on C ordering).

The stride is the distance you'd move in a flat representation of the tensor for each index within that dimension EG) For a 2x2 Tensor the Tensor would be laid out (in C order): [{0, 0}, {0, 1}, {1, 0}, {1, 1}] Thus the stride array would be provided as: [2, 1]

Specified by:

getStride in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

Returns:

The stride array for this tensor

getLength

public long getLength()

Specified by:

getLength in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

get

public TENSOR get(BooleanTensor booleanIndex)

Specified by:

get in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

Parameters:

booleanIndex - a boolean tensor the same shape as this tensor where true is specified if the element should be kept and false if not.

Returns:

a vector with the values that align with true from the boolean index.

diag

public TENSOR diag()

Specified by:

diag in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

diag

public static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> ResultWrapper<T,B> diag(int rank,
                                                                                         long[] shape,
                                                                                         B buffer,
                                                                                         JVMBuffer.ArrayWrapperFactory<T,B> factory)

permute

public TENSOR permute(int... rearrange)

Specified by:

permute in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

permute

public static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> ResultWrapper<T,B> permute(JVMBuffer.ArrayWrapperFactory<T,B> factory,
                                                                                            B buffer,
                                                                                            long[] shape,
                                                                                            long[] stride,
                                                                                            int... rearrange)

split

public java.util.List<TENSOR> split(int dimension,
                                    long... splitAtIndices)

Specified by:

split in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

Parameters:

dimension - the dimension to split on

splitAtIndices - the indices that the dimension to split on should be split on

Returns:

pieces of the tensor split in the order specified by splitAtIndices. To get pieces that encompasses the entire tensor, the last index in the splitAtIndices must be the length of the dimension being split on.

e.g A = [ 1, 2, 3, 4, 5, 6 7, 8, 9, 1, 2, 3 ]

A.split(0, [1]) gives List([1, 2, 3, 4, 5, 6]) A.split(0, [1, 2]) gives List([1, 2, 3, 4, 5, 6], [7, 8, 9, 1, 2, 3]

A.split(1, [1, 3, 6]) gives List( [1, [2, 3 , [4, 5, 6, 7] 8, 9] 1, 2, 3] )

split

public static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> java.util.List<ResultWrapper<T,B>> split(JVMBuffer.ArrayWrapperFactory<T,B> factory,
                                                                                                          B fromBuffer,
                                                                                                          long[] shape,
                                                                                                          long[] stride,
                                                                                                          int dimension,
                                                                                                          long... splitAtIndices)

slice

public TENSOR slice(int dimension,
                    long index)

Specified by:

slice in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

slice

public TENSOR slice(Slicer slicer)

Specified by:

slice in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

slice

public static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> ResultWrapper<T,B> slice(JVMBuffer.ArrayWrapperFactory<T,B> factory,
                                                                                          B buffer,
                                                                                          IndexMapper indexMapper)

concat

public static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> ResultWrapper<T,B> concat(JVMBuffer.ArrayWrapperFactory<T,B> factory,
                                                                                           Tensor[] tensors,
                                                                                           int dimension,
                                                                                           java.util.List<B> toConcat)

concatOnDimensionZero

public static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> B concatOnDimensionZero(JVMBuffer.ArrayWrapperFactory<T,B> factory,
                                                                                         long[] concatShape,
                                                                                         java.util.List<B> toConcat)

broadcastableBinaryOpWithAutoBroadcast

protected TENSOR broadcastableBinaryOpWithAutoBroadcast(java.util.function.BiFunction<T,T,T> op,
                                                        JVMTensor<T,TENSOR,B> right)

reshape

public TENSOR reshape(long... newShape)

Specified by:

reshape in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

broadcast

public TENSOR broadcast(long... toShape)

Specified by:

broadcast in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>

argCompare

public IntegerTensor argCompare(java.util.function.BiFunction<T,T,java.lang.Boolean> compareOp,
                                int axis)

argCompare

public static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> IntegerTensor argCompare(JVMBuffer.ArrayWrapperFactory<T,B> factory,
                                                                                          B buffer,
                                                                                          java.util.function.BiFunction<T,T,java.lang.Boolean> compareOp,
                                                                                          long[] shape,
                                                                                          long[] stride,
                                                                                          int axis)

argCompare

public int argCompare(java.util.function.BiFunction<T,T,java.lang.Boolean> compareOp)

argCompare

public static <T,B extends JVMBuffer.PrimitiveArrayWrapper<T,B>> int argCompare(B buffer,
                                                                                java.util.function.BiFunction<T,T,java.lang.Boolean> compareOp)

isApply

public BooleanTensor isApply(java.util.function.Function<T,java.lang.Boolean> op)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

create

protected abstract TENSOR create(B buffer,
                                 long[] shape,
                                 long[] stride)

set

protected abstract TENSOR set(B buffer,
                              long[] shape,
                              long[] stride)

getFactory

protected abstract JVMBuffer.ArrayWrapperFactory<T,B> getFactory()