edu.ie3.util.quantities

Class QuantityUtil

java.lang.Object

edu.ie3.util.quantities.QuantityUtil

public class QuantityUtil
extends java.lang.Object

Offers useful methods to handle Quantitys

For the purpose of this class and the use within the PowerSystemDataModel project, we differentiate between equality and equivalence:

Equality is understood like represented by Object.equals(Object), so a quantity of 1km is not equals to 1000m.

Equivalence is based on the quantities magnitude, a quantity of 1km is equivalent to 1000m.

Method Summary

Modifier and Type	Method and Description
static <Q extends javax.measure.Quantity<Q>> tech.units.indriya.ComparableQuantity<Q>	asComparable(javax.measure.Quantity<Q> quantity) Converts a given quantity to a comparable quantity
static <Q extends javax.measure.Quantity<Q>> boolean	considerablyAbsEqual(javax.measure.Quantity<Q> a, javax.measure.Quantity<Q> b, double absQuantityTolerance) Deprecated. renamed to isEquivalentAbs(Quantity, Quantity, double) for clarity und uniformity
static boolean	considerablyEqualAngle(javax.measure.Quantity<javax.measure.quantity.Angle> a, javax.measure.Quantity<javax.measure.quantity.Angle> b, double quantityTolerance) Deprecated. Renamed to isEquivalentAngle(Quantity, Quantity, double)
static <Q extends javax.measure.Quantity<Q>> boolean	considerablyRelEqual(javax.measure.Quantity<Q> a, javax.measure.Quantity<Q> b, double relQuantityTolerance) Deprecated. Renamed to isEquivalentRel(Quantity, Quantity, double) for clarity und uniformity
static <Q extends javax.measure.Quantity<Q>> boolean	equals(javax.measure.Quantity<Q> a, javax.measure.Quantity<Q> b) Compares two Quantitys, if they are equal.
static <Q extends javax.measure.Quantity<Q>> boolean	equals(javax.measure.Quantity<Q> a, javax.measure.Quantity<Q> b, double quantityTolerance) Compares two Quantitys, if they are equal.
static boolean	isEmpty(javax.measure.Quantity<?> that) Checks if the given quantity is empty by returning positive if it is an EmptyQuantity.
static <Q extends javax.measure.Quantity<Q>> boolean	isEquivalentAbs(javax.measure.Quantity<Q> a, javax.measure.Quantity<Q> b) Compares two Quantitys, if they are equivalent considering both quantities magnitude.
static <Q extends javax.measure.Quantity<Q>> boolean	isEquivalentAbs(javax.measure.Quantity<Q> a, javax.measure.Quantity<Q> b, double absQuantityTolerance) Compares two Quantitys, if they are equivalent considering both quantities magnitude.
static boolean	isEquivalentAngle(javax.measure.Quantity<javax.measure.quantity.Angle> a, javax.measure.Quantity<javax.measure.quantity.Angle> b) Compares two Angle Quantitys, if they are equivalent, especially considering semantic equality for angles.
static boolean	isEquivalentAngle(javax.measure.Quantity<javax.measure.quantity.Angle> a, javax.measure.Quantity<javax.measure.quantity.Angle> b, double quantityTolerance) Compares two Angle Quantitys, if they are equivalent, especially considering semantic equality for angles.
static <Q extends javax.measure.Quantity<Q>> boolean	isEquivalentConsideringEmpty(tech.units.indriya.ComparableQuantity<Q> a, tech.units.indriya.ComparableQuantity<Q> b) Compares two Quantitys, if they are equivalent.
static <Q extends javax.measure.Quantity<Q>> boolean	isEquivalentConsideringEmpty(tech.units.indriya.ComparableQuantity<Q> a, tech.units.indriya.ComparableQuantity<Q> b, double quantityTolerance) Compares two Quantitys, if they are equivalent.
static <Q extends javax.measure.Quantity<Q>> boolean	isEquivalentRel(javax.measure.Quantity<Q> a, javax.measure.Quantity<Q> b) Compares two Quantitys, if they are equivalent considering both quantities magnitude.
static <Q extends javax.measure.Quantity<Q>> boolean	isEquivalentRel(javax.measure.Quantity<Q> a, javax.measure.Quantity<Q> b, double relQuantityTolerance) Compares two Quantitys, if they are equivalent considering both quantities magnitude.
static <Q extends javax.measure.Quantity<Q>> boolean	isTheSameConsideringEmpty(javax.measure.Quantity<Q> a, javax.measure.Quantity<Q> b) Deprecated. Renamed to equals(Quantity, Quantity) for clarity and uniformity

