Numbers (Pitaya 0.1 API)

java.lang.Object
- org.kocakosm.pitaya.math.Numbers

public final class Numbers
extends Object

Extra math utilities.

Author:: Osman KOCAK

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`gcd(int a, int b)` Returns the greatest common divisor of the absolute value of the given two numbers.
`static long`	`gcd(long a, long b)` Returns the greatest common divisor of the absolute value of the given two numbers.
`static boolean`	`isFinite(double d)` Returns whether the given value is a "real" value.
`static boolean`	`isFinite(float f)` Returns whether the given value is a "real" value.
`static int`	`lcm(int a, int b)` Returns the least common multiple of the absolute value of the given two numbers.
`static long`	`lcm(long a, long b)` Returns the least common multiple of the absolute value of the given two numbers.
`static double`	`max(double... values)` Returns the maximum of the given values, using the same comparison rules as `Math.max(double, double)`.
`static float`	`max(float... values)` Returns the maximum of the given values, using the same comparison rules as `Math.max(float, float)`.
`static int`	`max(int... values)` Returns the maximum of the given values.
`static long`	`max(long... values)` Returns the maximum of the given values.
`static double`	`mean(double... values)` Returns the arithmetic mean of the given values.
`static double`	`mean(float... values)` Returns the arithmetic mean of the given values.
`static double`	`mean(int... values)` Returns the arithmetic mean of the given values.
`static double`	`mean(long... values)` Returns the arithmetic mean of the given values.
`static double`	`min(double... values)` Returns the minimum of the given values, using the same comparison rules as `Math.min(double, double)`.
`static float`	`min(float... values)` Returns the minimum of the given values, using the same comparison rules as `Math.min(float, float)`.
`static int`	`min(int... values)` Returns the minimum of the given values.
`static long`	`min(long... values)` Returns the minimum of the given values.
`static int`	`safeAbs(int a)` Returns the absolute value of the given value, provided the result fits into an `int`.
`static long`	`safeAbs(long a)` Returns the absolute value of the given value, provided the result fits into a `long`.
`static int`	`safeAdd(int a, int b)` Returns the sum of `a` and `b`, provided the result fits into an `int`.
`static long`	`safeAdd(long a, long b)` Returns the sum of `a` and `b`, provided the result fits into a `long`.
`static int`	`safeDivide(int a, int b)` Returns the result of the integer division of the first number by the second, provided the result fits into an `int`.
`static long`	`safeDivide(long a, long b)` Returns the result of the integer division of the first number by the second, provided the result fits into a `long`.
`static int`	`safeMultiply(int a, int b)` Returns the product of `a` and `b`, provided the result fits into an `int`.
`static long`	`safeMultiply(long a, long b)` Returns the product of `a` and `b`, provided the result fits into a `long`.
`static int`	`safeNegate(int a)` Returns the opposite of the given value, provided the result fits into an `int`.
`static long`	`safeNegate(long a)` Returns the opposite of the given value, provided the result fits into a `long`.
`static int`	`safePow(int a, int b)` Returns the value of the first argument raised to the power of the second, provided the result fits into an `int`.
`static long`	`safePow(long a, int b)` Returns the value of the first argument raised to the power of the second, provided the result fits into a `long`.
`static int`	`safeSubtract(int a, int b)` Returns the difference of `a` and `b`, provided the result fits into an `int`.
`static long`	`safeSubtract(long a, long b)` Returns the difference of `a` and `b`, provided the result fits into a `long`.
`static int`	`safeToInt(long a)` Casts the given `long` value to `int`, if possible.

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

- Method Detail
  - max
```
public static long max(long... values)
```
    Returns the maximum of the given values.
    
    Parameters:
    
    values - a non-empty array of long values.
    
    Returns:
    
    the maximum of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - max
```
public static int max(int... values)
```
    Returns the maximum of the given values.
    
    Parameters:
    
    values - a non-empty array of int values.
    
    Returns:
    
    the maximum of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - max
```
public static float max(float... values)
```
    Returns the maximum of the given values, using the same comparison rules as Math.max(float, float).
    
    Parameters:
    
    values - a non-empty array of float values.
    
    Returns:
    
    the maximum of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - max
```
public static double max(double... values)
```
    Returns the maximum of the given values, using the same comparison rules as Math.max(double, double).
    
    Parameters:
    
    values - a non-empty array of double values.
    
    Returns:
    
    the maximum of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - min
```
public static long min(long... values)
```
    Returns the minimum of the given values.
    
    Parameters:
    
    values - a non-empty array of long values.
    
    Returns:
    
    the minimum of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - min
```
public static int min(int... values)
```
    Returns the minimum of the given values.
    
    Parameters:
    
    values - a non-empty array of int values.
    
    Returns:
    
    the minimum of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - min
```
public static float min(float... values)
```
    Returns the minimum of the given values, using the same comparison rules as Math.min(float, float).
    
    Parameters:
    
    values - a non-empty array of float values.
    
    Returns:
    
    the minimum of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - min
