MathUtil (Revolution Systems Open Library TRUNK-SNAPSHOT API)

java.lang.Object
- com.revolsys.util.MathUtil

```
public final class MathUtil
extends Object
```
The MathUtil class is a utility class for handling integer, percent and currency BigDecimal values.

Author:

Paul Austin

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYTES_IN_DOUBLE`
`static int`	`BYTES_IN_INT`
`static int`	`BYTES_IN_LONG`
`static int`	`BYTES_IN_SHORT`
`static BigDecimal`	`CURRENCY_CENTS_PER_DOLLAR` The number of cents in a dollar.
`static int`	`CURRENCY_SCALE` The scale for currency numbers.
`static BigDecimal`	`CURRENCY0` A 0 currency.
`static int`	`INTEGER_SCALE` The scale for integer numbers.
`static BigDecimal`	`INTEGER0` A 0 integer.
`static BigDecimal`	`INTEGER1` A 1 integer.
`static int`	`PERCENT_SCALE` The scale for percent numbers.
`static BigDecimal`	`PERCENT0` A 0 percent.
`static BigDecimal`	`PERCENT100` A 1000 percent.
`static double`	`PI_OVER_2`
`static double`	`PI_OVER_4`
`static double`	`PI_TIMES_2`

Method Summary

Methods
Modifier and Type	Method and Description
`static BigDecimal`	`add(BigDecimal left, Number right)`
`static <V extends Number> V`	`add(Number left, Number right, Class<V> resultClass)`
`static void`	`append(StringBuilder string, double number)`
`static double`	`avg(double a, double b)`
`static double`	`clamp(double x, double min, double max)` Clamps a `double` value to a given range.
`static int`	`clamp(int x, int min, int max)` Clamps an `int` value to a given range.
`static String`	`currencyToString(BigDecimal amount)` Convert a BigDecimal amount to a currency string prefixed by the "$" sign.
`static double`	`distance(double x1, double y1, double x2, double y2)` Calculate the distance between two coordinates.
`static BigDecimal`	`divideCurrency(BigDecimal left, BigDecimal right)` Divide two currency amounts, setting the scale to `CURRENCY_SCALE` and rounding 1/2 u
`static BigDecimal`	`dividePercent(BigDecimal left, BigDecimal right)` Divide two percent amounts, setting the scale to `CURRENCY_SCALE` and rounding 1/2 u
`static BigDecimal`	`dividePercent(double left, double right)` Divide two percent amounts, setting the scale to `CURRENCY_SCALE` and rounding 1/2 u
`static BigDecimal`	`dividePercent(double left, int right)` Divide two percent amounts, setting the scale to `CURRENCY_SCALE` and rounding 1/2 u
`static String`	`format(String pattern, Number number)`
`static double`	`getAngle(LineString points, int i1, int i2, boolean start)` Code taken from DRA FME scripts to calculate angles.
`static BigDecimal`	`getBigDecimal(Object value)`
`static BigDecimal`	`getCurrency(BigDecimal amount)` Convert a BigDecimal amount into a currency BigDecimal.
`static BigDecimal`	`getCurrency(double amount)` Convert a double amount into a currency BigDecimal.
`static BigDecimal`	`getInteger(BigDecimal value)` Convert a BigDecimal into an ineteger BigDecimal.
`static BigDecimal`	`getInteger(int value)` Convert a int into an ineteger BigDecimal.
`static Object`	`getMaxValue(Class<?> dataType)`
`static Object`	`getMinValue(Class<?> dataType)`
`static double`	`getNorthClockwiseAngle(double angle)`
`static BigDecimal`	`getPercent(BigDecimal decimalPercent)` Convert a BigDecimal decimal percent (e.g.
`static BigDecimal`	`getPercent(double decimalPercent)` Convert a double decimal percent (e.g.
`static BigDecimal`	`getPercent(String decimalPercent)` Convert a String decimal percent (e.g.
`static int`	`hashCode(double d)`
`static String`	`integerToString(BigDecimal integer)` Convert a BigDecimal integer to a string.
`static boolean`	`isAcute(double x1, double y1, double x2, double y2, double x3, double y3)`
`static boolean`	`isNanOrInfinite(double... values)`
`static double`	`makePrecise(double scale, double value)`
`static double`	`max(double... values)`
`static int`	`max(int... values)`
`static double`	`max(Iterable<? extends Number> numbers)`
`static int`	`maxInt(Iterable<Integer> numbers)`
`static double`	`midpoint(double d1, double d2)`
`static double`	`min(double... values)`
`static int`	`min(int... values)`
`static double`	`min(Iterable<? extends Number> numbers)`
`static int`	`minInt(Iterable<Integer> numbers)`
`static double`	`orientedAngleBetween(double angle1, double angle2)`
`static String`	`percentToString(BigDecimal decimalPercent)` Convert a BigDecimal decimal percent to a percent string suffixed by the "%" sign.
`static String`	`percentToString(BigDecimal decimalPercent, int scale)` Convert a BigDecimal decimal percent to a percent string suffixed by the "%" sign with the specified number of decimal places.
`static double`	`pointLineDistance(double x, double y, double x1, double y1, double x2, double y2)`
`static boolean`	`precisionEqual(double value1, double value2, double scale)`
`static double`	`randomGaussian(double mean, double variance)`
`static double`	`randomRange(double min, double max)`
`static byte`	`sgn(byte x)`
`static int`	`sgn(double x)`
`static int`	`sgn(float x)`
`static int`	`sgn(int x)`
`static int`	`sgn(long x)`
`static short`	`sgn(short x)`
`static <V extends Number> V`	`subtract(Number left, Number right, Class<V> resultClass)`
`static Double`	`toDouble(Object value)`
`static double[]`	`toDoubleArray(List<? extends Number> numbers)`
`static double[]`	`toDoubleArray(String... values)`
`static double[]`	`toDoubleArraySplit(String value)`
`static double[]`	`toDoubleArraySplit(String value, String regex)`
`static Double`	`toDoubleValue(Object value)`
`static int`	`toInt(byte[] bytes, int offset)`
`static long`	`toLong(byte[] bytes, int offset)`
`static String`	`toString(BigDecimal number)`
`static String`	`toString(BigInteger number)`
`static String`	`toString(byte number)`
`static String`	`toString(double number)`
`static String`	`toString(double number, int precision)`
`static String`	`toString(float number)`
`static String`	`toString(int number)`
`static String`	`toString(long number)`
`static String`	`toString(Number number)`
`static String`	`toString(short number)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- BYTES_IN_DOUBLE
```
public static final int BYTES_IN_DOUBLE
```
  See Also:
  Constant Field Values
