Package me.datafox.dfxengine.math.utils

Class Numerals

java.lang.Object

me.datafox.dfxengine.math.utils.Numerals

public class Numerals
extends Object

Various operations for Numerals.

Constructor Summary

Constructors

Constructor	Description
Numerals()

Method Summary

Modifier and Type	Method	Description
static int	compare(Numeral numeral, Numeral other)
static NumeralType	getSignificantType(NumeralType... types)	Returns the most significant NumeralType.
static NumeralType	getSignificantType(NumeralType type1, NumeralType type2)
static boolean	isEven(Numeral numeral)
static boolean	isOne(Numeral numeral)
static boolean	isZero(Numeral numeral)
static DoubleNumeral	of(double d)
static FloatNumeral	of(float f)
static IntNumeral	of(int i)
static LongNumeral	of(long l)
static Numeral	of(Number number)	If the Number is not an instance of Integer, Long, BigInteger, Float, Double or BigDecimal, this method attempts to parse the number using Object.toString().
static Numeral	of(String str)	If the specified String represents an integer, a BigIntNumeral is returned.
static BigDecNumeral	of(BigDecimal bd)
static BigIntNumeral	of(BigInteger bi)

Methods inherited from class java.lang.Object

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

Constructor Details

Numerals

public Numerals()

Method Details

of

public static IntNumeral of(int i)

Parameters:

i - int value

Returns:

IntNumeral representing specified value

of

public static LongNumeral of(long l)

Parameters:

l - long value

Returns:

LongNumeral representing specified value

of

public static BigIntNumeral of(BigInteger bi)

Parameters:

bi - BigInteger value

Returns:

BigIntNumeral representing specified value

of

public static FloatNumeral of(float f)

Parameters:

f - float value

Returns:

FloatNumeral representing specified value

of

public static DoubleNumeral of(double d)

Parameters:

d - double value

Returns:

DoubleNumeral representing specified value

of

public static BigDecNumeral of(BigDecimal bd)

Parameters:

bd - BigDecimal value

Returns:

BigDecNumeral representing specified value

of

public static Numeral of(String str)

If the specified String represents an integer, a BigIntNumeral is returned. Otherwise, a BigDecNumeral is returned. A string is considered to represent an integer if it does not contain any of the characters ., e or E.

Parameters:

str - String representation of a numeric value

Returns:

Numeral representing specified value

Throws:

NumberFormatException - if str is not a valid number representation

of

public static Numeral of(Number number)

If the Number is not an instance of Integer, Long, BigInteger, Float, Double or BigDecimal, this method attempts to parse the number using Object.toString().

Parameters:

number - Number value

Returns:

Numeral representing the specified value

Throws:

NumberFormatException - If the Number is not recognised and parsing its string representation fails

isZero

public static boolean isZero(Numeral numeral)

Parameters:

numeral - Numeral to be checked

Returns:

true if the specified value represents the number zero

Throws:

NullPointerException - if the Numeral returns null for Numeral.getType()

IllegalArgumentException - if the Numeral does not return null for Numeral.getType(), but the value is not recognised as any of the elements of NumeralType. This should never happen

isOne

public static boolean isOne(Numeral numeral)

Parameters:

numeral - Numeral to be checked

Returns:

true if the specified value represents the number one

Throws:

NullPointerException - if the Numeral returns null for Numeral.getType()

IllegalArgumentException - if the Numeral does not return null for Numeral.getType(), but the value is not recognised as any of the elements of NumeralType. This should never happen

isEven

public static boolean isEven(Numeral numeral)

Parameters:

numeral - Numeral to be checked

Returns:

true if the Numeral represents an even number. For decimal Numerals, the number must not have a decimal part for true to be returned;

Throws:

NullPointerException - if the Numeral returns null for Numeral.getType()

IllegalArgumentException - if the Numeral does not return null for Numeral.getType(), but the value is not recognised as any of the elements of NumeralType. This should never happen

compare

public static int compare(Numeral numeral,
 Numeral other)

Parameters:

numeral - first Numeral to compare

other - second Numeral to compare

Returns:

0 if the Numeral values represent the same number, 1 if the first Numeral represents a larger value than the second Numeral, and -1 if the first Numeral represents a smaller value than the second Numeral.

Throws:

NullPointerException - if any of the Numerals return null for Numeral.getType()

IllegalArgumentException - if any of the Numerals do not return null for Numeral.getType(), but the value is not recognised as any of the elements of NumeralType. This should never happen

getSignificantType

public static NumeralType getSignificantType(NumeralType type1,
 NumeralType type2)

Parameters:

type1 - first NumeralType

type2 - second NumeralType

Returns:

the most significant type of specified values

Throws:

NullPointerException - if any of the types are null

See Also:

• getSignificantType(NumeralType...)

getSignificantType

public static NumeralType getSignificantType(NumeralType... types)

Returns the most significant NumeralType. The significance of a type is determined by how large numerical values it can represent. If any of the specified types is a decimal type, the return value of this method is also a decimal type. If any of the specified types is null, the return value is also null. null check takes precedence over all other checks.

Therefore, if any of the specified types is BIG_DEC, BIG_DEC is also returned. BIG_DEC is also returned if any of the specified types is BIG_INT and another is a decimal type. In all other cases the specified type with the highest significance will be returned.

Parameters:

types - types to be checked

Returns:

the most significant type

Throws:

NullPointerException - if any of the types are null