Methods inherited from class java.lang.Object

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

Method Detail

asComparable

public static <Q extends javax.measure.Quantity<Q>> tech.units.indriya.ComparableQuantity<Q> asComparable(javax.measure.Quantity<Q> quantity)

Converts a given quantity to a comparable quantity

Type Parameters:

Q - Type of input quantity

Parameters:

quantity - Input quantity

Returns:

The same value and unit, but as a ComparableQuantity

isEquivalentAbs

public static <Q extends javax.measure.Quantity<Q>> boolean isEquivalentAbs(javax.measure.Quantity<Q> a,
                                                                            javax.measure.Quantity<Q> b)

Compares two Quantitys, if they are equivalent considering both quantities magnitude. This is foremost important for NumberQuantitys with internal big decimal or double values. The comparison is made on the absolute difference of both quantities' value. Both quantities are converted into a's unit before the comparison. Internally calls isEquivalentAbs(Quantity, Quantity, double) with a default tolerance of

Type Parameters:

Q - Type of Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

Returns:

true, if both quantities' do not differ in values (considering no tolerance), else false

isEquivalentAbs

public static <Q extends javax.measure.Quantity<Q>> boolean isEquivalentAbs(javax.measure.Quantity<Q> a,
                                                                            javax.measure.Quantity<Q> b,
                                                                            double absQuantityTolerance)

Compares two Quantitys, if they are equivalent considering both quantities magnitude. This is foremost important for NumberQuantitys with internal big decimal or double values. The comparison is made on the absolute difference of both quantities' value. Both quantities are converted into a's unit before the comparison.

Type Parameters:

Q - Type of Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

absQuantityTolerance - Permissible absolute tolerance

Returns:

true, if both quantities' values differ less than the given tolerance (based on a's unit) else false

considerablyAbsEqual

@Deprecated
public static <Q extends javax.measure.Quantity<Q>> boolean considerablyAbsEqual(javax.measure.Quantity<Q> a,
                                                                                             javax.measure.Quantity<Q> b,
                                                                                             double absQuantityTolerance)

Deprecated. renamed to isEquivalentAbs(Quantity, Quantity, double) for clarity und uniformity

Compares two Quantitys, if they are equivalent considering both quantities magnitude. This is foremost important for NumberQuantitys with internal big decimal or double values. The comparison is made on the absolute difference of both quantities' value. Both quantities are converted into a's unit before the comparison.

Type Parameters:

Q - Type of Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

absQuantityTolerance - Permissible absolute tolerance

Returns:

true, if both quantities' values differ less than the given tolerance (based on a's unit) else false

isEquivalentRel

public static <Q extends javax.measure.Quantity<Q>> boolean isEquivalentRel(javax.measure.Quantity<Q> a,
                                                                            javax.measure.Quantity<Q> b)

Compares two Quantitys, if they are equivalent considering both quantities magnitude. This is foremost important for NumberQuantitys with internal big decimal or double values. The comparison is made on the relative difference of both quantities' value with regard to a's value. Both quantities are converted into a's unit before the comparison. Internally calls isEquivalentRel(Quantity, Quantity, double) with a default tolerance of

Type Parameters:

Q - Type of Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

Returns:

true, if both quantities' values do not differ in value (considering no tolerance) else false

isEquivalentRel

public static <Q extends javax.measure.Quantity<Q>> boolean isEquivalentRel(javax.measure.Quantity<Q> a,
                                                                            javax.measure.Quantity<Q> b,
                                                                            double relQuantityTolerance)

Compares two Quantitys, if they are equivalent considering both quantities magnitude. This is foremost important for NumberQuantitys with internal big decimal or double values. The comparison is made on the relative difference of both quantities' value with regard to a's value. Both quantities are converted into a's unit before the comparison.

Type Parameters:

Q - Type of Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

relQuantityTolerance - Permissible relative tolerance

Returns:

true, if both quantities' values differ less than the given tolerance else false

considerablyRelEqual

