Static Public Member Functions
static void	makeSureAllAreBounded (ModelVector oData, boolean[] p_bAppliesTo, float fLowerBound, float fUpperBound) throws ModelException
	Makes sure that all the values in a vector fall between two bounds. More...

static void	makeSureAllPositive (Float[] p_fData, String sName, boolean[] p_bAppliesTo) throws ModelException
	Makes sure the elements of a float array are positive numbers (greater than zero). More...

static void	makeSureAllPositive (Float[] p_fData, String sName) throws ModelException
	Makes sure the elements of a float array are positive numbers (greater than zero). More...

static void	makeSureAllNonNegative (Float[] p_fData, String sName, boolean[] p_bAppliesTo) throws ModelException
	Makes sure the elements of a float array are non-negative numbers (greater than or equal to zero). More...

static void	makeSureAllNonNegative (Float[] p_fData, String sName) throws ModelException
	Makes sure the elements of a float array are non-negative numbers (greater than or equal to zero). More...

static void	makeSureAllPositive (Integer[] p_iData, String sName, boolean[] p_bAppliesTo) throws ModelException
	Makes sure the elements of an integer array are positive numbers (greater than zero). More...

static void	makeSureAllPositive (Integer[] p_iData, String sName) throws ModelException
	Makes sure the elements of an integer array are positive numbers (greater than zero). More...

static void	makeSureAllNonNegative (Integer[] p_iData, String sName, boolean[] p_bAppliesTo) throws ModelException
	Makes sure the elements of an integer array are non-negative numbers (greater than or equal to zero). More...

static void	makeSureAllNonNegative (Integer[] p_iData, String sName) throws ModelException
	Makes sure the elements of an integer array are non-negative numbers (greater than or equal to zero). More...

static void	makeSureGreaterThan (ModelFloat oValue, float fLowerBound) throws ModelException
	Makes sure a value is greater than a certain value. More...

static void	makeSureGreaterThanEqualTo (ModelFloat oValue, float fLowerBound) throws ModelException
	Makes sure a value is greater than or equal to a certain value. More...

static void	makeSureGreaterThan (ModelInt oValue, float fLowerBound) throws ModelException
	Makes sure a value is greater than a certain value. More...

static void	makeSureGreaterThanEqualTo (ModelInt oValue, float fLowerBound) throws ModelException
	Makes sure a value is greater than or equal to a certain value. More...

static void	makeSureLessThan (ModelFloat oValue, float fUpperBound) throws ModelException
	Makes sure a value is less than a certain value. More...

static void	makeSureLessThan (ModelInt oValue, float fUpperBound) throws ModelException
	Makes sure a value is less than a certain value. More...

static void	makeSureLessThanEqualTo (ModelFloat oValue, float fUpperBound) throws ModelException
	Makes sure a value is less than or equal to a certain value. More...

static void	makeSureLessThanEqualTo (ModelInt oValue, float fUpperBound) throws ModelException
	Makes sure a value is less than or equal to a certain value. More...

static void	makeSureNotEqualTo (ModelFloat oValue, float fForbidden) throws ModelException
	Makes sure a value is not equal to another value. More...

static void	makeSureNotEqualTo (ModelInt oValue, float fForbidden) throws ModelException
	Makes sure a value is not equal to another value. More...

static void	makeSureIsBounded (ModelFloat oValue, float fLowerBound, float fUpperBound) throws ModelException
	Makes sure a value falls in an acceptable range. More...

static void	makeSureIsBounded (ModelInt oValue, float fLowerBound, float fUpperBound) throws ModelException
	Makes sure a value falls in an acceptable range. More...

static void	makeSureIsProportion (ModelFloat fValue) throws ModelException
	Makes sure a value is a proportion between 0 and 1 (inclusive). More...

static void	makeSureAllAreProportions (ModelVector oData, boolean[] p_bAppliesTo) throws ModelException
	Makes sure the data in a vector are proportions between 0 and 1 (inclusive). More...

static void	makeSureAllAreProportions (ModelVector oData) throws ModelException
	Makes sure all the data in a vector are proportions between 0 and 1 (inclusive). More...

static void	makeSureRightSize (ModelVector oData, int iLength) throws ModelException
	Makes sure that a vector is of a certain size. More...

static void	makeSureAllNonNegative (ModelVector oData) throws ModelException
	Makes sure the elements of a vector are non-negative numbers (greater than or equal to zero). More...

static void	makeSureAllNonZero (ModelVector oData) throws ModelException
	Makes sure the elements of a vector are non-zero. More...

