Skip to content

Commit 4300a3c

Browse files
committed
Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop
2 parents 03a4ad7 + 3282bd0 commit 4300a3c

File tree

153 files changed

+9363
-867
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

153 files changed

+9363
-867
lines changed

CONTRIBUTORS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ EuniceSim142 <[email protected]>
2828
Frank Kovacs <[email protected]>
2929
Golden Kumar <[email protected]>
3030
Gunj Joshi <[email protected]>
31+
Gururaj Gurram <[email protected]>
3132
3233
Harshita Kalani <[email protected]>
3334
Hridyanshu <[email protected]>
@@ -44,6 +45,7 @@ Justin Dennison <[email protected]>
4445
Kaif Mohd <[email protected]>
4546
Karthik Prakash <[email protected]>
4647
48+
Kohantika Nath <[email protected]>
4749
Krishnendu Das <[email protected]>
4850
4951
Manik Sharma <[email protected]>
@@ -94,6 +96,7 @@ Tudor Pagu <[email protected]>
9496
Tufailahmed Bargir <[email protected]>
9597
Utkarsh <http://[email protected]>
9698
Utkarsh Raj <[email protected]>
99+
UtkershBasnet <[email protected]>
97100
Vaibhav Patel <[email protected]>
98101
Varad Gupta <[email protected]>
99102
Xiaochuan Ye <[email protected]>

lib/node_modules/@stdlib/_tools/scaffold/math-iter-unary/data/README__md.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ limitations under the License.
1818

1919
-->
2020

21+
<!-- THIS IS A GENERATED FILE. DO NOT EDIT DIRECTLY. -->
22+
2123
# {{ALIAS}}
2224

2325
> {{PKG_DESC}}
@@ -90,11 +92,11 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the
9092
<!-- eslint no-undef: "error" -->
9193

