Package kotlin.math

Platform and version requirements: Kotlin 1.2

Mathematical functions and constants.

The functions include trigonometric, hyperbolic, exponentiation and power, logarithmic, rounding, sign and absolute value.

Properties

E

const val E: Double

Base of the natural logarithms, approximately 2.71828.

PI

const val PI: Double

Ratio of the circumference of a circle to its diameter, approximately 3.14159.

absoluteValue

val Double.absoluteValue: Double
val Float.absoluteValue: Float
val Int.absoluteValue: Int
val Long.absoluteValue: Long

Returns the absolute value of this value.

sign

val Double.sign: Double
val Float.sign: Float
val Int.sign: Int
val Long.sign: Int

Returns the sign of this value:

ulp

val Double.ulp: Double

Returns the ulp (unit in the last place) of this value.

val Float.ulp: Float

Returns the ulp of this value.

Functions

IEEErem

fun Double.IEEErem(divisor: Double): Double
fun Float.IEEErem(divisor: Float): Float

Computes the remainder of division of this value by the divisor value according to the IEEE 754 standard.

abs

fun abs(x: Double): Double
fun abs(x: Float): Float

Returns the absolute value of the given value x.

fun abs(n: Int): Int
fun abs(n: Long): Long

Returns the absolute value of the given value n.

acos

fun acos(x: Double): Double
fun acos(x: Float): Float

Computes the arc cosine of the value x; the returned value is an angle in the range from 0.0 to PI radians.

acosh

fun acosh(x: Double): Double
fun acosh(x: Float): Float

Computes the inverse hyperbolic cosine of the value x.

asin

fun asin(x: Double): Double
fun asin(x: Float): Float

Computes the arc sine of the value x; the returned value is an angle in the range from -PI/2 to PI/2 radians.

asinh

fun asinh(x: Double): Double
fun asinh(x: Float): Float

Computes the inverse hyperbolic sine of the value x.

atan

fun atan(x: Double): Double
fun atan(x: Float): Float

Computes the arc tangent of the value x; the returned value is an angle in the range from -PI/2 to PI/2 radians.

atan2

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

Returns the angle theta of the polar coordinates (r, theta) that correspond to the rectangular coordinates (x, y) by computing the arc tangent of the value y / x; the returned value is an angle in the range from -PI to PI radians.

atanh

fun atanh(x: Double): Double
fun atanh(x: Float): Float

Computes the inverse hyperbolic tangent of the value x.

ceil

fun ceil(x: Double): Double
fun ceil(x: Float): Float

Rounds the given value x to an integer towards positive infinity.

cos

fun cos(x: Double): Double
fun cos(x: Float): Float

Computes the cosine of the angle x given in radians.

cosh

fun cosh(x: Double): Double
fun cosh(x: Float): Float

Computes the hyperbolic cosine of the value x.

exp

fun exp(x: Double): Double
fun exp(x: Float): Float

Computes Euler's number e raised to the power of the value x.

expm1

fun expm1(x: Double): Double
fun expm1(x: Float): Float

Computes exp(x) - 1.

floor

fun floor(x: Double): Double
fun floor(x: Float): Float

Rounds the given value x to an integer towards negative infinity.

hypot

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

Computes sqrt(x^2 + y^2) without intermediate overflow or underflow.

ln

fun ln(x: Double): Double
fun ln(x: Float): Float

Computes the natural logarithm (base E) of the value x.

ln1p

fun ln1p(x: Double): Double

Computes ln(x + 1).

fun ln1p(x: Float): Float

Computes ln(a + 1).

log

fun log(x: Double, base: Double): Double
fun log(x: Float, base: Float): Float

Computes the logarithm of the value x to the given base.

log10

fun log10(x: Double): Double
fun log10(x: Float): Float

Computes the common logarithm (base 10) of the value x.

log2

fun log2(x: Double): Double
fun log2(x: Float): Float

Computes the binary logarithm (base 2) of the value x.

max

fun max(a: Double, b: Double): Double
fun max(a: Float, b: Float): Float
fun max(a: Int, b: Int): Int
fun max(a: Long, b: Long): Long

Returns the greater of two values.

min

fun min(a: Double, b: Double): Double
fun min(a: Float, b: Float): Float
fun min(a: Int, b: Int): Int
fun min(a: Long, b: Long): Long

Returns the smaller of two values.

nextDown

fun Double.nextDown(): Double

Returns the Double value nearest to this value in direction of negative infinity.

fun Float.nextDown(): Float

Returns the Float value nearest to this value in direction of negative infinity.

nextTowards

fun Double.nextTowards(to: Double): Double

Returns the Double value nearest to this value in direction from this value towards the value to.

fun Float.nextTowards(to: Float): Float

Returns the Float value nearest to this value in direction from this value towards the value to.

nextUp

fun Double.nextUp(): Double

Returns the Double value nearest to this value in direction of positive infinity.

fun Float.nextUp(): Float

Returns the Float value nearest to this value in direction of positive infinity.

pow

fun Double.pow(x: Double): Double
fun Float.pow(x: Float): Float

Raises this value to the power x.

fun Double.pow(n: Int): Double
fun Float.pow(n: Int): Float

Raises this value to the integer power n.

round

fun round(x: Double): Double
fun round(x: Float): Float

Rounds the given value x towards the closest integer with ties rounded towards even integer.

roundToInt

fun Double.roundToInt(): Int

Rounds this Double value to the nearest integer and converts the result to Int. Ties are rounded towards positive infinity.

fun Float.roundToInt(): Int

Rounds this Float value to the nearest integer and converts the result to Int. Ties are rounded towards positive infinity.

roundToLong

fun Double.roundToLong(): Long

Rounds this Double value to the nearest integer and converts the result to Long. Ties are rounded towards positive infinity.

fun Float.roundToLong(): Long

Rounds this Float value to the nearest integer and converts the result to Long. Ties are rounded towards positive infinity.

sign

fun sign(x: Double): Double
fun sign(x: Float): Float

Returns the sign of the given value x:

sin

fun sin(x: Double): Double
fun sin(x: Float): Float

Computes the sine of the angle x given in radians.

sinh

fun sinh(x: Double): Double
fun sinh(x: Float): Float

Computes the hyperbolic sine of the value x.

sqrt

fun sqrt(x: Double): Double
fun sqrt(x: Float): Float

Computes the positive square root of the value x.

tan

fun tan(x: Double): Double
fun tan(x: Float): Float

Computes the tangent of the angle x given in radians.

tanh

fun tanh(x: Double): Double
fun tanh(x: Float): Float

Computes the hyperbolic tangent of the value x.

truncate

fun truncate(x: Double): Double
fun truncate(x: Float): Float

Rounds the given value x to an integer towards zero.

withSign

fun Double.withSign(sign: Double): Double
fun Double.withSign(sign: Int): Double
fun Float.withSign(sign: Float): Float
fun Float.withSign(sign: Int): Float

Returns this value with the sign bit same as of the sign value.