io.improbable.keanu.tensor

Interface NumberTensor<N extends java.lang.Number,T extends NumberTensor<N,T>>

All Superinterfaces:

io.improbable.keanu.kotlin.NumberOperators<T>, Tensor<N>

All Known Subinterfaces:

DoubleTensor, IntegerTensor

All Known Implementing Classes:

Nd4jDoubleTensor, Nd4jIntegerTensor, ScalarDoubleTensor, ScalarIntegerTensor

public interface NumberTensor<N extends java.lang.Number,T extends NumberTensor<N,T>>
extends Tensor<N>, io.improbable.keanu.kotlin.NumberOperators<T>

Nested Class Summary

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

Tensor.FlattenedView<T>

Field Summary

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

ONE_BY_ONE_SHAPE, SCALAR_SHAPE, SCALAR_STRIDE

Method Summary

Modifier and Type	Method and Description
T	abs()
T	absInPlace()
T	apply(java.util.function.Function<N,N> function)
T	applyInPlace(java.util.function.Function<N,N> function)
int	argMax() Find the index into the flattened array of the tensor of the largest value, e.g.
IntegerTensor	argMax(int axis) Find the indices into the tensor of the largest values in a specified axis (dimension), e.g.
T	diag()
T	divInPlace(T that)
T	getGreaterThanMask(T greaterThanThis)
T	getGreaterThanOrEqualToMask(T greaterThanThis)
T	getLessThanMask(T lessThanThis)
T	getLessThanOrEqualToMask(T lessThanThis)
BooleanTensor	greaterThan(T value)
BooleanTensor	greaterThanOrEqual(T value)
BooleanTensor	lessThan(T value)
BooleanTensor	lessThanOrEqual(T value)
T	matrixMultiply(T value)
T	minusInPlace(T that)
T	plusInPlace(T that)
T	powInPlace(T exponent)
T	setWithMask(T mask, N value)
T	setWithMaskInPlace(T mask, N value)
N	sum()
T	sum(int... overDimensions)
T	tensorMultiply(T value, int[] dimLeft, int[] dimsRight)
T	timesInPlace(T that)
DoubleTensor	toDouble()
IntegerTensor	toInteger()
T	transpose()
T	unaryMinusInPlace()

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

asFlatArray, asFlatDoubleArray, asFlatIntegerArray, asFlatList, create, createFilled, duplicate, elementwiseEquals, elementwiseEquals, elementwiseEquals, getFlattenedView, getLength, getRank, getShape, getValue, getValue, hasSameShapeAs, hasSameShapeAs, isLengthOne, isMatrix, isScalar, isShapePlaceholder, isVector, reshape, scalar, scalar, setValue, slice

Methods inherited from interface io.improbable.keanu.kotlin.NumberOperators

div, minus, plus, pow, times, unaryMinus

Method Detail

sum

N sum()

toDouble

DoubleTensor toDouble()

toInteger

IntegerTensor toInteger()

diag

T diag()

transpose

T transpose()

sum

T sum(int... overDimensions)

matrixMultiply

T matrixMultiply(T value)

tensorMultiply

T tensorMultiply(T value,
                 int[] dimLeft,
                 int[] dimsRight)

abs

T abs()

argMax

int argMax()

Find the index into the flattened array of the tensor of the largest value, e.g.

 DoubleTensor tensor = DoubleTensor.arange(0, 6).reshape(2, 3);
 // [[0., 1., 2.],
 //  [3., 4., 5.]]
 IntegerTensor max = tensor.argMax();
 // [[5]]
 

Returns:

A scalar tensor with the index of the largest value. If there are multiple largest values, it will be the first index.

argMax

IntegerTensor argMax(int axis)

Find the indices into the tensor of the largest values in a specified axis (dimension), e.g.

 DoubleTensor tensor = DoubleTensor.arange(0, 6).reshape(2, 3);
 // [[0., 1., 2.],
 //  [3., 4., 5.]]
 IntegerTensor maxesFor0 = tensor.argMax(0);
 // [[1, 1, 1]]
 IntegerTensor maxFor1 = tensor.argMax(1);
 // [[2, 2]]
 

Parameters:

axis - The axis (dimension) to find the largest values in

Returns:

A tensor where each value is the location of the maximum value in the vector at that location in the specified dimension in the original tensor. If there are multiple largest values in this vector, it will be the first index.

See Also:

An article about argmax over an axis in numpy

getGreaterThanMask

T getGreaterThanMask(T greaterThanThis)

getGreaterThanOrEqualToMask

T getGreaterThanOrEqualToMask(T greaterThanThis)

getLessThanMask

T getLessThanMask(T lessThanThis)

getLessThanOrEqualToMask

T getLessThanOrEqualToMask(T lessThanThis)

setWithMaskInPlace

T setWithMaskInPlace(T mask,
                     N value)

setWithMask

T setWithMask(T mask,
              N value)

apply

T apply(java.util.function.Function<N,N> function)

minusInPlace

T minusInPlace(T that)

plusInPlace

T plusInPlace(T that)

timesInPlace

T timesInPlace(T that)

divInPlace

T divInPlace(T that)

powInPlace

T powInPlace(T exponent)

unaryMinusInPlace

T unaryMinusInPlace()

absInPlace

T absInPlace()

applyInPlace

T applyInPlace(java.util.function.Function<N,N> function)

lessThan

BooleanTensor lessThan(T value)

lessThanOrEqual

BooleanTensor lessThanOrEqual(T value)

greaterThan

BooleanTensor greaterThan(T value)

greaterThanOrEqual

BooleanTensor greaterThanOrEqual(T value)