org.tensorics.core.tensor.options

Interface BroadcastingStrategy

All Superinterfaces:

ManipulationOption, Option<ManipulationOption>

All Known Implementing Classes:

BroadcastMissingDimensionsStrategy

public interface BroadcastingStrategy
extends ManipulationOption

Implementations of this strategy type define how tensors shall be treated, if their dimensions do not match. A broadcasting strategy has to take care, that the two returned tensors have the same dimensions, but still might have different shape.

Method Summary

Modifier and Type	Method and Description
<V> TensorPair<V>	broadcast(Tensor<V> left, Tensor<V> right, java.util.Set<java.lang.Class<?>> excludedDimensions) Has to broadcast the given to tensors into a new pair of tensors, that are consistent according to the broadcasting strategy in question.

Methods inherited from interface org.tensorics.core.commons.options.Option

getMarkerInterface

Method Detail

broadcast

<V> TensorPair<V> broadcast(Tensor<V> left,
                            Tensor<V> right,
                            java.util.Set<java.lang.Class<?>> excludedDimensions)

Has to broadcast the given to tensors into a new pair of tensors, that are consistent according to the broadcasting strategy in question.

Parameters:

left - the left tensor to broadcast

right - the right tensor to broadcast

excludedDimensions - a set of dimensions, which should be excluded from broadcasting

Returns:

the result of the broadcasting