- BYTES_IN_INT
```
public static final int BYTES_IN_INT
```
  See Also:
  Constant Field Values
- BYTES_IN_LONG
```
public static final int BYTES_IN_LONG
```
  See Also:
  Constant Field Values
- BYTES_IN_SHORT
```
public static final int BYTES_IN_SHORT
```
  See Also:
  Constant Field Values
- CURRENCY_CENTS_PER_DOLLAR
```
public static final BigDecimal CURRENCY_CENTS_PER_DOLLAR
```
  The number of cents in a dollar.
- CURRENCY_SCALE
```
public static final int CURRENCY_SCALE
```
  The scale for currency numbers.
  
  See Also:
  Constant Field Values
- CURRENCY0
```
public static final BigDecimal CURRENCY0
```
  A 0 currency.
- INTEGER_SCALE
```
public static final int INTEGER_SCALE
```
  The scale for integer numbers.
  
  See Also:
  Constant Field Values
- INTEGER0
```
public static final BigDecimal INTEGER0
```
  A 0 integer.
- INTEGER1
```
public static final BigDecimal INTEGER1
```
  A 1 integer.
- PERCENT_SCALE
```
public static final int PERCENT_SCALE
```
  The scale for percent numbers.
  
  See Also:
  Constant Field Values
- PERCENT0
```
public static final BigDecimal PERCENT0
```
  A 0 percent.
- PERCENT100
```
public static final BigDecimal PERCENT100
```
  A 1000 percent.
- PI_OVER_2
```
public static final double PI_OVER_2
```
  See Also:
  Constant Field Values
- PI_OVER_4
```
public static final double PI_OVER_4
```
  See Also:
  Constant Field Values
- PI_TIMES_2
```
public static final double PI_TIMES_2
```
  See Also:
  Constant Field Values

Method Detail

add

public static BigDecimal add(BigDecimal left,
             Number right)

Parameters:: left - The left operand.; right - The right operand.
Returns:: The new amount.

add

public static <V extends Number> V add(Number left,
                       Number right,
                       Class<V> resultClass)

append

public static void append(StringBuilder string,
          double number)

avg

