Use HALF_EVEN rounding mode for round()

Add docs and tests for rounding.

 #KT-4900
This commit is contained in:
Ilya Gorbunov
2017-07-21 19:19:55 +03:00
parent 5e9e6d5951
commit d0b12e3872
3 changed files with 213 additions and 10 deletions
+79 -4
View File
@@ -268,13 +268,61 @@ public fun log2(a: Double): Double = nativeMath.log(a) / LN2
@InlineOnly
public inline fun log1p(a: Double): Double = nativeMath.log1p(a)
public inline fun ceil(a: Double): Double = nativeMath.ceil(a)
public inline fun floor(a: Double): Double = nativeMath.floor(a)
public inline fun truncate(a: Double): Double = nativeMath.rint(a)
/**
* Rounds the given value [a] to an integer towards positive infinity.
// also as extension val [absoluteValue]
* @return the smallest double value that is greater than the given value [a] and is a mathematical integer.
*
* Special cases:
* - `ceil(x)` is `x` where `x` is `NaN` or `+Inf` or `-Inf` or already a mathematical integer.
*/
@InlineOnly
public inline fun ceil(a: Double): Double = nativeMath.ceil(a)
/**
* Rounds the given value [a] to an integer towards negative infinity.
* @return the largest double value that is smaller than the given value [a] and is a mathematical integer.
*
* Special cases:
* - `floor(x)` is `x` where `x` is `NaN` or `+Inf` or `-Inf` or already a mathematical integer.
*/
@InlineOnly
public inline fun floor(a: Double): Double = nativeMath.floor(a)
/**
* Rounds the given value [a] to an integer towards zero.
*
* @return the value [a] having its fractional part truncated.
*
* Special cases:
* - `truncate(x)` is `x` where `x` is `NaN` or `+Inf` or `-Inf` or already a mathematical integer.
*/
public fun truncate(a: Double): Double = when {
a.isNaN() || a.isInfinite() -> a
a > 0 -> floor(a)
else -> ceil(a)
}
/**
* Rounds the given value [a] towards the closest integer with ties rounded towards even integer.
*
* Special cases:
* - `round(x)` is `x` where `x` is `NaN` or `+Inf` or `-Inf` or already a mathematical integer.
*/
@InlineOnly
public inline fun round(a: Double): Double = nativeMath.rint(a)
/**
* Returns the absolute value of the given value [a].
*
* @see absoluteValue extension property for [Double]
*/
@InlineOnly
public inline fun abs(a: Double): Double = nativeMath.abs(a)
// also as extension val [sign]
@InlineOnly
public inline fun sgn(a: Double): Double = nativeMath.signum(a)
@@ -327,6 +375,33 @@ public inline fun Double.nextUp(): Double = nativeMath.nextUp(this)
public inline fun Double.nextDown(): Double = nativeMath.nextAfter(this, Double.NEGATIVE_INFINITY)
public inline fun Double.nextTowards(to: Double): Double = nativeMath.nextAfter(this, to)
/**
* Rounds this [Double] value to the nearest integer and converts the result to [Int].
* Ties are rounded towards positive infinity.
*
* Special cases:
* - `x.roundToInt() == Int.MAX_VALUE` when `x > Int.MAX_VALUE`
* - `x.roundToInt() == Int.MIN_VALUE` when `x < Int.MIN_VALUE`
*
* @throws IllegalArgumentException when this value is `NaN`
*/
public fun Double.roundToInt(): Int = when {
isNaN() -> throw IllegalArgumentException("Cannot round NaN value.")
this > Int.MAX_VALUE -> Int.MAX_VALUE
this < Int.MIN_VALUE -> Int.MIN_VALUE
else -> nativeMath.round(this).toInt()
}
/**
* Rounds this [Double] value to the nearest integer and converts the result to [Long].
* Ties are rounded towards positive infinity.
*
* Special cases:
* - `x.roundToLong() == Long.MAX_VALUE` when `x > Long.MAX_VALUE`
* - `x.roundToLong() == Long.MIN_VALUE` when `x < Long.MIN_VALUE`
*
* @throws IllegalArgumentException when this value is `NaN`
*/
public fun Double.roundToLong(): Long = if (isNaN()) throw IllegalArgumentException("Cannot round NaN value.") else nativeMath.round(this)