com.cinchapi.concourse.util

Class Numbers

Object

Numbers

public abstract class Numbers
extends Object

This class contains utility methods that provide interoperability for the various Number types.

Constructor Summary

Constructors

Constructor and Description
Numbers()

Method Summary

Modifier and Type	Method and Description
static Number	add(Number a, Number b) Return the sum of two numbers.
static boolean	areEqual(Number a, Number b) Return true if a is mathematically equal to b.
static boolean	areEqualCastSafe(Object a, Object b) Perform a cast safe equality check for two objects.
static int	compare(Number a, Number b) Compare a to b.
static Number	divide(Number a, Number b) Return the division of two numbers.
static Number	incrementalAverage(Number running, Number number, int count) Compute the incremental average from the current running of the same, given the latest number and the total count of items (including the specified number).
static boolean	isEqualTo(Number a, Number b) Deprecated. Deprecated in version 0.7. Use areEqual(Number, Number) instead.
static boolean	isEqualToCastSafe(Object a, Object b) Deprecated. Deprecated in version 0.7. Use #areEqualCastSafe(Number, Number) instead.
static boolean	isEven(Number number) Return true if number is evenly divisible by two.
static boolean	isFloatingPoint(Number number) Return true if the number is a floating point type.
static boolean	isGreaterThan(Number a, Number b) Return true if a is mathematically greater than b
static boolean	isGreaterThanOrEqualTo(Number a, Number b) Return true if a is mathematically greater than or equal to b.
static boolean	isLessThan(Number a, Number b) Return true if a is mathematically less than b.
static boolean	isLessThanOrEqualTo(Number a, Number b) Return true if a is mathematically less than or equal to b.
static boolean	isOdd(Number number) Return true if number is not evenly divisible by two.
static Number	max(Number... numbers) Return the max from a list of numbers.
static Number	min(Number... numbers) Return the min from a list of numbers.
static Number	multiply(Number a, Number b) Return the product of two numbers.
static double	percent(Number numerator, Number denominator) Return numerator/denominator as a percent.
static double	round(Number value, int places) Round the numeric value to places without truncating.
static Number	scale(Number number, Number rawMin, Number rawMax, Number scaledMin, Number scaledMax) Scale number, which is between rawMin and rawMax to a value between scaledMin and scaleMax.
static BigDecimal	toBigDecimal(Number number) Checks the instance type of input Number and returns a corresponding BigDecimal.

Methods inherited from class Object

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

Constructor Detail

Numbers

public Numbers()

Method Detail

add

public static Number add(Number a,
                         Number b)

Return the sum of two numbers.

Parameters:

a - the first Number

b - the second Number

Returns:

the sum of a and b.

compare

public static int compare(Number a,
                          Number b)

Compare a to b.

Parameters:

a -

b -

Returns:

-1, 0, or 1 as a is numerically less than, equal to, or greater than b.

divide

public static Number divide(Number a,
                            Number b)

Return the division of two numbers.

Parameters:

a - the first Number

b - the second Number

Returns:

the division result of a by b.

incrementalAverage

public static Number incrementalAverage(Number running,
                                        Number number,
                                        int count)

Compute the incremental average from the current running of the same, given the latest number and the total count of items (including the specified number).

Parameters:

running - the running average

number - the next number to include in the average

count - the total number of items, including the specified number that contribute to the average

Returns:

the new incremental average

areEqual

public static boolean areEqual(Number a,
                               Number b)

Return true if a is mathematically equal to b.

Parameters:

a -

b -

Returns:

true if a == b

isEqualTo

@Deprecated
public static boolean isEqualTo(Number a,
                                            Number b)

Deprecated. Deprecated in version 0.7. Use areEqual(Number, Number) instead.

Return true if a is mathematically equal to b.

Parameters:

a -

b -

Returns:

true if a == b

areEqualCastSafe

public static boolean areEqualCastSafe(Object a,
                                       Object b)

Perform a cast safe equality check for two objects.

If both objects are instances of the Number class, this method will behave the same was as isEqualTo(Number, Number). Otherwise, this method returns false.

Parameters:

a - the first, possibly numeric, object

b - the second, possibly numeric, object

Returns:

true if both objects are numbers and are mathematically equal

isEqualToCastSafe

@Deprecated
public static boolean isEqualToCastSafe(Object a,
                                                    Object b)

Deprecated. Deprecated in version 0.7. Use #areEqualCastSafe(Number, Number) instead.

Perform a cast safe equality check for two objects.

If both objects are instances of the Number class, this method will behave the same was as isEqualTo(Number, Number). Otherwise, this method returns false.

Parameters:

a - the first, possibly numeric, object

b - the second, possibly numeric, object

Returns:

true if both objects are numbers and are mathematically equal

isEven

public static boolean isEven(Number number)

Return true if number is evenly divisible by two.

Parameters:

number -

Returns:

true if number is even.

isFloatingPoint

public static boolean isFloatingPoint(Number number)

Return true if the number is a floating point type.

Parameters:

number - the Number to check

Returns:

true if the Number is floating point

isGreaterThan

public static boolean isGreaterThan(Number a,
                                    Number b)

Return true if a is mathematically greater than b

Parameters:

a -

b -

Returns:

true if a > b

isGreaterThanOrEqualTo

public static boolean isGreaterThanOrEqualTo(Number a,
                                             Number b)

Return true if a is mathematically greater than or equal to b.

Parameters:

a -

b -

Returns:

true if a >= b

isLessThan

public static boolean isLessThan(Number a,
                                 Number b)

Return true if a is mathematically less than b.

Parameters:

a -

b -

Returns:

true if a < b

isLessThanOrEqualTo

public static boolean isLessThanOrEqualTo(Number a,
                                          Number b)

Return true if a is mathematically less than or equal to b.

Parameters:

a -

b -

Returns:

true if a <= b

isOdd

public static boolean isOdd(Number number)

Return true if number is not evenly divisible by two.

Parameters:

number -

Returns:

true if number is odd.

max

public static Number max(Number... numbers)

Return the max from a list of numbers.

Parameters:

numbers -

Returns:

the largest number

min

public static Number min(Number... numbers)

Return the min from a list of numbers.

Parameters:

numbers -

Returns:

the smallest number

multiply

public static Number multiply(Number a,
                              Number b)

Return the product of two numbers.

Parameters:

a - the first Number

b - the second Number

Returns:

the product of a and b.

percent

public static double percent(Number numerator,
                             Number denominator)

Return numerator/denominator as a percent.

Parameters:

numerator -

denominator -

Returns:

the percent

round

public static double round(Number value,
                           int places)

Round the numeric value to places without truncating.

Parameters:

value - the number to round

places - the max number of decimal places

Returns:

the rounded value, represented as a double

scale

public static Number scale(Number number,
                           Number rawMin,
                           Number rawMax,
                           Number scaledMin,
                           Number scaledMax)

Scale number, which is between rawMin and rawMax to a value between scaledMin and scaleMax.

Parameters:

number -

rawMin -

rawMax -

scaledMin -

scaledMax -

Returns:

the scaled value

toBigDecimal

public static BigDecimal toBigDecimal(Number number)

Checks the instance type of input Number and returns a corresponding BigDecimal.

Parameters:

number -

Returns:

BigDecimal