org.tensorics.core.lang

Class Tensorics

java.lang.Object

org.tensorics.core.lang.Tensorics

public final class Tensorics
extends java.lang.Object

The main entry point for constructing and structural manipulation of tensorics. If mathematical operations are required, then you should either inherit from TensoricSupport (or one of its convenience implementations) or use the using(ExtendedField) method (only recommended for one-liners).

Additional utilities for supporting classes can be found in the corresponding utility classes. E.g.

• Positions
• Shapes
• QuantityTensors
• Tensorbackeds

Method Summary

Modifier and Type	Method and Description
static Position	at(java.lang.Iterable<?> coordinates)
static Position	at(java.lang.Object... coordinates)
static <T> TensorBuilder<T>	builder(java.lang.Class<?>... dimensions)
static <T> TensorBuilder<T>	builder(java.lang.Iterable<java.lang.Class<?>> dimensions)
static <V,TB extends Tensorbacked<V>> TensorbackedBuilder<V,TB>	builderFor(java.lang.Class<TB> tensorbackedClass)
static <T> TensorBuilder<T>	builderFrom(Tensor<T> tensor)
static <S,TB extends Tensorbacked<S>> OngoingTensorbackedCompletion<TB,S>	complete(TB tensorbacked)
static <S> OngoingCompletion<S>	complete(Tensor<S> tensor)
static <V,TB extends Tensorbacked<V>> OngoingTensorbackedConstruction<V,TB>	construct(java.lang.Class<TB> tensorbackedClass)
static <S> Tensor<QuantifiedValue<S>>	convertToQuantified(Tensor<S> tensor, Unit unit) Deprecated. use renamed method quantityTensorOf(Tensor, Unit)
static <T> Tensor<T>	copyOf(Tensor<T> tensor)
static <S> Tensor<S>	createFrom(Shape shape, java.util.function.Function<Position,S> function) Deprecated. use tensor(Shape, Function)
static <S> Tensor<S>	createFrom(Shape shape, java.util.function.Supplier<S> supplier) Deprecated. use tensor(Shape, Supplier)
static <TB extends Tensorbacked<?>> int	dimensionalityOf(TB tensorbacked)
static java.util.Set<java.lang.Class<?>>	dimensionsOf(Tensor<?> tensor)
static java.util.Set<java.lang.Class<?>>	dimensionsOf(Tensorbacked<?> tensorbacked)
static <V> Tensor<V>	empty(java.lang.Class<?>... dimensions)
static <V,TB extends Tensorbacked<V>> TB	empty(java.lang.Class<TB> tensorbackedClass)
static <V> Tensor<V>	empty(java.lang.Iterable<java.lang.Class<?>> dimensions)
static <S> Tensor<com.google.common.base.Optional<S>>	errorsOf(Tensor<QuantifiedValue<S>> tensor)
static <S> Tensor<com.google.common.base.Optional<S>>	errorsOf(Tensorbacked<QuantifiedValue<S>> tensorbacked)
static <S> Tensor<S>	errorsOfOr(Tensor<QuantifiedValue<S>> tensor, S defaultValue)
static <V,TB extends Tensorbacked<V>> OngoingTensorbackedFiltering<V,TB>	filter(TB tensorbacked)
static <S> OngoingTensorFiltering<S>	filter(Tensor<S> tensor)
static <S> OngoingFlattening<S>	flatten(Tensor<S> tensor)
static <S> OngoingFlattening<S>	flatten(Tensorbacked<S> tensorbacked)
static <S> void	forEach(Tensor<S> tensor, java.util.function.BiConsumer<Position,S> consumer)
static <S> void	forEach(Tensor<S> tensor, java.util.function.Consumer<S> consumer)
static <S> void	forEach(Tensorbacked<S> tensorBacked, java.util.function.BiConsumer<Position,S> consumer)
static <S> void	forEach(Tensorbacked<S> tensorBacked, java.util.function.Consumer<S> consumer)
static <V> OngoingTensorManipulation<V>	from(Tensor<V> tensor)
static <V> OngoingTensorManipulation<V>	from(Tensorbacked<V> tensorbacked)
static <T> Tensor<T>	fromMap(java.lang.Iterable<java.lang.Class<?>> dimensions, java.util.Map<Position,T> map)
static <S,T> Tensor<T>	map(Tensor<S> tensor, java.util.function.BiFunction<Position,S,T> function)
static <S,T> Tensor<T>	map(Tensor<S> tensor, java.util.function.Function<S,T> function)
static <V> java.util.Map<Position,V>	mapFrom(Tensor<V> tensor)
static <E> Tensor<E>	merge(java.lang.Iterable<Tensor<E>> tensors)
static <E> Tensor<E>	mergeContextIntoShape(Tensor<E> tensor)
static java.util.Set<Position>	positionsOf(Tensor<?> tensor)
static java.util.Set<Position>	positionsOf(Tensorbacked<?> tensorbacked)
static <V> ImmutableQuantifiedValue<V>	quantityOf(V value, Unit unit)
static <V> ImmutableQuantifiedValue<V>	quantityOf(V value, javax.measure.unit.Unit<?> unit) Convenience method to create a quantity directly from a jscience base.
static <S> Tensor<QuantifiedValue<S>>	quantityTensorOf(Tensor<S> tensor, Unit unit)
static <S> Tensor<QuantifiedValue<S>>	quantityTensorOf(Tensor<S> tensor, javax.measure.unit.Unit<?> unit)
static <V> OngoingResamplingStart<V>	resample(Tensor<V> tensor)
static <S> Tensor<S>	sameValues(Shape shape, S value)
static <T> ImmutableScalar<T>	scalarOf(T value)
static <V,TB extends Tensorbacked<V>> TB	setContext(TB tensorbacked, Position context)
static <S> Tensor<S>	setContext(Tensor<S> tensor, Position context)
static Shape	shapeOf(Tensorbacked<?> tensorbacked)
static <TB extends Tensorbacked<?>> java.lang.Iterable<Shape>	shapesOf(java.lang.Iterable<TB> tensorbackeds)
static <TB extends Tensorbacked<?>> int	sizeOf(TB tensorbacked)
static <S> java.util.stream.Stream<java.util.Map.Entry<Position,S>>	stream(Tensor<S> tensor)
static <S> java.util.stream.Stream<java.util.Map.Entry<Position,S>>	stream(Tensorbacked<S> tensorBacked)
static <V,TB extends Tensorbacked<V>> TB	stripContext(TB tensorbacked)
static <S> Tensor<S>	stripContext(Tensor<S> tensor)
static <S> Tensor<S>	tensor(Shape shape, java.util.function.Function<Position,S> function)
static <S> Tensor<S>	tensor(Shape shape, java.util.function.Supplier<S> supplier)
static <S> java.lang.Iterable<Tensor<S>>	tensorsOf(java.lang.Iterable<? extends Tensorbacked<S>> tensorbackeds)
static <S,T> Tensor<T>	transformEntries(Tensor<S> tensor, java.util.function.Function<java.util.Map.Entry<Position,S>,T> function) Deprecated. use map(Tensor, BiFunction) instead
static <S> Unit	unitOf(Tensor<QuantifiedValue<S>> tensor)
static <S> Unit	unitOf(Tensorbacked<QuantifiedValue<S>> tensorbacked)
static <E> TensoricSupport<E>	using(ExtendedField<E> field) Creates an instance of a 'support' type class, which provides methods as starting points for the 'fluent' API for tensor manipulation.
static <S> Tensor<java.lang.Boolean>	validitiesOf(Tensor<QuantifiedValue<S>> tensor)
static <S> Tensor<java.lang.Boolean>	validitiesOf(Tensorbacked<QuantifiedValue<S>> tensorbacked)
static <S> Tensor<S>	valuesOf(Tensor<QuantifiedValue<S>> tensor)
static <S> Tensor<S>	valuesOf(Tensorbacked<QuantifiedValue<S>> tensorbacked)
static Scalar<QuantifiedValue<java.lang.Double>>	zeroDimensionalOf(double value, Unit unit)
static Scalar<QuantifiedValue<java.lang.Double>>	zeroDimensionalOf(double value, javax.measure.unit.Unit<?> unit)