```
public static double min(double... values)
```
    Returns the minimum of the given values, using the same comparison rules as Math.min(double, double).
    
    Parameters:
    
    values - a non-empty array of double values.
    
    Returns:
    
    the minimum of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - mean
```
public static double mean(int... values)
```
    Returns the arithmetic mean of the given values. This method is not subject to overflow.
    
    Parameters:
    
    values - the values.
    
    Returns:
    
    the arithmetic mean of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - mean
```
public static double mean(long... values)
```
    Returns the arithmetic mean of the given values. This method is not subject to overflow.
    
    Parameters:
    
    values - the values.
    
    Returns:
    
    the arithmetic mean of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - mean
```
public static double mean(double... values)
```
    Returns the arithmetic mean of the given values. This method is not subject to overflow.
    
    Parameters:
    
    values - the values.
    
    Returns:
    
    the arithmetic mean of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - mean
```
public static double mean(float... values)
```
    Returns the arithmetic mean of the given values. This method is not subject to overflow.
    
    Parameters:
    
    values - the values.
    
    Returns:
    
    the arithmetic mean of the given values.
    
    Throws:
    
    NullPointerException - if values is null.
    
    IllegalArgumentException - if values is empty.
  - isFinite
```
public static boolean isFinite(float f)
```
    Returns whether the given value is a "real" value. Namely, it returns false if the given value is infinite or NaN, and true in all other cases.
    
    Parameters:
    
    f - the value to test.
    
    Returns:
    
    whether the given value is a "real" value.
  - isFinite
```
public static boolean isFinite(double d)
```
    Returns whether the given value is a "real" value. Namely, it returns false if the given value is infinite or NaN, and true in all other cases.
    
    Parameters:
    
    d - the value to test.
    
    Returns:
    
    whether the given value is a "real" value.
  - safeAbs
```
public static long safeAbs(long a)
```
    Returns the absolute value of the given value, provided the result fits into a long.
    
    Parameters:
    
    a - the value.
    
    Returns:
    
    the absolute value of a.
    
    Throws:
    
    ArithmeticException - if the absolute value of a can't be represented by a long.
  - safeAbs
```
public static int safeAbs(int a)
```
    Returns the absolute value of the given value, provided the result fits into an int.
    
    Parameters:
    
    a - the value.
    
    Returns:
    
    the absolute value of a.
    
    Throws:
    
    ArithmeticException - if the absolute value of a can't be represented by an int.
  - safeNegate
```
public static long safeNegate(long a)
```
    Returns the opposite of the given value, provided the result fits into a long.
    
    Parameters:
    
    a - the value to negate.
    
    Returns:
    
    -a.
    
    Throws:
    
    ArithmeticException - if -a can't be represented by a long.
  - safeNegate
```
public static int safeNegate(int a)
```
    Returns the opposite of the given value, provided the result fits into an int.
    
    Parameters:
    
    a - the value to negate.
    
    Returns:
    
    -a.
    
    Throws:
    
    ArithmeticException - if -a can't be represented by an int.
  - safeAdd
```
public static long safeAdd(long a,
                           long b)
```
    Returns the sum of a and b, provided the result fits into a long.
    
    Parameters:
    
    a - the first operand.
    
    b - the second operand.
    
    Returns:
    
    a + b.
    
    Throws:
    
    ArithmeticException - if a + b can't be represented by a long.
  - safeAdd
```
public static int safeAdd(int a,
                          int b)
```
    Returns the sum of a and b, provided the result fits into an int.
    
    Parameters:
    
    a - the first operand.
    
    b - the second operand.
    
    Returns:
    
    a + b.
    
    Throws:
    
    ArithmeticException - if a + b can't be represented by an int.
  - safeSubtract
```
public static long safeSubtract(long a,
                                long b)
```
    Returns the difference of a and b, provided the result fits into a long.
    
    Parameters:
    
    a - the first operand.
    
    b - the second operand.
    
    Returns:
    
    a - b.
    
    Throws:
    
    ArithmeticException - if a - b can't be represented by a long.
  - safeSubtract
```
public static int safeSubtract(int a,
                               int b)
```
    Returns the difference of a and b, provided the result fits into an int.
    
    Parameters:
    
    a - the first operand.
    
    b - the second operand.
    
    Returns:
    
    a - b.
    
    Throws:
    
    ArithmeticException - if a - b can't be represented by an int.
  - safeMultiply
```
public static long safeMultiply(long a,
                                long b)
```
    Returns the product of a and b, provided the result fits into a long.
    
    Parameters:
    
    a - the first operand.
    
    b - the second operand.
    
    Returns:
    
    a * b.
    
    Throws:
    
    ArithmeticException - if a * b can't be represented by a long.
  - safeMultiply
```
public static int safeMultiply(int a,
                               int b)
```
    Returns the product of a and b, provided the result fits into an int.
    
    Parameters:
    
    a - the first operand.
    
    b - the second operand.
    
    Returns:
    
    a * b.
    
    Throws:
    
    ArithmeticException - if a * b can't be represented by an int.
  - safeDivide
