Added in API level 1

StrictMath

class StrictMath

kotlin.Any
↳	java.lang.StrictMath

The class contains methods for performing basic numeric operations such as the elementary exponential, logarithm, square root, and trigonometric functions.

To help ensure portability of Java programs, the definitions of some of the numeric functions in this package require that they produce the same results as certain published algorithms. These algorithms are available from the well-known network library netlib as the package "Freely Distributable Math Library," fdlibm. These algorithms, which are written in the C programming language, are then to be understood to be transliterated into Java and executed with all floating-point and integer operations following the rules of Java arithmetic. The following transformations are used in the transliteration:

Extraction and setting of the high and low halves of a 64-bit double in C is expressed using Java platform methods that perform bit-wise conversions java.lang.Double#doubleToRawLongBits(double)} and java.lang.Double#longBitsToDouble(long)}.
Unsigned int values in C are mapped to signed int values in Java with updates to operations to replicate unsigned semantics where the results on the same textual operation would differ. For example, >> shifts on unsigned C values are replaced with >>> shifts on signed Java values. Sized comparisons on unsigned C values (<, <=, >, >=) are replaced with semantically equivalent calls to compareUnsigned.

The Java math library is defined with respect to fdlibm version 5.3. Where fdlibm provides more than one definition for a function (such as acos), use the "IEEE 754 core function" version (residing in a file whose name begins with the letter e). The methods which require fdlibm semantics are sin, cos, tan, asin, acos, atan, exp, log, log10, cbrt, atan2, pow, sinh, cosh, tanh, hypot, expm1, and log1p.

The platform uses signed two's complement integer arithmetic with int and long primitive types. The developer should choose the primitive type to ensure that arithmetic operations consistently produce correct results, which in some cases means the operations will not overflow the range of values of the computation. The best practice is to choose the primitive type and algorithm to avoid overflow. In cases where the size is int or long and overflow errors need to be detected, the methods whose names end with Exact throw an ArithmeticException when the results overflow.

IEEE 754 Recommended Operations

The Math class discusses how the shared quality of implementation criteria for selected Math and StrictMath methods relate to the IEEE 754 recommended operations.

Summary

Constants
static Double	`E` The `double` value that is closer than any other to e, the base of the natural logarithms.
static Double	`PI` The `double` value that is closer than any other to pi (π), the ratio of the circumference of a circle to its diameter.
static Double	`TAU` The `double` value that is closer than any other to tau (τ), the ratio of the circumference of a circle to its radius.

Public methods
static Double	`IEEEremainder(f1: Double, f2: Double)` Computes the remainder operation on two arguments as prescribed by the IEEE 754 standard.
static Int	`abs(a: Int)` Returns the absolute value of an `int` value.
static Long	`abs(a: Long)` Returns the absolute value of a `long` value.
static Float	`abs(a: Float)` Returns the absolute value of a `float` value.
static Double	`abs(a: Double)` Returns the absolute value of a `double` value.
static Int	`absExact(a: Int)` Returns the mathematical absolute value of an `int` value if it is exactly representable as an `int`, throwing `ArithmeticException` if the result overflows the positive `int` range.
static Long	`absExact(a: Long)` Returns the mathematical absolute value of an `long` value if it is exactly representable as an `long`, throwing `ArithmeticException` if the result overflows the positive `long` range.
static Double	`acos(a: Double)` Returns the arc cosine of a value; the returned angle is in the range 0.
static Int	`addExact(x: Int, y: Int)` Returns the sum of its arguments, throwing an exception if the result overflows an `int`.
static Long	`addExact(x: Long, y: Long)` Returns the sum of its arguments, throwing an exception if the result overflows a `long`.
static Double	`asin(a: Double)` Returns the arc sine of a value; the returned angle is in the range -pi/2 through pi/2.
static Double	`atan(a: Double)` Returns the arc tangent of a value; the returned angle is in the range -pi/2 through pi/2.
static Double	`atan2(y: Double, x: Double)` Returns the angle theta from the conversion of rectangular coordinates (`x`, `y`) to polar coordinates (r, theta).
static Double	`cbrt(a: Double)` Returns the cube root of a `double` value.
static Double	`ceil(a: Double)` Returns the smallest (closest to negative infinity) `double` value that is greater than or equal to the argument and is equal to a mathematical integer.
static Int	`ceilDiv(x: Int, y: Int)` Returns the smallest (closest to negative infinity) `int` value that is greater than or equal to the algebraic quotient.
static Long	`ceilDiv(x: Long, y: Int)` Returns the smallest (closest to negative infinity) `long` value that is greater than or equal to the algebraic quotient.
static Long	`ceilDiv(x: Long, y: Long)` Returns the smallest (closest to negative infinity) `long` value that is greater than or equal to the algebraic quotient.
static Int	`ceilDivExact(x: Int, y: Int)` Returns the smallest (closest to negative infinity) `int` value that is greater than or equal to the algebraic quotient.
static Long	`ceilDivExact(x: Long, y: Long)` Returns the smallest (closest to negative infinity) `long` value that is greater than or equal to the algebraic quotient.
static Int	`ceilMod(x: Int, y: Int)` Returns the ceiling modulus of the `int` arguments.
static Int	`ceilMod(x: Long, y: Int)` Returns the ceiling modulus of the `long` and `int` arguments.
static Long	`ceilMod(x: Long, y: Long)` Returns the ceiling modulus of the `long` arguments.
static Int	`clamp(value: Long, min: Int, max: Int)` Clamps the value to fit between min and max.
static Long	`clamp(value: Long, min: Long, max: Long)` Clamps the value to fit between min and max.
static Double	`clamp(value: Double, min: Double, max: Double)` Clamps the value to fit between min and max.
static Float	`clamp(value: Float, min: Float, max: Float)` Clamps the value to fit between min and max.
static Double	`copySign(magnitude: Double, sign: Double)` Returns the first floating-point argument with the sign of the second floating-point argument.
static Float	`copySign(magnitude: Float, sign: Float)` Returns the first floating-point argument with the sign of the second floating-point argument.
static Double	`cos(a: Double)` Returns the trigonometric cosine of an angle.
static Double	`cosh(x: Double)` Returns the hyperbolic cosine of a `double` value.
static Int	`decrementExact(a: Int)` Returns the argument decremented by one, throwing an exception if the result overflows an `int`.
static Long	`decrementExact(a: Long)` Returns the argument decremented by one, throwing an exception if the result overflows a `long`.
static Int	`divideExact(x: Int, y: Int)` Returns the quotient of the arguments, throwing an exception if the result overflows an `int`.
static Long	`divideExact(x: Long, y: Long)` Returns the quotient of the arguments, throwing an exception if the result overflows a `long`.
static Double	`exp(a: Double)` Returns Euler's number e raised to the power of a `double` value.
static Double	`expm1(x: Double)` Returns ex -1.
static Double	`floor(a: Double)` Returns the largest (closest to positive infinity) `double` value that is less than or equal to the argument and is equal to a mathematical integer.
static Int	`floorDiv(x: Int, y: Int)` Returns the largest (closest to positive infinity) `int` value that is less than or equal to the algebraic quotient.
static Long	`floorDiv(x: Long, y: Int)` Returns the largest (closest to positive infinity) `long` value that is less than or equal to the algebraic quotient.
static Long	`floorDiv(x: Long, y: Long)` Returns the largest (closest to positive infinity) `long` value that is less than or equal to the algebraic quotient.
static Int	`floorDivExact(x: Int, y: Int)` Returns the largest (closest to positive infinity) `int` value that is less than or equal to the algebraic quotient.
static Long	`floorDivExact(x: Long, y: Long)` Returns the largest (closest to positive infinity) `long` value that is less than or equal to the algebraic quotient.
static Int	`floorMod(x: Int, y: Int)` Returns the floor modulus of the `int` arguments.
static Int	`floorMod(x: Long, y: Int)` Returns the floor modulus of the `long` and `int` arguments.
static Long	`floorMod(x: Long, y: Long)` Returns the floor modulus of the `long` arguments.
static Double	`fma(a: Double, b: Double, c: Double)` Returns the fused multiply add of the three arguments; that is, returns the exact product of the first two arguments summed with the third argument and then rounded once to the nearest `double`.
static Float	`fma(a: Float, b: Float, c: Float)` Returns the fused multiply add of the three arguments; that is, returns the exact product of the first two arguments summed with the third argument and then rounded once to the nearest `float`.
static Int	`getExponent(f: Float)` Returns the unbiased exponent used in the representation of a `float`.
static Int	`getExponent(d: Double)` Returns the unbiased exponent used in the representation of a `double`.
static Double	`hypot(x: Double, y: Double)` Returns sqrt(x2 +y2) without intermediate overflow or underflow.
static Int	`incrementExact(a: Int)` Returns the argument incremented by one, throwing an exception if the result overflows an `int`.
static Long	`incrementExact(a: Long)` Returns the argument incremented by one, throwing an exception if the result overflows a `long`.
static Double	`log(a: Double)` Returns the natural logarithm (base e) of a `double` value.
static Double	`log10(a: Double)` Returns the base 10 logarithm of a `double` value.
static Double	`log1p(x: Double)` Returns the natural logarithm of the sum of the argument and 1.
static Int	`max(a: Int, b: Int)` Returns the greater of two `int` values.
static Long	`max(a: Long, b: Long)` Returns the greater of two `long` values.
static Float	`max(a: Float, b: Float)` Returns the greater of two `float` values.
static Double	`max(a: Double, b: Double)` Returns the greater of two `double` values.
static Int	`min(a: Int, b: Int)` Returns the smaller of two `int` values.
static Long	`min(a: Long, b: Long)` Returns the smaller of two `long` values.
static Float	`min(a: Float, b: Float)` Returns the smaller of two `float` values.
static Double	`min(a: Double, b: Double)` Returns the smaller of two `double` values.
static Int	`multiplyExact(x: Int, y: Int)` Returns the product of the arguments, throwing an exception if the result overflows an `int`.
static Long	`multiplyExact(x: Long, y: Int)` Returns the product of the arguments, throwing an exception if the result overflows a `long`.
static Long	`multiplyExact(x: Long, y: Long)` Returns the product of the arguments, throwing an exception if the result overflows a `long`.
static Long	`multiplyFull(x: Int, y: Int)` Returns the exact mathematical product of the arguments.
static Long	`multiplyHigh(x: Long, y: Long)` Returns as a `long` the most significant 64 bits of the 128-bit product of two 64-bit factors.
static Int	`negateExact(a: Int)` Returns the negation of the argument, throwing an exception if the result overflows an `int`.
static Long	`negateExact(a: Long)` Returns the negation of the argument, throwing an exception if the result overflows a `long`.
static Double	`nextAfter(start: Double, direction: Double)` Returns the floating-point number adjacent to the first argument in the direction of the second argument.
static Float	`nextAfter(start: Float, direction: Double)` Returns the floating-point number adjacent to the first argument in the direction of the second argument.
static Double	`nextDown(d: Double)` Returns the floating-point value adjacent to `d` in the direction of negative infinity.
static Float	`nextDown(f: Float)` Returns the floating-point value adjacent to `f` in the direction of negative infinity.
static Double	`nextUp(d: Double)` Returns the floating-point value adjacent to `d` in the direction of positive infinity.
static Float	`nextUp(f: Float)` Returns the floating-point value adjacent to `f` in the direction of positive infinity.
static Double	`pow(a: Double, b: Double)` Returns the value of the first argument raised to the power of the second argument.
static Double	`random()` Returns a `double` value with a positive sign, greater than or equal to `0.0` and less than `1.0`.
static Double	`rint(a: Double)` Returns the `double` value that is closest in value to the argument and is equal to a mathematical integer.
static Int	`round(a: Float)` Returns the closest `int` to the argument, with ties rounding to positive infinity.
static Long	`round(a: Double)` Returns the closest `long` to the argument, with ties rounding to positive infinity.
static Double	`scalb(d: Double, scaleFactor: Int)` Returns `d` × 2`scaleFactor` rounded as if performed by a single correctly rounded floating-point multiply.
static Float	`scalb(f: Float, scaleFactor: Int)` Returns `f` × 2`scaleFactor` rounded as if performed by a single correctly rounded floating-point multiply.
static Double	`signum(d: Double)` Returns the signum function of the argument; zero if the argument is zero, 1.
static Float	`signum(f: Float)` Returns the signum function of the argument; zero if the argument is zero, 1.
static Double	`sin(a: Double)` Returns the trigonometric sine of an angle.
static Double	`sinh(x: Double)` Returns the hyperbolic sine of a `double` value.
static Double	`sqrt(a: Double)` Returns the correctly rounded positive square root of a `double` value.
static Int	`subtractExact(x: Int, y: Int)` Returns the difference of the arguments, throwing an exception if the result overflows an `int`.
static Long	`subtractExact(x: Long, y: Long)` Returns the difference of the arguments, throwing an exception if the result overflows a `long`.
static Double	`tan(a: Double)` Returns the trigonometric tangent of an angle.
static Double	`tanh(x: Double)` Returns the hyperbolic tangent of a `double` value.
static Double	`toDegrees(angrad: Double)` Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
static Int	`toIntExact(value: Long)` Returns the value of the `long` argument, throwing an exception if the value overflows an `int`.
static Double	`toRadians(angdeg: Double)` Converts an angle measured in degrees to an approximately equivalent angle measured in radians.
static Double	`ulp(d: Double)` Returns the size of an ulp of the argument.
static Float	`ulp(f: Float)` Returns the size of an ulp of the argument.
static Long	`unsignedMultiplyHigh(x: Long, y: Long)` Returns as a `long` the most significant 64 bits of the unsigned 128-bit product of two unsigned 64-bit factors.

