Clarify floor and ceil docs (KT-30418)

This commit is contained in:
Ilya Gorbunov
2019-03-15 19:23:05 +03:00
committed by Nikolay Igotti
parent 22a858df2c
commit 613084ad9b
+4 -4
View File
@@ -284,7 +284,7 @@ external public actual fun ln1p(x: Double): Double
/**
* Rounds the given value [x] to an integer towards positive infinity.
* @return the smallest double value that is greater than the given value [x] and is a mathematical integer.
* @return the smallest double value that is greater than or equal to the given value [x] and is a mathematical integer.
*
* Special cases:
* - `ceil(x)` is `x` where `x` is `NaN` or `+Inf` or `-Inf` or already a mathematical integer.
@@ -296,7 +296,7 @@ external public actual fun ceil(x: Double): Double
/**
* Rounds the given value [x] to an integer towards negative infinity.
* @return the largest double value that is smaller than the given value [x] and is a mathematical integer.
* @return the largest double value that is smaller than or equal to the given value [x] and is a mathematical integer.
*
* Special cases:
* - `floor(x)` is `x` where `x` is `NaN` or `+Inf` or `-Inf` or already a mathematical integer.
@@ -833,7 +833,7 @@ external public actual fun ln1p(x: Float): Float
/**
* Rounds the given value [x] to an integer towards positive infinity.
* @return the smallest Float value that is greater than the given value [x] and is a mathematical integer.
* @return the smallest Float value that is greater than or equal to the given value [x] and is a mathematical integer.
*
* Special cases:
* - `ceil(x)` is `x` where `x` is `NaN` or `+Inf` or `-Inf` or already a mathematical integer.
@@ -845,7 +845,7 @@ external public actual fun ceil(x: Float): Float
/**
* Rounds the given value [x] to an integer towards negative infinity.
* @return the largest Float value that is smaller than the given value [x] and is a mathematical integer.
* @return the largest Float value that is smaller than or equal to the given value [x] and is a mathematical integer.
*
* Special cases:
* - `floor(x)` is `x` where `x` is `NaN` or `+Inf` or `-Inf` or already a mathematical integer.