Package org.flag4j.util

Class ErrorMessages

java.lang.Object

org.flag4j.util.ErrorMessages

public abstract class ErrorMessages
extends Object

Contains error messages for common errors which may occur.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ARRAY_LENGTHS_MISMATCH_ERR	Error message for arrays which were expected to be the same length.
private static final String	AXIS_ERR	Error message for disallowed axis.
private static final String	AXIS_ERR_RANGE	Error message for disallowed axis.
private static final String	EQ_SHAPE_MISMATCH_ERR	Error message for matrices which do not have equal shape.
private static final String	GREATER_EQ_ERR	Error message for parameters which are expected to be greater than or equal to some threshold.
private static final String	INDICES_RANK_ERR	Error message for a number of indices which does not match the rank of the tensor being indexed.
private static final String	LESS_EQ_ERR	Error message for parameters which are expected to be less than or equal to some threshold.
private static final String	MAT_MULT_DIM_MISMATCH_ERR	Error message for matrices which do not have valid dimensions for matrix multiplication.
private static final String	NAMED_GREATER_EQ_ERR	Error message for names parameter which is expected to be greater than or equal to some threshold.
private static final String	NAMED_LESS_EQ_BI_ERR	Error message for named parameter which is expected to be less than or equal to some threshold.
private static final String	NAMED_LESS_EQ_ERR	Error message for named parameter which is expected to be less than or equal to some threshold.
private static final String	NEG_DIM_ERR	Error message for the attempted construction of a tensor with a negative dimension value.
private static final String	NEG_VALUE_ERR	Error message for a negative value when a non-negative was expected.
private static final String	NON_POS_ERR	Error message for a non-positive value when a positive non-zero value is expected.
private static final String	RANGE_ERR	Error message for a parameter which is not within the expected range.
private static final String	SHAPE_BROADCAST_ERR	Error message for shapes which cannot be broadcast.
private static final String	SHAPE_ENTRIES_ERR	Error message for a shape size which cannot contain a specified number of entries.
private static final String	SHAPE_RANK_ERR	Error message wrong shape.
private static final String	SQUARE_SHAPE_ERR	Error message for parameters which are expected to be square.
private static final String	TOTAL_ENTRIES_ERR	Error message for arrays which do not have the same total number of entries.
private static final String	UTILITY_CLASS_ERR	Error message for attempted instantiation of a utility class.
private static final String	VEC_COL_ORIENTATION_ERR	Error message for vector which was expected to be a column vector.
private static final String	VEC_ROW_ORIENTATION_ERR	Error message for vector which was expected to be row vector.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ErrorMessages()	Hide default constructor.

Method Summary

Modifier and Type	Method	Description
static String	equalShapeErrMsg(Shape shape1, Shape shape2)	Gets an error message for two tensors with mismatching shapes.
static String	getArrayLengthsMismatchErr(int... lengths)	Gets an error message for arrays which were expected to be the same length.
static String	getAxisErr(int axis)	Gets an error message for a disallowed axis.
static String	getAxisErr(int axis, int... allowedAxes)	Gets an error message for a disallowed axis.
static String	getGreaterEqErr(double threshold, double value)	Gets an error message for a value which was expected to be greater than of equal to a specified threshold but wasn't.
static String	getIndicesRankErr(int numIndices, int rank)	Gets an error message for a tensor being indexed with a number of indices not equal to the rank of the tensor.
static String	getLessEqErr(double threshold, double value)	Gets an error message for a value which was expected to be less than of equal to a specified threshold but wasn't.
static String	getNamedGreaterEqErr(double threshold, double value, String name)	Gets an error message for a value which was expected to be greater than of equal to a specified threshold but wasn't.
static String	getNamedLessEqErr(double threshold, double value, String name)	Gets an error message for a value which was expected to be less than of equal to a specified threshold but wasn't.
static String	getNamedLessEqErr(BigInteger threshold, double value, String name)	Gets an error message for a value which was expected to be less than of equal to a specified threshold but wasn't.
static String	getNegValueErr(double value)	Gets an error message for a negative value when a non-negative was expected.
static String	getNonPosErr(double value)	Gets an error message for a non-positive value when a positive, non-zero value was expected.
static String	getRangeErr(double value, double lowerBound, double upperBound, String paramName)	Gets an error message for a value which is not within the expected range.
static String	getShapeBroadcastErr(Shape shape1, Shape shape2)	Gets an error message for two shapes which cannot be broadcast together.
static String	getSquareShapeErr(Shape shape)	Gets an error message for a shape which was expected to be square but was not
static String	getTotalEntriesErr()	Gets an error message for arrays which do not have the same total number of entries.
static String	getUtilityClassErrMsg()	Gets an error message for an attempted instantiation of a utility class.
static String	matMultShapeErrMsg(Shape shape1, Shape shape2)	Gets an error message for two matrices with shapes not conducive with matrix multiplication.
static String	negativeDimErrMsg(int[] dims)	Gets an error message for an attempted construction of a tensor with a negative dimension.
static String	shapeEntriesError(Shape shape, int numEntries)	Gets an error message for a shape which cannot hold a specified number of entries.
static String	shapeRankErr(int actRank, int expRank)	Gets an error message for an incorrect shape.
static String	vecColOrientErrMsg(Shape shape)	Gets an error message for a vector which was expected to be a column vector but was a row vector.
static String	vecRowOrientErrMsg(Shape shape)	Gets an error message for a vector which was expected to be a row vector but was a column vector.

