info.bioinfweb.commons

Class Math2

java.lang.Object

info.bioinfweb.commons.Math2

public class Math2
extends java.lang.Object

Provides static methods implementing mathematical functions not present in java.lang.Math.

Author:

Ben Stöver

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	INT_PATTERN

Constructor Summary

Constructors

Constructor and Description
Math2()

Method Summary

Modifier and Type	Method and Description
static boolean	containsRect(java.awt.Rectangle containedRect, java.awt.Rectangle containingRect) Checks if one rectangle is completely contained inside the other.
static java.lang.String	decimalToString(double decimal, int decimalPlaceCount)
static int	divAbove(int divided, int divisor)
static java.math.BigDecimal	floorBigDecimal(java.math.BigDecimal value)
static java.math.BigInteger	floorBigDecimalToBigInteger(java.math.BigDecimal value)
static int	intPow(int basis, int exponent)
static boolean	isBetween(byte value, byte min, byte max) Checks if the specified value is greater or equal to the specified minimum and lower or equal to the specified maximum.
static boolean	isBetween(double value, double min, double max) Checks if the specified value is greater or equal to the specified minimum and lower or equal to the specified maximum.
static boolean	isBetween(float value, float min, float max) Checks if the specified value is greater or equal to the specified minimum and lower or equal to the specified maximum.
static boolean	isBetween(int value, int min, int max) Checks if the specified value is greater or equal to the specified minimum and lower or equal to the specified maximum.
static boolean	isBetween(long value, long min, long max) Checks if the specified value is greater or equal to the specified minimum and lower or equal to the specified maximum.
static boolean	isBetweenNE(byte value, byte min, byte max) Checks if the specified value is greater then the specified minimum and lower than the specified maximum.
static boolean	isBetweenNE(double value, double min, double max) Checks if the specified value is greater then the specified minimum and lower than the specified maximum.
static boolean	isBetweenNE(float value, float min, float max) Checks if the specified value is greater then the specified minimum and lower than the specified maximum.
static boolean	isBetweenNE(int value, int min, int max) Checks if the specified value is greater then the specified minimum and lower than the specified maximum.
static boolean	isBetweenNE(long value, long min, long max) Checks if the specified value is greater then the specified minimum and lower than the specified maximum.
static boolean	isDecimal(java.lang.String value) Returns the whether the given string can be parsed to a double or a float.
static boolean	isInt(double value) Checks if the specified value is a mathematical integer.
static boolean	isInt(float value) Checks if the specified value is a mathematical integer.
static boolean	isInt(java.lang.String value) Checks if the specified value is the string representation of a mathematical integer.
static double	log(double a, double base)
static long	longPow(long basis, long exponent)
static double	maxDouble(double... values) Returns the maximum of the specified values.
static float	maxFloat(float... values) Returns the maximum of the specified values.
static int	maxInt(int... values) Returns the maximum of the specified values.
static long	maxLong(long... values) Returns the maximum of the specified values.
static double	minDouble(double... values) Returns the minimum of the specified values.
static float	minFloat(float... values) Returns the minimum of the specified values.
static int	minInt(int... values) Returns the minimum of the specified values.
static long	minLong(long... values) Returns the minimum of the specified values.
static byte	moveBetween(byte value, byte min, byte max) Returns the specified value if it is between the specified minimum and maximum.
static double	moveBetween(double value, double min, double max) Returns the specified value if it is between the specified minimum and maximum.
static float	moveBetween(float value, float min, float max) Returns the specified value if it is between the specified minimum and maximum.
static int	moveBetween(int value, int min, int max) Returns the specified value if it is between the specified minimum and maximum.
static long	moveBetween(long value, long min, long max) Returns the specified value if it is between the specified minimum and maximum.
static boolean	overlaps(byte min1, byte max1, byte min2, byte max2) Checks whether the two specified intervals have an overlap.
static boolean	overlaps(double min1, double max1, double min2, double max2) Checks whether the two specified intervals have an overlap.
static boolean	overlaps(float min1, float max1, float min2, float max2) Checks whether the two specified intervals have an overlap.
static boolean	overlaps(int min1, int max1, int min2, int max2) Checks whether the two specified intervals have an overlap.
static boolean	overlaps(long min1, long max1, long min2, long max2) Checks whether the two specified intervals have an overlap.
static boolean	overlapsNE(byte min1, byte max1, byte min2, byte max2)
static boolean	overlapsNE(double min1, double max1, double min2, double max2)
static boolean	overlapsNE(float min1, float max1, float min2, float max2)
static boolean	overlapsNE(int min1, int max1, int min2, int max2)
static boolean	overlapsNE(long min1, long max1, long min2, long max2)
static double	parseDouble(java.lang.String string) Parses a double value which can have either "," or "." as its decimal separator.
static float	parseFloat(java.lang.String string) Parses a float value which can have either "," or "." as its decimal separator.
static java.math.BigDecimal	roundBigDecimal(java.math.BigDecimal value, java.math.RoundingMode roundingMode)
static java.math.BigInteger	roundBigDecimalToBigInteger(java.math.BigDecimal value, java.math.RoundingMode roundingMode)
static double	roundFirstSignificantDigit(double value) Rounds a double value at the given first significant digit.
static float	roundFirstSignificantDigit(float value) Rounds a float value at the given first significant digit.
static double	roundSignificantDigit(double value, int digit) Rounds a double value at the given significant digit.
static float	roundSignificantDigit(float value, int digit) Rounds a float value at the given significant digit.
static long	roundUp(double value) Returns the next integer value that is greater or equal to the specified value.
static int	roundUp(float value) Returns the next integer value that is greater or equal to the specified value.
static int	sum1ToN(int n) Returns the sum of all integers from 1 to the specified value.

