Nd4jNumberTensor (keanu-project 0.0.26 API)

java.lang.Object
- io.improbable.keanu.tensor.ndj4.Nd4jTensor<T,TENSOR>
- - io.improbable.keanu.tensor.ndj4.Nd4jNumberTensor<T,TENSOR>

All Implemented Interfaces:

io.improbable.keanu.kotlin.NumberOperators<TENSOR>, NumberTensor<T,TENSOR>, Tensor<T,TENSOR>

Direct Known Subclasses:

Nd4jFixedPointTensor, Nd4jFloatingPointTensor
```
public abstract class Nd4jNumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
extends Nd4jTensor<T,TENSOR>
implements NumberTensor<T,TENSOR>
```

Nested Class Summary
- Nested classes/interfaces inherited from interface io.improbable.keanu.tensor.Tensor
  Tensor.FlattenedView<N>

Field Summary
- Fields inherited from class io.improbable.keanu.tensor.ndj4.Nd4jTensor
  tensor
- Fields inherited from interface io.improbable.keanu.tensor.Tensor
  ONE_BY_ONE_SHAPE, SCALAR_SHAPE, SCALAR_STRIDE

Constructor Summary

Constructors
Constructor and Description

Nd4jNumberTensor(org.nd4j.linalg.api.ndarray.INDArray tensor)

Constructors
Constructor and Description
`Nd4jNumberTensor(org.nd4j.linalg.api.ndarray.INDArray tensor)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`TENSOR`	`absInPlace()`
`TENSOR`	`applyInPlace(java.util.function.Function<T,T> 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)`
`T`	`average()`
`TENSOR`	`clampInPlace(TENSOR min, TENSOR max)`
`TENSOR`	`cumProdInPlace(int requestedDimension)`
`TENSOR`	`cumSumInPlace(int requestedDimension)`
`TENSOR`	`div(TENSOR that)`
`TENSOR`	`divInPlace(T value)`
`TENSOR`	`divInPlace(TENSOR that)`
`BooleanTensor`	`elementwiseEquals(T value)`
`BooleanTensor`	`elementwiseEquals(Tensor that)`
`protected BooleanTensor`	`fromMask(org.nd4j.linalg.api.ndarray.INDArray mask)`
`protected abstract T`	`getNumber(java.lang.Number number)`
`BooleanTensor`	`greaterThan(T value)`
`BooleanTensor`	`greaterThan(TENSOR value)`
`BooleanTensor`	`greaterThanOrEqual(T value)`
`BooleanTensor`	`greaterThanOrEqual(TENSOR value)`
`BooleanTensor`	`lessThan(T value)`
`BooleanTensor`	`lessThan(TENSOR value)`
`BooleanTensor`	`lessThanOrEqual(T value)`
`BooleanTensor`	`lessThanOrEqual(TENSOR value)`
`TENSOR`	`matrixMultiply(TENSOR value)`
`T`	`max()`
`TENSOR`	`maxInPlace(TENSOR max)`
`T`	`min()`
`TENSOR`	`minInPlace(TENSOR min)`
`TENSOR`	`minus(TENSOR that)`
`TENSOR`	`minusInPlace(T value)`
`TENSOR`	`minusInPlace(TENSOR that)`
`TENSOR`	`plus(TENSOR that)`
`TENSOR`	`plusInPlace(T value)`
`TENSOR`	`plusInPlace(TENSOR that)`
`TENSOR`	`powInPlace(T exponent)`
`TENSOR`	`powInPlace(TENSOR exponent)`
`T`	`product()`
`TENSOR`	`product(int... overDimensions)`
`TENSOR`	`reverseDivInPlace(T value)`
`TENSOR`	`reverseDivInPlace(TENSOR that)`
`TENSOR`	`reverseMinusInPlace(T value)`
`TENSOR`	`reverseMinusInPlace(TENSOR that)`
`TENSOR`	`setWithMaskInPlace(TENSOR mask, T value)`
`T`	`standardDeviation()`
`T`	`sum()`
`TENSOR`	`sum(int... overDimensions)`
`TENSOR`	`tensorMultiply(TENSOR value, int[] dimLeft, int[] dimsRight)`
`TENSOR`	`times(TENSOR that)`
`TENSOR`	`timesInPlace(T value)`
`TENSOR`	`timesInPlace(TENSOR that)`
`TENSOR`	`unaryMinusInPlace()`

Methods inherited from class io.improbable.keanu.tensor.ndj4.Nd4jTensor
broadcast, create, diag, duplicate, equals, get, getLength, getRank, getShape, getStride, getTensor, getTensor, getThis, hashCode, permute, reshape, set, slice, slice, split, take, toString, transpose

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.improbable.keanu.tensor.NumberTensor
abs, apply, asFlatDoubleArray, asFlatIntegerArray, clamp, cumProd, cumSum, div, equalsWithinEpsilon, greaterThanMask, greaterThanOrEqualToMask, lessThanMask, lessThanOrEqualToMask, max, min, minus, plus, pow, pow, reverseDiv, reverseDiv, reverseMinus, reverseMinus, safeLogTimes, safeLogTimesInPlace, setAllInPlace, setWithMask, times, toDouble, toInteger, unaryMinus

Methods inherited from interface io.improbable.keanu.tensor.Tensor
asFlatArray, asFlatList, broadcast, create, createFilled, diag, duplicate, elementwiseEquals, expandDims, get, getFlattenedView, getLength, getRank, getShape, getStride, getValue, hasSameShapeAs, hasSameShapeAs, isLengthOne, isMatrix, isScalar, isVector, moveAxis, permute, reshape, scalar, scalar, setValue, slice, slice, slice, sliceAlongDimension, split, squeeze, swapAxis, take, transpose

- Constructor Detail
  - Nd4jNumberTensor
```
public Nd4jNumberTensor(org.nd4j.linalg.api.ndarray.INDArray tensor)
```
- Method Detail
  - setWithMaskInPlace
```
public TENSOR setWithMaskInPlace(TENSOR mask,
                                 T value)
