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

Rename Random.next* parameters: remaining renames

Browse Source 
- Correct docs after parameter renaming
- Rename parameters in Random inheritors
- Rename local variables

#KT-26596
This commit is contained in:
Ilya Gorbunov
2018-09-12 21:27:45 +03:00
parent ffb83bbdf0
commit 928fe19801
4 changed files with 54 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/src/kotlin/random/Random.kt
+28 -29
View File
@@ -37,9 +37,9 @@ public abstract class Random {
public open fun nextInt(): Int = nextBits(32)
/**
* Gets the next random non-negative `Int` from the random number generator not greater than the specified [until].
* Gets the next random non-negative `Int` from the random number generator not greater than the specified [until] bound.
*
* Generates an `Int` random value uniformly distributed between `0` (inclusive) and the specified [until] (exclusive).
* Generates an `Int` random value uniformly distributed between `0` (inclusive) and the specified [until] bound (exclusive).
*
* @param until must be positive.
*
@@ -50,7 +50,7 @@ public abstract class Random {
/**
* Gets the next random `Int` from the random number generator in the specified range.
*
* Generates an `Int` random value uniformly distributed between the specified [from] (inclusive) and the specified [until] (exclusive).
* Generates an `Int` random value uniformly distributed between the specified [from] (inclusive) and [until] (exclusive) bounds.
*
* @throws IllegalArgumentException if [from] is greater than or equal to [until].
*/
@@ -101,9 +101,9 @@ public abstract class Random {
public open fun nextLong(): Long = nextInt().toLong().shl(32) + nextInt()
/**
* Gets the next random non-negative `Long` from the random number generator not greater than the specified [until].
* Gets the next random non-negative `Long` from the random number generator not greater than the specified [until] bound.
*
* Generates a `Long` random value uniformly distributed between `0` (inclusive) and the specified [until] (exclusive).
* Generates a `Long` random value uniformly distributed between `0` (inclusive) and the specified [until] bound (exclusive).
*
* @param until must be positive.
*
@@ -114,7 +114,7 @@ public abstract class Random {
/**
* Gets the next random `Long` from the random number generator in the specified range.
*
* Generates a `Long` random value uniformly distributed between the specified [from] (inclusive) and the specified [until] (exclusive).
* Generates a `Long` random value uniformly distributed between the specified [from] (inclusive) and [until] (exclusive) bounds.
*
* @throws IllegalArgumentException if [from] is greater than or equal to [until].
*/
@@ -183,7 +183,7 @@ public abstract class Random {
public open fun nextDouble(): Double = doubleFromParts(nextBits(26), nextBits(27))
/**
* Gets the next random non-negative `Double` from the random number generator not greater than the specified [until].
* Gets the next random non-negative `Double` from the random number generator not greater than the specified [until] bound.
*
* Generates a `Double` random value uniformly distributed between 0 (inclusive) and [until] (exclusive).
*
@@ -194,7 +194,7 @@ public abstract class Random {
/**
* Gets the next random `Double` from the random number generator in the specified range.
*
* Generates a `Double` random value uniformly distributed between the specified [from] (inclusive) and the specified [until] (exclusive).
* Generates a `Double` random value uniformly distributed between the specified [from] (inclusive) and [until] (exclusive) bounds.
*
* [from] and [until] must be finite otherwise the behavior is unspecified.
*
@@ -331,9 +331,9 @@ public fun Random(seed: Long): Random = XorWowRandom(seed.toInt(), seed.shr(32).
public fun Random.nextUInt(): UInt = nextInt().toUInt()
/**
* Gets the next random [UInt] from the random number generator not greater than the specified [until].
* Gets the next random [UInt] from the random number generator not greater than the specified [until] bound.
*
* Generates a [UInt] random value uniformly distributed between `0` (inclusive) and the specified [until] (exclusive).
* Generates a [UInt] random value uniformly distributed between `0` (inclusive) and the specified [until] bound (exclusive).
*
* @throws IllegalArgumentException if [until] is zero.
*/
@@ -344,7 +344,7 @@ public fun Random.nextUInt(until: UInt): UInt = nextUInt(0u, until)
/**
* Gets the next random [UInt] from the random number generator in the specified range.
*
* Generates a [UInt] random value uniformly distributed between the specified [from] (inclusive) and the specified [until] (exclusive).
* Generates a [UInt] random value uniformly distributed between the specified [from] (inclusive) and [until] (exclusive) bounds.
*
* @throws IllegalArgumentException if [from] is greater than or equal to [until].
*/
@@ -353,12 +353,11 @@ public fun Random.nextUInt(until: UInt): UInt = nextUInt(0u, until)
public fun Random.nextUInt(from: UInt, until: UInt): UInt {
checkUIntRangeBounds(from, until)
val originTransformedToInt = from.toInt() xor Int.MIN_VALUE
val boundTransformedToInt = until.toInt() xor Int.MIN_VALUE
val signedFrom = from.toInt() xor Int.MIN_VALUE
val signedUntil = until.toInt() xor Int.MIN_VALUE
val randomValueTransformedBack = nextInt(originTransformedToInt, boundTransformedToInt) xor Int.MIN_VALUE
return randomValueTransformedBack.toUInt()
val signedResult = nextInt(signedFrom, signedUntil) xor Int.MIN_VALUE
return signedResult.toUInt()
}
/**
@@ -388,9 +387,9 @@ public fun Random.nextUInt(range: UIntRange): UInt = when {
public fun Random.nextULong(): ULong = nextLong().toULong()
/**
* Gets the next random [ULong] from the random number generator not greater than the specified [until].
* Gets the next random [ULong] from the random number generator not greater than the specified [until] bound.
*
* Generates a [ULong] random value uniformly distributed between `0` (inclusive) and the specified [until] (exclusive).
* Generates a [ULong] random value uniformly distributed between `0` (inclusive) and the specified [until] bound (exclusive).
*
* @throws IllegalArgumentException if [until] is zero.
*/
@@ -401,7 +400,7 @@ public fun Random.nextULong(until: ULong): ULong = nextULong(0uL, until)
/**
* Gets the next random [ULong] from the random number generator in the specified range.
*
* Generates a [ULong] random value uniformly distributed between the specified [from] (inclusive) and the specified [until] (exclusive).
* Generates a [ULong] random value uniformly distributed between the specified [from] (inclusive) and [until] (exclusive) bounds.
*
* @throws IllegalArgumentException if [from] is greater than or equal to [until].
*/
@@ -410,11 +409,11 @@ public fun Random.nextULong(until: ULong): ULong = nextULong(0uL, until)
public fun Random.nextULong(from: ULong, until: ULong): ULong {
checkULongRangeBounds(from, until)
val originTransformedToLong = from.toLong() xor Long.MIN_VALUE
val boundTransformedToLong = until.toLong() xor Long.MIN_VALUE
val signedFrom = from.toLong() xor Long.MIN_VALUE
val signedUntil = until.toLong() xor Long.MIN_VALUE
val randomValueTransformedBack = nextLong(originTransformedToLong, boundTransformedToLong) xor Long.MIN_VALUE
return randomValueTransformedBack.toULong()
val signedResult = nextLong(signedFrom, signedUntil) xor Long.MIN_VALUE
return signedResult.toULong()
}
/**
@@ -473,10 +472,10 @@ internal expect fun doubleFromParts(hi26: Int, low27: Int): Double
internal fun Int.takeUpperBits(bitCount: Int): Int =
this.ushr(32 - bitCount) and (-bitCount).shr(31)
internal fun checkRangeBounds(origin: Int, bound: Int) = require(bound > origin) { boundsErrorMessage(origin, bound) }
internal fun checkUIntRangeBounds(origin: UInt, bound: UInt) = require(bound > origin) { boundsErrorMessage(origin, bound) }
internal fun checkRangeBounds(origin: Long, bound: Long) = require(bound > origin) { boundsErrorMessage(origin, bound) }
internal fun checkULongRangeBounds(origin: ULong, bound: ULong) = require(bound > origin) { boundsErrorMessage(origin, bound) }
internal fun checkRangeBounds(origin: Double, bound: Double) = require(bound > origin) { boundsErrorMessage(origin, bound) }
internal fun checkRangeBounds(from: Int, until: Int) = require(until > from) { boundsErrorMessage(from, until) }
internal fun checkUIntRangeBounds(from: UInt, until: UInt) = require(until > from) { boundsErrorMessage(from, until) }
internal fun checkRangeBounds(from: Long, until: Long) = require(until > from) { boundsErrorMessage(from, until) }
internal fun checkULongRangeBounds(from: ULong, until: ULong) = require(until > from) { boundsErrorMessage(from, until) }
internal fun checkRangeBounds(from: Double, until: Double) = require(until > from) { boundsErrorMessage(from, until) }
private fun boundsErrorMessage(origin: Any, bound: Any) = "Random range is empty: [$origin, $bound)."
private fun boundsErrorMessage(from: Any, until: Any) = "Random range is empty: [$from, $until)."