Methods inherited from class java.lang.Object

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

Field Details

EQ_SHAPE_MISMATCH_ERR

private static final String EQ_SHAPE_MISMATCH_ERR

Error message for matrices which do not have equal shape.

See Also:

• Constant Field Values

MAT_MULT_DIM_MISMATCH_ERR

private static final String MAT_MULT_DIM_MISMATCH_ERR

Error message for matrices which do not have valid dimensions for matrix multiplication.

See Also:

• Constant Field Values

VEC_ROW_ORIENTATION_ERR

private static final String VEC_ROW_ORIENTATION_ERR

Error message for vector which was expected to be row vector.

See Also:

• Constant Field Values

VEC_COL_ORIENTATION_ERR

private static final String VEC_COL_ORIENTATION_ERR

Error message for vector which was expected to be a column vector.

See Also:

• Constant Field Values

NEG_DIM_ERR

private static final String NEG_DIM_ERR

Error message for the attempted construction of a tensor with a negative dimension value.

See Also:

• Constant Field Values

UTILITY_CLASS_ERR

private static final String UTILITY_CLASS_ERR

Error message for attempted instantiation of a utility class.

See Also:

• Constant Field Values

NEG_VALUE_ERR

private static final String NEG_VALUE_ERR

Error message for a negative value when a non-negative was expected.

See Also:

• Constant Field Values

NON_POS_ERR

private static final String NON_POS_ERR

Error message for a non-positive value when a positive non-zero value is expected.

See Also:

• Constant Field Values

AXIS_ERR_RANGE

private static final String AXIS_ERR_RANGE

Error message for disallowed axis.

See Also:

• Constant Field Values

AXIS_ERR

private static final String AXIS_ERR

Error message for disallowed axis.

See Also:

• Constant Field Values

SHAPE_RANK_ERR

private static final String SHAPE_RANK_ERR

Error message wrong shape.

See Also:

• Constant Field Values

SHAPE_ENTRIES_ERR

private static final String SHAPE_ENTRIES_ERR

Error message for a shape size which cannot contain a specified number of entries.

See Also:

• Constant Field Values

ARRAY_LENGTHS_MISMATCH_ERR

private static final String ARRAY_LENGTHS_MISMATCH_ERR

Error message for arrays which were expected to be the same length.

See Also:

• Constant Field Values

INDICES_RANK_ERR

private static final String INDICES_RANK_ERR

Error message for a number of indices which does not match the rank of the tensor being indexed.

See Also:

• Constant Field Values

SHAPE_BROADCAST_ERR

private static final String SHAPE_BROADCAST_ERR

Error message for shapes which cannot be broadcast.

See Also:

