Package me.datafox.dfxengine.math.utils

Class Operations

java.lang.Object
me.datafox.dfxengine.math.utils.Operations
public class Operations extends Object
Various math operations for Numerals.

  • Constructor Details

    • Operations

      public Operations()

  • Method Details

    • getContext

      public static MathContext getContext()
      Returns:
      current MathContext for BigDecimal operations

    • setContext

      public static void setContext(MathContext context)
      Parameters:
      context - MathContext for BigDecimal operations

    • add

      public static Numeral add(Numeral augend, Numeral addend)
      Adds two Numerals together. The Numeral parameters are converted to the most significant type with Numerals.getSignificantType(NumeralType...). Additionally, the resulting Numeral will be converted to a higher type if the addition would result in an overflow or underflow.
      Parameters:
      augend - Numeral to be added
      addend - Numeral to be added
      Returns:
      result of the addition
      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

    • subtract

      public static Numeral subtract(Numeral minuend, Numeral subtrahend)
      Subtracts a Numeral from another Numeral. The Numeral parameters are converted to the most significant type with Numerals.getSignificantType(NumeralType...). Additionally, the resulting Numeral will be converted to a higher type if the subtraction would result in an overflow or underflow.
      Parameters:
      minuend - Numeral to be subtracted from
      subtrahend - Numeral to be subtracted
      Returns:
      result of the subtraction
      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

    • multiply

      public static Numeral multiply(Numeral multiplicand, Numeral multiplier)
      Multiplies two Numerals together. The Numeral parameters are converted to the most significant type with Numerals.getSignificantType(NumeralType...). Additionally, the resulting Numeral will be converted to a higher type if the multiplication would result in an overflow or underflow.
      Parameters:
      multiplicand - Numeral to be multiplied
      multiplier - Numeral to be multiplied
      Returns:
      result of the multiplication
      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

    • divide

      public static Numeral divide(Numeral dividend, Numeral divisor)
      Divides a Numeral from another Numeral. The Numeral parameters are converted to the most significant type with Numerals.getSignificantType(NumeralType...). Additionally, the resulting Numeral will be converted to a higher type if the division would result in an overflow or underflow.
      Parameters:
      dividend - Numeral to be divided
      divisor - Numeral to be divided with
      Returns:
      result of the division
      Throws:
      ArithmeticException - if the divisor is zero
      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

    • inverse

      public static Numeral inverse(Numeral numeral)
      Inverts a Numeral. This is equivalent to divide(1, numeral). The resulting Numeral will be converted to a higher type if the division would result in an overflow or underflow.
      Parameters:
      numeral - Numeral to be inverted
      Returns:
      result of the inversion
      Throws:
      ArithmeticException - if the divisor is zero
      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

    • power

      public static Numeral power(Numeral base, Numeral exponent)
      Raises a Numeral to the power of another Numeral. The Numeral parameters are converted to the most significant type with Numerals.getSignificantType(NumeralType...). Additionally, the resulting Numeral will be converted to a higher type if the exponentiation would result in an overflow or underflow.
      Parameters:
      base - Numeral to be exponentiated
      exponent - exponent
      Returns:
      result of the exponentiation
      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

    • exp

      public static Numeral exp(Numeral numeral)
      Calculates the natural exponent of a Numeral. The resulting Numeral will be converted to a higher type if the exponentiation would result in an overflow or underflow.
      Parameters:
      numeral - Numeral to be calculated
      Returns:
      natural exponent of the specified Numeral
      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

    • sqrt

      public static Numeral sqrt(Numeral numeral)
      Calculates the square root of a Numeral.
      Parameters:
      numeral - Numeral to be calculated
      Returns:
      square root of the specified Numeral
      Throws:
      ArithmeticException - if the Numeral is negative
      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

    • cbrt

      public static Numeral cbrt(Numeral numeral)
      Calculates the cube root of a Numeral.
      Parameters:
      numeral - Numeral to be calculated
      Returns:
      cube root of the specified Numeral
      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

    • root

      public static Numeral root(Numeral numeral, Numeral base)
      Calculates the root of a Numeral in the base of another Numeral. The Numeral parameters are converted to the most significant type with Numerals.getSignificantType(NumeralType...). Additionally, the resulting Numeral will be converted to a higher type if the operation would result in an overflow or underflow.
      Parameters:
      numeral - Numeral to be calculated
      base - base of the root
      Returns:
      result of the operation
      Throws:
      ArithmeticException - if the Numeral is negative or if the root is zero
      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

    • log

      public static Numeral log(Numeral numeral)
      Calculates the natural logarithm of a Numeral.
      Parameters:
      numeral - Numeral to be calculated
      Returns:
      natural logarithm of the specified Numeral
      Throws:
      ArithmeticException - if the Numeral is zero or negative
      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

    • log2

      public static Numeral log2(Numeral numeral)
      Calculates the binary logarithm of a Numeral.
      Parameters:
      numeral - Numeral to be calculated
      Returns:
      binary logarithm of the specified Numeral
      Throws:
      ArithmeticException - if the Numeral is zero or negative
      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

    • log10

      public static Numeral log10(Numeral numeral)
      Calculates the base 10 logarithm of a Numeral.
      Parameters:
      numeral - Numeral to be calculated
      Returns:
      base 10 logarithm of the specified Numeral
      Throws:
      ArithmeticException - if the Numeral is zero or negative
      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

    • logN

      public static Numeral logN(Numeral numeral, Numeral base)
      Calculates the logarithm a Numeral in the base of another Numeral. The Numeral parameters are converted to the most significant type with Numerals.getSignificantType(NumeralType...). Additionally, the resulting Numeral will be converted to a higher type if the logarithm would result in an overflow or underflow.
      Parameters:
      numeral - Numeral to be calculated
      base - base of the logarithm
      Returns:
      result of the logarithm
      Throws:
      ArithmeticException - if the Numeral is zero or negative, if the base is zero or negative, or if the base is one
      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

    • min

      public static Numeral min(Numeral numeral, Numeral other)
      Returns the minimum of two Numerals, that is, the Numeral that represents a lesser number. If the Numerals represent the same number, the first Numeral is returned
      Parameters:
      numeral - Numeral to compare
      other - Numeral to compare
      Returns:
      the lesser of the specified Numerals
      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

    • max

      public static Numeral max(Numeral numeral, Numeral other)
      Returns the maximum of two Numerals, that is, the Numeral that represents a greater number. If the Numerals represent the same number, the first Numeral is returned
      Parameters:
      numeral - Numeral to compare
      other - Numeral to compare
      Returns:
      the greater of the specified Numerals
      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

    • lerp

      public static Numeral lerp(Numeral numeral, Numeral min, Numeral max)
      Linearly interpolates a Numeral based on a minimum and maximum numeral. The mathematical formula for the operation is numeral * (max - min) + min. Values smaller than zero and greater than one are allowed.
      Parameters:
      numeral - Numeral to be interpolated
      min - minimum value
      max - maximum value
      Returns:
      result of the linear interpolation
      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

    • add

      public static Numeral add(int augend, int addend)
      Parameters:
      augend - augend
      addend - addend
      Returns:
      result of the addition

    • add

      public static Numeral add(long augend, long addend)
      Parameters:
      augend - augend
      addend - addend
      Returns:
      result of the addition

    • add

      public static BigIntNumeral add(BigInteger augend, BigInteger addend)
      Parameters:
      augend - augend
      addend - addend
      Returns:
      result of the addition

    • add

      public static Numeral add(float augend, float addend)
      Parameters:
      augend - augend
      addend - addend
      Returns:
      result of the addition

    • add

      public static Numeral add(double augend, double addend)
      Parameters:
      augend - augend
      addend - addend
      Returns:
      result of the addition

    • add

      public static BigDecNumeral add(BigDecimal augend, BigDecimal addend)
      Parameters:
      augend - augend
      addend - addend
      Returns:
      result of the addition

    • subtract

      public static Numeral subtract(int minuend, int subtrahend)
      Parameters:
      minuend - minuend
      subtrahend - subtrahend
      Returns:
      result of the subtraction

    • subtract

      public static Numeral subtract(long minuend, long subtrahend)
      Parameters:
      minuend - minuend
      subtrahend - subtrahend
      Returns:
      result of the subtraction

    • subtract

      public static BigIntNumeral subtract(BigInteger minuend, BigInteger subtrahend)
      Parameters:
      minuend - minuend
      subtrahend - subtrahend
      Returns:
      result of the subtraction

    • subtract

      public static Numeral subtract(float minuend, float subtrahend)
      Parameters:
      minuend - minuend
      subtrahend - subtrahend
      Returns:
      result of the subtraction

    • subtract

      public static Numeral subtract(double minuend, double subtrahend)
      Parameters:
      minuend - minuend
      subtrahend - subtrahend
      Returns:
      result of the subtraction

    • subtract

      public static BigDecNumeral subtract(BigDecimal minuend, BigDecimal subtrahend)
      Parameters:
      minuend - minuend
      subtrahend - subtrahend
      Returns:
      result of the subtraction

    • multiply

      public static Numeral multiply(int multiplicand, int multiplier)
      Parameters:
      multiplicand - multiplicand
      multiplier - multiplier
      Returns:
      result of the multiplication

    • multiply

      public static Numeral multiply(long multiplicand, long multiplier)
      Parameters:
      multiplicand - multiplicand
      multiplier - multiplier
      Returns:
      result of the multiplication

    • multiply

      public static BigIntNumeral multiply(BigInteger multiplicand, BigInteger multiplier)
      Parameters:
      multiplicand - multiplicand
      multiplier - multiplier
      Returns:
      result of the multiplication

    • multiply

      public static Numeral multiply(float multiplicand, float multiplier)
      Parameters:
      multiplicand - multiplicand
      multiplier - multiplier
      Returns:
      result of the multiplication

    • multiply

      public static Numeral multiply(double multiplicand, double multiplier)
      Parameters:
      multiplicand - multiplicand
      multiplier - multiplier
      Returns:
      result of the multiplication

    • multiply

      public static BigDecNumeral multiply(BigDecimal multiplicand, BigDecimal multiplier)
      Parameters:
      multiplicand - multiplicand
      multiplier - multiplier
      Returns:
      result of the multiplication

    • divide

      public static Numeral divide(int dividend, int divisor)
      Parameters:
      dividend - dividend
      divisor - divisor
      Returns:
      result of the division

    • divide

      public static Numeral divide(long dividend, long divisor)
      Parameters:
      dividend - dividend
      divisor - divisor
      Returns:
      result of the division

    • divide

      public static BigIntNumeral divide(BigInteger dividend, BigInteger divisor)
      Parameters:
      dividend - dividend
      divisor - divisor
      Returns:
      result of the division

    • divide

      public static Numeral divide(float dividend, float divisor)
      Parameters:
      dividend - dividend
      divisor - divisor
      Returns:
      result of the division

    • divide

      public static Numeral divide(double dividend, double divisor)
      Parameters:
      dividend - dividend
      divisor - divisor
      Returns:
      result of the division

    • divide

      public static BigDecNumeral divide(BigDecimal dividend, BigDecimal divisor)
      Parameters:
      dividend - dividend
      divisor - divisor
      Returns:
      result of the division

    • power

      public static Numeral power(int base, int exponent)
      Parameters:
      base - base
      exponent - exponent
      Returns:
      result of the exponentiation

    • power

      public static Numeral power(long base, long exponent)
      Parameters:
      base - base
      exponent - exponent
      Returns:
      result of the exponentiation

    • power

      public static Numeral power(BigInteger base, BigInteger exponent)
      Parameters:
      base - base
      exponent - exponent
      Returns:
      result of the exponentiation

    • power

      public static Numeral power(float base, float exponent)
      Parameters:
      base - base
      exponent - exponent
      Returns:
      result of the exponentiation

    • power

      public static Numeral power(double base, double exponent)
      Parameters:
      base - base
      exponent - exponent
      Returns:
      result of the exponentiation

    • power

      public static Numeral power(BigDecimal base, BigDecimal exponent)
      Parameters:
      base - base
      exponent - exponent
      Returns:
      result of the exponentiation

    • exp

      public static Numeral exp(int value)
      Parameters:
      value - value
      Returns:
      natural exponent of the value

    • exp

      public static Numeral exp(long value)
      Parameters:
      value - value
      Returns:
      natural exponent of the value

    • exp

      public static Numeral exp(BigInteger value)
      Parameters:
      value - exponent
      Returns:
      natural exponent of value

    • exp

      public static Numeral exp(float value)
      Parameters:
      value - value
      Returns:
      natural exponent of the value

    • exp

      public static Numeral exp(double value)
      Parameters:
      value - value
      Returns:
      natural exponent of the value

    • exp

      public static Numeral exp(BigDecimal value)
      Parameters:
      value - value
      Returns:
      natural exponent of the value

    • sqrt

      public static Numeral sqrt(int value)
      Parameters:
      value - value
      Returns:
      square root of value

    • sqrt

      public static Numeral sqrt(long value)
      Parameters:
      value - value
      Returns:
      square root of value

    • sqrt

      public static Numeral sqrt(BigInteger value)
      Parameters:
      value - value
      Returns:
      square root of value

    • sqrt

      public static Numeral sqrt(float value)
      Parameters:
      value - value
      Returns:
      square root of value

    • sqrt

      public static Numeral sqrt(double value)
      Parameters:
      value - value
      Returns:
      square root of value

    • sqrt

      public static Numeral sqrt(BigDecimal value)
      Parameters:
      value - value
      Returns:
      square root of value

    • cbrt

      public static Numeral cbrt(int value)
      Parameters:
      value - value
      Returns:
      cube root of value

    • cbrt

      public static Numeral cbrt(long value)
      Parameters:
      value - value
      Returns:
      cube root of value

    • cbrt

      public static Numeral cbrt(BigInteger value)
      Parameters:
      value - value
      Returns:
      cube root of value

    • cbrt

      public static Numeral cbrt(float value)
      Parameters:
      value - value
      Returns:
      cube root of value

    • cbrt

      public static Numeral cbrt(double value)
      Parameters:
      value - value
      Returns:
      cube root of value

    • cbrt

      public static Numeral cbrt(BigDecimal value)
      Parameters:
      value - value
      Returns:
      cube root of value

    • root

      public static Numeral root(int value, int base)
      Parameters:
      value - value
      base - base of the root
      Returns:
      root of the value in the specified base

    • root

      public static Numeral root(long value, long base)
      Parameters:
      value - value
      base - base of the root
      Returns:
      root of the value in the specified base

    • root

      public static Numeral root(BigInteger value, BigInteger base)
      Parameters:
      value - value
      base - base of the root
      Returns:
      root of the value in the specified base

    • root

      public static Numeral root(float value, float base)
      Parameters:
      value - value
      base - base of the root
      Returns:
      root of the value in the specified base

    • root

      public static Numeral root(double value, double base)
      Parameters:
      value - value
      base - base of the root
      Returns:
      root of the value in the specified base

    • root

      public static Numeral root(BigDecimal value, BigDecimal base)
      Parameters:
      value - value
      base - base of the root
      Returns:
      root of the value in the specified base

    • log

      public static Numeral log(int value)
      Parameters:
      value - value
      Returns:
      natural logarithm of the value

    • log

      public static Numeral log(long value)
      Parameters:
      value - value
      Returns:
      natural logarithm of the value

    • log

      public static Numeral log(BigInteger value)
      Parameters:
      value - value
      Returns:
      natural logarithm of the value

    • log

      public static Numeral log(float value)
      Parameters:
      value - value
      Returns:
      natural logarithm of the value

    • log

      public static Numeral log(double value)
      Parameters:
      value - value
      Returns:
      natural logarithm of the value

    • log

      public static Numeral log(BigDecimal value)
      Parameters:
      value - value
      Returns:
      natural logarithm of the value

    • log2

      public static Numeral log2(int value)
      Parameters:
      value - value
      Returns:
      binary logarithm of the value

    • log2

      public static Numeral log2(long value)
      Parameters:
      value - value
      Returns:
      binary logarithm of the value

    • log2

      public static Numeral log2(BigInteger value)
      Parameters:
      value - value
      Returns:
      binary logarithm of the value

    • log2

      public static Numeral log2(float value)
      Parameters:
      value - value
      Returns:
      binary logarithm of the value

    • log2

      public static Numeral log2(double value)
      Parameters:
      value - value
      Returns:
      binary logarithm of the value

    • log2

      public static Numeral log2(BigDecimal value)
      Parameters:
      value - value
      Returns:
      binary logarithm of the value

    • log10

      public static Numeral log10(int value)
      Parameters:
      value - value
      Returns:
      base 10 logarithm of the value

    • log10

      public static Numeral log10(long value)
      Parameters:
      value - value
      Returns:
      base 10 logarithm of the value

    • log10

      public static Numeral log10(BigInteger value)
      Parameters:
      value - value
      Returns:
      base 10 logarithm of the value

    • log10

      public static Numeral log10(float value)
      Parameters:
      value - value
      Returns:
      base 10 logarithm of the value

    • log10

      public static Numeral log10(double value)
      Parameters:
      value - value
      Returns:
      base 10 logarithm of the value

    • log10

      public static Numeral log10(BigDecimal value)
      Parameters:
      value - value
      Returns:
      base 10 logarithm of the value

    • logN

      public static Numeral logN(int value, int base)
      Parameters:
      value - value
      base - base
      Returns:
      logarithm of the value in the specified base

    • logN

      public static Numeral logN(long value, long base)
      Parameters:
      value - value
      base - base
      Returns:
      logarithm of the value in the specified base

    • logN

      public static Numeral logN(BigInteger value, BigInteger base)
      Parameters:
      value - value
      base - base
      Returns:
      logarithm of the value in the specified base

    • logN

      public static Numeral logN(float value, float base)
      Parameters:
      value - value
      base - base
      Returns:
      logarithm of the value in the specified base

    • logN

      public static Numeral logN(double value, double base)
      Parameters:
      value - value
      base - base
      Returns:
      logarithm of the value in the specified base

    • logN

      public static Numeral logN(BigDecimal value, BigDecimal base)
      Parameters:
      value - value
      base - base
      Returns:
      logarithm of the value in the specified base

    • lerp

      public static Numeral lerp(int value, int min, int max)
      Parameters:
      value - value to be interpolated
      min - minimum value
      max - maximum value
      Returns:
      result of the linear interpolation

    • lerp

      public static Numeral lerp(long value, long min, long max)
      Parameters:
      value - value to be interpolated
      min - minimum value
      max - maximum value
      Returns:
      result of the linear interpolation

    • lerp

      public static Numeral lerp(BigInteger value, BigInteger min, BigInteger max)
      Parameters:
      value - value to be interpolated
      min - minimum value
      max - maximum value
      Returns:
      result of the linear interpolation

    • lerp

      public static Numeral lerp(float value, float min, float max)
      Parameters:
      value - value to be interpolated
      min - minimum value
      max - maximum value
      Returns:
      result of the linear interpolation

    • lerp

      public static Numeral lerp(double value, double min, double max)
      Parameters:
      value - value to be interpolated
      min - minimum value
      max - maximum value
      Returns:
      result of the linear interpolation

    • lerp

      public static Numeral lerp(BigDecimal value, BigDecimal min, BigDecimal max)
      Parameters:
      value - value to be interpolated
      min - minimum value
      max - maximum value
      Returns:
      result of the linear interpolation