Methods inherited from class java.lang.Object

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

Method Detail

using

public static <E> TensoricSupport<E> using(ExtendedField<E> field)

Creates an instance of a 'support' type class, which provides methods as starting points for the 'fluent' API for tensor manipulation.

Type Parameters:

E - the types of values in the field

Parameters:

field - the (mathematical construct) field which defines the operations for the tensor elements.

Returns:

a tensoric support, which provides the starting methods for the tensoric fluent API.

merge

public static <E> Tensor<E> merge(java.lang.Iterable<Tensor<E>> tensors)

mergeContextIntoShape

public static <E> Tensor<E> mergeContextIntoShape(Tensor<E> tensor)

See Also:

TensorStructurals.mergeContextIntoShape(Tensor)

builder

public static <T> TensorBuilder<T> builder(java.lang.Iterable<java.lang.Class<?>> dimensions)

See Also:

ImmutableTensor.builder(Iterable)

builder

public static <T> TensorBuilder<T> builder(java.lang.Class<?>... dimensions)

See Also:

ImmutableTensor.builder(Class...)

fromMap

public static <T> Tensor<T> fromMap(java.lang.Iterable<java.lang.Class<?>> dimensions,
                                    java.util.Map<Position,T> map)

See Also:

ImmutableTensor.fromMap(Iterable, Map)