• Constant Field Values

TOTAL_ENTRIES_ERR

private static final String TOTAL_ENTRIES_ERR

Error message for arrays which do not have the same total number of entries.

See Also:

• Constant Field Values

GREATER_EQ_ERR

private static final String GREATER_EQ_ERR

Error message for parameters which are expected to be greater than or equal to some threshold.

See Also:

• Constant Field Values

NAMED_GREATER_EQ_ERR

private static final String NAMED_GREATER_EQ_ERR

Error message for names parameter which is expected to be greater than or equal to some threshold.

See Also:

• Constant Field Values

LESS_EQ_ERR

private static final String LESS_EQ_ERR

Error message for parameters which are expected to be less than or equal to some threshold.

See Also:

• Constant Field Values

NAMED_LESS_EQ_ERR

private static final String NAMED_LESS_EQ_ERR

Error message for named parameter which is expected to be less than or equal to some threshold.

See Also:

• Constant Field Values

NAMED_LESS_EQ_BI_ERR

private static final String NAMED_LESS_EQ_BI_ERR

Error message for named parameter which is expected to be less than or equal to some threshold.

See Also:

• Constant Field Values

SQUARE_SHAPE_ERR

private static final String SQUARE_SHAPE_ERR

Error message for parameters which are expected to be square.

See Also:

• Constant Field Values

RANGE_ERR

private static final String RANGE_ERR

Error message for a parameter which is not within the expected range.

See Also:

• Constant Field Values

Constructor Details

ErrorMessages

private ErrorMessages()

Hide default constructor.

Method Details

equalShapeErrMsg

public static String equalShapeErrMsg(Shape shape1,
 Shape shape2)

Gets an error message for two tensors with mismatching shapes.

Parameters:

shape1 - The shape of the first tensor.

shape2 - The shape of the second tensor.

Returns:

An error message for tensors with mismatching shapes.

matMultShapeErrMsg

public static String matMultShapeErrMsg(Shape shape1,
 Shape shape2)

Gets an error message for two matrices with shapes not conducive with matrix multiplication.

Parameters:

shape1 - The shape of the first matrix.

shape2 - The shape of the second matrix.

Returns:

An error message for matrices with shapes not conducive with matrix multiplication.

vecRowOrientErrMsg

public static String vecRowOrientErrMsg(Shape shape)

Gets an error message for a vector which was expected to be a row vector but was a column vector.

Parameters:

shape - Shape of the vector.

Returns:

An error message for a vector which is not a row vector.

vecColOrientErrMsg

public static String vecColOrientErrMsg(Shape shape)

Gets an error message for a vector which was expected to be a column vector but was a row vector.

Parameters:

shape - Shape of the vector.

Returns:

An error message for a vector which is not a row vector.

negativeDimErrMsg

public static String negativeDimErrMsg(int[] dims)

Gets an error message for an attempted construction of a tensor with a negative dimension.

Parameters:

dims - Shape of the tensor.

Returns:

An error message for negative dimension.

getUtilityClassErrMsg

public static String getUtilityClassErrMsg()

Gets an error message for an attempted instantiation of a utility class.

Returns:

An error message for the attempted instantiation of a utility class;

getNegValueErr

public static String getNegValueErr(double value)

Gets an error message for a negative value when a non-negative was expected.

Parameters:

value - Negative value.

Returns:

An error message for a negative value.

getNonPosErr

public static String getNonPosErr(double value)

Gets an error message for a non-positive value when a positive, non-zero value was expected.

Parameters:

value - Non-positive value.

Returns:

An error message for a Non-positive value.

getAxisErr

public static String getAxisErr(int axis,
 int... allowedAxes)

Gets an error message for a disallowed axis.

Parameters:

axis - Negative value.

allowedAxes - An array containing allowed axes.

Returns:

An error message for a disallowed axis.

getAxisErr

public static String getAxisErr(int axis)

Gets an error message for a disallowed axis.

Parameters:

axis - Negative value.

Returns:

An error message for a disallowed axis.

shapeRankErr

public static String shapeRankErr(int actRank,
 int expRank)

