IndexedTensor (vespajlib 6.177.31 API)

java.lang.Object
- com.yahoo.tensor.IndexedTensor

All Implemented Interfaces:

Tensor
```
@Beta
public class IndexedTensor
extends Object
implements Tensor
```
An indexed (dense) tensor backed by a double array.

Author:

bratseth

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IndexedTensor.BoundBuilder` A bound builder can create the double array directly
`static class`	`IndexedTensor.Builder`
`private class`	`IndexedTensor.CellIterator`
`private static class`	`IndexedTensor.EmptyIndexes`
`private static class`	`IndexedTensor.EqualSizeMultiDimensionIndexes` In this case we can reuse the source index computation for the iteration index
`private static class`	`IndexedTensor.EqualSizeSingleDimensionIndexes` In this case we only need to keep track of one index
`static class`	`IndexedTensor.Indexes` An array of indexes into this tensor which are able to find the next index in the value order.
`private static class`	`IndexedTensor.LazyCell` A Cell which does not compute its TensorAddress unless it really has to
`private static class`	`IndexedTensor.MultiDimensionIndexes`
`private static class`	`IndexedTensor.SingleDimensionIndexes` In this case we can keep track of indexes using a step instead of using the more elaborate computation
`private static class`	`IndexedTensor.SingleValueIndexes`
`class`	`IndexedTensor.SubspaceIterator` An iterator over a subspace of this tensor.
`private class`	`IndexedTensor.SuperspaceIterator`
`private static class`	`IndexedTensor.UnboundBuilder` A builder used when we don't know the size of the dimensions up front.
`private class`	`IndexedTensor.ValueIterator`

Nested classes/interfaces inherited from interface com.yahoo.tensor.Tensor
Tensor.Cell

Field Summary

Fields
Modifier and Type	Field and Description
`private DimensionSizes`	`dimensionSizes` The sizes of the dimensions of this in the order of the dimensions of the type
`private TensorType`	`type` The prescribed and possibly abstract type this is an instance of
`private double[]`	`values`

Constructor Summary

Constructors
Modifier Constructor and Description

private IndexedTensor(TensorType type, DimensionSizes dimensionSizes, double[] values)

Constructors
Modifier	Constructor and Description
`private`	`IndexedTensor(TensorType type, DimensionSizes dimensionSizes, double[] values)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Iterator<Tensor.Cell>`	`cellIterator()` Returns an iterator over the cells of this.
`IndexedTensor.SubspaceIterator`	`cellIterator(PartialAddress partialAddress, DimensionSizes iterationSizes)` Returns an iterator over all the cells in this tensor which matches the given partial address
`Map<TensorAddress,Double>`	`cells()` Returns an immutable map of the cells of this in no particular order.
`DimensionSizes`	`dimensionSizes()`
`boolean`	`equals(Object other)` Returns whether this tensor and the given tensor is mathematically equal: That they have the same dimension names and the same content.
`double`	`get(int... indexes)` Returns the value at the given indexes
`private double`	`get(int valueIndex)`
`double`	`get(TensorAddress address)` Returns the value at this address, or NaN if there is no value at this address
`int`	`hashCode()`
`private static int`	`productOfDimensionsAfter(int afterIndex, DimensionSizes sizes)`
`int`	`size()` Returns the number of cells in this
`Iterator<IndexedTensor.SubspaceIterator>`	`subspaceIterator(Set<String> dimensions)` Returns a subspace iterator having the sizes of the dimensions of this tensor
`Iterator<IndexedTensor.SubspaceIterator>`	`subspaceIterator(Set<String> dimensions, DimensionSizes sizes)` Returns an iterator over value iterators where the outer iterator is over each unique value of the dimensions given and the inner iterator is over each unique value of the rest of the dimensions, in the same order as other iterator.
`String`	`toString()` Returns this tensor on the form `{address1:value1,address2:value2,...}` where each address is on the form `{dimension1:label1,dimension2:label2,...}`, and values are numbers.
`private static int`	`toValueIndex(int[] indexes, DimensionSizes sizes)`
`private static int`	`toValueIndex(TensorAddress address, DimensionSizes sizes)`
`TensorType`	`type()`
`Iterator<Double>`	`valueIterator()` Returns an iterator over the values of this.

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

Methods inherited from interface com.yahoo.tensor.Tensor
add, approxEqual, approxEquals, approxEquals, argmax, argmin, asDouble, atan2, avg, avg, concat, concat, contentToString, count, count, diag, divide, equal, equals, fmod, from, from, from, generate, isEmpty, join, l1Normalize, l2Normalize, larger, largerOrEqual, ldexp, map, matmul, max, max, max, min, min, min, multiply, notEqual, pow, prod, prod, random, range, reduce, reduce, rename, rename, smaller, smallerOrEqual, softmax, subtract, sum, sum, toStandardString, xwPlusB

- Field Detail
  - type
```
private final TensorType type
```
    The prescribed and possibly abstract type this is an instance of
  - dimensionSizes
```
private final DimensionSizes dimensionSizes
```
    The sizes of the dimensions of this in the order of the dimensions of the type
  - values
```
private final double[] values
```
- Constructor Detail
  - IndexedTensor
```
private IndexedTensor(TensorType type,
                      DimensionSizes dimensionSizes,
                      double[] values)