```
public static long safeDivide(long a,
                              long b)
```
    Returns the result of the integer division of the first number by the second, provided the result fits into a long.
    
    Parameters:
    
    a - the dividend.
    
    b - the divisor.
    
    Returns:
    
    a / b.
    
    Throws:
    
    ArithmeticException - if b is equal to 0 or if a / b can't be represented by a long.
  - safeDivide
```
public static int safeDivide(int a,
                             int b)
```
    Returns the result of the integer division of the first number by the second, provided the result fits into an int.
    
    Parameters:
    
    a - the dividend.
    
    b - the divisor.
    
    Returns:
    
    a / b.
    
    Throws:
    
    ArithmeticException - if b is equal to 0 or if a / b can't be represented by an int.
  - safePow
```
public static long safePow(long a,
                           int b)
```
    Returns the value of the first argument raised to the power of the second, provided the result fits into a long. This method implements the exponentiation by squaring method. Please refer to Wikipedia for further information.
    
    Parameters:
    
    a - the base.
    
    b - the exponent.
    
    Returns:
    
    a ^ b.
    
    Throws:
    
    IllegalArgumentException - if b < 0.
    
    ArithmeticException - if a ^ b can't be represented by a long.
  - safePow
```
public static int safePow(int a,
                          int b)
```
    Returns the value of the first argument raised to the power of the second, provided the result fits into an int. This method implements the exponentiation by squaring method. Please refer to Wikipedia for further information.
    
    Parameters:
    
    a - the base.
    
    b - the exponent.
    
    Returns:
    
    a ^ b.
    
    Throws:
    
    IllegalArgumentException - if b < 0.
    
    ArithmeticException - if a ^ b can't be represented by an int.
  - gcd
```
public static long gcd(long a,
                       long b)
```
    Returns the greatest common divisor of the absolute value of the given two numbers. This method first computes the absolute values of the given numbers, thus it doesn't accept Long.MIN_VALUE. Also, note that if one of the given values is 0, this method will return the absolute value of the second argument. This method implements the binary GCD algorithm (also known as Stein's algorithm). For further information on this algorithm, please refer to Wikipedia.
    
    Parameters:
    
    a - the first number.
    
    b - the second number.
    
    Returns:
    
    the greatest common divisor of a and b.
    
    Throws:
    
    ArithmeticException - if a or b is equal to Long.MIN_VALUE.
  - gcd
```
public static int gcd(int a,
                      int b)
```
    Returns the greatest common divisor of the absolute value of the given two numbers. This method first computes the absolute values of the given numbers, thus it doesn't accept Integer.MIN_VALUE. Also, note that if one of the given values is 0, this method will return the absolute value of the second argument. This method implements the binary GCD algorithm (also known as Stein's algorithm). For further information on this algorithm, please refer to Wikipedia.
    
    Parameters:
    
    a - the first number.
    
    b - the second number.
    
    Returns:
    
    the greatest common divisor of a and b.
    
    Throws:
    
    ArithmeticException - if a or b is equal to Integer.MIN_VALUE.
  - lcm
```
public static long lcm(long a,
                       long b)
```
    Returns the least common multiple of the absolute value of the given two numbers. This method first computes the absolute values of the given numbers, thus it doesn't accept Long.MIN_VALUE. Also, note that if one of the given values is 0, this method will return the absolute value of the second argument. This method uses the formula lcm(a,b) = (a / gcd(a,b)) * b. Please refer to Wikipedia for further information.
    
    Parameters:
    
    a - the first number.
    
    b - the second number.
    
    Returns:
    
    the least common multiple of a and b.
    
    Throws:
    
    ArithmeticException - if a or b is equal to Long.MIN_VALUE.
  - lcm
```
public static int lcm(int a,
                      int b)
```
    Returns the least common multiple of the absolute value of the given two numbers. This method first computes the absolute values of the given numbers, thus it doesn't accept Integer.MIN_VALUE. Also, note that if one of the given values is 0, this method will return the absolute value of the second argument. This method uses the formula lcm(a,b) = (a / gcd(a,b)) * b. Please refer to Wikipedia for further information.
    
    Parameters:
    
    a - the first number.
    
    b - the second number.
    
    Returns:
    
    the least common multiple of a and b.
    
    Throws:
    
    ArithmeticException - if a or b is equal to Integer.MIN_VALUE.
  - safeToInt
```
public static int safeToInt(long a)
```
    Casts the given long value to int, if possible.
    
    Parameters:
    
    a - the value to cast to int.
    
    Returns:
    
    the casted value.
    
    Throws:
    
    ArithmeticException - if a cannot be cast into an int.

Class Numbers

Method Summary

Methods inherited from class java.lang.Object

Method Detail

max

max

max

max

min

min

min

min

mean

mean

mean

mean

isFinite

isFinite

safeAbs

safeAbs

safeNegate

safeNegate

safeAdd

safeAdd

safeSubtract

safeSubtract

safeMultiply

safeMultiply

safeDivide

safeDivide

safePow

safePow

gcd

gcd

lcm

lcm

safeToInt