static void	makeSureAllNonZero (ModelVector oData, boolean[] p_bAppliesTo) throws ModelException
	Makes sure the elements of a vector are non-zero numbers. More...

static void	makeSureAllPositive (ModelVector oData, boolean[] p_bAppliesTo) throws ModelException
	Makes sure the elements of a vector are positive numbers (greater than zero). More...

static void	makeSureAllPositive (ModelVector oData) throws ModelException
	Makes sure the elements of a vector are positive numbers (greater than zero). More...

static void	makeSureAllNonNegative (ModelVector oData, boolean[] p_bAppliesTo) throws ModelException
	Makes sure the elements of a vector are non-negative numbers (greater than or equal to zero). More...

Member Function Documentation

◆ makeSureAllAreBounded()

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllAreBounded	(	ModelVector	oData,
		boolean []	p_bAppliesTo,
		float	fLowerBound,
		float	fUpperBound
	)		throws ModelException

static

Makes sure that all the values in a vector fall between two bounds.

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters

oData	ModelVector Vector to check.
p_bAppliesTo	boolean[] Set of flags for which values to check.
fLowerBound	Float Minimum acceptable value.
fUpperBound	Float Maximum acceptable value.

Exceptions

ModelException If any value falls outside of the range.

◆ makeSureAllAreProportions() [1/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllAreProportions	(	ModelVector	oData,
		boolean []	p_bAppliesTo
	)		throws ModelException

static

Makes sure the data in a vector are proportions between 0 and 1 (inclusive).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters

oData	Vector to check
p_bAppliesTo	Set of flags for which values to check

Exceptions

ModelException if any value in the vector is not a valid proportion.

◆ makeSureAllAreProportions() [2/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllAreProportions ( ModelVector oData ) throws ModelException

static

Makes sure all the data in a vector are proportions between 0 and 1 (inclusive).

Parameters

oData Vector to check

Exceptions

ModelException if any value in the vector is not a valid proportion.

◆ makeSureAllNonNegative() [1/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative	(	Float []	p_fData,
		String	sName,
		boolean []	p_bAppliesTo
	)		throws ModelException

static

Makes sure the elements of a float array are non-negative numbers (greater than or equal to zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters

p_fData	The array to check.
sName	The name of the vector, to put in the error message.
p_bAppliesTo	Set of flags for which values to check

Exceptions

ModelException if there are any negative number values in the vector.

◆ makeSureAllNonNegative() [2/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative	(	Float []	p_fData,
		String	sName
	)		throws ModelException

static

Makes sure the elements of a float array are non-negative numbers (greater than or equal to zero).

Parameters

p_fData	The array to check.
sName	The name of the vector, to put in the error message.

Exceptions

ModelException if there are any negative number values in the vector.

◆ makeSureAllNonNegative() [3/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative	(	Integer []	p_iData,
		String	sName,
		boolean []	p_bAppliesTo
	)		throws ModelException

static

Makes sure the elements of an integer array are non-negative numbers (greater than or equal to zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters

p_iData	The array to check.
sName	The name of the vector, to put in the error message.
p_bAppliesTo	Set of flags for which values to check

Exceptions

ModelException if there are any negative number values in the vector.

◆ makeSureAllNonNegative() [4/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative	(	Integer []	p_iData,
		String	sName
	)		throws ModelException

static

Makes sure the elements of an integer array are non-negative numbers (greater than or equal to zero).

Parameters

p_iData	The array to check.
sName	The name of the vector, to put in the error message.

Exceptions

ModelException if there are any negative number values in the vector.

◆ makeSureAllNonNegative() [5/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative ( ModelVector oData ) throws ModelException

static

Makes sure the elements of a vector are non-negative numbers (greater than or equal to zero).

Parameters

oData The vector to check.

Exceptions

ModelException if there are any negative number values in the vector.

◆ makeSureAllNonNegative() [6/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative	(	ModelVector	oData,
		boolean []	p_bAppliesTo
	)		throws ModelException

static

Makes sure the elements of a vector are non-negative numbers (greater than or equal to zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters

oData	The vector to check.
p_bAppliesTo	Set of flags for which values to check

Exceptions

ModelException if there are any negative number values in the vector.

◆ makeSureAllNonZero() [1/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonZero ( ModelVector oData ) throws ModelException

static

Makes sure the elements of a vector are non-zero.

Parameters

oData The vector to check.

Exceptions

ModelException if there are any 0 values in the vector.

◆ makeSureAllNonZero() [2/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonZero	(	ModelVector	oData,
		boolean []	p_bAppliesTo
	)		throws ModelException

static

Makes sure the elements of a vector are non-zero numbers.

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters

oData	The vector to check.
p_bAppliesTo	Set of flags for which values to check

Exceptions

ModelException if there are any negative number values in the vector.

◆ makeSureAllPositive() [1/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive	(	Float []	p_fData,
		String	sName,
		boolean []	p_bAppliesTo
	)		throws ModelException

static

Makes sure the elements of a float array are positive numbers (greater than zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters

p_fData	The array to check.
sName	The name of the vector, to put in the error message.
p_bAppliesTo	Set of flags for which values to check

Exceptions

ModelException if there are any non-positive number values in the vector.

◆ makeSureAllPositive() [2/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive	(	Float []	p_fData,
		String	sName
	)		throws ModelException

static

Makes sure the elements of a float array are positive numbers (greater than zero).

Parameters

p_fData	The array to check.
sName	The name of the vector, to put in the error message.

Exceptions

ModelException if there are any non-positive number values in the vector.

◆ makeSureAllPositive() [3/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive	(	Integer []	p_iData,
		String	sName,
		boolean []	p_bAppliesTo
	)		throws ModelException

static

Makes sure the elements of an integer array are positive numbers (greater than zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters

p_iData	The array to check.
sName	The name of the vector, to put in the error message.
p_bAppliesTo	Set of flags for which values to check

Exceptions

ModelException if there are any non-positive number values in the vector.

◆ makeSureAllPositive() [4/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive	(	Integer []	p_iData,
		String	sName
	)		throws ModelException

static

Makes sure the elements of an integer array are positive numbers (greater than zero).

Parameters

p_iData	The array to check.
sName	The name of the vector, to put in the error message.

Exceptions

ModelException if there are any non-positive number values in the vector.

◆ makeSureAllPositive() [5/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive	(	ModelVector	oData,
		boolean []	p_bAppliesTo
	)		throws ModelException

static

Makes sure the elements of a vector are positive numbers (greater than zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters

oData	The vector to check.
p_bAppliesTo	Set of flags for which values to check

Exceptions

ModelException if there are any non-positive number values in the vector.

◆ makeSureAllPositive() [6/6]

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive ( ModelVector oData ) throws ModelException

static

Makes sure the elements of a vector are positive numbers (greater than zero).

Parameters

oData The vector to check.

Exceptions

ModelException if there are any non-positive number values in the vector.

◆ makeSureGreaterThan() [1/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureGreaterThan	(	ModelFloat	oValue,
		float	fLowerBound
	)		throws ModelException

static

Makes sure a value is greater than a certain value.

Parameters

oValue	The value to check.
fLowerBound	The value the test value must be greater than.

Exceptions

ModelException if the value is not greater than fLowerBound.

◆ makeSureGreaterThan() [2/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureGreaterThan	(	ModelInt	oValue,
		float	fLowerBound
	)		throws ModelException

static

Makes sure a value is greater than a certain value.

Parameters

oValue	The value to check.
fLowerBound	The value the test value must be greater than.

Exceptions

ModelException if the value is not greater than fLowerBound.

◆ makeSureGreaterThanEqualTo() [1/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureGreaterThanEqualTo	(	ModelFloat	oValue,
		float	fLowerBound
	)		throws ModelException

static

Makes sure a value is greater than or equal to a certain value.

Parameters

oValue	The value to check.
fLowerBound	The value the test value must be greater than or equal to.

Exceptions

ModelException if the value is not greater than fLowerBound.

◆ makeSureGreaterThanEqualTo() [2/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureGreaterThanEqualTo	(	ModelInt	oValue,
		float	fLowerBound
	)		throws ModelException

static

Makes sure a value is greater than or equal to a certain value.

Parameters

oValue	The value to check.
fLowerBound	The value the test value must be greater than or equal to.

Exceptions

ModelException if the value is not greater than fLowerBound.

◆ makeSureIsBounded() [1/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureIsBounded	(	ModelFloat	oValue,
		float	fLowerBound,
		float	fUpperBound
	)		throws ModelException

static

Makes sure a value falls in an acceptable range.

Parameters

oValue	The value to check.
fLowerBound	float Minimum acceptable value.
fUpperBound	float Maximum acceptable value.

Exceptions

ModelException If any value falls outside of the range.

◆ makeSureIsBounded() [2/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureIsBounded	(	ModelInt	oValue,
		float	fLowerBound,
		float	fUpperBound
	)		throws ModelException

static

Makes sure a value falls in an acceptable range.

Parameters

oValue	The value to check.
fLowerBound	float Minimum acceptable value.
fUpperBound	float Maximum acceptable value.

Exceptions

ModelException If any value falls outside of the range.

◆ makeSureIsProportion()

static void sortie.data.funcgroups.ValidationHelpers.makeSureIsProportion ( ModelFloat fValue ) throws ModelException

static

Makes sure a value is a proportion between 0 and 1 (inclusive).

Parameters

fValue Value to check.

Exceptions

ModelException if the value is not a valid proportion.

◆ makeSureLessThan() [1/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureLessThan	(	ModelFloat	oValue,
		float	fUpperBound
	)		throws ModelException

static

Makes sure a value is less than a certain value.

Parameters

oValue	The value to check.
fUpperBound	The value the test value must be less than.

Exceptions

ModelException if the value is not less than fUpperBound.

◆ makeSureLessThan() [2/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureLessThan	(	ModelInt	oValue,
		float	fUpperBound
	)		throws ModelException

static

Makes sure a value is less than a certain value.

Parameters

oValue	The value to check.
fUpperBound	The value the test value must be less than.

Exceptions

ModelException if the value is not less than fUpperBound.

◆ makeSureLessThanEqualTo() [1/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureLessThanEqualTo	(	ModelFloat	oValue,
		float	fUpperBound
	)		throws ModelException

static

Makes sure a value is less than or equal to a certain value.

Parameters

oValue	The value to check.
fUpperBound	The value the test value must be less than or equal to.

Exceptions

ModelException if the value is not greater than fUpperBound.

◆ makeSureLessThanEqualTo() [2/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureLessThanEqualTo	(	ModelInt	oValue,
		float	fUpperBound
	)		throws ModelException

static

Makes sure a value is less than or equal to a certain value.

Parameters

oValue	The value to check.
fUpperBound	The value the test value must be less than or equal to.

Exceptions

ModelException if the value is not greater than fUpperBound.

◆ makeSureNotEqualTo() [1/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureNotEqualTo	(	ModelFloat	oValue,
		float	fForbidden
	)		throws ModelException

static

Makes sure a value is not equal to another value.

Parameters

oValue	The value to check.
fForbidden	The value the test value cannot equal.

Exceptions

ModelException if the value is equal to the specified value, within a very small number.

◆ makeSureNotEqualTo() [2/2]

static void sortie.data.funcgroups.ValidationHelpers.makeSureNotEqualTo	(	ModelInt	oValue,
		float	fForbidden
	)		throws ModelException

static

Makes sure a value is not equal to another value.

Parameters

oValue	The value to check.
fForbidden	The value the test value cannot equal.

Exceptions

ModelException if the value is equal to the specified value, within a very small number.

◆ makeSureRightSize()

static void sortie.data.funcgroups.ValidationHelpers.makeSureRightSize	(	ModelVector	oData,
		int	iLength
	)		throws ModelException

static

Makes sure that a vector is of a certain size.

Parameters

oData	Vector to validate.
iLength	Expected length.

Exceptions

ModelException if the vector is not of the correct length.

The documentation for this class was generated from the following file:

ValidationHelpers.java

Static Public Member Functions

Member Function Documentation

◆ makeSureAllAreBounded()

◆ makeSureAllAreProportions() [1/2]

◆ makeSureAllAreProportions() [2/2]

◆ makeSureAllNonNegative() [1/6]

◆ makeSureAllNonNegative() [2/6]

◆ makeSureAllNonNegative() [3/6]

◆ makeSureAllNonNegative() [4/6]

◆ makeSureAllNonNegative() [5/6]

◆ makeSureAllNonNegative() [6/6]

◆ makeSureAllNonZero() [1/2]

◆ makeSureAllNonZero() [2/2]

◆ makeSureAllPositive() [1/6]

◆ makeSureAllPositive() [2/6]

◆ makeSureAllPositive() [3/6]

◆ makeSureAllPositive() [4/6]

◆ makeSureAllPositive() [5/6]

◆ makeSureAllPositive() [6/6]

◆ makeSureGreaterThan() [1/2]

◆ makeSureGreaterThan() [2/2]

◆ makeSureGreaterThanEqualTo() [1/2]

◆ makeSureGreaterThanEqualTo() [2/2]

◆ makeSureIsBounded() [1/2]

◆ makeSureIsBounded() [2/2]

◆ makeSureIsProportion()

◆ makeSureLessThan() [1/2]

◆ makeSureLessThan() [2/2]

◆ makeSureLessThanEqualTo() [1/2]

◆ makeSureLessThanEqualTo() [2/2]

◆ makeSureNotEqualTo() [1/2]

◆ makeSureNotEqualTo() [2/2]

◆ makeSureRightSize()