@stdlib/random-streams-invgamma 0.1.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2023 The Stdlib Authors.
1
+ Copyright (c) 2016-2024 The Stdlib Authors.
package/README.md CHANGED
@@ -523,7 +523,7 @@ See [LICENSE][stdlib-license].
523
523
 
524
524
  ## Copyright
525
525
 
526
- Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
526
+ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
527
527
 
528
528
  </section>
529
529
 
@@ -538,8 +538,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
538
538
  [npm-image]: http://img.shields.io/npm/v/@stdlib/random-streams-invgamma.svg
539
539
  [npm-url]: https://npmjs.org/package/@stdlib/random-streams-invgamma
540
540
 
541
- [test-image]: https://github.com/stdlib-js/random-streams-invgamma/actions/workflows/test.yml/badge.svg?branch=v0.1.0
542
- [test-url]: https://github.com/stdlib-js/random-streams-invgamma/actions/workflows/test.yml?query=branch:v0.1.0
541
+ [test-image]: https://github.com/stdlib-js/random-streams-invgamma/actions/workflows/test.yml/badge.svg?branch=v0.2.1
542
+ [test-url]: https://github.com/stdlib-js/random-streams-invgamma/actions/workflows/test.yml?query=branch:v0.2.1
543
543
 
544
544
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-streams-invgamma/main.svg
545
545
  [coverage-url]: https://codecov.io/github/stdlib-js/random-streams-invgamma?branch=main
