1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.random;
/**
* Interface extracted from <code>java.util.Random</code>. This interface is implemented by {@link
* AbstractRandomGenerator}.
*
* @since 1.1
*/
public interface RandomGenerator {
/**
* Sets the seed of the underlying random number generator using an <code>int</code> seed.
*
* <p>Sequences of values generated starting with the same seeds should be identical.
*
* @param seed the seed value
*/
void setSeed(int seed);
/**
* Sets the seed of the underlying random number generator using an <code>int</code> array seed.
*
* <p>Sequences of values generated starting with the same seeds should be identical.
*
* @param seed the seed value
*/
void setSeed(int[] seed);
/**
* Sets the seed of the underlying random number generator using a <code>long</code> seed.
*
* <p>Sequences of values generated starting with the same seeds should be identical.
*
* @param seed the seed value
*/
void setSeed(long seed);
/**
* Generates random bytes and places them into a user-supplied byte array. The number of random
* bytes produced is equal to the length of the byte array.
*
* @param bytes the non-null byte array in which to put the random bytes
*/
void nextBytes(byte[] bytes);
/**
* Returns the next pseudorandom, uniformly distributed <code>int</code> value from this random
* number generator's sequence. All 2<font size="-1"><sup>32</sup></font> possible {@code int}
* values should be produced with (approximately) equal probability.
*
* @return the next pseudorandom, uniformly distributed <code>int</code> value from this random
* number generator's sequence
*/
int nextInt();
/**
* Returns a pseudorandom, uniformly distributed {@code int} value between 0 (inclusive) and the
* specified value (exclusive), drawn from this random number generator's sequence.
*
* @param n the bound on the random number to be returned. Must be positive.
* @return a pseudorandom, uniformly distributed {@code int} value between 0 (inclusive) and n
* (exclusive).
* @throws IllegalArgumentException if n is not positive.
*/
int nextInt(int n);
/**
* Returns the next pseudorandom, uniformly distributed <code>long</code> value from this random
* number generator's sequence. All 2<font size="-1"><sup>64</sup></font> possible {@code long}
* values should be produced with (approximately) equal probability.
*
* @return the next pseudorandom, uniformly distributed <code>long</code> value from this random
* number generator's sequence
*/
long nextLong();
/**
* Returns the next pseudorandom, uniformly distributed <code>boolean</code> value from this
* random number generator's sequence.
*
* @return the next pseudorandom, uniformly distributed <code>boolean</code> value from this
* random number generator's sequence
*/
boolean nextBoolean();
/**
* Returns the next pseudorandom, uniformly distributed <code>float</code> value between <code>
* 0.0</code> and <code>1.0</code> from this random number generator's sequence.
*
* @return the next pseudorandom, uniformly distributed <code>float</code> value between <code>
* 0.0</code> and <code>1.0</code> from this random number generator's sequence
*/
float nextFloat();
/**
* Returns the next pseudorandom, uniformly distributed <code>double</code> value between <code>
* 0.0</code> and <code>1.0</code> from this random number generator's sequence.
*
* @return the next pseudorandom, uniformly distributed <code>double</code> value between <code>
* 0.0</code> and <code>1.0</code> from this random number generator's sequence
*/
double nextDouble();
/**
* Returns the next pseudorandom, Gaussian ("normally") distributed <code>double</code> value
* with mean <code>0.0</code> and standard deviation <code>1.0</code> from this random number
* generator's sequence.
*
* @return the next pseudorandom, Gaussian ("normally") distributed <code>double</code> value
* with mean <code>0.0</code> and standard deviation <code>1.0</code> from this random
* number generator's sequence
*/
double nextGaussian();
}
|