copyOf

public static <T> Tensor<T> copyOf(Tensor<T> tensor)

See Also:

ImmutableTensor.copyOf(Tensor)

builderFrom

public static <T> TensorBuilder<T> builderFrom(Tensor<T> tensor)

See Also:

ImmutableTensor.builderFrom(Tensor)

scalarOf

public static <T> ImmutableScalar<T> scalarOf(T value)

See Also:

ImmutableScalar.of(Object)

quantityOf

public static <V> ImmutableQuantifiedValue<V> quantityOf(V value,
                                                         Unit unit)

See Also:

ImmutableQuantifiedValue.of(Object, Unit)

quantityOf

public static <V> ImmutableQuantifiedValue<V> quantityOf(V value,
                                                         javax.measure.unit.Unit<?> unit)

Convenience method to create a quantity directly from a jscience base.

Parameters:

value - the of the quantity

unit - the base of the quantity

Returns:

a new instance of the quantity

See Also:

quantityOf(Object, Unit)

builderFor

public static <V,TB extends Tensorbacked<V>> TensorbackedBuilder<V,TB> builderFor(java.lang.Class<TB> tensorbackedClass)

See Also:

Tensorbackeds.builderFor(Class)

sizeOf

public static <TB extends Tensorbacked<?>> int sizeOf(TB tensorbacked)

See Also:

Tensorbackeds.sizeOf(Tensorbacked)

dimensionalityOf

public static <TB extends Tensorbacked<?>> int dimensionalityOf(TB tensorbacked)

See Also:

Tensorbackeds.dimensionalityOf(Tensorbacked)

empty

public static <V,TB extends Tensorbacked<V>> TB empty(java.lang.Class<TB> tensorbackedClass)

See Also:

Tensorbackeds.empty(Class)

empty

public static <V> Tensor<V> empty(java.lang.Iterable<java.lang.Class<?>> dimensions)

empty

public static <V> Tensor<V> empty(java.lang.Class<?>... dimensions)

validitiesOf

public static <S> Tensor<java.lang.Boolean> validitiesOf(Tensorbacked<QuantifiedValue<S>> tensorbacked)

See Also:

Tensorbackeds.validitiesOf(Tensorbacked)

valuesOf

public static <S> Tensor<S> valuesOf(Tensorbacked<QuantifiedValue<S>> tensorbacked)

See Also:

Tensorbackeds.valuesOf(Tensorbacked)

