Nd4jTensor (keanu-project 0.0.26 API)

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

All Implemented Interfaces:: Tensor<T,TENSOR>

Direct Known Subclasses:: Nd4jNumberTensor

public abstract class Nd4jTensor<T,TENSOR extends Tensor<T,TENSOR>>
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 org.nd4j.linalg.api.ndarray.INDArray tensor
- Fields inherited from interface io.improbable.keanu.tensor.Tensor
  ONE_BY_ONE_SHAPE, SCALAR_SHAPE, SCALAR_STRIDE

Fields
Modifier and Type	Field and Description
`protected org.nd4j.linalg.api.ndarray.INDArray`	`tensor`

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`TENSOR`	`broadcast(long... toShape)`
`protected abstract TENSOR`	`create(org.nd4j.linalg.api.ndarray.INDArray tensor)`
`TENSOR`	`diag()`
`TENSOR`	`duplicate()`
`boolean`	`equals(java.lang.Object o)`
`TENSOR`	`get(BooleanTensor booleanIndex)`
`long`	`getLength()`
`int`	`getRank()`
`long[]`	`getShape()`
`long[]`	`getStride()` Returns the stride for each dimension of the tensor (based on C ordering).
`org.nd4j.linalg.api.ndarray.INDArray`	`getTensor()`
`protected abstract org.nd4j.linalg.api.ndarray.INDArray`	`getTensor(Tensor<T,?> tensor)`
`protected abstract TENSOR`	`getThis()`
`int`	`hashCode()`
`TENSOR`	`permute(int... rearrange)`
`TENSOR`	`reshape(long... newShape)`
`protected abstract TENSOR`	`set(org.nd4j.linalg.api.ndarray.INDArray tensor)`
`TENSOR`	`slice(int dimension, long index)`
`TENSOR`	`slice(Slicer slicer)`
`java.util.List<TENSOR>`	`split(int dimension, long... splitAtIndices)`
`TENSOR`	`take(long... index)`
`java.lang.String`	`toString()`
`TENSOR`	`transpose()`

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, elementwiseEquals, elementwiseEquals, elementwiseEquals, expandDims, getFlattenedView, getValue, hasSameShapeAs, hasSameShapeAs, isLengthOne, isMatrix, isScalar, isVector, moveAxis, scalar, scalar, setValue, slice, sliceAlongDimension, squeeze, swapAxis

- Field Detail
  - tensor
```
protected org.nd4j.linalg.api.ndarray.INDArray tensor
```
- Constructor Detail
  - Nd4jTensor
```
public Nd4jTensor(org.nd4j.linalg.api.ndarray.INDArray tensor)
```
- 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.
  - 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>>
  - permute
```
public TENSOR permute(int... rearrange)
```
    Specified by:
    
    permute in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>
  - diag
```
public TENSOR diag()
```
    Specified by:
    
    diag in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>
  - duplicate
```
public TENSOR duplicate()
```
    Specified by:
    
    duplicate in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>
  - transpose
```
public TENSOR transpose()
```
    Specified by:
    
    transpose in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>
  - 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>>
  - take
```
public TENSOR take(long... index)
```
    Specified by:
    
    take in interface Tensor<T,TENSOR extends Tensor<T,TENSOR>>
  - 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] )
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - 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
  - getTensor
```
public org.nd4j.linalg.api.ndarray.INDArray getTensor()
```
  - getTensor
```
protected abstract org.nd4j.linalg.api.ndarray.INDArray getTensor(Tensor<T,?> tensor)
```
  - create
```
protected abstract TENSOR create(org.nd4j.linalg.api.ndarray.INDArray tensor)
```
  - set
```
protected abstract TENSOR set(org.nd4j.linalg.api.ndarray.INDArray tensor)
```
  - getThis
```
protected abstract TENSOR getThis()
```

Class Nd4jTensor<T,TENSOR extends Tensor<T,TENSOR>>

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

tensor

Constructor Detail

Nd4jTensor

Method Detail

getRank

getShape

getStride

getLength

get

reshape

broadcast

permute

diag

duplicate

transpose

slice

slice

take

split

hashCode

equals

toString

getTensor

getTensor

create

set

getThis