io.improbable.keanu.tensor.intgr

Class ScalarIntegerTensor

java.lang.Object

io.improbable.keanu.tensor.intgr.ScalarIntegerTensor

All Implemented Interfaces:

io.improbable.keanu.kotlin.IntegerOperators<IntegerTensor>, io.improbable.keanu.kotlin.NumberOperators<IntegerTensor>, FixedPointTensor<java.lang.Integer,IntegerTensor>, IntegerTensor, NumberTensor<java.lang.Integer,IntegerTensor>, Tensor<java.lang.Integer,IntegerTensor>

public class ScalarIntegerTensor
extends java.lang.Object
implements IntegerTensor

Nested Class Summary

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

Tensor.FlattenedView<N>

Field Summary

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

ONE_BY_ONE_SHAPE, SCALAR_SHAPE, SCALAR_STRIDE

Constructor Summary

Constructors

Constructor and Description
ScalarIntegerTensor(int value)
ScalarIntegerTensor(long[] shape)

Method Summary

Modifier and Type	Method and Description
IntegerTensor	absInPlace()
IntegerTensor	applyInPlace(java.util.function.Function<java.lang.Integer,java.lang.Integer> 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.
int	argMin()
IntegerTensor	argMin(int axis)
java.lang.Integer[]	asFlatArray()
double[]	asFlatDoubleArray()
int[]	asFlatIntegerArray()
java.lang.Integer	average()
IntegerTensor	broadcast(long... toShape)
IntegerTensor	clampInPlace(IntegerTensor min, IntegerTensor max)
IntegerTensor	cumProdInPlace(int dimension)
IntegerTensor	cumSumInPlace(int dimension)
IntegerTensor	diag()
IntegerTensor	divInPlace(java.lang.Integer that)
IntegerTensor	divInPlace(IntegerTensor that)
IntegerTensor	duplicate()
BooleanTensor	elementwiseEquals(java.lang.Integer value)
BooleanTensor	elementwiseEquals(Tensor that)
boolean	equals(java.lang.Object o)
boolean	equalsWithinEpsilon(IntegerTensor other, java.lang.Integer epsilon)
IntegerTensor	get(BooleanTensor booleanIndex)
Tensor.FlattenedView<java.lang.Integer>	getFlattenedView()
long	getLength()
int	getRank()
long[]	getShape()
long[]	getStride() Returns the stride for each dimension of the tensor (based on C ordering).
BooleanTensor	greaterThan(java.lang.Integer value)
BooleanTensor	greaterThan(IntegerTensor that)
IntegerTensor	greaterThanMask(IntegerTensor greaterThanThis)
BooleanTensor	greaterThanOrEqual(java.lang.Integer value)
BooleanTensor	greaterThanOrEqual(IntegerTensor that)
IntegerTensor	greaterThanOrEqualToMask(IntegerTensor greaterThanOrEqualToThis)
int	hashCode()
BooleanTensor	lessThan(java.lang.Integer that)
BooleanTensor	lessThan(IntegerTensor that)
IntegerTensor	lessThanMask(IntegerTensor lessThanThis)
BooleanTensor	lessThanOrEqual(java.lang.Integer that)
BooleanTensor	lessThanOrEqual(IntegerTensor that)
IntegerTensor	lessThanOrEqualToMask(IntegerTensor lessThanOrEqualsThis)
IntegerTensor	matrixMultiply(IntegerTensor that)
java.lang.Integer	max()
IntegerTensor	maxInPlace(IntegerTensor max)
java.lang.Integer	min()
IntegerTensor	minInPlace(IntegerTensor min)
IntegerTensor	minusInPlace(java.lang.Integer that)
IntegerTensor	minusInPlace(IntegerTensor that)
IntegerTensor	modInPlace(java.lang.Integer that)
IntegerTensor	modInPlace(IntegerTensor that)
IntegerTensor	permute(int... rearrange)
IntegerTensor	plusInPlace(java.lang.Integer that)
IntegerTensor	plusInPlace(IntegerTensor that)
IntegerTensor	powInPlace(java.lang.Integer exponent)
IntegerTensor	powInPlace(IntegerTensor exponent)
java.lang.Integer	product()
IntegerTensor	product(int... overDimensions)
IntegerTensor	reshape(long... newShape)
IntegerTensor	reverseDivInPlace(java.lang.Integer value)
IntegerTensor	reverseDivInPlace(IntegerTensor value)
IntegerTensor	reverseMinusInPlace(java.lang.Integer value)
IntegerTensor	reverseMinusInPlace(IntegerTensor value)
IntegerTensor	safeLogTimesInPlace(IntegerTensor y)
java.lang.Integer	scalar()
IntegerTensor	setAllInPlace(java.lang.Integer value)
IntegerTensor	setWithMaskInPlace(IntegerTensor withMask, java.lang.Integer valueToApply)
IntegerTensor	slice(int dimension, long index)
IntegerTensor	slice(Slicer slicer)
java.util.List<IntegerTensor>	split(int dimension, long... splitAtIndices)
java.lang.Integer	standardDeviation()
java.lang.Integer	sum()
IntegerTensor	sum(int... overDimensions)
IntegerTensor	take(long... index)
IntegerTensor	tensorMultiply(IntegerTensor that, int[] dimsLeft, int[] dimsRight)
IntegerTensor	timesInPlace(java.lang.Integer that)
IntegerTensor	timesInPlace(IntegerTensor that)
DoubleTensor	toDouble()
IntegerTensor	toInteger()
java.lang.String	toString()
IntegerTensor	transpose()
IntegerTensor	unaryMinusInPlace()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.improbable.keanu.tensor.intgr.IntegerTensor

concat, concat, create, create, create, create, create, div, eye, max, min, minus, ones, plus, pow, reverseDiv, reverseMinus, scalar, stack, times, vector, zeros

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

mod, mod

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

abs, apply, clamp, cumProd, cumSum, div, div, max, min, minus, minus, plus, plus, pow, pow, reverseDiv, reverseDiv, reverseMinus, reverseMinus, safeLogTimes, setWithMask, times, times, unaryMinus

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

asFlatList, create, createFilled, elementwiseEquals, expandDims, getValue, hasSameShapeAs, hasSameShapeAs, isLengthOne, isMatrix, isScalar, isVector, moveAxis, setValue, slice, sliceAlongDimension, squeeze, swapAxis

Constructor Detail

ScalarIntegerTensor

public ScalarIntegerTensor(int value)

ScalarIntegerTensor

public ScalarIntegerTensor(long[] shape)

Method Detail

getRank

public int getRank()

Specified by:

getRank in interface Tensor<java.lang.Integer,IntegerTensor>

getShape

public long[] getShape()

Specified by:

getShape in interface Tensor<java.lang.Integer,IntegerTensor>

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<java.lang.Integer,IntegerTensor>

Returns:

The stride array for this tensor

getLength

public long getLength()

Specified by:

getLength in interface Tensor<java.lang.Integer,IntegerTensor>

get

public IntegerTensor get(BooleanTensor booleanIndex)

Specified by:

get in interface Tensor<java.lang.Integer,IntegerTensor>

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.

duplicate

public IntegerTensor duplicate()

Specified by:

duplicate in interface Tensor<java.lang.Integer,IntegerTensor>

sum

public java.lang.Integer sum()

Specified by:

sum in interface NumberTensor<java.lang.Integer,IntegerTensor>

toDouble

public DoubleTensor toDouble()

Specified by:

toDouble in interface NumberTensor<java.lang.Integer,IntegerTensor>

toInteger

public IntegerTensor toInteger()

Specified by:

toInteger in interface NumberTensor<java.lang.Integer,IntegerTensor>

scalar

public java.lang.Integer scalar()

Specified by:

scalar in interface Tensor<java.lang.Integer,IntegerTensor>

reshape

public IntegerTensor reshape(long... newShape)

Specified by:

reshape in interface Tensor<java.lang.Integer,IntegerTensor>

permute

public IntegerTensor permute(int... rearrange)

Specified by:

permute in interface Tensor<java.lang.Integer,IntegerTensor>

broadcast

public IntegerTensor broadcast(long... toShape)

Specified by:

broadcast in interface Tensor<java.lang.Integer,IntegerTensor>

diag

public IntegerTensor diag()

Specified by:

diag in interface Tensor<java.lang.Integer,IntegerTensor>

transpose

public IntegerTensor transpose()

Specified by:

transpose in interface Tensor<java.lang.Integer,IntegerTensor>

sum

public IntegerTensor sum(int... overDimensions)

Specified by:

sum in interface NumberTensor<java.lang.Integer,IntegerTensor>

cumSumInPlace

public IntegerTensor cumSumInPlace(int dimension)

Specified by:

cumSumInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

product

public java.lang.Integer product()

Specified by:

product in interface NumberTensor<java.lang.Integer,IntegerTensor>

product

public IntegerTensor product(int... overDimensions)

Specified by:

product in interface NumberTensor<java.lang.Integer,IntegerTensor>

cumProdInPlace

public IntegerTensor cumProdInPlace(int dimension)

Specified by:

cumProdInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

equalsWithinEpsilon

public boolean equalsWithinEpsilon(IntegerTensor other,
                                   java.lang.Integer epsilon)

Specified by:

equalsWithinEpsilon in interface NumberTensor<java.lang.Integer,IntegerTensor>

matrixMultiply

public IntegerTensor matrixMultiply(IntegerTensor that)

Specified by:

matrixMultiply in interface NumberTensor<java.lang.Integer,IntegerTensor>

tensorMultiply

public IntegerTensor tensorMultiply(IntegerTensor that,
                                    int[] dimsLeft,
                                    int[] dimsRight)

Specified by:

tensorMultiply in interface NumberTensor<java.lang.Integer,IntegerTensor>

greaterThanMask

public IntegerTensor greaterThanMask(IntegerTensor greaterThanThis)

Specified by:

greaterThanMask in interface NumberTensor<java.lang.Integer,IntegerTensor>

greaterThanOrEqualToMask

public IntegerTensor greaterThanOrEqualToMask(IntegerTensor greaterThanOrEqualToThis)

Specified by:

greaterThanOrEqualToMask in interface NumberTensor<java.lang.Integer,IntegerTensor>

lessThanMask

public IntegerTensor lessThanMask(IntegerTensor lessThanThis)

Specified by:

lessThanMask in interface NumberTensor<java.lang.Integer,IntegerTensor>

lessThanOrEqualToMask

public IntegerTensor lessThanOrEqualToMask(IntegerTensor lessThanOrEqualsThis)

Specified by:

lessThanOrEqualToMask in interface NumberTensor<java.lang.Integer,IntegerTensor>

setWithMaskInPlace

public IntegerTensor setWithMaskInPlace(IntegerTensor withMask,
                                        java.lang.Integer valueToApply)

Specified by:

setWithMaskInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

slice

public IntegerTensor slice(int dimension,
                           long index)

Specified by:

slice in interface Tensor<java.lang.Integer,IntegerTensor>

slice

public IntegerTensor slice(Slicer slicer)

Specified by:

slice in interface Tensor<java.lang.Integer,IntegerTensor>

take

public IntegerTensor take(long... index)

Specified by:

take in interface Tensor<java.lang.Integer,IntegerTensor>

split

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

Specified by:

split in interface Tensor<java.lang.Integer,IntegerTensor>

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] )