Constants

E

Added in API level 1

static val E: Double

The double value that is closer than any other to e, the base of the natural logarithms.

Value: 2.718281828459045

PI

Added in API level 1

static val PI: Double

The double value that is closer than any other to pi (π), the ratio of the circumference of a circle to its diameter.

Value: 3.141592653589793

TAU

Added in API level 35

static val TAU: Double

The double value that is closer than any other to tau (τ), the ratio of the circumference of a circle to its radius.

Value: 6.283185307179586

Public methods

IEEEremainder

Added in API level 1

static fun IEEEremainder(
    f1: Double, 
    f2: Double
): Double

Computes the remainder operation on two arguments as prescribed by the IEEE 754 standard. The remainder value is mathematically equal to f1 - f2 × n, where n is the mathematical integer closest to the exact mathematical value of the quotient f1/f2, and if two mathematical integers are equally close to f1/f2, then n is the integer that is even. If the remainder is zero, its sign is the same as the sign of the first argument. Special cases:

If either argument is NaN, or the first argument is infinite, or the second argument is positive zero or negative zero, then the result is NaN.
If the first argument is finite and the second argument is infinite, then the result is the same as the first argument.

Parameters
`f1`	Double: the dividend.
`f2`	Double: the divisor.

Return
`Double`	the remainder when `f1` is divided by `f2`.

abs

Added in API level 1

static fun abs(a: Int): Int

Returns the absolute value of an int value. If the argument is not negative, the argument is returned. If the argument is negative, the negation of the argument is returned.

Note that if the argument is equal to the value of java.lang.Integer#MIN_VALUE, the most negative representable int value, the result is that same value, which is negative. In contrast, the StrictMath#absExact(int) method throws an ArithmeticException for this value.

Parameters
`a`	Int: the argument whose absolute value is to be determined.

Return
`Int`	the absolute value of the argument.

See Also

java.lang.Math#absExact(int)

abs

Added in API level 1

static fun abs(a: Long): Long

Returns the absolute value of a long value. If the argument is not negative, the argument is returned. If the argument is negative, the negation of the argument is returned.

Note that if the argument is equal to the value of java.lang.Long#MIN_VALUE, the most negative representable long value, the result is that same value, which is negative. In contrast, the StrictMath#absExact(long) method throws an ArithmeticException for this value.

Parameters
`a`	Long: the argument whose absolute value is to be determined.

Return
`Long`	the absolute value of the argument.

See Also

java.lang.Math#absExact(long)

abs

Added in API level 1

static fun abs(a: Float): Float

Returns the absolute value of a float value. If the argument is not negative, the argument is returned. If the argument is negative, the negation of the argument is returned. Special cases:

If the argument is positive zero or negative zero, the result is positive zero.
If the argument is infinite, the result is positive infinity.
If the argument is NaN, the result is NaN.

Parameters
`a`	Float: the argument whose absolute value is to be determined

Return
`Float`	the absolute value of the argument.

abs

Added in API level 1

static fun abs(a: Double): Double

Returns the absolute value of a double value. If the argument is not negative, the argument is returned. If the argument is negative, the negation of the argument is returned. Special cases:

If the argument is positive zero or negative zero, the result is positive zero.
If the argument is infinite, the result is positive infinity.
If the argument is NaN, the result is NaN.

Parameters
`a`	Double: the argument whose absolute value is to be determined

Return
`Double`	the absolute value of the argument.

absExact

Added in API level 34

static fun absExact(a: Int): Int

Returns the mathematical absolute value of an int value if it is exactly representable as an int, throwing ArithmeticException if the result overflows the positive int range.

Since the range of two's complement integers is asymmetric with one additional negative value (JLS {@jls 4.2.1}), the mathematical absolute value of Integer#MIN_VALUE overflows the positive int range, so an exception is thrown for that argument.

Parameters
`a`	Int: the argument whose absolute value is to be determined

Return
`Int`	the absolute value of the argument, unless overflow occurs

Exceptions
`java.lang.ArithmeticException`	if the argument is `Integer#MIN_VALUE`

See Also

absExact

Added in API level 34

static fun absExact(a: Long): Long