@@ -566,8 +566,11 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
566
566
  [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
567
567
 
568
568
  [deno-url]: https://github.com/stdlib-js/random-streams-invgamma/tree/deno
569
+ [deno-readme]: https://github.com/stdlib-js/random-streams-invgamma/blob/deno/README.md
569
570
  [umd-url]: https://github.com/stdlib-js/random-streams-invgamma/tree/umd
571
+ [umd-readme]: https://github.com/stdlib-js/random-streams-invgamma/blob/umd/README.md
570
572
  [esm-url]: https://github.com/stdlib-js/random-streams-invgamma/tree/esm
573
+ [esm-readme]: https://github.com/stdlib-js/random-streams-invgamma/blob/esm/README.md
571
574
  [branches-url]: https://github.com/stdlib-js/random-streams-invgamma/blob/main/branches.md
572
575
 
573
576
  [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-streams-invgamma/main/LICENSE
package/SECURITY.md ADDED
@@ -0,0 +1,5 @@
1
+ # Security
2
+
3
+ > Policy for reporting security vulnerabilities.
4
+
5
+ See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).
@@ -96,7 +96,7 @@ declare class RandomStream extends Readable {
96
96
  * @returns stream instance
97
97
  *
98
98
  * @example
99
- * var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
99
+ * var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
100
100
  *
101
101
  * function log( chunk ) {
102
102
  * console.log( chunk.toString() );
@@ -115,37 +115,37 @@ declare class RandomStream extends Readable {
115
115
  /**
116
116
  * Destruction state.
117
117
  */
118
- private readonly _destroyed: boolean; // tslint:disable-line: variable-name
118
+ private readonly _destroyed: boolean;
119
119
 
120
120
  /**
121
121
  * Flag indicating whether a stream is operating in object mode.
122
122
  */
123
- private readonly _objectMode: boolean; // tslint:disable-line: variable-name
123
+ private readonly _objectMode: boolean;
124
124
 
125
125
  /**
126
126
  * Data separator.
127
127
  */
128
- private readonly _sep: string; // tslint:disable-line: variable-name
128
+ private readonly _sep: string;
129
129
 
130
130
  /**
131
131
  * Total number of iterations.
132
132
  */
133
- private readonly _iter: number; // tslint:disable-line: variable-name
133
+ private readonly _iter: number;
134
134
 
135
135
  /**
136
136
  * Number of iterations after which to emit the underlying PRNG state.
137
137
  */
138
- private readonly _siter: number; // tslint:disable-line: variable-name
138
+ private readonly _siter: number;
139
139
 
140
140
  /**
141
141
  * Iteration counter.
142
142
  */
143
- private _i: number; // tslint:disable-line: variable-name
143
+ private _i: number;
144
144
 
145
145
  /**
146
146
  * Pseudorandom number generator for generating inverse gamma distributed pseudorandom numbers.
147
147
  */
148
- private readonly _prng: random.PRNG; // tslint:disable-line: variable-name
148
+ private readonly _prng: random.PRNG;
149
149
 
150
150
  /**
151
151
  * Underlying PRNG.
@@ -182,7 +182,7 @@ declare class RandomStream extends Readable {
182
182
  *
183
183
  * @param size - number (of bytes) to read
184
184
  */
185
- _read( size: number ): void; // tslint:disable-line: variable-name
185
+ _read( size: number ): void;
186
186
 
187
187
  /**
188
188
  * Gracefully destroys a stream, providing backward compatibility.
@@ -217,7 +217,7 @@ interface Constructor {
217
217
  * @returns stream instance
218
218
  *
219
219
  * @example
220
- * var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
220
+ * var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
221
221
  *
222
222
  * function log( chunk ) {
223
223
  * console.log( chunk.toString() );
@@ -246,7 +246,7 @@ interface Constructor {
246
246
  * @returns stream instance
247
247
  *
248
248
  * @example
249
- * var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
249
+ * var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
250
250
  *
251
251
  * function log( chunk ) {
252
252
  * console.log( chunk.toString() );
@@ -287,7 +287,7 @@ interface Constructor {
287
287
  * streams.push( createStream() );
288
288
  * }
289
289
  */
290
- factory( alpha: number, beta: number, options?: Options ): ( ...args: Array<any> ) => RandomStream; // tslint:disable-line: max-line-length
290
+ factory( alpha: number, beta: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;
291
291
 
292
292
  /**
293
293
  * Returns a function for creating readable streams which generate pseudorandom numbers drawn from an inverse gamma distribution.
@@ -312,7 +312,7 @@ interface Constructor {
312
312
  * streams.push( createStream( 2.0, 5.0 ) );
313
313
  * }
314
314
  */
315
- factory( options?: Options ): ( alpha: number, beta: number ) => RandomStream; // tslint:disable-line: max-line-length
315
+ factory( options?: Options ): ( alpha: number, beta: number ) => RandomStream;
316
316
 
317
317
  /**
318
318
  * Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from an inverse gamma distribution.
@@ -327,7 +327,7 @@ interface Constructor {
327
327
  * @returns stream instance
328
328
  *
329
329
  * @example
330
- * var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
330
+ * var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
331
331
  *
332
332
  * function log( v ) {
333
333
  * console.log( v );
@@ -357,7 +357,7 @@ interface Constructor {
357
357
  * @returns stream instance
358
358
  *
359
359
  * @example
360
- * var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
360
+ * var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
361
361
  *
362
362
  * function log( chunk ) {
363
363
  * console.log( chunk.toString() );
@@ -372,7 +372,7 @@ interface Constructor {
372
372
  * stream.pipe( inspectStream( log ) );
373
373
  *
374
374
  * @example
375
- * var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
375
+ * var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
376
376
  *
377
377
  * function log( chunk ) {
378
378
  * console.log( chunk.toString() );
@@ -388,7 +388,7 @@ interface Constructor {
388
388
  * stream.pipe( inspectStream( log ) );
389
389
  *
390
390
  * @example
391
- * var inspectStream = require( `@stdlib/streams/node/inspect-sink` );
391
+ * var inspectStream = require( '@stdlib/streams-node-inspect-sink' );
392
392
  *
393
393
  * function log( v ) {
394
394
  * console.log( v );
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/random-streams-invgamma",
3
- "version": "0.1.0",
3
+ "version": "0.2.1",
4
4
  "description": "Create a readable stream for generating pseudorandom numbers drawn from an inverse gamma distribution.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -15,19 +15,12 @@
15
15
  ],
16
16
  "main": "./lib",
17
17
  "directories": {
18
- "benchmark": "./benchmark",
19
18
  "doc": "./docs",
20
- "example": "./examples",
21
19
  "lib": "./lib",
22
- "test": "./test"
20
+ "dist": "./dist"
23
21
  },
24
22
  "types": "./docs/types",
25
- "scripts": {
26
- "test": "make test",
27
- "test-cov": "make test-cov",
28
- "examples": "make examples",
29
- "benchmark": "make benchmark"
30
- },
23
+ "scripts": {},
31
24
  "homepage": "https://stdlib.io",
32
25
  "repository": {
33
26
  "type": "git",
@@ -37,35 +30,30 @@
37
30
  "url": "https://github.com/stdlib-js/stdlib/issues"
38
31
  },
39
32
  "dependencies": {
40
- "@stdlib/assert-has-own-property": "^0.1.0",
41
- "@stdlib/assert-is-boolean": "^0.1.0",
42
- "@stdlib/assert-is-error": "^0.1.0",
43
- "@stdlib/assert-is-nonnegative-integer": "^0.1.0",
44
- "@stdlib/assert-is-nonnegative-number": "^0.1.0",
45
- "@stdlib/assert-is-plain-object": "^0.1.0",
46
- "@stdlib/assert-is-positive-integer": "^0.1.0",
47
- "@stdlib/assert-is-positive-number": "^0.1.0",
48
- "@stdlib/assert-is-string": "^0.1.0",
49
- "@stdlib/buffer-from-string": "^0.1.0",
50
- "@stdlib/object-assign": "^0.1.0",
51
- "@stdlib/random-base-invgamma": "^0.1.0",
52
- "@stdlib/string-format": "^0.1.0",
53
- "@stdlib/utils-define-nonenumerable-property": "^0.1.0",
54
- "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
55
- "@stdlib/utils-define-read-only-accessor": "^0.1.0",
56
- "@stdlib/utils-define-read-write-accessor": "^0.1.0",
57
- "@stdlib/utils-inherit": "^0.1.0",
58
- "@stdlib/utils-next-tick": "^0.1.0",
33
+ "@stdlib/assert-has-own-property": "^0.2.1",
34
+ "@stdlib/assert-is-boolean": "^0.2.1",
35
+ "@stdlib/assert-is-error": "^0.2.1",
36
+ "@stdlib/assert-is-nonnegative-integer": "^0.2.1",
37
+ "@stdlib/assert-is-nonnegative-number": "^0.2.1",
38
+ "@stdlib/assert-is-plain-object": "^0.2.1",
39
+ "@stdlib/assert-is-positive-integer": "^0.2.1",
40
+ "@stdlib/assert-is-positive-number": "^0.2.1",
41
+ "@stdlib/assert-is-string": "^0.2.1",
42
+ "@stdlib/buffer-from-string": "^0.2.1",
43
+ "@stdlib/object-assign": "^0.2.1",
44
+ "@stdlib/random-base-invgamma": "^0.2.1",
45
+ "@stdlib/string-format": "^0.2.1",
46
+ "@stdlib/utils-define-nonenumerable-property": "^0.2.1",
47
+ "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1",
48
+ "@stdlib/utils-define-read-only-accessor": "^0.2.1",
49
+ "@stdlib/utils-define-read-write-accessor": "^0.2.1",
50
+ "@stdlib/utils-inherit": "^0.2.1",
51
+ "@stdlib/utils-next-tick": "^0.2.1",
59
52
  "debug": "^2.6.9",
60
- "readable-stream": "^2.1.4"
61
- },
62
- "devDependencies": {
63
- "@stdlib/streams-node-inspect-sink": "^0.1.0",
64
- "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
65
- "proxyquire": "^2.0.0",
66
- "istanbul": "^0.4.1",
67
- "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
53
+ "readable-stream": "^2.1.4",
54
+ "@stdlib/error-tools-fmtprodmsg": "^0.2.1"
68
55
  },
56
+ "devDependencies": {},
69
57
  "engines": {
70
58
  "node": ">=0.10.0",
71
59
  "npm": ">2.7.0"
package/CITATION.cff DELETED
@@ -1,30 +0,0 @@
1
- cff-version: 1.2.0
2
- title: stdlib
3
- message: >-
4
- If you use this software, please cite it using the
5
- metadata from this file.
6
-
7
- type: software
8
-
9
- authors:
10
- - name: The Stdlib Authors
11
- url: https://github.com/stdlib-js/stdlib/graphs/contributors
12
-
13
- repository-code: https://github.com/stdlib-js/stdlib
14
- url: https://stdlib.io
15
-
16
- abstract: |
17
- Standard library for JavaScript and Node.js.
18
-
19
- keywords:
20
- - JavaScript
21
- - Node.js
22
- - TypeScript
23
- - standard library
24
- - scientific computing
25
- - numerical computing
26
- - statistical computing
27
-
28
- license: Apache-2.0 AND BSL-1.0
29
-
30
- date-released: 2016