minusInPlace

public IntegerTensor minusInPlace(java.lang.Integer that)

Specified by:

minusInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

plusInPlace

public IntegerTensor plusInPlace(java.lang.Integer that)

Specified by:

plusInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

timesInPlace

public IntegerTensor timesInPlace(java.lang.Integer that)

Specified by:

timesInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

divInPlace

public IntegerTensor divInPlace(java.lang.Integer that)

Specified by:

divInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

powInPlace

public IntegerTensor powInPlace(IntegerTensor exponent)

Specified by:

powInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

powInPlace

public IntegerTensor powInPlace(java.lang.Integer exponent)

Specified by:

powInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

average

public java.lang.Integer average()

Specified by:

average in interface NumberTensor<java.lang.Integer,IntegerTensor>

standardDeviation

public java.lang.Integer standardDeviation()

Specified by:

standardDeviation in interface NumberTensor<java.lang.Integer,IntegerTensor>

minusInPlace

public IntegerTensor minusInPlace(IntegerTensor that)

Specified by:

minusInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

reverseMinusInPlace

public IntegerTensor reverseMinusInPlace(IntegerTensor value)

Specified by:

reverseMinusInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

reverseMinusInPlace

public IntegerTensor reverseMinusInPlace(java.lang.Integer value)