9294
```javascript
93-
var uniform = require( '@stdlib/random/iter/uniform' );
95+
var random = require( '@stdlib/random/iter/{{BASE_PRNG}}' );
9496
var {{ALIAS}} = require( '@{{PKG}}' );
9597

9698
// Create a seeded iterator for generating pseudorandom numbers:
97-
var rand = uniform( {{RAND_MIN}}, {{RAND_MAX}}, {
99+
var rand = random( {{RAND_MIN}}, {{RAND_MAX}}, {
98100
'seed': 1234,
99101
'iter': 10
100102
});
@@ -139,7 +141,7 @@ while ( true ) {
139141

140142
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
141143

142-
[@{{UNARY_PKG}}]: https://github.com/stdlib-js/stdlib
144+
[@{{UNARY_PKG}}]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40{{UNARY_PKG}}
143145

144146
</section>
145147

lib/node_modules/@stdlib/_tools/scaffold/math-iter-unary/data/benchmark/benchmark__js.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@
1616
* limitations under the License.
1717
*/
1818

19+
/* THIS IS A GENERATED FILE. DO NOT EDIT DIRECTLY. */
20+
1921
'use strict';
2022

2123
// MODULES //
2224

2325
var bench = require( '@stdlib/bench' );
24-
var uniform = require( '@stdlib/random/iter/uniform' );
26+
var random = require( '@stdlib/random/iter/{{BASE_PRNG}}' );
2527
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2628
var isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
2729
var pkg = require( './../package.json' ).name;
@@ -35,7 +37,7 @@ bench( pkg, function benchmark( b ) {
3537
var iter;
3638
var i;
3739

38-
rand = uniform( {{RAND_MIN}}, {{RAND_MAX}} );
40+
rand = random( {{RAND_MIN}}, {{RAND_MAX}} );
3941

4042
b.tic();
4143
for ( i = 0; i < b.iterations; i++ ) {
@@ -58,7 +60,7 @@ bench( pkg+'::iteration', function benchmark( b ) {
5860
var z;
5961
var i;
6062

61-
rand = uniform( {{RAND_MIN}}, {{RAND_MAX}} );
63+
rand = random( {{RAND_MIN}}, {{RAND_MAX}} );
6264
iter = {{ALIAS}}( rand );
6365

6466
b.tic();

lib/node_modules/@stdlib/_tools/scaffold/math-iter-unary/data/docs/repl__txt.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@
2525

2626
Examples
2727
--------
28-
> var r = {{alias:@stdlib/random/iter/uniform}}( {{RAND_MIN}}, {{RAND_MAX}} );
28+
> var r = {{alias:@stdlib/random/iter/{{BASE_PRNG}}}}( {{RAND_MIN}}, {{RAND_MAX}} );
2929
> var it = {{alias}}( r );
3030
> var v = it.next().value
31-
<number>
31+
<{{JAVASCRIPT_RETURN_TYPE}}>
3232
> v = it.next().value
33-
<number>
33+
<{{JAVASCRIPT_RETURN_TYPE}}>
3434

3535
See Also
3636
--------

lib/node_modules/@stdlib/_tools/scaffold/math-iter-unary/data/docs/types/index__d__ts.txt

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,13 @@
1616
* limitations under the License.
1717
*/
1818

19+
/* THIS IS A GENERATED FILE. DO NOT EDIT DIRECTLY. */
20+
1921
// TypeScript Version: 4.1
2022

2123
/// <reference types="@stdlib/types"/>
2224

23-
import { TypedIterator as Iter, TypedIterableIterator } from '@stdlib/types/iter';
25+
import { TypedIterator as Iter, TypedIterableIterator as IterableIterator } from '@stdlib/types/iter';
2426

2527
// Define a union type representing both iterable and non-iterable iterators:
2628
type Iterator<T> = Iter<T> | IterableIterator<T>;
@@ -36,22 +38,22 @@ type Iterator<T> = Iter<T> | IterableIterator<T>;
3638
* @returns iterator
3739
*
3840
* @example
39-
* var uniform = require( `@stdlib/random/iter/uniform` );
41+
* var random = require( '@stdlib/random/iter/{{BASE_PRNG}}' );
4042
*
41-
* var iter = {{ALIAS}}( uniform( {{RAND_MIN}}, {{RAND_MAX}} ) );
43+
* var iter = {{ALIAS}}( random( {{RAND_MIN}}, {{RAND_MAX}} ) );
4244
*
4345
* var v = iter.next().value;
44-
* // returns <number>
46+
* // returns <{{JAVASCRIPT_RETURN_TYPE}}>
4547
*
4648
* v = iter.next().value;
47-
* // returns <number>
49+
* // returns <{{JAVASCRIPT_RETURN_TYPE}}>
4850
*
4951
* v = iter.next().value;
50-
* // returns <number>
52+
* // returns <{{JAVASCRIPT_RETURN_TYPE}}>
5153
*
5254
* // ...
5355
*/
54-
declare function {{ALIAS}}( iterator: Iterator<number> ): Iterator<number>;
56+
declare function {{ALIAS}}( iterator: Iterator<{{JAVASCRIPT_RETURN_TYPE}}> ): Iterator<{{JAVASCRIPT_RETURN_TYPE}}>;
5557

5658

5759
// EXPORTS //

lib/node_modules/@stdlib/_tools/scaffold/math-iter-unary/data/docs/types/test__ts.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
* limitations under the License.
1717
*/
1818

19+
/* THIS IS A GENERATED FILE. DO NOT EDIT DIRECTLY. */
20+
1921
import {{ALIAS}} = require( './index' );
2022

2123
/**
@@ -36,7 +38,7 @@ function iterator() {
3638
*/
3739
function next() {
3840
return {
39-
'value': true,
41+
'value': 1.0,
4042
'done': false
4143
};
4244
}
@@ -46,7 +48,7 @@ function next() {
4648

4749
// The function returns an iterator...
4850
{
49-
{{ALIAS}}( iterator() ); // $ExpectType TypedIterator<number>
51+
{{ALIAS}}( iterator() ); // $ExpectType TypedIterator<{{JAVASCRIPT_RETURN_TYPE}}>
5052
}
5153

5254
// The compiler throws an error if the function is provided a first argument which is not an iterator protocol-compliant object...

lib/node_modules/@stdlib/_tools/scaffold/math-iter-unary/data/examples/index__js.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@
1616
* limitations under the License.
1717
*/
1818

19+
/* THIS IS A GENERATED FILE. DO NOT EDIT DIRECTLY. */
20+
1921
'use strict';
2022

21-
var uniform = require( '@stdlib/random/iter/uniform' );
23+
var random = require( '@stdlib/random/iter/{{BASE_PRNG}}' );
2224
var {{ALIAS}} = require( './../lib' );
2325

2426
// Create a seeded iterator for generating pseudorandom numbers:
25-
var rand = uniform( {{RAND_MIN}}, {{RAND_MAX}}, {
27+
var rand = random( {{RAND_MIN}}, {{RAND_MAX}}, {
2628
'seed': 1234,
2729
'iter': 10
2830
});

lib/node_modules/@stdlib/_tools/scaffold/math-iter-unary/data/lib/index__js.txt

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
* limitations under the License.
1717
*/
1818

19+
/* THIS IS A GENERATED FILE. DO NOT EDIT DIRECTLY. */
20+
1921
'use strict';
2022

2123
/**
@@ -24,28 +26,28 @@
2426
* @module @{{PKG}}
2527
*
2628
* @example
27-
* var uniform = require( '@stdlib/random/iter/uniform' );
29+
* var random = require( '@stdlib/random/iter/{{BASE_PRNG}}' );
2830
* var {{ALIAS}} = require( '@{{PKG}}' );
2931
*
30-
* var iter = {{ALIAS}}( uniform( {{RAND_MIN}}, {{RAND_MAX}} ) );
32+
* var iter = {{ALIAS}}( random( {{RAND_MIN}}, {{RAND_MAX}} ) );
3133
*
3234
* var v = iter.next().value;
33-
* // returns <number>
35+
* // returns <{{JAVASCRIPT_RETURN_TYPE}}>
3436
*
3537
* v = iter.next().value;
36-
* // returns <number>
38+
* // returns <{{JAVASCRIPT_RETURN_TYPE}}>
3739
*
3840
* v = iter.next().value;
39-
* // returns <number>
41+
* // returns <{{JAVASCRIPT_RETURN_TYPE}}>
4042
*
4143
* // ...
4244
*/
4345

4446
// MODULES //
4547

46-
var iterator = require( './main.js' );
48+
var main = require( './main.js' );
4749

4850

4951
// EXPORTS //
5052

51-
module.exports = iterator;
53+
module.exports = main;

lib/node_modules/@stdlib/_tools/scaffold/math-iter-unary/data/lib/main__js.txt

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
* limitations under the License.
1717
*/
1818

19+
/* THIS IS A GENERATED FILE. DO NOT EDIT DIRECTLY. */
20+
1921
'use strict';
2022

2123
// MODULES //
@@ -38,18 +40,18 @@ var {{UNARY_ALIAS}} = require( '@{{UNARY_PKG}}' );
3840
* @returns {Iterator} iterator
3941
*
4042
* @example
41-
* var uniform = require( '@stdlib/random/iter/uniform' );
43+
* var random = require( '@stdlib/random/iter/{{BASE_PRNG}}' );
4244
*
43-
* var iter = {{ALIAS}}( uniform( {{RAND_MIN}}, {{RAND_MAX}} ) );
45+
* var iter = {{ALIAS}}( random( {{RAND_MIN}}, {{RAND_MAX}} ) );
4446
*
4547
* var v = iter.next().value;
46-
* // returns <number>
48+
* // returns <{{JAVASCRIPT_RETURN_TYPE}}>
4749
*
4850
* v = iter.next().value;
49-
* // returns <number>
51+
* // returns <{{JAVASCRIPT_RETURN_TYPE}}>
5052
*
5153
* v = iter.next().value;
52-
* // returns <number>
54+
* // returns <{{JAVASCRIPT_RETURN_TYPE}}>
5355
*
5456
* // ...
5557
*/

lib/node_modules/@stdlib/_tools/scaffold/math-iter-unary/data/package__json.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,10 @@
4949
"windows"
5050
],
5151
"keywords": [
52-
"stdlib",{{KEYWORDS}}
52+
"stdlib",
53+
"stdmath",
54+
"math",
55+
"mathematics",{{KEYWORDS}}
5356
"iterator",
5457
"iterable",
5558
"iterate"

0 commit comments

Comments
 (0)