```
    Specified by:
    
    setWithMaskInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - sum
```
public TENSOR sum(int... overDimensions)
```
    Specified by:
    
    sum in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - sum
```
public T sum()
```
    Specified by:
    
    sum in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - cumSumInPlace
```
public TENSOR cumSumInPlace(int requestedDimension)
```
    Specified by:
    
    cumSumInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - product
```
public T product()
```
    Specified by:
    
    product in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - product
```
public TENSOR product(int... overDimensions)
```
    Specified by:
    
    product in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - cumProdInPlace
```
public TENSOR cumProdInPlace(int requestedDimension)
```
    Specified by:
    
    cumProdInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - clampInPlace
```
public TENSOR clampInPlace(TENSOR min,
                           TENSOR max)
```
    Specified by:
    
    clampInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - max
```
public T max()
```
    Specified by:
    
    max in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - min
```
public T min()
```
    Specified by:
    
    min in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - maxInPlace
```
public TENSOR maxInPlace(TENSOR max)
```
    Specified by:
    
    maxInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - minInPlace
```
public TENSOR minInPlace(TENSOR min)
```
    Specified by:
    
    minInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - 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<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
    
    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<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
    
    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<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - argMin
```
public IntegerTensor argMin(int axis)
```
    Specified by:
    
    argMin in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - minus
```
public TENSOR minus(TENSOR that)
```
    Specified by:
    
    minus in interface io.improbable.keanu.kotlin.NumberOperators<TENSOR extends NumberTensor<T,TENSOR>>
    
    Specified by:
    
    minus in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - plus
```
public TENSOR plus(TENSOR that)
```
    Specified by:
    
    plus in interface io.improbable.keanu.kotlin.NumberOperators<TENSOR extends NumberTensor<T,TENSOR>>
    
    Specified by:
    
    plus in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - times
```
public TENSOR times(TENSOR that)
```
    Specified by:
    
    times in interface io.improbable.keanu.kotlin.NumberOperators<TENSOR extends NumberTensor<T,TENSOR>>
    
    Specified by:
    
    times in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - div
```
public TENSOR div(TENSOR that)
```
    Specified by:
    
    div in interface io.improbable.keanu.kotlin.NumberOperators<TENSOR extends NumberTensor<T,TENSOR>>
    
    Specified by:
    
    div in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - minusInPlace
```
public TENSOR minusInPlace(T value)
```
    Specified by:
    
    minusInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - plusInPlace
```
public TENSOR plusInPlace(T value)
```
    Specified by:
    
    plusInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - timesInPlace
```
public TENSOR timesInPlace(T value)
```
    Specified by:
    
    timesInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - divInPlace
```
public TENSOR divInPlace(T value)
```
    Specified by:
    
    divInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - powInPlace
```
public TENSOR powInPlace(TENSOR exponent)
```
    Specified by:
    
    powInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - powInPlace
```
public TENSOR powInPlace(T exponent)
```
    Specified by:
    
    powInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - minusInPlace
```
public TENSOR minusInPlace(TENSOR that)
```
    Specified by:
    
    minusInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
    
    Parameters:
    
    that - Right operand.
    
    Returns:
    
    A new DoubleTensor instance only if this has a length of 1 and right operand has a length greater than 1. Otherwise return this.
  - reverseMinusInPlace
```
public TENSOR reverseMinusInPlace(TENSOR that)
```
    Specified by:
    
    reverseMinusInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - reverseMinusInPlace
```
public TENSOR reverseMinusInPlace(T value)
```
    Specified by:
    
    reverseMinusInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - plusInPlace
```
public TENSOR plusInPlace(TENSOR that)
```
    Specified by:
    
    plusInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
    
    Parameters:
    
    that - Right operand.
    
    Returns:
    
    A new DoubleTensor instance only if this has a length of 1 and right operand has a length greater than 1. Otherwise return this.
  - timesInPlace
```
public TENSOR timesInPlace(TENSOR that)
```
    Specified by:
    
    timesInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
    
    Parameters:
    
    that - Right operand.
    
    Returns:
    
    A new DoubleTensor instance only if this has a length of 1 and right operand has a length greater than 1. Otherwise return this.
  - divInPlace
```
public TENSOR divInPlace(TENSOR that)
```
    Specified by:
    
    divInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
    
    Parameters:
    
    that - Right operand.
    
    Returns:
    
    A new DoubleTensor instance only if this has a length of 1 and right operand has a length greater than 1. Otherwise return this.
  - reverseDivInPlace
```
public TENSOR reverseDivInPlace(T value)
```
    Specified by:
    
    reverseDivInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - reverseDivInPlace
```
public TENSOR reverseDivInPlace(TENSOR that)
```
    Specified by:
    
    reverseDivInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - unaryMinusInPlace
```
public TENSOR unaryMinusInPlace()
```
    Specified by:
    
    unaryMinusInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - absInPlace
```
public TENSOR absInPlace()
```
    Specified by:
    
    absInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - average
```
public T average()
```
    Specified by:
    
    average in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - standardDeviation
```
public T standardDeviation()
```
    Specified by:
    
    standardDeviation in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - greaterThan
```
public BooleanTensor greaterThan(T value)
```
    Specified by:
    
    greaterThan in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - greaterThanOrEqual
```
public BooleanTensor greaterThanOrEqual(T value)
```
    Specified by:
    
    greaterThanOrEqual in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - greaterThan
```
public BooleanTensor greaterThan(TENSOR value)
```
    Specified by:
    
    greaterThan in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - greaterThanOrEqual
```
public BooleanTensor greaterThanOrEqual(TENSOR value)
```
    Specified by:
    
    greaterThanOrEqual in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - lessThan
```
public BooleanTensor lessThan(T value)
```
    Specified by:
    
    lessThan in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - lessThanOrEqual
```
public BooleanTensor lessThanOrEqual(T value)
```
    Specified by:
    
    lessThanOrEqual in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - lessThan
```
public BooleanTensor lessThan(TENSOR value)
```
    Specified by:
    
    lessThan in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - lessThanOrEqual
```
public BooleanTensor lessThanOrEqual(TENSOR value)
```
    Specified by:
    
    lessThanOrEqual in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - applyInPlace
```
public TENSOR applyInPlace(java.util.function.Function<T,T> function)
```
    Specified by:
    
    applyInPlace in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - elementwiseEquals
```
public BooleanTensor elementwiseEquals(Tensor that)
```
    Specified by:
    
    elementwiseEquals in interface Tensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - elementwiseEquals
```
public BooleanTensor elementwiseEquals(T value)
```
    Specified by:
    
    elementwiseEquals in interface Tensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - matrixMultiply
```
public TENSOR matrixMultiply(TENSOR value)
```
    Specified by:
    
    matrixMultiply in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - tensorMultiply
```
public TENSOR tensorMultiply(TENSOR value,
                             int[] dimLeft,
                             int[] dimsRight)