@Deprecated
public static <Q extends javax.measure.Quantity<Q>> boolean considerablyRelEqual(javax.measure.Quantity<Q> a,
                                                                                             javax.measure.Quantity<Q> b,
                                                                                             double relQuantityTolerance)

Deprecated. Renamed to isEquivalentRel(Quantity, Quantity, double) for clarity und uniformity

Compares two Quantitys, if they are equivalent considering both quantities magnitude. This is foremost important for NumberQuantitys with internal big decimal or double values. The comparison is made on the relative difference of both quantities' value with regard to a's value. Both quantities are converted into a's unit before the comparison.

Type Parameters:

Q - Type of Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

relQuantityTolerance - Permissible relative tolerance

Returns:

true, if both quantities' values differ less than the given tolerance else false

isEquivalentAngle

public static boolean isEquivalentAngle(javax.measure.Quantity<javax.measure.quantity.Angle> a,
                                        javax.measure.Quantity<javax.measure.quantity.Angle> b)

Compares two Angle Quantitys, if they are equivalent, especially considering semantic equality for angles. This is foremost important for NumberQuantitys with internal big decimal or double values. The comparison is made on the absolute difference of both quantities' value. As of the repetitive nature of angles, they have to be treated separately, e.g. -170° is semantically the same angle as 190°. To ensure this, all quantities are converted to PowerSystemUnits.DEGREE_GEOM. Internally calls isEquivalentAngle(Quantity, Quantity, double) with a default tolerance of

Parameters:

a - First quantity to compare

b - Second quantity to compare

Returns:

true, if both quantities' values differ less (converted to degree) than the given tolerance else false

isEquivalentAngle

public static boolean isEquivalentAngle(javax.measure.Quantity<javax.measure.quantity.Angle> a,
                                        javax.measure.Quantity<javax.measure.quantity.Angle> b,
                                        double quantityTolerance)

Compares two Angle Quantitys, if they are equivalent, especially considering semantic equality for angles. This is foremost important for NumberQuantitys with internal big decimal or double values. The comparison is made on the absolute difference of both quantities' value. As of the repetitive nature of angles, they have to be treated separately, e.g. -170° is semantically the same angle as 190°. To ensure this, all quantities are converted to PowerSystemUnits.DEGREE_GEOM.

Parameters:

a - First quantity to compare

b - Second quantity to compare

quantityTolerance - Permissible absolute tolerance

Returns:

true, if both quantities' values differ less (converted to degree) than the given tolerance else false

considerablyEqualAngle

@Deprecated
public static boolean considerablyEqualAngle(javax.measure.Quantity<javax.measure.quantity.Angle> a,
                                                         javax.measure.Quantity<javax.measure.quantity.Angle> b,
                                                         double quantityTolerance)

Deprecated. Renamed to isEquivalentAngle(Quantity, Quantity, double)

Compares two Angle Quantitys, if they are equivalent, especially considering semantic equality for angles. This is foremost important for NumberQuantitys with internal big decimal or double values. The comparison is made on the absolute difference of both quantities' value. As of the repetitive nature of angles, they have to be treated separately, e.g. -170° is semantically the same angle as 190°. To ensure this, all quantities are converted to PowerSystemUnits.DEGREE_GEOM.

Parameters:

a - First quantity to compare

b - Second quantity to compare

quantityTolerance - Permissible absolute tolerance

Returns:

true, if both quantities' values differ less (converted to degree) than the given tolerance else false

isEquivalentConsideringEmpty

public static <Q extends javax.measure.Quantity<Q>> boolean isEquivalentConsideringEmpty(tech.units.indriya.ComparableQuantity<Q> a,
                                                                                         tech.units.indriya.ComparableQuantity<Q> b)

Compares two Quantitys, if they are equivalent. Returns true only if both quantities are of type EmptyQuantity or if they represent equivalent values. Throws a NullPointerException if any quantity is null, as null is not to be expected as any known empty value should be replaced by an EmptyQuantity. Internally calls isEquivalentConsideringEmpty(ComparableQuantity, ComparableQuantity, double) with a default tolerance of

isEquivalentConsideringEmpty(1 km, 1000 m)// true
isEquivalentConsideringEmpty(1.0 km, 1 km) // true

Type Parameters:

Q - Type of the Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

Returns:

true, if both are an EmptyQuantity or if they are equivalent

Throws:

java.lang.NullPointerException - if any quantity is null

isEquivalentConsideringEmpty