public static double avg(double a,
         double b)

clamp
```
public static double clamp(double x,
           double min,
           double max)
```
Clamps a double value to a given range.

Parameters:
x - the value to clamp
min - the minimum value of the range
max - the maximum value of the range

Returns:
the clamped value

clamp
```
public static int clamp(int x,
        int min,
        int max)
```
Clamps an int value to a given range.

Parameters:
x - the value to clamp
min - the minimum value of the range
max - the maximum value of the range

Returns:
the clamped value

currencyToString
```
public static String currencyToString(BigDecimal amount)
```
Convert a BigDecimal amount to a currency string prefixed by the "$" sign.

Parameters:
amount - The BigDecimal amount.

Returns:
The currency String

distance
```
public static double distance(double x1,
              double y1,
              double x2,
              double y2)
```
Calculate the distance between two coordinates.

Parameters:
x1 - The first x coordinate.
y1 - The first y coordinate.
x2 - The second x coordinate.
y2 - The second y coordinate.

Returns:
The distance.

divideCurrency
```
public static BigDecimal divideCurrency(BigDecimal left,
                        BigDecimal right)
```
Divide two currency amounts, setting the scale to CURRENCY_SCALE and rounding 1/2 u

Parameters:
left - The left operand.
right - The right operand.

Returns:
The new amount.

dividePercent
```
public static BigDecimal dividePercent(BigDecimal left,
                       BigDecimal right)
```
Divide two percent amounts, setting the scale to CURRENCY_SCALE and rounding 1/2 u

Parameters:
left - The left operand.
right - The right operand.

Returns:
The new amount.

dividePercent
```
public static BigDecimal dividePercent(double left,
                       double right)
```
Divide two percent amounts, setting the scale to CURRENCY_SCALE and rounding 1/2 u

Parameters:
left - The left operand.
right - The right operand.

Returns:
The new amount.

dividePercent
```
public static BigDecimal dividePercent(double left,
                       int right)
```
Divide two percent amounts, setting the scale to CURRENCY_SCALE and rounding 1/2 u

Parameters:
left - The left operand.
right - The right operand.

Returns:
The new amount.

format

public static String format(String pattern,
            Number number)

getAngle

public static double getAngle(LineString points,
              int i1,
              int i2,
              boolean start)

Code taken from DRA FME scripts to calculate angles.

Parameters:: points -; i1 -; i2 -
Returns:

getBigDecimal

public static BigDecimal getBigDecimal(Object value)

getCurrency
```
public static BigDecimal getCurrency(BigDecimal amount)
```
Convert a BigDecimal amount into a currency BigDecimal.

Parameters:
amount - The ammount.

Returns:
The currency.

getCurrency
```
public static BigDecimal getCurrency(double amount)
```
Convert a double amount into a currency BigDecimal.

Parameters:
amount - The ammount.

Returns:
The currency.

getInteger
```
public static BigDecimal getInteger(BigDecimal value)
```
Convert a BigDecimal into an ineteger BigDecimal.

Parameters:
value - The BigDecimal value.

Returns:
The ineteger BigDecimal.

getInteger
```
public static BigDecimal getInteger(int value)
```
Convert a int into an ineteger BigDecimal.

Parameters:
value - The int value.

Returns:
The ineteger BigDecimal.

getMaxValue

public static Object getMaxValue(Class<?> dataType)

getMinValue

public static Object getMinValue(Class<?> dataType)

getNorthClockwiseAngle

public static double getNorthClockwiseAngle(double angle)

getPercent
```
public static BigDecimal getPercent(BigDecimal decimalPercent)
```
Convert a BigDecimal decimal percent (e.g. 0.5 is 50%) into an percent BigDecimal.

Parameters:
decimalPercent - The decimal percent value.

Returns:
The currency.

getPercent
```
public static BigDecimal getPercent(double decimalPercent)
```
Convert a double decimal percent (e.g. 0.5 is 50%) into an percent BigDecimal.

Parameters:
decimalPercent - The decimal percent value.

Returns:
The currency.

getPercent
```
public static BigDecimal getPercent(String decimalPercent)
```
Convert a String decimal percent (e.g. 0.5 is 50%) into an percent BigDecimal.

Parameters:
decimalPercent - The decimal percent value.

Returns:
The currency.

hashCode
```
public static int hashCode(double d)
```

integerToString
```
public static String integerToString(BigDecimal integer)
```
Convert a BigDecimal integer to a string.