```
    Specified by:
    
    tensorMultiply in interface NumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>
  - fromMask
```
protected final BooleanTensor fromMask(org.nd4j.linalg.api.ndarray.INDArray mask)
```
  - getNumber
```
protected abstract T getNumber(java.lang.Number number)
```

Class Nd4jNumberTensor<T extends java.lang.Number,TENSOR extends NumberTensor<T,TENSOR>>

Nested Class Summary

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

Field Summary

Fields inherited from class io.improbable.keanu.tensor.ndj4.Nd4jTensor

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

Constructor Summary

Method Summary

Methods inherited from class io.improbable.keanu.tensor.ndj4.Nd4jTensor

Methods inherited from class java.lang.Object

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

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

Constructor Detail

Nd4jNumberTensor

Method Detail

setWithMaskInPlace

sum

sum

cumSumInPlace

product

product

cumProdInPlace

clampInPlace

max

min

maxInPlace

minInPlace

argMax

argMax

argMin

argMin

minus

plus

times

div

minusInPlace

plusInPlace

timesInPlace

divInPlace

powInPlace

powInPlace

minusInPlace

reverseMinusInPlace

reverseMinusInPlace

plusInPlace

timesInPlace

divInPlace

reverseDivInPlace

reverseDivInPlace

unaryMinusInPlace

absInPlace

average

standardDeviation

greaterThan

greaterThanOrEqual

greaterThan

greaterThanOrEqual

lessThan

lessThanOrEqual

lessThan

lessThanOrEqual

applyInPlace

elementwiseEquals

elementwiseEquals

matrixMultiply

tensorMultiply

fromMask

getNumber