Returns the mathematical absolute value of an long value if it is exactly representable as an long, throwing ArithmeticException if the result overflows the positive long range.

Since the range of two's complement integers is asymmetric with one additional negative value (JLS {@jls 4.2.1}), the mathematical absolute value of Long#MIN_VALUE overflows the positive long range, so an exception is thrown for that argument.

Parameters
`a`	Long: the argument whose absolute value is to be determined

Return
`Long`	the absolute value of the argument, unless overflow occurs

Exceptions
`java.lang.ArithmeticException`	if the argument is `Long#MIN_VALUE`

See Also

acos

Added in API level 1

static fun acos(a: Double): Double

Returns the arc cosine of a value; the returned angle is in the range 0.0 through pi. Special case:

If the argument is NaN or its absolute value is greater than 1, then the result is NaN.
If the argument is 1.0, the result is positive zero.

Parameters
`a`	Double: the value whose arc cosine is to be returned.

Return
`Double`	the arc cosine of the argument.

addExact

Added in API level 24

static fun addExact(
    x: Int, 
    y: Int
): Int

Returns the sum of its arguments, throwing an exception if the result overflows an int.

Parameters
`x`	Int: the first value
`y`	Int: the second value

Return
`Int`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows an int

See Also

java.lang.Math#addExact(int,int)

addExact

Added in API level 24

static fun addExact(
    x: Long, 
    y: Long
): Long

Returns the sum of its arguments, throwing an exception if the result overflows a long.

Parameters
`x`	Long: the first value
`y`	Long: the second value

Return
`Long`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows a long

See Also

java.lang.Math#addExact(long,long)

asin

Added in API level 1

static fun asin(a: Double): Double

Returns the arc sine of a value; the returned angle is in the range -pi/2 through pi/2. Special cases:

If the argument is NaN or its absolute value is greater than 1, then the result is NaN.
If the argument is zero, then the result is a zero with the same sign as the argument.

Parameters
`a`	Double: the value whose arc sine is to be returned.

Return
`Double`	the arc sine of the argument.

atan

Added in API level 1

static fun atan(a: Double): Double

Returns the arc tangent of a value; the returned angle is in the range -pi/2 through pi/2. Special cases:

If the argument is NaN, then the result is NaN.
If the argument is zero, then the result is a zero with the same sign as the argument.
If the argument is java.lang.Double#isInfinite, then the result is the closest value to pi/2 with the same sign as the input.

Parameters
`a`	Double: the value whose arc tangent is to be returned.

Return
`Double`	the arc tangent of the argument.

atan2

Added in API level 1

static fun atan2(
    y: Double, 
    x: Double
): Double

Returns the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta). This method computes the phase theta by computing an arc tangent of y/x in the range of -pi to pi. Special cases:

If either argument is NaN, then the result is NaN.
If the first argument is positive zero and the second argument is positive, or the first argument is positive and finite and the second argument is positive infinity, then the result is positive zero.
If the first argument is negative zero and the second argument is positive, or the first argument is negative and finite and the second argument is positive infinity, then the result is negative zero.
If the first argument is positive zero and the second argument is negative, or the first argument is positive and finite and the second argument is negative infinity, then the result is the double value closest to pi.
If the first argument is negative zero and the second argument is negative, or the first argument is negative and finite and the second argument is negative infinity, then the result is the double value closest to -pi.
If the first argument is positive and the second argument is positive zero or negative zero, or the first argument is positive infinity and the second argument is finite, then the result is the double value closest to pi/2.
If the first argument is negative and the second argument is positive zero or negative zero, or the first argument is negative infinity and the second argument is finite, then the result is the double value closest to -pi/2.
If both arguments are positive infinity, then the result is the double value closest to pi/4.
If the first argument is positive infinity and the second argument is negative infinity, then the result is the double value closest to 3*pi/4.
If the first argument is negative infinity and the second argument is positive infinity, then the result is the double value closest to -pi/4.
If both arguments are negative infinity, then the result is the double value closest to -3*pi/4.

Parameters
`y`	Double: the ordinate coordinate
`x`	Double: the abscissa coordinate

Return
`Double`	the theta component of the point (r, theta) in polar coordinates that corresponds to the point (x, y) in Cartesian coordinates.

cbrt

Added in API level 1

static fun cbrt(a: Double): Double

Returns the cube root of a double value. For positive finite x, cbrt(-x) == -cbrt(x); that is, the cube root of a negative value is the negative of the cube root of that value's magnitude. Special cases:

If the argument is NaN, then the result is NaN.
If the argument is infinite, then the result is an infinity with the same sign as the argument.
If the argument is zero, then the result is a zero with the same sign as the argument.

Parameters
`a`	Double: a value.

Return
`Double`	the cube root of `a`.

ceil

Added in API level 1

static fun ceil(a: Double): Double

Returns the smallest (closest to negative infinity) double value that is greater than or equal to the argument and is equal to a mathematical integer. Special cases:

If the argument value is already equal to a mathematical integer, then the result is the same as the argument.
If the argument is NaN or an infinity or positive zero or negative zero, then the result is the same as the argument.
If the argument value is less than zero but greater than -1.0, then the result is negative zero.

Note that the value of StrictMath.ceil(x) is exactly the value of -StrictMath.floor(-x).

Parameters
`a`	Double: a value.

Return
`Double`	the smallest (closest to negative infinity) floating-point value that is greater than or equal to the argument and is equal to a mathematical integer.

ceilDiv

Added in API level 35

static fun ceilDiv(
    x: Int, 
    y: Int
): Int

Returns the smallest (closest to negative infinity) int value that is greater than or equal to the algebraic quotient. There is one special case: if the dividend is Integer.MIN_VALUE and the divisor is -1, then integer overflow occurs and the result is equal to Integer.MIN_VALUE.

See Math.ceilDiv for examples and a comparison to the integer division / operator.

Parameters
`x`	Int: the dividend
`y`	Int: the divisor

Return
`Int`	the smallest (closest to negative infinity) `int` value that is greater than or equal to the algebraic quotient.

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

ceilDiv

Added in API level 35

static fun ceilDiv(
    x: Long, 
    y: Int
): Long

Returns the smallest (closest to negative infinity) long value that is greater than or equal to the algebraic quotient. There is one special case: if the dividend is Long.MIN_VALUE and the divisor is -1, then integer overflow occurs and the result is equal to Long.MIN_VALUE.

See Math.ceilDiv for examples and a comparison to the integer division / operator.

Parameters
`x`	Long: the dividend
`y`	Int: the divisor

Return
`Long`	the smallest (closest to negative infinity) `long` value that is greater than or equal to the algebraic quotient.

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

ceilDiv

Added in API level 35

static fun ceilDiv(
    x: Long, 
    y: Long
): Long

See Math.ceilDiv for examples and a comparison to the integer division / operator.

Parameters
`x`	Long: the dividend
`y`	Long: the divisor

Return
`Long`	the smallest (closest to negative infinity) `long` value that is greater than or equal to the algebraic quotient.

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

ceilDivExact

Added in API level 35

static fun ceilDivExact(
    x: Int, 
    y: Int
): Int

Returns the smallest (closest to negative infinity) int value that is greater than or equal to the algebraic quotient. This method is identical to ceilDiv(int,int) except that it throws an ArithmeticException when the dividend is Integer.MIN_VALUE and the divisor is -1 instead of ignoring the integer overflow and returning Integer.MIN_VALUE.

The ceil modulus method ceilMod(int,int) is a suitable counterpart both for this method and for the ceilDiv(int,int) method.

See Math.ceilDiv for examples and a comparison to the integer division / operator.

Parameters
`x`	Int: the dividend
`y`	Int: the divisor

Return
`Int`	the smallest (closest to negative infinity) `int` value that is greater than or equal to the algebraic quotient.

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero, or the dividend `x` is `Integer.MIN_VALUE` and the divisor `y` is `-1`.

See Also

java.lang.Math#ceilDiv(int, int)

ceilDivExact

Added in API level 35

static fun ceilDivExact(
    x: Long, 
    y: Long
): Long

Returns the smallest (closest to negative infinity) long value that is greater than or equal to the algebraic quotient. This method is identical to ceilDiv(long,long) except that it throws an ArithmeticException when the dividend is Long.MIN_VALUE and the divisor is -1 instead of ignoring the integer overflow and returning Long.MIN_VALUE.

The ceil modulus method ceilMod(long,long) is a suitable counterpart both for this method and for the ceilDiv(long,long) method.

For examples, see Math.ceilDiv.

Parameters
`x`	Long: the dividend
`y`	Long: the divisor

Return
`Long`	the smallest (closest to negative infinity) `long` value that is greater than or equal to the algebraic quotient.

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero, or the dividend `x` is `Long.MIN_VALUE` and the divisor `y` is `-1`.

See Also

ceilMod

Added in API level 35

static fun ceilMod(
    x: Int, 
    y: Int
): Int

Returns the ceiling modulus of the int arguments.

