azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor fixes in logarithm functions docs

Browse Source
This commit is contained in:
Ilya Gorbunov
2017-07-31 22:42:50 +03:00
parent 57f5791e70
commit 5bfa9b248e
3 changed files with 56 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
js/js.libraries/src/core/math.kt
+19 -19
View File
@@ -202,7 +202,7 @@ public inline fun exp(a: Double): Double = nativeMath.exp(a)
public inline fun expm1(a: Double): Double = nativeMath.expm1(a)
/**
* Computes the logarithm in the given [base] of the [a] value.
* Computes the logarithm of the value [a] to the given [base].
*
* Special cases:
* - `log(a, b)` is `NaN` if either `a` or `b` are `NaN`
@@ -218,7 +218,7 @@ public fun log(a: Double, base: Double): Double {
}
/**
* Computes the natural logarithm (base `E`) of the [a] value.
* Computes the natural logarithm (base `E`) of the value [a].
*
* Special cases:
* - `ln(NaN)` is `NaN`
@@ -231,7 +231,7 @@ public fun log(a: Double, base: Double): Double {
public inline fun ln(a: Double): Double = nativeMath.log(a)
/**
* Computes the decimal logarithm (base 10) of the [a] value.
* Computes the common logarithm (base 10) of the value [a].
*
* @see [ln] function for special cases.
*/
@@ -240,7 +240,7 @@ public inline fun ln(a: Double): Double = nativeMath.log(a)
public inline fun log10(a: Double): Double = nativeMath.log10(a)
/**
* Computes the binary logarithm (base 2) of the [a] value.
* Computes the binary logarithm (base 2) of the value [a].
*
* @see [ln] function for special cases.
*/
@@ -249,17 +249,17 @@ public inline fun log10(a: Double): Double = nativeMath.log10(a)
public inline fun log2(a: Double): Double = nativeMath.log2(a)
/**
* Computes `log(a + 1)`.
* Computes `ln(a + 1)`.
*
* This function can be implemented to produce more precise result for [a] near zero.
*
* Special cases:
* - `log1p(NaN)` is `NaN`
* - `log1p(x)` is `NaN` where `x < -1.0`
* - `log1p(-1.0)` is `-Inf`
* - `log1p(+Inf)` is `+Inf`
* - `ln1p(NaN)` is `NaN`
* - `ln1p(x)` is `NaN` where `x < -1.0`
* - `ln1p(-1.0)` is `-Inf`
* - `ln1p(+Inf)` is `+Inf`
*
* @see [ln] function.
* @see [ln] function
* @see [expm1] function
*/
@SinceKotlin("1.2")
@@ -642,7 +642,7 @@ public inline fun exp(a: Float): Float = nativeMath.exp(a.toDouble()).toFloat()
public inline fun expm1(a: Float): Float = nativeMath.expm1(a.toDouble()).toFloat()
/**
* Computes the logarithm in the given [base] of the [a] value.
* Computes the logarithm of the value [a] to the given [base].
*
* Special cases:
* - `log(a, b)` is `NaN` if either `a` or `b` are `NaN`
@@ -656,7 +656,7 @@ public inline fun expm1(a: Float): Float = nativeMath.expm1(a.toDouble()).toFloa
public inline fun log(a: Float, base: Float): Float = log(a.toDouble(), base.toDouble()).toFloat()
/**
* Computes the natural logarithm (base `E`) of the [a] value.
* Computes the natural logarithm (base `E`) of the value [a].
*
* Special cases:
* - `ln(NaN)` is `NaN`
@@ -669,7 +669,7 @@ public inline fun log(a: Float, base: Float): Float = log(a.toDouble(), base.toD
public inline fun ln(a: Float): Float = nativeMath.log(a.toDouble()).toFloat()
/**
* Computes the decimal logarithm (base 10) of the [a] value.
* Computes the common logarithm (base 10) of the value [a].
*
* @see [ln] function for special cases.
*/
@@ -678,7 +678,7 @@ public inline fun ln(a: Float): Float = nativeMath.log(a.toDouble()).toFloat()
public inline fun log10(a: Float): Float = nativeMath.log10(a.toDouble()).toFloat()
/**
* Computes the binary logarithm (base 2) of the [a] value.
* Computes the binary logarithm (base 2) of the value [a].
*
* @see [ln] function for special cases.
*/
@@ -687,15 +687,15 @@ public inline fun log10(a: Float): Float = nativeMath.log10(a.toDouble()).toFloa
public inline fun log2(a: Float): Float = nativeMath.log2(a.toDouble()).toFloat()
/**
* Computes `log(a + 1)`.
* Computes `ln(a + 1)`.
*
* This function can be implemented to produce more precise result for [a] near zero.
*
* Special cases:
* - `log1p(NaN)` is `NaN`
* - `log1p(x)` is `NaN` where `x < -1.0`
* - `log1p(-1.0)` is `-Inf`
* - `log1p(+Inf)` is `+Inf`
* - `ln1p(NaN)` is `NaN`
* - `ln1p(x)` is `NaN` where `x < -1.0`
* - `ln1p(-1.0)` is `-Inf`
* - `ln1p(+Inf)` is `+Inf`
*
* @see [ln] function
* @see [expm1] function