/
AbstractXoShiRo512.java
267 lines (244 loc) · 8.42 KB
/
AbstractXoShiRo512.java
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
/*
* 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.rng.core.source64;
import org.apache.commons.rng.JumpableUniformRandomProvider;
import org.apache.commons.rng.LongJumpableUniformRandomProvider;
import org.apache.commons.rng.UniformRandomProvider;
import org.apache.commons.rng.core.util.NumberFactory;
/**
* This abstract class is a base for algorithms from the Xor-Shift-Rotate family of 64-bit
* generators with 512-bits of state.
*
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
* @since 1.3
*/
abstract class AbstractXoShiRo512 extends LongProvider implements LongJumpableUniformRandomProvider {
/** Size of the state vector. */
private static final int SEED_SIZE = 8;
/** The coefficients for the jump function. */
private static final long[] JUMP_COEFFICIENTS = {
0x33ed89b6e7a353f9L, 0x760083d7955323beL, 0x2837f2fbb5f22faeL, 0x4b8c5674d309511cL,
0xb11ac47a7ba28c25L, 0xf1be7667092bcc1cL, 0x53851efdb6df0aafL, 0x1ebbc8b23eaf25dbL
};
/** The coefficients for the long jump function. */
private static final long[] LONG_JUMP_COEFFICIENTS = {
0x11467fef8f921d28L, 0xa2a819f2e79c8ea8L, 0xa8299fc284b3959aL, 0xb4d347340ca63ee1L,
0x1cb0940bedbff6ceL, 0xd956c5c4fa1f8e17L, 0x915e38fd4eda93bcL, 0x5b3ccdfa5d7daca5L
};
// State is maintained using variables rather than an array for performance
/** State 0 of the generator. */
protected long state0;
/** State 1 of the generator. */
protected long state1;
/** State 2 of the generator. */
protected long state2;
/** State 3 of the generator. */
protected long state3;
/** State 4 of the generator. */
protected long state4;
/** State 5 of the generator. */
protected long state5;
/** State 6 of the generator. */
protected long state6;
/** State 7 of the generator. */
protected long state7;
/**
* Creates a new instance.
*
* @param seed Initial seed.
* If the length is larger than 8, only the first 8 elements will
* be used; if smaller, the remaining elements will be automatically
* set. A seed containing all zeros will create a non-functional generator.
*/
AbstractXoShiRo512(long[] seed) {
if (seed.length < SEED_SIZE) {
final long[] state = new long[SEED_SIZE];
fillState(state, seed);
setState(state);
} else {
setState(seed);
}
}
/**
* Creates a new instance using an 8 element seed.
* A seed containing all zeros will create a non-functional generator.
*
* @param seed0 Initial seed element 0.
* @param seed1 Initial seed element 1.
* @param seed2 Initial seed element 2.
* @param seed3 Initial seed element 3.
* @param seed4 Initial seed element 4.
* @param seed5 Initial seed element 5.
* @param seed6 Initial seed element 6.
* @param seed7 Initial seed element 7.
*/
AbstractXoShiRo512(long seed0, long seed1, long seed2, long seed3,
long seed4, long seed5, long seed6, long seed7) {
state0 = seed0;
state1 = seed1;
state2 = seed2;
state3 = seed3;
state4 = seed4;
state5 = seed5;
state6 = seed6;
state7 = seed7;
}
/**
* Creates a copy instance.
*
* @param source Source to copy.
*/
protected AbstractXoShiRo512(AbstractXoShiRo512 source) {
super(source);
state0 = source.state0;
state1 = source.state1;
state2 = source.state2;
state3 = source.state3;
state4 = source.state4;
state5 = source.state5;
state6 = source.state6;
state7 = source.state7;
}
/**
* Copies the state from the array into the generator state.
*
* @param state the new state
*/
private void setState(long[] state) {
state0 = state[0];
state1 = state[1];
state2 = state[2];
state3 = state[3];
state4 = state[4];
state5 = state[5];
state6 = state[6];
state7 = state[7];
}
/** {@inheritDoc} */
@Override
protected byte[] getStateInternal() {
return composeStateInternal(NumberFactory.makeByteArray(
new long[] {state0, state1, state2, state3,
state4, state5, state6, state7}),
super.getStateInternal());
}
/** {@inheritDoc} */
@Override
protected void setStateInternal(byte[] s) {
final byte[][] c = splitStateInternal(s, SEED_SIZE * 8);
setState(NumberFactory.makeLongArray(c[0]));
super.setStateInternal(c[1]);
}
/** {@inheritDoc} */
@Override
public long next() {
final long result = nextOutput();
final long t = state1 << 11;
state2 ^= state0;
state5 ^= state1;
state1 ^= state2;
state7 ^= state3;
state3 ^= state4;
state4 ^= state5;
state0 ^= state6;
state6 ^= state7;
state6 ^= t;
state7 = Long.rotateLeft(state7, 21);
return result;
}
/**
* Use the current state to compute the next output from the generator.
* The output function shall vary with respect to different generators.
* This method is called from {@link #next()} before the current state is updated.
*
* @return the next output
*/
protected abstract long nextOutput();
/**
* {@inheritDoc}
*
* <p>The jump size is the equivalent of 2<sup>256</sup>
* calls to {@link UniformRandomProvider#nextLong() nextLong()}. It can provide
* up to 2<sup>256</sup> non-overlapping subsequences.</p>
*/
@Override
public UniformRandomProvider jump() {
final UniformRandomProvider copy = copy();
performJump(JUMP_COEFFICIENTS);
return copy;
}
/**
* {@inheritDoc}
*
* <p>The jump size is the equivalent of 2<sup>384</sup> calls to
* {@link UniformRandomProvider#nextLong() nextLong()}. It can provide up to
* 2<sup>128</sup> non-overlapping subsequences of length 2<sup>384</sup>; each
* subsequence can provide up to 2<sup>128</sup> non-overlapping subsequences of
* length 2<sup>256</sup> using the {@link #jump()} method.</p>
*/
@Override
public JumpableUniformRandomProvider longJump() {
final JumpableUniformRandomProvider copy = copy();
performJump(LONG_JUMP_COEFFICIENTS);
return copy;
}
/**
* Create a copy.
*
* @return the copy
*/
protected abstract AbstractXoShiRo512 copy();
/**
* Perform the jump to advance the generator state. Resets the cached state of the generator.
*
* @param jumpCoefficients Jump coefficients.
*/
private void performJump(long[] jumpCoefficients) {
long s0 = 0;
long s1 = 0;
long s2 = 0;
long s3 = 0;
long s4 = 0;
long s5 = 0;
long s6 = 0;
long s7 = 0;
for (final long jc : jumpCoefficients) {
for (int b = 0; b < 64; b++) {
if ((jc & (1L << b)) != 0) {
s0 ^= state0;
s1 ^= state1;
s2 ^= state2;
s3 ^= state3;
s4 ^= state4;
s5 ^= state5;
s6 ^= state6;
s7 ^= state7;
}
next();
}
}
state0 = s0;
state1 = s1;
state2 = s2;
state3 = s3;
state4 = s4;
state5 = s5;
state6 = s6;
state7 = s7;
resetCachedState();
}
}