The ceiling modulus is r = x - (ceilDiv(x, y) * y), has the opposite sign as the divisor y or is zero, and is in the range of -abs(y) < r < +abs(y).

The relationship between ceilDiv and ceilMod is such that:

ceilDiv(x, y) * y + ceilMod(x, y) == x

See Math.ceilMod for examples and a comparison to the % operator.

Parameters
`x`	Int: the dividend
`y`	Int: the divisor

Return
`Int`	the ceiling modulus `x - (ceilDiv(x, y) * y)`

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

ceilMod

Added in API level 35

static fun ceilMod(
    x: Long, 
    y: Int
): Int

Returns the ceiling modulus of the long and int arguments.

The ceiling modulus is r = x - (ceilDiv(x, y) * y), has the opposite sign as the divisor y or is zero, and is in the range of -abs(y) < r < +abs(y).

The relationship between ceilDiv and ceilMod is such that:

ceilDiv(x, y) * y + ceilMod(x, y) == x

See Math.ceilMod for examples and a comparison to the % operator.

Parameters
`x`	Long: the dividend
`y`	Int: the divisor

Return
`Int`	the ceiling modulus `x - (ceilDiv(x, y) * y)`

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

ceilMod

Added in API level 35

static fun ceilMod(
    x: Long, 
    y: Long
): Long

Returns the ceiling modulus of the long arguments.

The ceiling modulus is r = x - (ceilDiv(x, y) * y), has the opposite sign as the divisor y or is zero, and is in the range of -abs(y) < r < +abs(y).

The relationship between ceilDiv and ceilMod is such that:

ceilDiv(x, y) * y + ceilMod(x, y) == x

See Math.ceilMod for examples and a comparison to the % operator.

Parameters
`x`	Long: the dividend
`y`	Long: the divisor

Return
`Long`	the ceiling modulus `x - (ceilDiv(x, y) * y)`

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

clamp

Added in API level 35

static fun clamp(
    value: Long, 
    min: Int, 
    max: Int
): Int

Clamps the value to fit between min and max. If the value is less than min, then min is returned. If the value is greater than max, then max is returned. Otherwise, the original value is returned.

While the original value of type long may not fit into the int type, the bounds have the int type, so the result always fits the int type. This allows to use method to safely cast long value to int with saturation.

Parameters
`value`	Long: value to clamp
`min`	Int: minimal allowed value
`max`	Int: maximal allowed value

Return
`Int`	a clamped value that fits into `min..max` interval

Exceptions
`java.lang.IllegalArgumentException`	if `min > max`

clamp

Added in API level 35

static fun clamp(
    value: Long, 
    min: Long, 
    max: Long
): Long

Parameters
`value`	Long: value to clamp
`min`	Long: minimal allowed value
`max`	Long: maximal allowed value

Return
`Long`	a clamped value that fits into `min..max` interval

Exceptions
`java.lang.IllegalArgumentException`	if `min > max`

clamp

Added in API level 35

static fun clamp(
    value: Double, 
    min: Double, 
    max: Double
): Double

Unlike the numerical comparison operators, this method considers negative zero to be strictly smaller than positive zero. E.g., clamp(-0.0, 0.0, 1.0) returns 0.0.

Parameters
`value`	Double: value to clamp
`min`	Double: minimal allowed value
`max`	Double: maximal allowed value

Return
`Double`	a clamped value that fits into `min..max` interval

Exceptions
`java.lang.IllegalArgumentException`	if either of `min` and `max` arguments is NaN, or `min > max`, or `min` is +0.0, and `max` is -0.0.

clamp

Added in API level 35

static fun clamp(
    value: Float, 
    min: Float, 
    max: Float
): Float

Unlike the numerical comparison operators, this method considers negative zero to be strictly smaller than positive zero. E.g., clamp(-0.0f, 0.0f, 1.0f) returns 0.0f.

Parameters
`value`	Float: value to clamp
`min`	Float: minimal allowed value
`max`	Float: maximal allowed value

Return
`Float`	a clamped value that fits into `min..max` interval

Exceptions
`java.lang.IllegalArgumentException`	if either of `min` and `max` arguments is NaN, or `min > max`, or `min` is +0.0f, and `max` is -0.0f.

copySign

Added in API level 9

static fun copySign(
    magnitude: Double, 
    sign: Double
): Double

Returns the first floating-point argument with the sign of the second floating-point argument. For this method, a NaN sign argument is always treated as if it were positive.

Parameters
`magnitude`	Double: the parameter providing the magnitude of the result
`sign`	Double: the parameter providing the sign of the result

Return
`Double`	a value with the magnitude of `magnitude` and the sign of `sign`.

copySign

Added in API level 9

static fun copySign(
    magnitude: Float, 
    sign: Float
): Float

Returns the first floating-point argument with the sign of the second floating-point argument. For this method, a NaN sign argument is always treated as if it were positive.

Parameters
`magnitude`	Float: the parameter providing the magnitude of the result
`sign`	Float: the parameter providing the sign of the result

Return
`Float`	a value with the magnitude of `magnitude` and the sign of `sign`.

cos

Added in API level 1

static fun cos(a: Double): Double

Returns the trigonometric cosine of an angle. Special cases:

If the argument is NaN or an infinity, then the result is NaN.
If the argument is zero, then the result is 1.0.

Parameters
`a`	Double: an angle, in radians.

Return
`Double`	the cosine of the argument.

cosh

Added in API level 1

static fun cosh(x: Double): Double

Returns the hyperbolic cosine of a double value. The hyperbolic cosine of x is defined to be (ex + e-x)/2 where e is Euler's number.

Special cases:

If the argument is NaN, then the result is NaN.
If the argument is infinite, then the result is positive infinity.
If the argument is zero, then the result is 1.0.

Parameters
`x`	Double: The number whose hyperbolic cosine is to be returned.

Return
`Double`	The hyperbolic cosine of `x`.

decrementExact

Added in API level 34

static fun decrementExact(a: Int): Int

Returns the argument decremented by one, throwing an exception if the result overflows an int. The overflow only occurs for the minimum value.

Parameters
`a`	Int: the value to decrement

Return
`Int`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows an int

See Also

java.lang.Math#decrementExact(int)

decrementExact

Added in API level 34

static fun decrementExact(a: Long): Long

Returns the argument decremented by one, throwing an exception if the result overflows a long. The overflow only occurs for the minimum value.

Parameters
`a`	Long: the value to decrement

Return
`Long`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows a long

See Also

java.lang.Math#decrementExact(long)

divideExact

Added in API level 35

static fun divideExact(
    x: Int, 
    y: Int
): Int

Returns the quotient of the arguments, throwing an exception if the result overflows an int. Such overflow occurs in this method if x is Integer#MIN_VALUE and y is -1. In contrast, if Integer.MIN_VALUE / -1 were evaluated directly, the result would be Integer.MIN_VALUE and no exception would be thrown.

If y is zero, an ArithmeticException is thrown (JLS {@jls 15.17.2}).

The built-in remainder operator "%" is a suitable counterpart both for this method and for the built-in division operator "/".

Parameters
`x`	Int: the dividend
`y`	Int: the divisor

Return
`Int`	the quotient `x / y`

Exceptions
`java.lang.ArithmeticException`	if `y` is zero or the quotient overflows an int

See Also

java.lang.Math#divideExact(int,int)

divideExact

Added in API level 35

static fun divideExact(
    x: Long, 
    y: Long
): Long

Returns the quotient of the arguments, throwing an exception if the result overflows a long. Such overflow occurs in this method if x is Long#MIN_VALUE and y is -1. In contrast, if Long.MIN_VALUE / -1 were evaluated directly, the result would be Long.MIN_VALUE and no exception would be thrown.

If y is zero, an ArithmeticException is thrown (JLS {@jls 15.17.2}).

The built-in remainder operator "%" is a suitable counterpart both for this method and for the built-in division operator "/".

Parameters
`x`	Long: the dividend
`y`	Long: the divisor

Return
`Long`	the quotient `x / y`

Exceptions
`java.lang.ArithmeticException`	if `y` is zero or the quotient overflows a long

See Also

java.lang.Math#divideExact(long,long)

exp

Added in API level 1

static fun exp(a: Double): Double

Returns Euler's number e raised to the power of a double value. Special cases:

If the argument is NaN, the result is NaN.
If the argument is positive infinity, then the result is positive infinity.
If the argument is negative infinity, then the result is positive zero.
If the argument is zero, then the result is 1.0.

Parameters
`a`	Double: the exponent to raise e to.

Return
`Double`	the value e`a`, where e is the base of the natural logarithms.

expm1

Added in API level 1

static fun expm1(x: Double): Double

Returns ex -1. Note that for values of x near 0, the exact sum of expm1(x) + 1 is much closer to the true result of ex than exp(x).

Special cases:

If the argument is NaN, the result is NaN.
If the argument is positive infinity, then the result is positive infinity.
If the argument is negative infinity, then the result is -1.0.
If the argument is zero, then the result is a zero with the same sign as the argument.

