io.improbable.keanu.tensor

Class TensorShapeValidation

java.lang.Object

io.improbable.keanu.tensor.TensorShapeValidation

public class TensorShapeValidation
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static long[]	checkAllShapesMatch(java.util.Collection<long[]> shapes)
static long[]	checkAllShapesMatch(long[]... shapes)
static long[]	checkAllShapesMatch(java.lang.String errorMessage, java.util.Collection<long[]> shapes)
static long[]	checkAllShapesMatch(java.lang.String errorMessage, long[]... shapes)
static void	checkDimensionExistsInShape(int dimension, long[] shape) Check if the given dimension exists within the shape
static long[]	checkHasOneNonLengthOneShapeOrAllLengthOne(long[]... shapes) This ensures there is at most a single non length one shape.
static void	checkIndexIsValid(long[] shape, long... index)
static long[]	checkIsBroadcastable(long[] left, long[] right)
static void	checkShapeIsSquareMatrix(long[] shape)
static long[]	checkShapesCanBeConcatenated(int dimension, long[]... shapes)
static void	checkShapesMatch(long[] actual, long[] expected)
static void	checkTensorsAreScalar(java.lang.String message, long[]... shapes)
static void	checkTensorsMatchNonLengthOneShapeOrAreLengthOne(long[] proposalShape, long[]... shapes) This is a common function to check that tensors are either the same shape of the proposal in question OR length one.
static long[]	checkTernaryConditionShapeIsValid(long[] predicate, long[] thn, long[] els)
static long[]	getMatrixMultiplicationResultingShape(long[] left, long[] right)
static long[]	getTensorMultiplyResultShape(long[] leftShape, long[] rightShape, int[] dimsLeft, int[] dimsRight)
static boolean	isBroadcastable(long[] left, long[] right)

Methods inherited from class java.lang.Object

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

Method Detail

checkTensorsMatchNonLengthOneShapeOrAreLengthOne

public static void checkTensorsMatchNonLengthOneShapeOrAreLengthOne(long[] proposalShape,
                                                                    long[]... shapes)

This is a common function to check that tensors are either the same shape of the proposal in question OR length one.

Parameters:

proposalShape - the tensor shape being validated

shapes - the tensors being validated against

Throws:

java.lang.IllegalArgumentException - if there is more than one non length one shape OR if the non length one shape does not match the proposal shape.

checkDimensionExistsInShape

public static void checkDimensionExistsInShape(int dimension,
                                               long[] shape)

Check if the given dimension exists within the shape

Parameters:

dimension - Proposed dimension

shape - Shape to check

Throws:

java.lang.IllegalArgumentException - if the dimension exceeds the rank of the shape

checkTensorsAreScalar

public static void checkTensorsAreScalar(java.lang.String message,
                                         long[]... shapes)

checkHasOneNonLengthOneShapeOrAllLengthOne

public static long[] checkHasOneNonLengthOneShapeOrAllLengthOne(long[]... shapes)

This ensures there is at most a single non length one shape.

Parameters:

shapes - the tensors for shape checking

Returns:

either a length one shape OR the single non length one shape.

Throws:

java.lang.IllegalArgumentException - if there is more than one non length one shape or multiple ranks of length 1 shapes

checkIsBroadcastable

public static long[] checkIsBroadcastable(long[] left,
                                          long[] right)

isBroadcastable

public static boolean isBroadcastable(long[] left,
                                      long[] right)

checkTernaryConditionShapeIsValid

public static long[] checkTernaryConditionShapeIsValid(long[] predicate,
                                                       long[] thn,
                                                       long[] els)

Parameters:

predicate - shape of predicate

thn - shape of then

els - shape of else

Returns:

the result shape of predicate ? thn : els. This will be the shape of the predicate if it is not a length one shape or the shape of thn/els if the predicate is length one and thn/else are not.

checkShapeIsSquareMatrix

public static void checkShapeIsSquareMatrix(long[] shape)

checkShapesMatch

public static void checkShapesMatch(long[] actual,
                                    long[] expected)

checkAllShapesMatch

public static long[] checkAllShapesMatch(long[]... shapes)

checkAllShapesMatch

public static long[] checkAllShapesMatch(java.lang.String errorMessage,
                                         long[]... shapes)

checkAllShapesMatch

public static long[] checkAllShapesMatch(java.lang.String errorMessage,
                                         java.util.Collection<long[]> shapes)

checkAllShapesMatch

public static long[] checkAllShapesMatch(java.util.Collection<long[]> shapes)

checkShapesCanBeConcatenated

public static long[] checkShapesCanBeConcatenated(int dimension,
                                                  long[]... shapes)

checkIndexIsValid

public static void checkIndexIsValid(long[] shape,
                                     long... index)

getTensorMultiplyResultShape

public static long[] getTensorMultiplyResultShape(long[] leftShape,
                                                  long[] rightShape,
                                                  int[] dimsLeft,
                                                  int[] dimsRight)

getMatrixMultiplicationResultingShape

public static long[] getMatrixMultiplicationResultingShape(long[] left,
                                                           long[] right)