Methods inherited from class java.lang.Object

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

Field Detail

INT_PATTERN

public static final java.util.regex.Pattern INT_PATTERN

Constructor Detail

Math2

public Math2()

Method Detail

log

public static double log(double a,
                         double base)

intPow

public static int intPow(int basis,
                         int exponent)

longPow

public static long longPow(long basis,
                           long exponent)

divAbove

public static int divAbove(int divided,
                           int divisor)

isInt

public static boolean isInt(java.lang.String value)

Checks if the specified value is the string representation of a mathematical integer.

Parameters:

value - the string to be tested

Returns:

true if value is the string representation of an integer or false otherwise

isInt

public static boolean isInt(double value)

Checks if the specified value is a mathematical integer.

Parameters:

value - the value to be tested

Returns:

true if value is an integer or false otherwise

isInt

public static boolean isInt(float value)

Checks if the specified value is a mathematical integer.

Parameters:

value - the value to be tested

Returns:

true if value is an integer or false otherwise

isDecimal

public static boolean isDecimal(java.lang.String value)

Returns the whether the given string can be parsed to a double or a float.

Parameters:

value - the string to be parsed

Returns:

true if the given string could be parsed, false otherwise.

minInt

public static int minInt(int... values)

Returns the minimum of the specified values.

It is possible to pass only one value which is directly returned in that case.

Parameters:

values - a list of values

Returns:

the minimal value that was passed

Throws:

java.lang.IllegalArgumentException - if an empty array is specified

minLong

public static long minLong(long... values)

Returns the minimum of the specified values.

It is possible to pass only one value which is directly returned in that case.

Parameters:

values - a list of values

Returns:

the minimal value that was passed

Throws:

java.lang.IllegalArgumentException - if an empty array is specified

minFloat

public static float minFloat(float... values)

Returns the minimum of the specified values.

It is possible to pass only one value which is directly returned in that case.

Parameters:

values - a list of values

Returns:

the minimal value that was passed

Throws:

java.lang.IllegalArgumentException - if an empty array is specified

minDouble

public static double minDouble(double... values)

Returns the minimum of the specified values.

It is possible to pass only one value which is directly returned in that case.

Parameters:

values - a list of values

Returns:

the minimal value that was passed

Throws:

java.lang.IllegalArgumentException - if an empty array is specified

maxInt

public static int maxInt(int... values)

Returns the maximum of the specified values.

It is possible to pass only one value which is directly returned in that case.

Parameters:

values - a list of values

Returns:

the maximal value that was passed

Throws:

java.lang.IllegalArgumentException - if an empty array is specified

maxLong

public static long maxLong(long... values)

Returns the maximum of the specified values.

It is possible to pass only one value which is directly returned in that case.

Parameters:

values - a list of values

Returns:

the maximal value that was passed

Throws:

java.lang.IllegalArgumentException - if an empty array is specified

maxFloat

public static float maxFloat(float... values)

Returns the maximum of the specified values.