Parameters:
integer - The BigDecimal integer.

Returns:
The integer String

isAcute

public static boolean isAcute(double x1,
              double y1,
              double x2,
              double y2,
              double x3,
              double y3)

isNanOrInfinite

public static boolean isNanOrInfinite(double... values)

makePrecise

public static double makePrecise(double scale,
                 double value)

max

public static double max(double... values)

max
```
public static int max(int... values)
```

max

public static double max(Iterable<? extends Number> numbers)

maxInt

public static int maxInt(Iterable<Integer> numbers)

midpoint

public static double midpoint(double d1,
              double d2)

min

public static double min(double... values)

min
```
public static int min(int... values)
```

min

public static double min(Iterable<? extends Number> numbers)

minInt

public static int minInt(Iterable<Integer> numbers)

orientedAngleBetween

public static double orientedAngleBetween(double angle1,
                          double angle2)

percentToString
```
public static String percentToString(BigDecimal decimalPercent)
```
Convert a BigDecimal decimal percent to a percent string suffixed by the "%" sign.

Parameters:
decimalPercent - The BigDecimal percent.

Returns:
The percent String

percentToString
```
public static String percentToString(BigDecimal decimalPercent,
                     int scale)
```
Convert a BigDecimal decimal percent to a percent string suffixed by the "%" sign with the specified number of decimal places.

Parameters:
decimalPercent - The BigDecimal percent.
scale - The number of decimal places to show.

Returns:
The percent String

pointLineDistance

public static double pointLineDistance(double x,
                       double y,
                       double x1,
                       double y1,
                       double x2,
                       double y2)

precisionEqual

public static boolean precisionEqual(double value1,
                     double value2,
                     double scale)

randomGaussian

public static double randomGaussian(double mean,
                    double variance)

randomRange

public static double randomRange(double min,
                 double max)

sgn
```
public static byte sgn(byte x)
```

sgn
```
public static int sgn(double x)
```

sgn
```
public static int sgn(float x)
```

sgn
```
public static int sgn(int x)
```

sgn
```
public static int sgn(long x)
```

sgn
```
public static short sgn(short x)
```

subtract

public static <V extends Number> V subtract(Number left,
                            Number right,
                            Class<V> resultClass)

toDouble

public static Double toDouble(Object value)

toDoubleArray

public static double[] toDoubleArray(List<? extends Number> numbers)

toDoubleArray

public static double[] toDoubleArray(String... values)

toDoubleArraySplit

public static double[] toDoubleArraySplit(String value)

toDoubleArraySplit

public static double[] toDoubleArraySplit(String value,
                          String regex)

toDoubleValue

public static Double toDoubleValue(Object value)

toInt

public static final int toInt(byte[] bytes,
        int offset)

toLong

public static final long toLong(byte[] bytes,
          int offset)

toString

public static String toString(BigDecimal number)

toString

public static String toString(BigInteger number)

toString

public static String toString(byte number)

toString

public static String toString(double number)

toString

public static String toString(double number,
              int precision)

toString

public static String toString(float number)

toString

public static String toString(int number)

toString

public static String toString(long number)

toString

public static String toString(Number number)

toString

public static String toString(short number)

Class MathUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BYTES_IN_DOUBLE

BYTES_IN_INT

BYTES_IN_LONG

BYTES_IN_SHORT

CURRENCY_CENTS_PER_DOLLAR

CURRENCY_SCALE

CURRENCY0

INTEGER_SCALE

INTEGER0

INTEGER1

PERCENT_SCALE

PERCENT0

PERCENT100

PI_OVER_2

PI_OVER_4

PI_TIMES_2

Method Detail

add

add

append

avg

clamp

clamp

currencyToString

distance

divideCurrency

dividePercent

dividePercent

dividePercent

format

getAngle

getBigDecimal

getCurrency

getCurrency

getInteger

getInteger

getMaxValue

getMinValue

getNorthClockwiseAngle

getPercent

getPercent

getPercent

hashCode

integerToString

isAcute

isNanOrInfinite

makePrecise

max

max

max

maxInt

midpoint

min

min

min

minInt

orientedAngleBetween

percentToString

percentToString

pointLineDistance

precisionEqual

randomGaussian

randomRange

sgn

sgn

sgn

sgn

sgn

sgn

subtract

toDouble

toDoubleArray

toDoubleArray

toDoubleArraySplit

toDoubleArraySplit