Parameters
`x`	Double: the exponent to raise e to in the computation of e`x` -1.

Return
`Double`	the value e`x` - 1.

floor

Added in API level 1

static fun floor(a: Double): Double

Returns the largest (closest to positive infinity) double value that is less than or equal to the argument and is equal to a mathematical integer. Special cases:

If the argument value is already equal to a mathematical integer, then the result is the same as the argument.
If the argument is NaN or an infinity or positive zero or negative zero, then the result is the same as the argument.

Parameters
`a`	Double: a value.

Return
`Double`	the largest (closest to positive infinity) floating-point value that less than or equal to the argument and is equal to a mathematical integer.

floorDiv

Added in API level 24

static fun floorDiv(
    x: Int, 
    y: Int
): Int

Returns the largest (closest to positive infinity) int value that is less than or equal to the algebraic quotient. There is one special case: if the dividend is Integer.MIN_VALUE and the divisor is -1, then integer overflow occurs and the result is equal to Integer.MIN_VALUE.

See Math.floorDiv for examples and a comparison to the integer division / operator.

Parameters
`x`	Int: the dividend
`y`	Int: the divisor

Return
`Int`	the largest (closest to positive infinity) `int` value that is less than or equal to the algebraic quotient.

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

floorDiv

Added in API level 31

static fun floorDiv(
    x: Long, 
    y: Int
): Long

Returns the largest (closest to positive infinity) long value that is less than or equal to the algebraic quotient. There is one special case: if the dividend is Long.MIN_VALUE and the divisor is -1, then integer overflow occurs and the result is equal to Long.MIN_VALUE.

See Math.floorDiv for examples and a comparison to the integer division / operator.

Parameters
`x`	Long: the dividend
`y`	Int: the divisor

Return
`Long`	the largest (closest to positive infinity) `long` value that is less than or equal to the algebraic quotient.

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

floorDiv

Added in API level 24

static fun floorDiv(
    x: Long, 
    y: Long
): Long

See Math.floorDiv for examples and a comparison to the integer division / operator.

Parameters
`x`	Long: the dividend
`y`	Long: the divisor

Return
`Long`	the largest (closest to positive infinity) `long` value that is less than or equal to the algebraic quotient.

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

floorDivExact

Added in API level 35

static fun floorDivExact(
    x: Int, 
    y: Int
): Int

Returns the largest (closest to positive infinity) int value that is less than or equal to the algebraic quotient. This method is identical to floorDiv(int,int) except that it throws an ArithmeticException when the dividend is Integer.MIN_VALUE and the divisor is -1 instead of ignoring the integer overflow and returning Integer.MIN_VALUE.

The floor modulus method floorMod(int,int) is a suitable counterpart both for this method and for the floorDiv(int,int) method.

See Math.floorDiv for examples and a comparison to the integer division / operator.

Parameters
`x`	Int: the dividend
`y`	Int: the divisor

Return
`Int`	the largest (closest to positive infinity) `int` value that is less than or equal to the algebraic quotient.

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero, or the dividend `x` is `Integer.MIN_VALUE` and the divisor `y` is `-1`.

See Also

java.lang.Math#floorDiv(int, int)

floorDivExact

Added in API level 35

static fun floorDivExact(
    x: Long, 
    y: Long
): Long

Returns the largest (closest to positive infinity) long value that is less than or equal to the algebraic quotient. This method is identical to floorDiv(long,long) except that it throws an ArithmeticException when the dividend is Long.MIN_VALUE and the divisor is -1 instead of ignoring the integer overflow and returning Long.MIN_VALUE.

The floor modulus method floorMod(long,long) is a suitable counterpart both for this method and for the floorDiv(long,long) method.

For examples, see Math.floorDiv.

Parameters
`x`	Long: the dividend
`y`	Long: the divisor

Return
`Long`	the largest (closest to positive infinity) `long` value that is less than or equal to the algebraic quotient.

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero, or the dividend `x` is `Long.MIN_VALUE` and the divisor `y` is `-1`.

See Also

floorMod

Added in API level 24

static fun floorMod(
    x: Int, 
    y: Int
): Int

Returns the floor modulus of the int arguments.

The floor modulus is r = x - (floorDiv(x, y) * y), has the same sign as the divisor y or is zero, and is in the range of -abs(y) < r < +abs(y).

The relationship between floorDiv and floorMod is such that:

floorDiv(x, y) * y + floorMod(x, y) == x

See Math.floorMod for examples and a comparison to the % operator.

Parameters
`x`	Int: the dividend
`y`	Int: the divisor

Return
`Int`	the floor modulus `x - (floorDiv(x, y) * y)`

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

floorMod

Added in API level 31

static fun floorMod(
    x: Long, 
    y: Int
): Int

Returns the floor modulus of the long and int arguments.

The floor modulus is r = x - (floorDiv(x, y) * y), has the same sign as the divisor y or is zero, and is in the range of -abs(y) < r < +abs(y).

The relationship between floorDiv and floorMod is such that:

floorDiv(x, y) * y + floorMod(x, y) == x

See Math.floorMod for examples and a comparison to the % operator.

Parameters
`x`	Long: the dividend
`y`	Int: the divisor

Return
`Int`	the floor modulus `x - (floorDiv(x, y) * y)`

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

floorMod

Added in API level 24

static fun floorMod(
    x: Long, 
    y: Long
): Long

Returns the floor modulus of the long arguments.

The floor modulus is r = x - (floorDiv(x, y) * y), has the same sign as the divisor y or is zero, and is in the range of -abs(y) < r < +abs(y).

The relationship between floorDiv and floorMod is such that:

floorDiv(x, y) * y + floorMod(x, y) == x

See Math.floorMod for examples and a comparison to the % operator.

Parameters
`x`	Long: the dividend
`y`	Long: the divisor

Return
`Long`	the floor modulus `x - (floorDiv(x, y) * y)`

Exceptions
`java.lang.ArithmeticException`	if the divisor `y` is zero

See Also

fma

Added in API level 33

static fun fma(
    a: Double, 
    b: Double, 
    c: Double
): Double

Returns the fused multiply add of the three arguments; that is, returns the exact product of the first two arguments summed with the third argument and then rounded once to the nearest double. The rounding is done using the round to nearest even. In contrast, if a * b + c is evaluated as a regular floating-point expression, two rounding errors are involved, the first for the multiply operation, the second for the addition operation.

Special cases:

If any argument is NaN, the result is NaN.
If one of the first two arguments is infinite and the other is zero, the result is NaN.
If the exact product of the first two arguments is infinite (in other words, at least one of the arguments is infinite and the other is neither zero nor NaN) and the third argument is an infinity of the opposite sign, the result is NaN.

Note that fusedMac(a, 1.0, c) returns the same result as (a + c). However, fusedMac(a, b, +0.0) does not always return the same result as (a * b) since fusedMac(-0.0, +0.0, +0.0) is +0.0 while (-0.0 * +0.0) is -0.0; fusedMac(a, b, -0.0) is equivalent to (a * b) however.

Parameters
`a`	Double: a value
`b`	Double: a value
`c`	Double: a value

Return
`Double`	(a × b + c) computed, as if with unlimited range and precision, and rounded once to the nearest `double` value

fma

Added in API level 33

static fun fma(
    a: Float, 
    b: Float, 
    c: Float
): Float

Returns the fused multiply add of the three arguments; that is, returns the exact product of the first two arguments summed with the third argument and then rounded once to the nearest float. The rounding is done using the round to nearest even. In contrast, if a * b + c is evaluated as a regular floating-point expression, two rounding errors are involved, the first for the multiply operation, the second for the addition operation.

Special cases:

If any argument is NaN, the result is NaN.
If one of the first two arguments is infinite and the other is zero, the result is NaN.
If the exact product of the first two arguments is infinite (in other words, at least one of the arguments is infinite and the other is neither zero nor NaN) and the third argument is an infinity of the opposite sign, the result is NaN.

Note that fma(a, 1.0f, c) returns the same result as (a + c). However, fma(a, b, +0.0f) does not always return the same result as (a * b) since fma(-0.0f, +0.0f, +0.0f) is +0.0f while (-0.0f * +0.0f) is -0.0f; fma(a, b, -0.0f) is equivalent to (a * b) however.

Parameters
`a`	Float: a value
`b`	Float: a value
`c`	Float: a value

Return
`Float`	(a × b + c) computed, as if with unlimited range and precision, and rounded once to the nearest `float` value

getExponent

Added in API level 9

static fun getExponent(f: Float): Int

Returns the unbiased exponent used in the representation of a float. Special cases:

If the argument is NaN or infinite, then the result is Float#MAX_EXPONENT + 1.
If the argument is zero or subnormal, then the result is Float#MIN_EXPONENT -1.

Parameters
`f`	Float: a `float` value

Return
`Int`	the unbiased exponent of the argument

getExponent

Added in API level 9