It is possible to pass only one value which is directly returned in that case.

Parameters:

values - a list of values

Returns:

the maximal value that was passed

Throws:

java.lang.IllegalArgumentException - if an empty array is specified

maxDouble

public static double maxDouble(double... values)

Returns the maximum of the specified values.

It is possible to pass only one value which is directly returned in that case.

Parameters:

values - a list of values

Returns:

the maximal value that was passed

Throws:

java.lang.IllegalArgumentException - if an empty array is specified

isBetween

public static boolean isBetween(byte value,
                                byte min,
                                byte max)

Checks if the specified value is greater or equal to the specified minimum and lower or equal to the specified maximum.

Parameters:

value - the value to be tested

min - the minimum value

max - the maximum value

Returns:

true if value if between min and max, false otherwise

isBetween

public static boolean isBetween(int value,
                                int min,
                                int max)

Checks if the specified value is greater or equal to the specified minimum and lower or equal to the specified maximum.

Parameters:

value - the value to be tested

min - the minimum value

max - the maximum value

Returns:

true if value if between min and max, false otherwise

isBetween

public static boolean isBetween(long value,
                                long min,
                                long max)

Checks if the specified value is greater or equal to the specified minimum and lower or equal to the specified maximum.

Parameters:

value - the value to be tested

min - the minimum value

max - the maximum value

Returns:

true if value if between min and max, false otherwise

isBetween

public static boolean isBetween(float value,
                                float min,
                                float max)

Checks if the specified value is greater or equal to the specified minimum and lower or equal to the specified maximum.

Parameters:

value - the value to be tested

min - the minimum value

max - the maximum value

Returns:

true if value if between min and max, false otherwise

isBetween

public static boolean isBetween(double value,
                                double min,
                                double max)

Checks if the specified value is greater or equal to the specified minimum and lower or equal to the specified maximum.

Parameters:

value - the value to be tested

min - the minimum value

max - the maximum value

Returns:

true if value if between min and max, false otherwise

isBetweenNE

public static boolean isBetweenNE(byte value,
                                  byte min,
                                  byte max)

Checks if the specified value is greater then the specified minimum and lower than the specified maximum. If value is equal to min or max this method will return false.

Parameters:

value - the value to be tested

min - the minimum value

max - the maximum value

Returns:

true if value if between min and max, false otherwise

isBetweenNE

public static boolean isBetweenNE(int value,
                                  int min,
                                  int max)

Checks if the specified value is greater then the specified minimum and lower than the specified maximum. If value is equal to min or max this method will return false.

Parameters:

value - the value to be tested

min - the minimum value

max - the maximum value

Returns:

true if value if between min and max, false otherwise

isBetweenNE

public static boolean isBetweenNE(long value,
                                  long min,
                                  long max)

Checks if the specified value is greater then the specified minimum and lower than the specified maximum. If value is equal to min or max this method will return false.

Parameters:

value - the value to be tested

min - the minimum value

max - the maximum value

Returns:

true if value if between min and max, false otherwise

isBetweenNE

public static boolean isBetweenNE(float value,
                                  float min,
                                  float max)

Checks if the specified value is greater then the specified minimum and lower than the specified maximum. If value is equal to min or max this method will return false.

Parameters:

value - the value to be tested

min - the minimum value

max - the maximum value

Returns:

true if value if between min and max, false otherwise

isBetweenNE

public static boolean isBetweenNE(double value,
                                  double min,
                                  double max)

Checks if the specified value is greater then the specified minimum and lower than the specified maximum. If value is equal to min or max this method will return false.

Parameters:

value - the value to be tested

min - the minimum value

max - the maximum value

Returns:

true if value if between min and max, false otherwise

moveBetween

public static byte moveBetween(byte value,
                               byte min,
                               byte max)

Returns the specified value if it is between the specified minimum and maximum. If value is lower than min, min is returned, if it is greater than max, max is returned.

Parameters:

value - the value to be moved into the specified interval

min - the lower border of the interval

max - the upper border of the interval

Returns:

a value equal to Math.min(max, Math.max(min, value))

moveBetween

public static int moveBetween(int value,
                              int min,
                              int max)

Returns the specified value if it is between the specified minimum and maximum. If value is lower than min, min is returned, if it is greater than max, max is returned.

Parameters:

value - the value to be moved into the specified interval

min - the lower border of the interval

