Skip to content

Commit 03a165d

Browse files
refactor: rename package xorshift to xorshift32
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 230d7af commit 03a165d

File tree

22 files changed

+394
-394
lines changed

22 files changed

+394
-394
lines changed

lib/node_modules/@stdlib/random/base/xorshift/README.md renamed to lib/node_modules/@stdlib/random/base/xorshift32/README.md

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -27,33 +27,33 @@ limitations under the License.
2727
## Usage
2828

2929
```javascript
30-
var xorshift = require( '@stdlib/random/base/xorshift' );
30+
var xorshift32 = require( '@stdlib/random/base/xorshift32' );
3131
```
3232

33-
#### xorshift()
33+
#### xorshift32()
3434

3535
Returns a pseudorandom integer on the interval `[1, 4294967295]`.
3636

3737
```javascript
38-
var r = xorshift();
38+
var r = xorshift32();
3939
// returns <number>
4040
```
4141

42-
#### xorshift.normalized()
42+
#### xorshift32.normalized()
4343

4444
Returns a pseudorandom number on the interval `[0,1)`.
4545

4646
```javascript
47-
var r = xorshift.normalized();
47+
var r = xorshift32.normalized();
4848
// returns <number>
4949
```
5050

51-
#### xorshift.factory( \[options] )
51+
#### xorshift32.factory( \[options] )
5252

5353
Returns a 32-bit [xorshift][] pseudorandom number generator.
5454

5555
```javascript
56-
var rand = xorshift.factory();
56+
var rand = xorshift32.factory();
5757
```
5858

5959
The function accepts the following `options`:
@@ -65,7 +65,7 @@ The function accepts the following `options`:
6565
By default, a random integer is used to seed the returned generator. To seed the generator, provide either an `integer` on the interval `[1, 4294967295]`
6666

6767
```javascript
68-
var rand = xorshift.factory({
68+
var rand = xorshift32.factory({
6969
'seed': 1234
7070
});
7171

@@ -78,7 +78,7 @@ or, for arbitrary length seeds, an array-like `object` containing unsigned 32-bi
7878
```javascript
7979
var Uint32Array = require( '@stdlib/array/uint32' );
8080