static fun getExponent(d: Double): Int

Returns the unbiased exponent used in the representation of a double. Special cases:

If the argument is NaN or infinite, then the result is Double#MAX_EXPONENT + 1.
If the argument is zero or subnormal, then the result is Double#MIN_EXPONENT -1.

Parameters
`d`	Double: a `double` value

Return
`Int`	the unbiased exponent of the argument

hypot

Added in API level 1

static fun hypot(
    x: Double, 
    y: Double
): Double

Returns sqrt(x2 +y2) without intermediate overflow or underflow.

Special cases:

If either argument is infinite, then the result is positive infinity.
If either argument is NaN and neither argument is infinite, then the result is NaN.
If both arguments are zero, the result is positive zero.

Parameters
`x`	Double: a value
`y`	Double: a value

Return
`Double`	sqrt(x2 +y2) without intermediate overflow or underflow

incrementExact

Added in API level 34

static fun incrementExact(a: Int): Int

Returns the argument incremented by one, throwing an exception if the result overflows an int. The overflow only occurs for the maximum value.

Parameters
`a`	Int: the value to increment

Return
`Int`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows an int

See Also

java.lang.Math#incrementExact(int)

incrementExact

Added in API level 34

static fun incrementExact(a: Long): Long

Returns the argument incremented by one, throwing an exception if the result overflows a long. The overflow only occurs for the maximum value.

Parameters
`a`	Long: the value to increment

Return
`Long`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows a long

See Also

java.lang.Math#incrementExact(long)

log

Added in API level 1

static fun log(a: Double): Double

Returns the natural logarithm (base e) of a double value. Special cases:

If the argument is NaN or less than zero, then the result is NaN.
If the argument is positive infinity, then the result is positive infinity.
If the argument is positive zero or negative zero, then the result is negative infinity.
If the argument is 1.0, then the result is positive zero.

Parameters
`a`	Double: a value

Return
`Double`	the value ln `a`, the natural logarithm of `a`.

log10

Added in API level 1

static fun log10(a: Double): Double

Returns the base 10 logarithm of a double value. Special cases:

If the argument is NaN or less than zero, then the result is NaN.
If the argument is positive infinity, then the result is positive infinity.
If the argument is positive zero or negative zero, then the result is negative infinity.
If the argument is equal to 10n for integer n, then the result is n. In particular, if the argument is 1.0 (100), then the result is positive zero.

Parameters
`a`	Double: a value

Return
`Double`	the base 10 logarithm of `a`.

log1p

Added in API level 1

static fun log1p(x: Double): Double

Returns the natural logarithm of the sum of the argument and 1. Note that for small values x, the result of log1p(x) is much closer to the true result of ln(1 + x) than the floating-point evaluation of log(1.0+x).

Special cases:

If the argument is NaN or less than -1, then the result is NaN.
If the argument is positive infinity, then the result is positive infinity.
If the argument is negative one, then the result is negative infinity.
If the argument is zero, then the result is a zero with the same sign as the argument.

Parameters
`x`	Double: a value

Return
`Double`	the value ln(`x` + 1), the natural log of `x` + 1

max

Added in API level 1

static fun max(
    a: Int, 
    b: Int
): Int

Returns the greater of two int values. That is, the result is the argument closer to the value of Integer#MAX_VALUE. If the arguments have the same value, the result is that same value.

Parameters
`a`	Int: an argument.
`b`	Int: another argument.

Return
`Int`	the larger of `a` and `b`.

max

Added in API level 1

static fun max(
    a: Long, 
    b: Long
): Long

Returns the greater of two long values. That is, the result is the argument closer to the value of Long#MAX_VALUE. If the arguments have the same value, the result is that same value.

Parameters
`a`	Long: an argument.
`b`	Long: another argument.

Return
`Long`	the larger of `a` and `b`.

max

Added in API level 1

static fun max(
    a: Float, 
    b: Float
): Float

Returns the greater of two float values. That is, the result is the argument closer to positive infinity. If the arguments have the same value, the result is that same value. If either value is NaN, then the result is NaN. Unlike the numerical comparison operators, this method considers negative zero to be strictly smaller than positive zero. If one argument is positive zero and the other negative zero, the result is positive zero.

Parameters
`a`	Float: an argument.
`b`	Float: another argument.

Return
`Float`	the larger of `a` and `b`.

max

Added in API level 1

static fun max(
    a: Double, 
    b: Double
): Double

Returns the greater of two double values. That is, the result is the argument closer to positive infinity. If the arguments have the same value, the result is that same value. If either value is NaN, then the result is NaN. Unlike the numerical comparison operators, this method considers negative zero to be strictly smaller than positive zero. If one argument is positive zero and the other negative zero, the result is positive zero.

Parameters
`a`	Double: an argument.
`b`	Double: another argument.

Return
`Double`	the larger of `a` and `b`.

min

Added in API level 1

static fun min(
    a: Int, 
    b: Int
): Int

Returns the smaller of two int values. That is, the result the argument closer to the value of Integer#MIN_VALUE. If the arguments have the same value, the result is that same value.

Parameters
`a`	Int: an argument.
`b`	Int: another argument.

Return
`Int`	the smaller of `a` and `b`.

min

Added in API level 1

static fun min(
    a: Long, 
    b: Long
): Long

Returns the smaller of two long values. That is, the result is the argument closer to the value of Long#MIN_VALUE. If the arguments have the same value, the result is that same value.

Parameters
`a`	Long: an argument.
`b`	Long: another argument.

Return
`Long`	the smaller of `a` and `b`.

min

Added in API level 1

static fun min(
    a: Float, 
    b: Float
): Float

Returns the smaller of two float values. That is, the result is the value closer to negative infinity. If the arguments have the same value, the result is that same value. If either value is NaN, then the result is NaN. Unlike the numerical comparison operators, this method considers negative zero to be strictly smaller than positive zero. If one argument is positive zero and the other is negative zero, the result is negative zero.

Parameters
`a`	Float: an argument.
`b`	Float: another argument.

Return
`Float`	the smaller of `a` and `b.`

min

Added in API level 1

static fun min(
    a: Double, 
    b: Double
): Double

Returns the smaller of two double values. That is, the result is the value closer to negative infinity. If the arguments have the same value, the result is that same value. If either value is NaN, then the result is NaN. Unlike the numerical comparison operators, this method considers negative zero to be strictly smaller than positive zero. If one argument is positive zero and the other is negative zero, the result is negative zero.

Parameters
`a`	Double: an argument.
`b`	Double: another argument.

Return
`Double`	the smaller of `a` and `b`.

multiplyExact

Added in API level 24

static fun multiplyExact(
    x: Int, 
    y: Int
): Int

Returns the product of the arguments, throwing an exception if the result overflows an int.

Parameters
`x`	Int: the first value
`y`	Int: the second value

Return
`Int`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows an int

See Also

java.lang.Math#multiplyExact(int,int)

multiplyExact

Added in API level 31

static fun multiplyExact(
    x: Long, 
    y: Int
): Long

Returns the product of the arguments, throwing an exception if the result overflows a long.

Parameters
`x`	Long: the first value
`y`	Int: the second value

Return
`Long`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows a long

See Also

java.lang.Math#multiplyExact(long,int)

multiplyExact

Added in API level 24

static fun multiplyExact(
    x: Long, 
    y: Long
): Long

Returns the product of the arguments, throwing an exception if the result overflows a long.

Parameters
`x`	Long: the first value
`y`	Long: the second value

Return
`Long`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows a long

See Also

java.lang.Math#multiplyExact(long,long)

multiplyFull

Added in API level 31

static fun multiplyFull(
    x: Int, 
    y: Int
): Long

Returns the exact mathematical product of the arguments.

Parameters
`x`	Int: the first value
`y`	Int: the second value

Return
`Long`	the result

See Also

java.lang.Math#multiplyFull(int,int)

multiplyHigh

Added in API level 31

static fun multiplyHigh(
    x: Long, 
    y: Long
): Long

Returns as a long the most significant 64 bits of the 128-bit product of two 64-bit factors.

Parameters
`x`	Long: the first value
`y`	Long: the second value

Return
`Long`	the result

See Also

negateExact

Added in API level 34

static fun negateExact(a: Int): Int

Returns the negation of the argument, throwing an exception if the result overflows an int. The overflow only occurs for the minimum value.

Parameters
`a`	Int: the value to negate

Return
`Int`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows an int

See Also

java.lang.Math#negateExact(int)

negateExact

Added in API level 34

static fun negateExact(a: Long): Long

Returns the negation of the argument, throwing an exception if the result overflows a long. The overflow only occurs for the minimum value.

Parameters
`a`	Long: the value to negate

Return
`Long`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows a long

See Also

java.lang.Math#negateExact(long)

nextAfter

Added in API level 9

static fun nextAfter(
    start: Double, 
    direction: Double
): Double

Returns the floating-point number adjacent to the first argument in the direction of the second argument. If both arguments compare as equal the second argument is returned.