max - the upper border of the interval

Returns:

a value equal to Math.min(max, Math.max(min, value))

moveBetween

public static long moveBetween(long value,
                               long min,
                               long max)

Returns the specified value if it is between the specified minimum and maximum. If value is lower than min, min is returned, if it is greater than max, max is returned.

Parameters:

value - the value to be moved into the specified interval

min - the lower border of the interval

max - the upper border of the interval

Returns:

a value equal to Math.min(max, Math.max(min, value))

moveBetween

public static float moveBetween(float value,
                                float min,
                                float max)

Returns the specified value if it is between the specified minimum and maximum. If value is lower than min, min is returned, if it is greater than max, max is returned.

Parameters:

value - the value to be moved into the specified interval

min - the lower border of the interval

max - the upper border of the interval

Returns:

a value equal to Math.min(max, Math.max(min, value))

moveBetween

public static double moveBetween(double value,
                                 double min,
                                 double max)

Returns the specified value if it is between the specified minimum and maximum. If value is lower than min, min is returned, if it is greater than max, max is returned.

Parameters:

value - the value to be moved into the specified interval

min - the lower border of the interval

max - the upper border of the interval

Returns:

a value equal to Math.min(max, Math.max(min, value))

overlaps

public static boolean overlaps(byte min1,
                               byte max1,
                               byte min2,
                               byte max2)

Checks whether the two specified intervals have an overlap. Intervals that touch each other are not considered as overlapping.

min1 must be lower or equal than max1 and min2 must be lower or equal to max2. This method does not check whether this conditions are fulfilled.

Parameters:

min1 - the lower border of the first interval

max1 - the upper border of the first interval

min2 - the lower border of the second interval

max2 - the upper border of the second interval

Returns:

true if the two intervals overlap, false otherwise

overlaps

public static boolean overlaps(int min1,
                               int max1,
                               int min2,
                               int max2)

Checks whether the two specified intervals have an overlap. Intervals that touch each other are not considered as overlapping.

min1 must be lower or equal than max1 and min2 must be lower or equal to max2. This method does not check whether this conditions are fulfilled.

Parameters:

min1 - the lower border of the first interval

max1 - the upper border of the first interval

min2 - the lower border of the second interval

max2 - the upper border of the second interval

Returns:

true if the two intervals overlap, false otherwise

overlaps

public static boolean overlaps(long min1,
                               long max1,
                               long min2,
                               long max2)

Checks whether the two specified intervals have an overlap. Intervals that touch each other are not considered as overlapping.

min1 must be lower or equal than max1 and min2 must be lower or equal to max2. This method does not check whether this conditions are fulfilled.

Parameters:

min1 - the lower border of the first interval

max1 - the upper border of the first interval

min2 - the lower border of the second interval

max2 - the upper border of the second interval

Returns:

true if the two intervals overlap, false otherwise

overlaps

public static boolean overlaps(float min1,
                               float max1,
                               float min2,
                               float max2)

Checks whether the two specified intervals have an overlap. If the upper border of one interval is equal to the lower border of another theses intervals are considered as overlapping.

min1 must be lower or equal than max1 and min2 must be lower or equal to max2. This method does not check whether this conditions are fulfilled.

Parameters:

min1 - the lower border of the first interval

max1 - the upper border of the first interval

min2 - the lower border of the second interval

max2 - the upper border of the second interval

Returns:

true if the two intervals overlap, false otherwise

overlaps

public static boolean overlaps(double min1,
                               double max1,
                               double min2,
                               double max2)

Checks whether the two specified intervals have an overlap. If the upper border of one interval is equal to the lower border of another theses intervals are considered as overlapping.

min1 must be lower or equal than max1 and min2 must be lower or equal to max2. This method does not check whether this conditions are fulfilled.

Parameters:

min1 - the lower border of the first interval

max1 - the upper border of the first interval

min2 - the lower border of the second interval

max2 - the upper border of the second interval

Returns:

true if the two intervals overlap, false otherwise

overlapsNE

public static boolean overlapsNE(byte min1,
                                 byte max1,
                                 byte min2,
                                 byte max2)

overlapsNE

public static boolean overlapsNE(int min1,
                                 int max1,
                                 int min2,
                                 int max2)

overlapsNE

public static boolean overlapsNE(long min1,
                                 long max1,
                                 long min2,
                                 long max2)

