# RandomGenerator.ArbitrarilyJumpableGenerator Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # ArbitrarilyJumpableGenerator ``` interface ArbitrarilyJumpableGenerator : RandomGenerator.LeapableGenerator ``` |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [java.util.random.RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#) | This interface is designed to provide a common protocol for objects that generate sequences of pseudorandom values and can easily*jump*forward, by an arbitrary amount, to a distant point in the state cycle. Ideally, all[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)objects produced by iterative jumping from a single original[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)object are statistically independent of one another and individually uniform, provided that they do not traverse overlapping portions of the state cycle. In practice, one must settle for some approximation to independence and uniformity. In particular, a specific implementation may assume that each generator in a stream produced by the[jump](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#jump())() method is used to produce a number of values no larger than the jump distance specified. Implementors are advised to use algorithms whose period is at least 2127. For many applications, it suffices to jump forward by a power of two or some small multiple of a power of two, but this power of two may not be representable as a`long`value. To avoid the use of[BigInteger](https://developer.android.com/reference/kotlin/java/math/BigInteger.html#)values as jump distances,`double`values are used instead. Methods are provided to perform a single jump operation and also to produce a stream of generators produced from the original by iterative copying and jumping of internal state. A typical strategy for a multithreaded application is to create a single[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)object, call its[jump](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#jump())() method exactly once, and then parcel out generators from the resulting stream, one to each thread. However, each generator produced also has type[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#); with care, different jump distances can be used to traverse the entire state cycle in various ways. Objects that implement[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)are typically not cryptographically secure. Consider instead using[SecureRandom](https://developer.android.com/reference/kotlin/java/security/SecureRandom.html#)to get a cryptographically secure pseudo-random number generator for use by security-sensitive applications. ## Summary | Public methods || |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | abstract[RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)! | [copy](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#copy())`()` Returns a new generator whose internal state is an exact copy of this generator (therefore their future behavior should be identical if subjected to the same series of operations). | | open[RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)! | [copyAndJump](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#copyAndJump(kotlin.Double))`(`distance:` `[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`)` Copy this generator, jump this generator forward, then return the copy. | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [jump](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#jump())`()` Alter the state of this pseudorandom number generator so as to jump forward a large, fixed distance (typically 264 or more) within its state cycle. | | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [jump](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#jump(kotlin.Double))`(`distance:` `[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`)` Alter the state of this pseudorandom number generator so as to jump forward a specified distance within its state cycle. | | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [jumpPowerOfTwo](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#jumpPowerOfTwo(kotlin.Int))`(`logDistance:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Alter the state of this pseudorandom number generator so as to jump forward a distance equal to 2`logDistance`within its state cycle. | | open[Stream](https://developer.android.com/reference/kotlin/java/util/stream/Stream.html#)\<[RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)!\>! | [jumps](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#jumps(kotlin.Double))`(`distance:` `[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`)` Returns an effectively unlimited stream of new pseudorandom number generators, each of which implements the[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)interface, produced by jumping copies of this generator by different integer multiples of the specified jump distance. | | open[Stream](https://developer.android.com/reference/kotlin/java/util/stream/Stream.html#)\<[RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)!\>! | [jumps](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#jumps(kotlin.Long,%20kotlin.Double))`(`streamSize:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`, `distance:` `[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)`)` Returns a stream producing the given`streamSize`number of new pseudorandom number generators, each of which implements the[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)interface, produced by jumping copies of this generator by different integer multiples of the specified jump distance. | | open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [leap](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#leap())`()` Alter the state of this pseudorandom number generator so as to jump forward a very large, fixed distance (typically 2128 or more) within its state cycle. | | openstatic[RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)! | [of](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#of(kotlin.String))`(`name:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Returns an instance of[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)that utilizes the`name`[algorithm](https://developer.android.com/reference/kotlin/java/util/random/package-summary#algorithms). | | Inherited functions || |---|---| | From class[JumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator) |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)! | [copyAndJump](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#copyAndJump())`()`
Copy this generator, jump this generator forward, then return the copy.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [jump](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#jump())`()`
Alter the state of this pseudorandom number generator so as to jump forward a large, fixed distance (typically 264 or more) within its state cycle.
| | [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) | [jumpDistance](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#jumpDistance())`()`
Returns the distance by which the[jump](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#jump())() method will jump forward within the state cycle of this generator object.
| | [Stream](https://developer.android.com/reference/kotlin/java/util/stream/Stream.html#)<[RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)!>! | [jumps](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#jumps())`()`
Returns an effectively unlimited stream of new pseudorandom number generators, each of which implements the[RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)interface.
| | [Stream](https://developer.android.com/reference/kotlin/java/util/stream/Stream.html#)<[RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)!>! | [jumps](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#jumps(kotlin.Long))`(`streamSize:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)`
Returns a stream producing the given`streamSize`number of new pseudorandom number generators, each of which implements the[RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)interface.
| | [Stream](https://developer.android.com/reference/kotlin/java/util/stream/Stream.html#)<[RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)!>! | [rngs](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#rngs())`()`
Returns an effectively unlimited stream of new pseudorandom number generators, each of which implements the[RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)interface. Ideally the generators in the stream will appear to be statistically independent.
| | [Stream](https://developer.android.com/reference/kotlin/java/util/stream/Stream.html#)<[RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)!>! | [rngs](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#rngs(kotlin.Long))`(`streamSize:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)`
Returns a stream producing the given`streamSize`number of new pseudorandom number generators, each of which implements the[RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)interface. Ideally the generators in the stream will appear to be statistically independent.
| || | From class[LeapableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.LeapableGenerator) |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [RandomGenerator.JumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator)! | [copyAndLeap](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.LeapableGenerator#copyAndLeap())`()`
Copy this generator, leap this generator forward, then return the copy.
| | [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) | [leapDistance](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.LeapableGenerator#leapDistance())`()`
Returns the distance by which the[leap](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.LeapableGenerator#leap())() method will leap forward within the state cycle of this generator object.
| | [Stream](https://developer.android.com/reference/kotlin/java/util/stream/Stream.html#)<[RandomGenerator.JumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator)!>! | [leaps](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.LeapableGenerator#leaps())`()`
Returns an effectively unlimited stream of new pseudorandom number generators, each of which implements the[JumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator)interface.
| | [Stream](https://developer.android.com/reference/kotlin/java/util/stream/Stream.html#)<[RandomGenerator.JumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator)!>! | [leaps](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.LeapableGenerator#leaps(kotlin.Long))`(`streamSize:` `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)`
Returns a stream producing the given`streamSize`number of new pseudorandom number generators, each of which implements the[JumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator)interface.
| || ## Public methods ### copy Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun copy(): RandomGenerator.ArbitrarilyJumpableGenerator! ``` Returns a new generator whose internal state is an exact copy of this generator (therefore their future behavior should be identical if subjected to the same series of operations). | Return || |----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| | [RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)! | a new object that is a copy of this generator | ### copyAndJump Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun copyAndJump(distance: Double): RandomGenerator.ArbitrarilyJumpableGenerator! ``` Copy this generator, jump this generator forward, then return the copy. | Parameters || |------------|------------------------------------------------------------------------------------------------------------------------------------| | `distance` | [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html):a distance to jump forward within the state cycle | | Return || |----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| | [RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)! | a copy of this generator object before the jump occurred | | Exceptions || |--------------------------------------|--------------------------------------------------------------------------------------------------| | `java.lang.IllegalArgumentException` | if`distance`is not greater than or equal to 0.0, or is greater than the period of this generator | ### jump Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun jump(): Unit ``` Alter the state of this pseudorandom number generator so as to jump forward a large, fixed distance (typically 264 or more) within its state cycle. The distance used is that returned by method[jumpDistance](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.JumpableGenerator#jumpDistance())(). ### jump Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun jump(distance: Double): Unit ``` Alter the state of this pseudorandom number generator so as to jump forward a specified distance within its state cycle. | Parameters || |------------|--------------------------------------------------------------------------------------------------------------------------------------| | `distance` | [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html):the distance to jump forward within the state cycle | | Exceptions || |--------------------------------------|--------------------------------------------------------------------------------------------------| | `java.lang.IllegalArgumentException` | if`distance`is not greater than or equal to 0.0, or is greater than the period of this generator | ### jumpPowerOfTwo Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun jumpPowerOfTwo(logDistance: Int): Unit ``` Alter the state of this pseudorandom number generator so as to jump forward a distance equal to 2`logDistance`within its state cycle. | Parameters || |---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| | `logDistance` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the base-2 logarithm of the distance to jump forward within the state cycle | | Exceptions || |--------------------------------------|------------------------------------------------------------------------------| | `java.lang.IllegalArgumentException` | if`logDistance`is 2`logDistance`is greater than the period of this generator | ### jumps Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun jumps(distance: Double): Stream! ``` Returns an effectively unlimited stream of new pseudorandom number generators, each of which implements the[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)interface, produced by jumping copies of this generator by different integer multiples of the specified jump distance. | Parameters || |------------|------------------------------------------------------------------------------------------------------------------------------------| | `distance` | [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html):a distance to jump forward within the state cycle | | Return || |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| | [Stream](https://developer.android.com/reference/kotlin/java/util/stream/Stream.html#)<[RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)!>! | a stream of objects that implement the[RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)interface | | Exceptions || |--------------------------------------|--------------------------------------------------------------------------------------------------| | `java.lang.IllegalArgumentException` | if`distance`is not greater than or equal to 0.0, or is greater than the period of this generator | ### jumps Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun jumps(     streamSize: Long,     distance: Double ): Stream! ``` Returns a stream producing the given`streamSize`number of new pseudorandom number generators, each of which implements the[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)interface, produced by jumping copies of this generator by different integer multiples of the specified jump distance. | Parameters || |--------------|------------------------------------------------------------------------------------------------------------------------------------| | `streamSize` | [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html):the number of generators to generate | | `distance` | [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html):a distance to jump forward within the state cycle | | Return || |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| | [Stream](https://developer.android.com/reference/kotlin/java/util/stream/Stream.html#)<[RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)!>! | a stream of objects that implement the[RandomGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator)interface | | Exceptions || |--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------| | `java.lang.IllegalArgumentException` | if`streamSize`is less than zero or if`distance`is not greater than or equal to 0.0, or is greater than the period of this generator | ### leap Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun leap(): Unit ``` Alter the state of this pseudorandom number generator so as to jump forward a very large, fixed distance (typically 2128 or more) within its state cycle. The distance used is that returned by method[leapDistance](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.LeapableGenerator#leapDistance())(). ### of Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open static fun of(name: String!): RandomGenerator.ArbitrarilyJumpableGenerator! ``` Returns an instance of[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)that utilizes the`name`[algorithm](https://developer.android.com/reference/kotlin/java/util/random/package-summary#algorithms). | Parameters || |--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `name` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:Name of random number generator[algorithm](https://developer.android.com/reference/kotlin/java/util/random/package-summary#algorithms) | | Return || |----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | [RandomGenerator.ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#)! | An instance of[ArbitrarilyJumpableGenerator](https://developer.android.com/reference/kotlin/java/util/random/RandomGenerator.ArbitrarilyJumpableGenerator#) | | Exceptions || |--------------------------------------|-------------------------------------| | `java.lang.NullPointerException` | if name is null | | `java.lang.IllegalArgumentException` | if the named algorithm is not found |