Package org.tensorics.core.tensor

Interface TensorBuilder<V>

Type Parameters:

V - the type of the tensor values

All Known Implementing Classes:

AbstractTensorBuilder, ImmutableDoubleArrayBackedTensor.Builder, ImmutableTensor.Builder

public interface TensorBuilder<V>

The interface any builder of a tensor have to implement.

Method Summary

Modifier and Type	Method	Description
Tensor<V>	build()
TensorBuilder<V>	context(java.lang.Object... coordinates)
TensorBuilder<V>	context(Position context)
TensorBuilder<V>	put(java.util.Map.Entry<Position,V> entry)
TensorBuilder<V>	put(Position position, V value)
TensorBuilder<V>	putAll(java.util.Map<Position,V> newEntries)
TensorBuilder<V>	putAll(java.util.Set<java.util.Map.Entry<Position,V>> entries)
TensorBuilder<V>	putAll(Position position, java.util.Map<Position,V> map)
TensorBuilder<V>	putAll(Position position, Tensor<V> tensor)
TensorBuilder<V>	putAll(Tensor<V> tensor)	Puts all the values of the given tensor into the new tensor, at the given position.
TensorBuilder<V>	remove(Position position)

Method Detail

context

TensorBuilder<V> context(Position context)

context

TensorBuilder<V> context(java.lang.Object... coordinates)

putAll

TensorBuilder<V> putAll(Tensor<V> tensor)

Puts all the values of the given tensor into the new tensor, at the given position. The positions in the new tensor will be the merged positions of the original coordinates in the tensor with the given target position. Therefore, the given position is not allowed to have a dimensions overlap with the positions in the original tensor.

Parameters:

tensor - the tensor, whose values to add to the tensor under construction

putAll

TensorBuilder<V> putAll(Position position,
                        Tensor<V> tensor)

put

TensorBuilder<V> put(Position position,
                     V value)

put

TensorBuilder<V> put(java.util.Map.Entry<Position,V> entry)

remove

TensorBuilder<V> remove(Position position)

putAll

TensorBuilder<V> putAll(java.util.Map<Position,V> newEntries)

putAll

TensorBuilder<V> putAll(java.util.Set<java.util.Map.Entry<Position,V>> entries)

putAll

TensorBuilder<V> putAll(Position position,
                        java.util.Map<Position,V> map)

build

Tensor<V> build()