public static <Q extends javax.measure.Quantity<Q>> boolean isEquivalentConsideringEmpty(tech.units.indriya.ComparableQuantity<Q> a,
                                                                                         tech.units.indriya.ComparableQuantity<Q> b,
                                                                                         double quantityTolerance)

Compares two Quantitys, if they are equivalent. Returns true only if both quantities are of type EmptyQuantity or if they represent equivalent values, considering the given tolerance. Throws a NullPointerException if any quantity is null, as null is not to be expected as any known empty value should be replaced by an EmptyQuantity.

QuantityUtil.isEquivalentConsideringEmpty(1 km, 1000 m, 0) //true
QuantityUtil.isEquivalentConsideringEmpty(1.0 km, 1 km, 0) //true
QuantityUtil.isEquivalentConsideringEmpty(1.0km, 1.1km, 0.1) //true
QuantityUtil.isEquivalentConsideringEmpty(1.0km, 1100m, 0.1) //true QuantityUtil.isEquivalentConsideringEmpty(1100m, 1.0km, 0.1) //false

Type Parameters:

Q - Type of the Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

quantityTolerance - permissible absolute tolerance - applied in a's units

Returns:

true, if both are an EmptyQuantity or if they are equivalent

Throws:

java.lang.NullPointerException - if any quantity is null

isEmpty

public static boolean isEmpty(javax.measure.Quantity<?> that)

Checks if the given quantity is empty by returning positive if it is an EmptyQuantity.

Parameters:

that - quantity to compare

Returns:

true, if the object is a EmptyQuantity - false otherwise, even if the quantity is null

equals

public static <Q extends javax.measure.Quantity<Q>> boolean equals(javax.measure.Quantity<Q> a,
                                                                   javax.measure.Quantity<Q> b)

Compares two Quantitys, if they are equal. Returns true only if both quantities are of type EmptyQuantity or if they are equal in value and Unit. The type of the value does not matter. Throws a NullPointerException if any quantity is null, as null is not to be expected as any known empty value should be replaced by an EmptyQuantity.
Internally calls equals(Quantity, Quantity, double) with a default tolerance of

QuantityUtil.equals(1 km, 1000 m) // false
QuantityUtil.equals(1.0 km, 1 km) //true

Type Parameters:

Q - Type of the Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

Returns:

true, if both are an EmptyQuantity or if they are equal

Throws:

java.lang.NullPointerException - if any quantity is null

equals

public static <Q extends javax.measure.Quantity<Q>> boolean equals(javax.measure.Quantity<Q> a,
                                                                   javax.measure.Quantity<Q> b,
                                                                   double quantityTolerance)

Compares two Quantitys, if they are equal. Returns true only if both quantities are of type EmptyQuantity or if they are equal in value and Unit. The type of the value does not matter. Throws a NullPointerException if any quantity is null, as null is not to be expected as any known empty value should be replaced by an EmptyQuantity.

QuantityUtil.equals(1 km, 1000 m, 0) //false
QuantityUtil.equals(1.0 km, 1 km, 0) //true
QuantityUtil.equals(1.0km, 1.1km, 0.1) //true

Type Parameters:

Q - Type of the Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

quantityTolerance - permissible absolute tolerance

Returns:

true, if both are an EmptyQuantity or if they are equal

Throws:

java.lang.NullPointerException - if any quantity is null

isTheSameConsideringEmpty

@Deprecated
public static <Q extends javax.measure.Quantity<Q>> boolean isTheSameConsideringEmpty(javax.measure.Quantity<Q> a,
                                                                                                  javax.measure.Quantity<Q> b)

Deprecated. Renamed to equals(Quantity, Quantity) for clarity and uniformity

Compares two Quantitys, if they are equal. Returns true only if both quantities are of type EmptyQuantity or if they are equal in value and Unit. The type of the value does not matter. Throws a NullPointerException if any quantity is null, as null is not to be expected as any known empty value should be replaced by an EmptyQuantity.

isTheSameConsideringEmpty(1 km, 1000 m) // false
isTheSameConsideringEmpty(1.0 km, 1 km) //true

Type Parameters:

Q - Type of the Quantity

Parameters:

a - First quantity to compare

b - Second quantity to compare

Returns:

true, if both are an EmptyQuantity or if they are equal

Throws:

java.lang.NullPointerException - if any quantity is null