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[]	checkHasSingleNonScalarShapeOrAllScalar(long[]... shapes) This ensures there is at most a single non-scalar shape.
static void	checkIndexIsValid(long[] shape, long... index)
static void	checkRankIsAtLeastTwo(long[] shape)
static void	checkShapeIsSquareMatrix(long[] shape)
static long[]	checkShapesCanBeConcatenated(int dimension, long[]... shapes)
static void	checkTensorsMatchNonScalarShapeOrAreScalar(long[] proposalShape, long[]... shapes) This is a common function to check that tensors are either the same shape of the proposal in question OR scalar.

Methods inherited from class java.lang.Object

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

Method Detail

checkTensorsMatchNonScalarShapeOrAreScalar

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

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

Parameters:

proposalShape - the tensor shape being validated

shapes - the tensors being validated against

Throws:

java.lang.IllegalArgumentException - if there is more than one non-scalar shape OR if the non-scalar 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

checkHasSingleNonScalarShapeOrAllScalar

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

This ensures there is at most a single non-scalar shape.

Parameters:

shapes - the tensors for shape checking

Returns:

either a scalar shape OR the single non-scalar shape.

Throws:

java.lang.IllegalArgumentException - if there is more than one non-scalar shape

checkShapeIsSquareMatrix

public static void checkShapeIsSquareMatrix(long[] shape)

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)

checkRankIsAtLeastTwo

public static void checkRankIsAtLeastTwo(long[] shape)