```
- Method Detail
  - size
```
public int size()
```
    Description copied from interface: Tensor
    
    Returns the number of cells in this
    
    Specified by:
    
    size in interface Tensor
  - cellIterator
```
public Iterator<Tensor.Cell> cellIterator()
```
    Returns an iterator over the cells of this. Cells are returned in order of increasing indexes in each dimension, increasing indexes of later dimensions in the dimension type before earlier.
    
    Specified by:
    
    cellIterator in interface Tensor
  - cellIterator
```
public IndexedTensor.SubspaceIterator cellIterator(PartialAddress partialAddress,
                                                   DimensionSizes iterationSizes)
```
    Returns an iterator over all the cells in this tensor which matches the given partial address
  - valueIterator
```
public Iterator<Double> valueIterator()
```
    Returns an iterator over the values of this. Values are returned in order of increasing indexes in each dimension, increasing indexes of later dimensions in the dimension type before earlier.
    
    Specified by:
    
    valueIterator in interface Tensor
  - subspaceIterator
```
public Iterator<IndexedTensor.SubspaceIterator> subspaceIterator(Set<String> dimensions,
                                                                 DimensionSizes sizes)
```
    Returns an iterator over value iterators where the outer iterator is over each unique value of the dimensions given and the inner iterator is over each unique value of the rest of the dimensions, in the same order as other iterator.
    
    Parameters:
    
    dimensions - the names of the dimensions of the superspace
    
    sizes - the size of each dimension in the space we are returning values for, containing one value per dimension of this tensor (in order). Each size may be the same or smaller than the corresponding size of this tensor
  - subspaceIterator
```
public Iterator<IndexedTensor.SubspaceIterator> subspaceIterator(Set<String> dimensions)
```
    Returns a subspace iterator having the sizes of the dimensions of this tensor
  - get
```
public double get(int... indexes)
```
    Returns the value at the given indexes
    
    Parameters:
    
    indexes - the indexes into the dimensions of this. Must be one number per dimension of this
    
    Throws:
    
    IndexOutOfBoundsException - if any of the indexes are out of bound or a wrong number of indexes are given
  - get
```
public double get(TensorAddress address)
```
    Returns the value at this address, or NaN if there is no value at this address
    
    Specified by:
    
    get in interface Tensor
  - get
```
private double get(int valueIndex)
```
  - toValueIndex
```
private static int toValueIndex(int[] indexes,
                                DimensionSizes sizes)
```
  - toValueIndex
```
private static int toValueIndex(TensorAddress address,
                                DimensionSizes sizes)
```
  - productOfDimensionsAfter
```
private static int productOfDimensionsAfter(int afterIndex,
                                            DimensionSizes sizes)
```
  - type
```
public TensorType type()
```
    Specified by:
    
    type in interface Tensor
  - dimensionSizes
```
public DimensionSizes dimensionSizes()
```
  - cells
```
public Map<TensorAddress,Double> cells()
```
    Description copied from interface: Tensor
    
    Returns an immutable map of the cells of this in no particular order. This may be expensive for some implementations - avoid when possible
    
    Specified by:
    
    cells in interface Tensor
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Description copied from interface: Tensor
    
    Returns this tensor on the form {address1:value1,address2:value2,...} where each address is on the form {dimension1:label1,dimension2:label2,...}, and values are numbers.
    Cells are listed in the natural order of tensor addresses: Increasing size primarily and by element lexical order secondarily.
    Note that while this is suggestive of JSON, it is not JSON.
    
    Specified by:
    
    toString in interface Tensor
    
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Description copied from interface: Tensor
    
    Returns whether this tensor and the given tensor is mathematically equal: That they have the same dimension *names* and the same content.
    
    Specified by:
    
    equals in interface Tensor
    
    Overrides:
    
    equals in class Object

Class IndexedTensor

Nested Class Summary

Nested classes/interfaces inherited from interface com.yahoo.tensor.Tensor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.yahoo.tensor.Tensor

Field Detail

type

dimensionSizes

values

Constructor Detail

IndexedTensor

Method Detail

size

cellIterator

cellIterator

valueIterator

subspaceIterator

subspaceIterator

get

get

get

toValueIndex

toValueIndex

productOfDimensionsAfter

type

dimensionSizes

cells

hashCode

toString

equals