UniformLongSampler (Apache Commons RNG Sampling 1.6 API)

java.lang.Object
- org.apache.commons.rng.sampling.distribution.UniformLongSampler

All Implemented Interfaces:

LongSampler, SharedStateLongSampler, SharedStateSampler<SharedStateLongSampler>
```
public abstract class UniformLongSampler
extends Object
implements SharedStateLongSampler
```
Discrete uniform distribution sampler generating values of type long.
Sampling uses UniformRandomProvider.nextLong().

When the range is a power of two the number of calls is 1 per sample. Otherwise a rejection algorithm is used to ensure uniformity. In the worst case scenario where the range spans half the range of a long (2⁶³ + 1) the expected number of calls is 2 per sample.

Since:

1.4

Field Summary

Fields
Modifier and Type Field Description

protected UniformRandomProvider rng
Underlying source of randomness.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static UniformLongSampler`	`of(UniformRandomProvider rng, long lower, long upper)`	Creates a new discrete uniform distribution sampler.
`String`	`toString()`
`abstract UniformLongSampler`	`withUniformRandomProvider(UniformRandomProvider rng)`	Create a new instance of the sampler with the same underlying state using the given uniform random provider as the source of randomness.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.rng.sampling.distribution.LongSampler
sample, samples, samples

- Field Detail
  - rng
```
protected final UniformRandomProvider rng
```
    Underlying source of randomness.
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - withUniformRandomProvider
```
public abstract UniformLongSampler withUniformRandomProvider(UniformRandomProvider rng)
```
    Create a new instance of the sampler with the same underlying state using the given uniform random provider as the source of randomness.
    
    Specified by:
    
    withUniformRandomProvider in interface SharedStateSampler<SharedStateLongSampler>
    
    Parameters:
    
    rng - Generator of uniformly distributed random numbers.
    
    Returns:
    
    the sampler
  - of
```
public static UniformLongSampler of(UniformRandomProvider rng,
                                    long lower,
                                    long upper)
```
    Creates a new discrete uniform distribution sampler.
    
    Parameters:
    
    rng - Generator of uniformly distributed random numbers.
    
    lower - Lower bound (inclusive) of the distribution.
    
    upper - Upper bound (inclusive) of the distribution.
    
    Returns:
    
    the sampler
    
    Throws:
    
    IllegalArgumentException - if lower > upper.