Specified by:

reverseMinusInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

plusInPlace

public IntegerTensor plusInPlace(IntegerTensor that)

Specified by:

plusInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

timesInPlace

public IntegerTensor timesInPlace(IntegerTensor that)

Specified by:

timesInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

divInPlace

public IntegerTensor divInPlace(IntegerTensor that)

Specified by:

divInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

reverseDivInPlace

public IntegerTensor reverseDivInPlace(java.lang.Integer value)

Specified by:

reverseDivInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

reverseDivInPlace

public IntegerTensor reverseDivInPlace(IntegerTensor value)

Specified by:

reverseDivInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

unaryMinusInPlace

public IntegerTensor unaryMinusInPlace()

Specified by:

unaryMinusInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

absInPlace

public IntegerTensor absInPlace()

Specified by:

absInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

applyInPlace

public IntegerTensor applyInPlace(java.util.function.Function<java.lang.Integer,java.lang.Integer> function)

Specified by:

applyInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

setAllInPlace

public IntegerTensor setAllInPlace(java.lang.Integer value)

Specified by:

setAllInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

safeLogTimesInPlace

public IntegerTensor safeLogTimesInPlace(IntegerTensor y)

Specified by:

safeLogTimesInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

lessThan

public BooleanTensor lessThan(java.lang.Integer that)