81-
var rand = xorshift.factory({
81+
var rand = xorshift32.factory({
8282
'seed': new Uint32Array( [ 1234 ] )
8383
});
8484

@@ -93,136 +93,136 @@ To return a generator having a specific initial state, set the generator `state`
9393
var r;
9494
var i;
9595
for ( i = 0; i < 1000; i++ ) {
96-
r = xorshift();
96+
r = xorshift32();
9797
}
9898

99-
// Create a new PRNG initialized to the current state of `xorshift`:
100-
var rand = xorshift.factory({
101-
'state': xorshift.state
99+
// Create a new PRNG initialized to the current state of `xorshift32`:
100+
var rand = xorshift32.factory({
101+
'state': xorshift32.state
102102
});
103103

104104
// Test that the generated pseudorandom numbers are the same:
105-
var bool = ( rand() === xorshift() );
105+
var bool = ( rand() === xorshift32() );
106106
// returns true
107107
```
108108

109-
#### xorshift.NAME
109+
#### xorshift32.NAME
110110

111111
The generator name.
112112

113113
```javascript
114-
var str = xorshift.NAME;
115-
// returns 'xorshift'
114+
var str = xorshift32.NAME;
115+
// returns 'xorshift32'
116116
```
117117

118-
#### xorshift.MIN
118+
#### xorshift32.MIN
119119

120120
Minimum possible value.
121121

122122
```javascript
123-
var min = xorshift.MIN;
123+
var min = xorshift32.MIN;
124124
// returns 1
125125
```
126126

127-
#### xorshift.MAX
127+
#### xorshift32.MAX
128128

129129
Maximum possible value.
130130

131131
```javascript
132-
var max = xorshift.MAX;
132+
var max = xorshift32.MAX;
133133
// returns 4294967295
134134
```
135135

136-
#### xorshift.seed
136+
#### xorshift32.seed
137137

138-
The value used to seed `xorshift()`.
138+
The value used to seed `xorshift32()`.
139139

140140
```javascript
141141
// Generate pseudorandom values...
142142
var r;
143143
var i;
144144
for ( i = 0; i < 100; i++ ) {
145-
r = xorshift();
145+
r = xorshift32();
146146
}
147147

148148
// Generate the same pseudorandom values...
149-
var rand = xorshift.factory({
150-
'seed': xorshift.seed
149+
var rand = xorshift32.factory({
150+
'seed': xorshift32.seed
151151
});
152152
for ( i = 0; i < 100; i++ ) {
153153
r = rand();
154154
}
155155
```
156156

157-
#### xorshift.seedLength
157+
#### xorshift32.seedLength
158158

159159
Length of generator seed.
160160

161161
```javascript
162-
var len = xorshift.seedLength;
162+
var len = xorshift32.seedLength;
163163
// returns <number>
164164
```
165165

166-
#### xorshift.state
166+
#### xorshift32.state
167167

168168
Writable property for getting and setting the generator state.
169169

170170
```javascript
171-
var r = xorshift();
171+
var r = xorshift32();
172172
// returns <number>
173173

174-
r = xorshift();
174+
r = xorshift32();
175175
// returns <number>
176176

177177
// ...
178178

179179
// Get the current state:
180-
var state = xorshift.state;
180+
var state = xorshift32.state;
181181
// returns <Uint32Array>
182182

183-
r = xorshift();
183+
r = xorshift32();
184184
// returns <number>
185185

186-
r = xorshift();
186+
r = xorshift32();
187187
// returns <number>
188188

189189
// Reset the state:
190-
xorshift.state = state;
190+
xorshift32.state = state;
191191

192192
// Replay the last two pseudorandom numbers:
193-
r = xorshift();
193+
r = xorshift32();
194194
// returns <number>
195195

196-
r = xorshift();
196+
r = xorshift32();
197197
// returns <number>
198198

199199
// ...
200200
```
201201

202-
#### xorshift.stateLength
202+
#### xorshift32.stateLength
203203

204204
Length of generator state.
205205

206206
```javascript
207-
var len = xorshift.stateLength;
207+
var len = xorshift32.stateLength;
208208
// returns <number>
209209
```
210210

211-
#### xorshift.byteLength
211+
#### xorshift32.byteLength
212212

213213
Size (in bytes) of generator state.
214214

215215
```javascript
216-
var sz = xorshift.byteLength;
216+
var sz = xorshift32.byteLength;
217217
// returns <number>
218218
```
219219

220-
#### xorshift.toJSON()
220+
#### xorshift32.toJSON()
221221

222222
Serializes the pseudorandom number generator as a JSON object.
223223

224224
```javascript
225-
var o = xorshift.toJSON();
225+
var o = xorshift32.toJSON();
226226
// returns { 'type': 'PRNG', 'name': '...', 'state': {...}, 'params': [] }
227227
```
228228

@@ -250,26 +250,26 @@ var o = xorshift.toJSON();
250250
<!-- eslint no-undef: "error" -->
251251

252252
```javascript
253-
var xorshift = require( '@stdlib/random/base/xorshift' );
253+
var xorshift32 = require( '@stdlib/random/base/xorshift32' );
254254

255255
// Generate pseudorandom numbers...
256256
var i;
257257
for ( i = 0; i < 100; i++ ) {
258-
console.log( xorshift() );
258+
console.log( xorshift32() );
259259
}
260260

261261
// Create a new pseudorandom number generator...
262262
var seed = 1234;
263-
var rand = xorshift.factory({
263+
var rand = xorshift32.factory({
264264
'seed': seed
265265
});
266266
for ( i = 0; i < 100; i++ ) {
267267
console.log( rand() );
268268
}
269269

270270
// Create another pseudorandom number generator using a previous seed...
271-
rand = xorshift.factory({
272-
'seed': xorshift.seed
271+
rand = xorshift32.factory({
272+
'seed': xorshift32.seed
273273
});
274274
for ( i = 0; i < 100; i++ ) {
275275
console.log( rand() );

lib/node_modules/@stdlib/random/base/xorshift/benchmark/benchmark.js renamed to lib/node_modules/@stdlib/random/base/xorshift32/benchmark/benchmark.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
var bench = require( '@stdlib/bench' );
2424
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2525
var pkg = require( './../package.json' ).name;
26-
var xorshift = require( './../lib' );
26+
var xorshift32 = require( './../lib' );
2727

2828

2929
// MAIN //
@@ -34,7 +34,7 @@ bench( pkg, function benchmark( b ) {
3434

3535
b.tic();
3636
for ( i = 0; i < b.iterations; i++ ) {
37-
z = xorshift();
37+
z = xorshift32();
3838
if ( isnan( z ) ) {
3939
b.fail( 'should not return NaN' );
4040
}
@@ -53,7 +53,7 @@ bench( pkg+':normalized', function benchmark( b ) {
5353

5454
b.tic();
5555
for ( i = 0; i < b.iterations; i++ ) {
56-
z = xorshift.normalized();
56+
z = xorshift32.normalized();
5757
if ( isnan( z ) ) {
5858
b.fail( 'should not return NaN' );
5959
}

0 commit comments

Comments
 (0)