Special cases:

If either argument is a NaN, then NaN is returned.
If both arguments are signed zeros, direction is returned unchanged (as implied by the requirement of returning the second argument if the arguments compare as equal).
If start is ±Double#MIN_VALUE and direction has a value such that the result should have a smaller magnitude, then a zero with the same sign as start is returned.
If start is infinite and direction has a value such that the result should have a smaller magnitude, Double#MAX_VALUE with the same sign as start is returned.
If start is equal to ± Double#MAX_VALUE and direction has a value such that the result should have a larger magnitude, an infinity with same sign as start is returned.

Parameters
`start`	Double: starting floating-point value
`direction`	Double: value indicating which of `start`'s neighbors or `start` should be returned

Return
`Double`	The floating-point number adjacent to `start` in the direction of `direction`.

nextAfter

Added in API level 9

static fun nextAfter(
    start: Float, 
    direction: Double
): Float

Returns the floating-point number adjacent to the first argument in the direction of the second argument. If both arguments compare as equal a value equivalent to the second argument is returned.

Special cases:

If either argument is a NaN, then NaN is returned.
If both arguments are signed zeros, a value equivalent to direction is returned.
If start is ±Float#MIN_VALUE and direction has a value such that the result should have a smaller magnitude, then a zero with the same sign as start is returned.
If start is infinite and direction has a value such that the result should have a smaller magnitude, Float#MAX_VALUE with the same sign as start is returned.
If start is equal to ± Float#MAX_VALUE and direction has a value such that the result should have a larger magnitude, an infinity with same sign as start is returned.

Parameters
`start`	Float: starting floating-point value
`direction`	Double: value indicating which of `start`'s neighbors or `start` should be returned

Return
`Float`	The floating-point number adjacent to `start` in the direction of `direction`.

nextDown

Added in API level 24

static fun nextDown(d: Double): Double

Returns the floating-point value adjacent to d in the direction of negative infinity. This method is semantically equivalent to nextAfter(d, Double.NEGATIVE_INFINITY); however, a nextDown implementation may run faster than its equivalent nextAfter call.

Special Cases:

If the argument is NaN, the result is NaN.
If the argument is negative infinity, the result is negative infinity.
If the argument is zero, the result is -Double.MIN_VALUE

Parameters
`d`	Double: starting floating-point value

Return
`Double`	The adjacent floating-point value closer to negative infinity.

nextDown

Added in API level 24

static fun nextDown(f: Float): Float

Returns the floating-point value adjacent to f in the direction of negative infinity. This method is semantically equivalent to nextAfter(f, Float.NEGATIVE_INFINITY); however, a nextDown implementation may run faster than its equivalent nextAfter call.

Special Cases:

If the argument is NaN, the result is NaN.
If the argument is negative infinity, the result is negative infinity.
If the argument is zero, the result is -Float.MIN_VALUE

Parameters
`f`	Float: starting floating-point value

Return
`Float`	The adjacent floating-point value closer to negative infinity.

nextUp

Added in API level 9

static fun nextUp(d: Double): Double

Returns the floating-point value adjacent to d in the direction of positive infinity. This method is semantically equivalent to nextAfter(d, Double.POSITIVE_INFINITY); however, a nextUp implementation may run faster than its equivalent nextAfter call.

Special Cases:

If the argument is NaN, the result is NaN.
If the argument is positive infinity, the result is positive infinity.
If the argument is zero, the result is Double#MIN_VALUE

Parameters
`d`	Double: starting floating-point value

Return
`Double`	The adjacent floating-point value closer to positive infinity.

nextUp

Added in API level 9

static fun nextUp(f: Float): Float

Returns the floating-point value adjacent to f in the direction of positive infinity. This method is semantically equivalent to nextAfter(f, Float.POSITIVE_INFINITY); however, a nextUp implementation may run faster than its equivalent nextAfter call.

Special Cases:

If the argument is NaN, the result is NaN.
If the argument is positive infinity, the result is positive infinity.
If the argument is zero, the result is Float#MIN_VALUE

Parameters
`f`	Float: starting floating-point value

Return
`Float`	The adjacent floating-point value closer to positive infinity.

pow

Added in API level 1

static fun pow(
    a: Double, 
    b: Double
): Double

Returns the value of the first argument raised to the power of the second argument. Special cases:

If the second argument is positive or negative zero, then the result is 1.0.
If the second argument is 1.0, then the result is the same as the first argument.
If the second argument is NaN, then the result is NaN.
If the first argument is NaN and the second argument is nonzero, then the result is NaN.
If
- the absolute value of the first argument is greater than 1 and the second argument is positive infinity, or
- the absolute value of the first argument is less than 1 and the second argument is negative infinity,
then the result is positive infinity.
If
- the absolute value of the first argument is greater than 1 and the second argument is negative infinity, or
- the absolute value of the first argument is less than 1 and the second argument is positive infinity,
then the result is positive zero.
If the absolute value of the first argument equals 1 and the second argument is infinite, then the result is NaN.
If
- the first argument is positive zero and the second argument is greater than zero, or
- the first argument is positive infinity and the second argument is less than zero,
then the result is positive zero.
If
- the first argument is positive zero and the second argument is less than zero, or
- the first argument is positive infinity and the second argument is greater than zero,
then the result is positive infinity.
If
- the first argument is negative zero and the second argument is greater than zero but not a finite odd integer, or
- the first argument is negative infinity and the second argument is less than zero but not a finite odd integer,
then the result is positive zero.
If
- the first argument is negative zero and the second argument is a positive finite odd integer, or
- the first argument is negative infinity and the second argument is a negative finite odd integer,
then the result is negative zero.
If
- the first argument is negative zero and the second argument is less than zero but not a finite odd integer, or
- the first argument is negative infinity and the second argument is greater than zero but not a finite odd integer,
then the result is positive infinity.
If
- the first argument is negative zero and the second argument is a negative finite odd integer, or
- the first argument is negative infinity and the second argument is a positive finite odd integer,
then the result is negative infinity.
If the first argument is finite and less than zero
- if the second argument is a finite even integer, the result is equal to the result of raising the absolute value of the first argument to the power of the second argument
- if the second argument is a finite odd integer, the result is equal to the negative of the result of raising the absolute value of the first argument to the power of the second argument
- if the second argument is finite and not an integer, then the result is NaN.
If both arguments are integers, then the result is exactly equal to the mathematical result of raising the first argument to the power of the second argument if that result can in fact be represented exactly as a double value.

(In the foregoing descriptions, a floating-point value is considered to be an integer if and only if it is finite and a fixed point of the method ceil or, equivalently, a fixed point of the method floor. A value is a fixed point of a one-argument method if and only if the result of applying the method to the value is equal to the value.)

Parameters
`a`	Double: base.
`b`	Double: the exponent.

Return
`Double`	the value `ab`.

random

Added in API level 1

static fun random(): Double

Returns a double value with a positive sign, greater than or equal to 0.0 and less than 1.0. Returned values are chosen pseudorandomly with (approximately) uniform distribution from that range.

When this method is first called, it creates a single new pseudorandom-number generator, exactly as if by the expression

new java.util.Random() This new pseudorandom-number generator is used thereafter for all calls to this method and is used nowhere else.

This method is properly synchronized to allow correct use by more than one thread. However, if many threads need to generate pseudorandom numbers at a great rate, it may reduce contention for each thread to have its own pseudorandom-number generator.

Return
`Double`	a pseudorandom `double` greater than or equal to `0.0` and less than `1.0`.

See Also

java.util.Random#nextDouble()

rint

Added in API level 1

static fun rint(a: Double): Double

Returns the double value that is closest in value to the argument and is equal to a mathematical integer. If two double values that are mathematical integers are equally close to the value of the argument, the result is the integer value that is even. Special cases:

If the argument value is already equal to a mathematical integer, then the result is the same as the argument.
If the argument is NaN or an infinity or positive zero or negative zero, then the result is the same as the argument.

Parameters
`a`	Double: a value.

Return
`Double`	the closest floating-point value to `a` that is equal to a mathematical integer.

round

Added in API level 1

static fun round(a: Float): Int

Returns the closest int to the argument, with ties rounding to positive infinity.

Special cases:

If the argument is NaN, the result is 0.
If the argument is negative infinity or any value less than or equal to the value of Integer.MIN_VALUE, the result is equal to the value of Integer.MIN_VALUE.
If the argument is positive infinity or any value greater than or equal to the value of Integer.MAX_VALUE, the result is equal to the value of Integer.MAX_VALUE.

Parameters
`a`	Float: a floating-point value to be rounded to an integer.

Return
`Int`	the value of the argument rounded to the nearest `int` value.

See Also

round

Added in API level 1

static fun round(a: Double): Long

Returns the closest long to the argument, with ties rounding to positive infinity.

Special cases:

If the argument is NaN, the result is 0.
If the argument is negative infinity or any value less than or equal to the value of Long.MIN_VALUE, the result is equal to the value of Long.MIN_VALUE.
If the argument is positive infinity or any value greater than or equal to the value of Long.MAX_VALUE, the result is equal to the value of Long.MAX_VALUE.

Parameters
`a`	Double: a floating-point value to be rounded to a `long`.

Return
`Long`	the value of the argument rounded to the nearest `long` value.

See Also

scalb

Added in API level 9

static fun scalb(
    d: Double, 
    scaleFactor: Int
): Double

Returns d × 2scaleFactor rounded as if performed by a single correctly rounded floating-point multiply. If the exponent of the result is between Double#MIN_EXPONENT and java.lang.Double#MAX_EXPONENT, the answer is calculated exactly. If the exponent of the result would be larger than Double.MAX_EXPONENT, an infinity is returned. Note that if the result is subnormal, precision may be lost; that is, when scalb(x, n) is subnormal, scalb(scalb(x, n), -n) may not equal x. When the result is non-NaN, the result has the same sign as d.

Special cases:

If the first argument is NaN, NaN is returned.
If the first argument is infinite, then an infinity of the same sign is returned.
If the first argument is zero, then a zero of the same sign is returned.

Parameters
`d`	Double: number to be scaled by a power of two.
`scaleFactor`	Int: power of 2 used to scale `d`

Return
`Double`	`d` × 2`scaleFactor`

scalb

Added in API level 9

static fun scalb(
    f: Float, 
    scaleFactor: Int
): Float

Returns f × 2scaleFactor rounded as if performed by a single correctly rounded floating-point multiply. If the exponent of the result is between Float#MIN_EXPONENT and java.lang.Float#MAX_EXPONENT, the answer is calculated exactly. If the exponent of the result would be larger than Float.MAX_EXPONENT, an infinity is returned. Note that if the result is subnormal, precision may be lost; that is, when scalb(x, n) is subnormal, scalb(scalb(x, n), -n) may not equal x. When the result is non-NaN, the result has the same sign as f.

Special cases:

If the first argument is NaN, NaN is returned.
If the first argument is infinite, then an infinity of the same sign is returned.
If the first argument is zero, then a zero of the same sign is returned.

Parameters
`f`	Float: number to be scaled by a power of two.
`scaleFactor`	Int: power of 2 used to scale `f`

Return
`Float`	`f` × 2`scaleFactor`

signum

Added in API level 1

static fun signum(d: Double): Double

Returns the signum function of the argument; zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.

Special Cases:

If the argument is NaN, then the result is NaN.
If the argument is positive zero or negative zero, then the result is the same as the argument.

Parameters
`d`	Double: the floating-point value whose signum is to be returned

Return
`Double`	the signum function of the argument

signum

Added in API level 1

static fun signum(f: Float): Float

Returns the signum function of the argument; zero if the argument is zero, 1.0f if the argument is greater than zero, -1.0f if the argument is less than zero.

Special Cases:

If the argument is NaN, then the result is NaN.
If the argument is positive zero or negative zero, then the result is the same as the argument.

Parameters
`f`	Float: the floating-point value whose signum is to be returned

Return
`Float`	the signum function of the argument

sin

Added in API level 1

static fun sin(a: Double): Double

Returns the trigonometric sine of an angle. Special cases:

If the argument is NaN or an infinity, then the result is NaN.
If the argument is zero, then the result is a zero with the same sign as the argument.

Parameters
`a`	Double: an angle, in radians.

Return
`Double`	the sine of the argument.

sinh

Added in API level 1

static fun sinh(x: Double): Double

Returns the hyperbolic sine of a double value. The hyperbolic sine of x is defined to be (ex - e-x)/2 where e is Euler's number.

Special cases:

If the argument is NaN, then the result is NaN.
If the argument is infinite, then the result is an infinity with the same sign as the argument.
If the argument is zero, then the result is a zero with the same sign as the argument.

Parameters
`x`	Double: The number whose hyperbolic sine is to be returned.

Return
`Double`	The hyperbolic sine of `x`.

sqrt

Added in API level 1

static fun sqrt(a: Double): Double

Returns the correctly rounded positive square root of a double value. Special cases:

If the argument is NaN or less than zero, then the result is NaN.
If the argument is positive infinity, then the result is positive infinity.
If the argument is positive zero or negative zero, then the result is the same as the argument.

Otherwise, the result is the double value closest to the true mathematical square root of the argument value.

Parameters
`a`	Double: a value.

Return
`Double`	the positive square root of `a`.

subtractExact

Added in API level 24

static fun subtractExact(
    x: Int, 
    y: Int
): Int

Returns the difference of the arguments, throwing an exception if the result overflows an int.

Parameters
`x`	Int: the first value
`y`	Int: the second value to subtract from the first

Return
`Int`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows an int

See Also

java.lang.Math#subtractExact(int,int)

subtractExact

Added in API level 24

static fun subtractExact(
    x: Long, 
    y: Long
): Long

Returns the difference of the arguments, throwing an exception if the result overflows a long.

Parameters
`x`	Long: the first value
`y`	Long: the second value to subtract from the first

Return
`Long`	the result

Exceptions
`java.lang.ArithmeticException`	if the result overflows a long

See Also

java.lang.Math#subtractExact(long,long)

tan

Added in API level 1

static fun tan(a: Double): Double

Returns the trigonometric tangent of an angle. Special cases:

If the argument is NaN or an infinity, then the result is NaN.
If the argument is zero, then the result is a zero with the same sign as the argument.

Parameters
`a`	Double: an angle, in radians.

Return
`Double`	the tangent of the argument.

tanh

Added in API level 1

static fun tanh(x: Double): Double

Returns the hyperbolic tangent of a double value. The hyperbolic tangent of x is defined to be (ex - e-x)/(ex + e-x), in other words, sinh(x)/cosh(x). Note that the absolute value of the exact tanh is always less than 1.

Special cases:

If the argument is NaN, then the result is NaN.
If the argument is zero, then the result is a zero with the same sign as the argument.
If the argument is positive infinity, then the result is +1.0.
If the argument is negative infinity, then the result is -1.0.

Parameters
`x`	Double: The number whose hyperbolic tangent is to be returned.

Return
`Double`	The hyperbolic tangent of `x`.

toDegrees

Added in API level 1

static fun toDegrees(angrad: Double): Double

Converts an angle measured in radians to an approximately equivalent angle measured in degrees. The conversion from radians to degrees is generally inexact; users should not expect cos(toRadians(90.0)) to exactly equal 0.0.

Parameters
`angrad`	Double: an angle, in radians

Return
`Double`	the measurement of the angle `angrad` in degrees.

toIntExact

Added in API level 24

static fun toIntExact(value: Long): Int

Returns the value of the long argument, throwing an exception if the value overflows an int.

Parameters
`value`	Long: the long value

Return
`Int`	the argument as an int

Exceptions
`java.lang.ArithmeticException`	if the `argument` overflows an int

See Also

java.lang.Math#toIntExact(long)

toRadians

Added in API level 1

static fun toRadians(angdeg: Double): Double

Converts an angle measured in degrees to an approximately equivalent angle measured in radians. The conversion from degrees to radians is generally inexact.

Parameters
`angdeg`	Double: an angle, in degrees

Return
`Double`	the measurement of the angle `angdeg` in radians.

ulp

Added in API level 1

static fun ulp(d: Double): Double

Returns the size of an ulp of the argument. An ulp, unit in the last place, of a double value is the positive distance between this floating-point value and the double value next larger in magnitude. Note that for non-NaN x, ulp(-x) == ulp(x).

Special Cases:

If the argument is NaN, then the result is NaN.
If the argument is positive or negative infinity, then the result is positive infinity.
If the argument is positive or negative zero, then the result is Double.MIN_VALUE.
If the argument is ±Double.MAX_VALUE, then the result is equal to 2971.

Parameters
`d`	Double: the floating-point value whose ulp is to be returned

Return
`Double`	the size of an ulp of the argument

ulp

Added in API level 1

static fun ulp(f: Float): Float

Returns the size of an ulp of the argument. An ulp, unit in the last place, of a float value is the positive distance between this floating-point value and the float value next larger in magnitude. Note that for non-NaN x, ulp(-x) == ulp(x).

Special Cases:

If the argument is NaN, then the result is NaN.
If the argument is positive or negative infinity, then the result is positive infinity.
If the argument is positive or negative zero, then the result is Float.MIN_VALUE.
If the argument is ±Float.MAX_VALUE, then the result is equal to 2104.

Parameters
`f`	Float: the floating-point value whose ulp is to be returned

Return
`Float`	the size of an ulp of the argument

unsignedMultiplyHigh

Added in API level 35

static fun unsignedMultiplyHigh(
    x: Long, 
    y: Long
): Long

Returns as a long the most significant 64 bits of the unsigned 128-bit product of two unsigned 64-bit factors.

Parameters
`x`	Long: the first value
`y`	Long: the second value

Return
`Long`	the result

See Also