org.tensorics.core.tensor.variance

Class CoContraDimensionPair

java.lang.Object

org.tensorics.core.tensor.variance.CoContraDimensionPair

public final class CoContraDimensionPair
extends java.lang.Object

Represents a pair of dimensions, related to two different tensors (left, right), where either one has to be the covariant equivalent to the second contravariant dimension.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<?>	contravariant() Retrieves the contravariant part of the pair, no matter if it is left or right
java.lang.Class<?>	covariant() Retrieves the covariant part of the pair, no matter if it is left or right
java.lang.Class<?>	left()
static CoContraDimensionPair	ofLeftRight(java.lang.Class<?> leftDimension, java.lang.Class<?> rightDimension)
java.lang.Class<?>	right()
java.lang.Object	toLeft(java.lang.Object rightCoordinate)
java.lang.Object	toRight(java.lang.Object leftCoordinate)

Methods inherited from class java.lang.Object

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

Method Detail

ofLeftRight

public static CoContraDimensionPair ofLeftRight(java.lang.Class<?> leftDimension,
                                                java.lang.Class<?> rightDimension)

left

public java.lang.Class<?> left()

right

public java.lang.Class<?> right()

covariant

public java.lang.Class<?> covariant()

Retrieves the covariant part of the pair, no matter if it is left or right

Returns:

the covariant part

contravariant

public java.lang.Class<?> contravariant()

Retrieves the contravariant part of the pair, no matter if it is left or right

Returns:

the contravariant part

toLeft

public java.lang.Object toLeft(java.lang.Object rightCoordinate)

toRight

public java.lang.Object toRight(java.lang.Object leftCoordinate)