org.tensorics.core.tensorbacked

Class TensorbackedBuilder<V,TB extends Tensorbacked<V>>

java.lang.Object

org.tensorics.core.tensorbacked.TensorbackedBuilder<V,TB>

Type Parameters:

V - the type of the values of the tensor (and thus also the tensor backed object)

TB - the type of the tensor backed object

public class TensorbackedBuilder<V,TB extends Tensorbacked<V>>
extends java.lang.Object

A builder for tensor backed objects, which takes care that only positions which are compatible with the dimensions of the foreseen underlaying tensor are put into it. Internally, it uses a builder for a tensor, to which most of the methods are delegated. At build time, the tensor is encapsulated in the according tensor backed class.

This class is not thread safe.

Method Summary

Modifier and Type	Method and Description
TB	build() Builds the tensor backed object, after all the content is set.
TensorbackedBuilder<V,TB>	context(java.lang.Object... coordinates)
TensorbackedBuilder<V,TB>	context(Position context)
TensorbackedBuilder<V,TB>	put(java.util.Map.Entry<Position,V> entry)
TensorbackedBuilder<V,TB>	put(Position position, V value)
TensorbackedBuilder<V,TB>	putAll(java.util.Map<Position,V> newEntries)
TensorbackedBuilder<V,TB>	putAll(Position position, java.util.Map<Position,V> entries)
TensorbackedBuilder<V,TB>	putAll(Position position, Tensor<V> tensor)
TensorbackedBuilder<V,TB>	putAll(Position position, Tensorbacked<V> tensorbacked)
TensorbackedBuilder<V,TB>	putAll(java.util.Set<java.util.Map.Entry<Position,V>> entries)
TensorbackedBuilder<V,TB>	putAll(TB tensorBacked)
TensorbackedBuilder<V,TB>	putAll(Tensor<V> tensor)
TensorbackedBuilder<V,TB>	remove(Position position)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

put

public final TensorbackedBuilder<V,TB> put(java.util.Map.Entry<Position,V> entry)

put

public final TensorbackedBuilder<V,TB> put(Position position,
                                           V value)

putAll

public final TensorbackedBuilder<V,TB> putAll(java.util.Set<java.util.Map.Entry<Position,V>> entries)

putAll

public final TensorbackedBuilder<V,TB> putAll(Position position,
                                              java.util.Map<Position,V> entries)

putAll

public final TensorbackedBuilder<V,TB> putAll(Position position,
                                              Tensor<V> tensor)

putAll

public final TensorbackedBuilder<V,TB> putAll(Position position,
                                              Tensorbacked<V> tensorbacked)

putAll

public final TensorbackedBuilder<V,TB> putAll(TB tensorBacked)

putAll

public final TensorbackedBuilder<V,TB> putAll(Tensor<V> tensor)

putAll

public final TensorbackedBuilder<V,TB> putAll(java.util.Map<Position,V> newEntries)

remove

public final TensorbackedBuilder<V,TB> remove(Position position)

context

public final TensorbackedBuilder<V,TB> context(Position context)

context

public final TensorbackedBuilder<V,TB> context(java.lang.Object... coordinates)

build

public TB build()

Builds the tensor backed object, after all the content is set.

Returns:

a new instance of the tensor backed object, containing all the data as described after instantiating the builder.