errorsOf

public static <S> Tensor<com.google.common.base.Optional<S>> errorsOf(Tensorbacked<QuantifiedValue<S>> tensorbacked)

See Also:

Tensorbackeds.errorsOf(Tensorbacked)

positionsOf

public static java.util.Set<Position> positionsOf(Tensorbacked<?> tensorbacked)

See Also:

Tensorbackeds.positionsOf(Tensorbacked)

convertToQuantified

@Deprecated
public static <S> Tensor<QuantifiedValue<S>> convertToQuantified(Tensor<S> tensor,
                                                                             Unit unit)

Deprecated. use renamed method quantityTensorOf(Tensor, Unit)

quantityTensorOf

public static <S> Tensor<QuantifiedValue<S>> quantityTensorOf(Tensor<S> tensor,
                                                              Unit unit)

See Also:

QuantityTensors.quantityTensorOf(Tensor, Unit)

quantityTensorOf

public static <S> Tensor<QuantifiedValue<S>> quantityTensorOf(Tensor<S> tensor,
                                                              javax.measure.unit.Unit<?> unit)

See Also:

QuantityTensors.quantityTensorOf(Tensor, javax.measure.unit.Unit)

unitOf

public static <S> Unit unitOf(Tensor<QuantifiedValue<S>> tensor)

See Also:

QuantityTensors.unitOf(Tensor)

unitOf

public static <S> Unit unitOf(Tensorbacked<QuantifiedValue<S>> tensorbacked)

See Also:

Tensorbackeds.unitOf(Tensorbacked)

shapeOf

public static Shape shapeOf(Tensorbacked<?> tensorbacked)

See Also:

Tensorbackeds.shapeOf(Tensorbacked)

dimensionsOf

public static java.util.Set<java.lang.Class<?>> dimensionsOf(Tensorbacked<?> tensorbacked)

from

public static <V> OngoingTensorManipulation<V> from(Tensor<V> tensor)

See Also:

TensorStructurals.from(Tensor)

from

public static <V> OngoingTensorManipulation<V> from(Tensorbacked<V> tensorbacked)

dimensionsOf

public static java.util.Set<java.lang.Class<?>> dimensionsOf(Tensor<?> tensor)

positionsOf

public static java.util.Set<Position> positionsOf(Tensor<?> tensor)

validitiesOf

public static <S> Tensor<java.lang.Boolean> validitiesOf(Tensor<QuantifiedValue<S>> tensor)

valuesOf

public static <S> Tensor<S> valuesOf(Tensor<QuantifiedValue<S>> tensor)

errorsOf

public static <S> Tensor<com.google.common.base.Optional<S>> errorsOf(Tensor<QuantifiedValue<S>> tensor)

errorsOfOr

public static <S> Tensor<S> errorsOfOr(Tensor<QuantifiedValue<S>> tensor,
                                       S defaultValue)

flatten

public static <S> OngoingFlattening<S> flatten(Tensor<S> tensor)

flatten

public static <S> OngoingFlattening<S> flatten(Tensorbacked<S> tensorbacked)

sameValues

public static <S> Tensor<S> sameValues(Shape shape,
                                       S value)

createFrom

@Deprecated
public static <S> Tensor<S> createFrom(Shape shape,
                                                   java.util.function.Supplier<S> supplier)

Deprecated. use tensor(Shape, Supplier)

tensor

public static <S> Tensor<S> tensor(Shape shape,
                                   java.util.function.Supplier<S> supplier)

createFrom

@Deprecated
public static <S> Tensor<S> createFrom(Shape shape,
                                                   java.util.function.Function<Position,S> function)

Deprecated. use tensor(Shape, Function)

tensor

public static <S> Tensor<S> tensor(Shape shape,
                                   java.util.function.Function<Position,S> function)

complete

public static <S> OngoingCompletion<S> complete(Tensor<S> tensor)

transformEntries

@Deprecated
public static <S,T> Tensor<T> transformEntries(Tensor<S> tensor,
                                                           java.util.function.Function<java.util.Map.Entry<Position,S>,T> function)