Gets an error message for an incorrect shape.

Parameters:

actRank - Actual rank of the shape.

expRank - Expected rank of the shape.

Returns:

An error message for a shape object with wrong shape.

shapeEntriesError

public static String shapeEntriesError(Shape shape,
 int numEntries)

Gets an error message for a shape which cannot hold a specified number of entries.

Parameters:

shape - Shape.

numEntries - Number of entries to hold.

Returns:

An error message for a shape which cannot hold a specified number of entries.

getArrayLengthsMismatchErr

public static String getArrayLengthsMismatchErr(int... lengths)

Gets an error message for arrays which were expected to be the same length.

Parameters:

lengths - Lengths of arrays.

Returns:

An error message for arrays which were expected to be the same length.

getIndicesRankErr

public static String getIndicesRankErr(int numIndices,
 int rank)

Gets an error message for a tensor being indexed with a number of indices not equal to the rank of the tensor.

Parameters:

numIndices - Number of indices.

rank - Rank of the tensor.

Returns:

An error message for a tensor being indexed with a number if indices not equal ot the rank of the tensor.

getShapeBroadcastErr

public static String getShapeBroadcastErr(Shape shape1,
 Shape shape2)

Gets an error message for two shapes which cannot be broadcast together.

Parameters:

shape1 - First shape.

shape2 - Second shape.

Returns:

An error message for two shapes which cannot be broadcast together.

getTotalEntriesErr

public static String getTotalEntriesErr()

Gets an error message for arrays which do not have the same total number of entries.

Returns:

An error message for arrays which do not have the same total number of entries.

getGreaterEqErr

public static String getGreaterEqErr(double threshold,
 double value)

Gets an error message for a value which was expected to be greater than of equal to a specified threshold but wasn't.

Parameters:

threshold - Threshold value.

value - Value expected to be greater than or equal to the threshold value.

Returns:

An error message for a value which was expected to be greater than of equal to a specified threshold but wasn't.

getNamedGreaterEqErr

public static String getNamedGreaterEqErr(double threshold,
 double value,
 String name)

Gets an error message for a value which was expected to be greater than of equal to a specified threshold but wasn't.

Parameters:

threshold - Threshold value.

value - Value expected to be greater than or equal to the threshold value.

Returns:

An error message for a value which was expected to be greater than of equal to a specified threshold but wasn't.

getLessEqErr

public static String getLessEqErr(double threshold,
 double value)

Gets an error message for a value which was expected to be less than of equal to a specified threshold but wasn't.

Parameters:

threshold - Threshold value.

value - Value expected to be less than or equal to the threshold value.

Returns:

An error message for a value which was expected to be greater than of equal to a specified threshold but wasn't.

getNamedLessEqErr

public static String getNamedLessEqErr(double threshold,
 double value,
 String name)

Gets an error message for a value which was expected to be less than of equal to a specified threshold but wasn't.

Parameters:

threshold - Threshold value.

value - Value expected to be less than or equal to the threshold value.

Returns:

An error message for a value which was expected to be greater than of equal to a specified threshold but wasn't.

getNamedLessEqErr

public static String getNamedLessEqErr(BigInteger threshold,
 double value,
 String name)

Gets an error message for a value which was expected to be less than of equal to a specified threshold but wasn't.

Parameters:

threshold - Threshold value.

value - Value expected to be less than or equal to the threshold value.

Returns:

An error message for a value which was expected to be greater than of equal to a specified threshold but wasn't.

getSquareShapeErr

public static String getSquareShapeErr(Shape shape)

Gets an error message for a shape which was expected to be square but was not

Parameters:

shape - Shape of the tensor.

Returns:

An error message for a shape which was expected to be square but was not

getRangeErr

public static String getRangeErr(double value,
 double lowerBound,
 double upperBound,
 String paramName)

Gets an error message for a value which is not within the expected range.

Parameters:

value - Value of interest.

lowerBound - Lower bound of expected range.

upperBound - Upper bound of expected range.

paramName - Name of the parameter which has the specified value.

Returns:

An error message for the parameter being out of the expected range.