Specified by:

lessThan in interface NumberTensor<java.lang.Integer,IntegerTensor>

lessThanOrEqual

public BooleanTensor lessThanOrEqual(java.lang.Integer that)

Specified by:

lessThanOrEqual in interface NumberTensor<java.lang.Integer,IntegerTensor>

lessThan

public BooleanTensor lessThan(IntegerTensor that)

Specified by:

lessThan in interface NumberTensor<java.lang.Integer,IntegerTensor>

lessThanOrEqual

public BooleanTensor lessThanOrEqual(IntegerTensor that)

Specified by:

lessThanOrEqual in interface NumberTensor<java.lang.Integer,IntegerTensor>

greaterThan

public BooleanTensor greaterThan(java.lang.Integer value)

Specified by:

greaterThan in interface NumberTensor<java.lang.Integer,IntegerTensor>

greaterThanOrEqual

public BooleanTensor greaterThanOrEqual(java.lang.Integer value)

Specified by:

greaterThanOrEqual in interface NumberTensor<java.lang.Integer,IntegerTensor>

minInPlace

public IntegerTensor minInPlace(IntegerTensor min)

Specified by:

minInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

clampInPlace

public IntegerTensor clampInPlace(IntegerTensor min,
                                  IntegerTensor max)

Specified by:

clampInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

maxInPlace

public IntegerTensor maxInPlace(IntegerTensor max)

Specified by:

maxInPlace in interface NumberTensor<java.lang.Integer,IntegerTensor>

min

public java.lang.Integer min()

Specified by:

min in interface NumberTensor<java.lang.Integer,IntegerTensor>

max

public java.lang.Integer max()

Specified by:

max in interface NumberTensor<java.lang.Integer,IntegerTensor>

argMax

public int argMax()

Description copied from interface: NumberTensor

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

Specified by:

argMax in interface NumberTensor<java.lang.Integer,IntegerTensor>

Returns:

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

argMax

public IntegerTensor argMax(int axis)

Description copied from interface: NumberTensor

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

Specified by:

argMax in interface NumberTensor<java.lang.Integer,IntegerTensor>

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

argMin

public int argMin()

Specified by:

argMin in interface NumberTensor<java.lang.Integer,IntegerTensor>

argMin

public IntegerTensor argMin(int axis)

Specified by:

argMin in interface NumberTensor<java.lang.Integer,IntegerTensor>

greaterThan

public BooleanTensor greaterThan(IntegerTensor that)

Specified by:

greaterThan in interface NumberTensor<java.lang.Integer,IntegerTensor>

greaterThanOrEqual

public BooleanTensor greaterThanOrEqual(IntegerTensor that)

Specified by:

greaterThanOrEqual in interface NumberTensor<java.lang.Integer,IntegerTensor>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getFlattenedView

public Tensor.FlattenedView<java.lang.Integer> getFlattenedView()

Specified by:

getFlattenedView in interface Tensor<java.lang.Integer,IntegerTensor>

elementwiseEquals

public BooleanTensor elementwiseEquals(Tensor that)

Specified by:

elementwiseEquals in interface Tensor<java.lang.Integer,IntegerTensor>

elementwiseEquals

public BooleanTensor elementwiseEquals(java.lang.Integer value)

Specified by:

elementwiseEquals in interface Tensor<java.lang.Integer,IntegerTensor>

asFlatDoubleArray

public double[] asFlatDoubleArray()

Specified by:

asFlatDoubleArray in interface NumberTensor<java.lang.Integer,IntegerTensor>

asFlatIntegerArray

public int[] asFlatIntegerArray()

Specified by:

asFlatIntegerArray in interface NumberTensor<java.lang.Integer,IntegerTensor>

asFlatArray

public java.lang.Integer[] asFlatArray()

Specified by:

asFlatArray in interface Tensor<java.lang.Integer,IntegerTensor>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

modInPlace

public IntegerTensor modInPlace(java.lang.Integer that)

Specified by:

modInPlace in interface FixedPointTensor<java.lang.Integer,IntegerTensor>

modInPlace

public IntegerTensor modInPlace(IntegerTensor that)

Specified by:

modInPlace in interface FixedPointTensor<java.lang.Integer,IntegerTensor>