Deprecated. use map(Tensor, BiFunction) instead

map

public static <S,T> Tensor<T> map(Tensor<S> tensor,
                                  java.util.function.Function<S,T> function)

map

public static <S,T> Tensor<T> map(Tensor<S> tensor,
                                  java.util.function.BiFunction<Position,S,T> function)

forEach

public static <S> void forEach(Tensorbacked<S> tensorBacked,
                               java.util.function.Consumer<S> consumer)

forEach

public static <S> void forEach(Tensorbacked<S> tensorBacked,
                               java.util.function.BiConsumer<Position,S> consumer)

forEach

public static <S> void forEach(Tensor<S> tensor,
                               java.util.function.Consumer<S> consumer)

forEach

public static <S> void forEach(Tensor<S> tensor,
                               java.util.function.BiConsumer<Position,S> consumer)

zeroDimensionalOf

public static final Scalar<QuantifiedValue<java.lang.Double>> zeroDimensionalOf(double value,
                                                                                javax.measure.unit.Unit<?> unit)

zeroDimensionalOf

public static final Scalar<QuantifiedValue<java.lang.Double>> zeroDimensionalOf(double value,
                                                                                Unit unit)

tensorsOf

public static <S> java.lang.Iterable<Tensor<S>> tensorsOf(java.lang.Iterable<? extends Tensorbacked<S>> tensorbackeds)

See Also:

Tensorbackeds.tensorsOf(Iterable)

construct

public static <V,TB extends Tensorbacked<V>> OngoingTensorbackedConstruction<V,TB> construct(java.lang.Class<TB> tensorbackedClass)

See Also:

Tensorbackeds.construct(Class)

stripContext

public static <V,TB extends Tensorbacked<V>> TB stripContext(TB tensorbacked)

See Also:

Tensorbackeds.stripContext(Tensorbacked)

stripContext

public static <S> Tensor<S> stripContext(Tensor<S> tensor)

See Also:

TensorStructurals.stripContext(Tensor)

filter

public static <S> OngoingTensorFiltering<S> filter(Tensor<S> tensor)

See Also:

TensorStructurals.filter(Tensor)

filter

public static <V,TB extends Tensorbacked<V>> OngoingTensorbackedFiltering<V,TB> filter(TB tensorbacked)

See Also:

Tensorbackeds.filter(Tensorbacked)

setContext

public static <S> Tensor<S> setContext(Tensor<S> tensor,
                                       Position context)

setContext

public static <V,TB extends Tensorbacked<V>> TB setContext(TB tensorbacked,
                                                           Position context)

stream

public static <S> java.util.stream.Stream<java.util.Map.Entry<Position,S>> stream(Tensor<S> tensor)

See Also:

TensorStreams.tensorEntryStream(Tensor)

stream

public static <S> java.util.stream.Stream<java.util.Map.Entry<Position,S>> stream(Tensorbacked<S> tensorBacked)

See Also:

TensorStreams.tensorEntryStream(Tensor)

shapesOf

public static <TB extends Tensorbacked<?>> java.lang.Iterable<Shape> shapesOf(java.lang.Iterable<TB> tensorbackeds)

See Also:

Tensorbackeds.shapeOf(Tensorbacked)

complete

public static <S,TB extends Tensorbacked<S>> OngoingTensorbackedCompletion<TB,S> complete(TB tensorbacked)

See Also:

Tensorbackeds.complete(Tensorbacked)

mapFrom

public static <V> java.util.Map<Position,V> mapFrom(Tensor<V> tensor)

See Also:

TensorInternals.mapFrom(Tensor)

at

public static Position at(java.lang.Iterable<?> coordinates)

See Also:

Position.of(Iterable)

at

public static Position at(java.lang.Object... coordinates)

See Also:

Position.of(Object...)

resample

public static <V> OngoingResamplingStart<V> resample(Tensor<V> tensor)

See Also:

TensorStructurals.resample(Tensor)