overlapsNE

public static boolean overlapsNE(float min1,
                                 float max1,
                                 float min2,
                                 float max2)

overlapsNE

public static boolean overlapsNE(double min1,
                                 double max1,
                                 double min2,
                                 double max2)

containsRect

public static boolean containsRect(java.awt.Rectangle containedRect,
                                   java.awt.Rectangle containingRect)

Checks if one rectangle is completely contained inside the other.

Parameters:

containedRect - the rectangle that shall be tested to be contained in containingRect

containingRect - the rectangle that shall be tested to contain containedRect

Returns:

true if the one rectangle is contained in the other, false otherwise

roundUp

public static long roundUp(double value)

Returns the next integer value that is greater or equal to the specified value.

Parameters:

value - the floating point value to be converted

Returns:

the next long >= value

roundUp

public static int roundUp(float value)

Returns the next integer value that is greater or equal to the specified value.

Parameters:

value - the floating point value to be converted

Returns:

the next int >= value

roundBigDecimal

public static java.math.BigDecimal roundBigDecimal(java.math.BigDecimal value,
                                                   java.math.RoundingMode roundingMode)

floorBigDecimal

public static java.math.BigDecimal floorBigDecimal(java.math.BigDecimal value)

roundBigDecimalToBigInteger

public static java.math.BigInteger roundBigDecimalToBigInteger(java.math.BigDecimal value,
                                                               java.math.RoundingMode roundingMode)

floorBigDecimalToBigInteger

public static java.math.BigInteger floorBigDecimalToBigInteger(java.math.BigDecimal value)

roundSignificantDigit

public static double roundSignificantDigit(double value,
                                           int digit)

Rounds a double value at the given significant digit.

Examples:

• roundSignificantDigit(12.4, 0) would return 12
• roundSignificantDigit(12.4, 1) would return 10
• roundSignificantDigit(0.03462, -3) would return 0.035

Parameters:

value - the value to be rounded

digit - the decimal power to be rounded to

Returns:

the rounded value

roundSignificantDigit

public static float roundSignificantDigit(float value,
                                          int digit)

Rounds a float value at the given significant digit.

Examples:

• roundSignificantDigit(12.4, 0) would return 12
• roundSignificantDigit(12.4, 1) would return 10
• roundSignificantDigit(0.03462, -3) would return 0.035

Parameters:

value - the value to be rounded

digit - the decimal power to be rounded to

Returns:

the rounded value

roundFirstSignificantDigit

public static double roundFirstSignificantDigit(double value)

Rounds a double value at the given first significant digit.

Examples:

• roundSignificantDigit(79.0) would return 80.0
• roundSignificantDigit(12.0) would return 10.0
• roundSignificantDigit(0.03462) would return 0.03

Calling this method is equivalent to roundSignificantDigit(value, (int)Math.floor(Math.log10(value))).

Parameters:

value - the value to be rounded

Returns:

the rounded value

roundFirstSignificantDigit

public static float roundFirstSignificantDigit(float value)

Rounds a float value at the given first significant digit.

Examples:

• roundSignificantDigit(79.0) would return 80.0
• roundSignificantDigit(12.0) would return 10.0
• roundSignificantDigit(0.03462) would return 0.03

Calling this method is equivalent to roundSignificantDigit(value, (int)Math.floor(Math.log10(value))).

Parameters:

value - the value to be rounded

Returns:

the rounded value

parseFloat

public static float parseFloat(java.lang.String string)

Parses a float value which can have either "," or "." as its decimal separator. The string must not contain thousand separators.

Parameters:

string - the string to parse

Returns:

the parsed float value

parseDouble

public static double parseDouble(java.lang.String string)

Parses a double value which can have either "," or "." as its decimal separator. The string must not contain thousand separators. (Distinguishing between "1,236" as 1236 in English and "1,236" as 1.236 in German is not possible.)

Parameters:

string - the string to parse

Returns:

the parsed double value

Throws:

java.lang.NumberFormatException - if the specified string does not represent a valid decimal value

decimalToString

public static java.lang.String decimalToString(double decimal,
                                               int decimalPlaceCount)

sum1ToN

public static int sum1ToN(int n)

Returns the sum of all integers from 1 to the specified value.

Parameters:

n - the value to sum up to (must be greater or equal to zero)

Throws:

java.lang.ArithmeticException - if n is smaller than zero