Skip to content

Commit 46cbdfe

Browse files
authored
docs: replace manual for loop in examples
PR-URL: #6639 Reviewed-by: Athan Reines <[email protected]>
1 parent df1110f commit 46cbdfe

File tree

10 files changed

+73
-63
lines changed

10 files changed

+73
-63
lines changed

lib/node_modules/@stdlib/math/base/special/kernel-cos/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ v = kernelCos( NaN, 0.0 );
5858

5959
- For increased accuracy, the number for which the [cosine][cosine] should be evaluated can be supplied as a [double-double number][double-double-arithmetic] (i.e., a non-evaluated sum of two [double-precision floating-point numbers][ieee754] `x` and `y`).
6060

61-
- As components of a [double-double number][double-double-arithmetic], the two [double-precision floating-point numbers][ieee754] `x` and `y` must satisfy
61+
- As components of a [double-double number][double-double-arithmetic], the two [double-precision floating-point numbers][ieee754] `x` and `y` must satisfy
6262

6363
<!-- <equation class="equation" label="eq:double_double_inequality" align="center" raw="|y| \leq \frac{1}{2} \operatorname{ulp}(x)" alt="Inequality for the two components of a double-double number."> -->
6464

@@ -82,16 +82,17 @@ v = kernelCos( NaN, 0.0 );
8282
<!-- eslint no-undef: "error" -->
8383

8484
```javascript
85-
var linspace = require( '@stdlib/array/base/linspace' );
85+
var uniform = require( '@stdlib/random/array/uniform' );
86+
var logEachMap = require( '@stdlib/console/log-each-map' );
8687
var PI = require( '@stdlib/constants/float64/pi' );
8788
var kernelCos = require( '@stdlib/math/base/special/kernel-cos' );
8889

89-
var x = linspace( -PI/4.0, PI/4.0, 100 );
90+
var opts = {
91+
'dtype': 'float64'
92+
};
93+
var x = uniform( 100, -PI/4.0, PI/4.0, opts );
9094

91-
var i;
92-
for ( i = 0; i < x.length; i++ ) {
93-
console.log( 'kernelCos(%d) = %d', x[ i ], kernelCos( x[ i ], 0.0 ) );
94-
}
95+
logEachMap( 'kernelCos(%0.4f, %0.4f) = %0.4f', x, 0.0, kernelCos );
9596
```
9697

9798
</section>

lib/node_modules/@stdlib/math/base/special/kernel-cos/examples/index.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@
1818

1919
'use strict';
2020

21-
var linspace = require( '@stdlib/array/base/linspace' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var PI = require( '@stdlib/constants/float64/pi' );
2324
var kernelCos = require( './../lib' );
2425

25-
var x = linspace( -PI/4.0, PI/4.0, 100 );
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 100, -PI/4.0, PI/4.0, opts );
2630

27-
var i;
28-
for ( i = 0; i < x.length; i++ ) {
29-
console.log( 'kernelCos(%d) = %d', x[ i ], kernelCos( x[ i ], 0.0 ) );
30-
}
31+
logEachMap( 'kernelCos(%0.4f, %0.4f) = %0.4f', x, 0.0, kernelCos );

lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,16 +66,17 @@ v = kernelLog1p( NaN );
6666
<!-- eslint no-undef: "error" -->
6767

6868
```javascript
69-
var linspace = require( '@stdlib/array/base/linspace' );
69+
var uniform = require( '@stdlib/random/array/uniform' );
70+
var logEachMap = require( '@stdlib/console/log-each-map' );
7071
var sqrt = require( '@stdlib/math/base/special/sqrt' );
7172
var kernelLog1p = require( '@stdlib/math/base/special/kernel-log1p' );
7273

73-
var x = linspace( sqrt( 2.0 ) / 2.0, sqrt( 2.0 ), 100 );
74+
var opts = {
75+
'dtype': 'float64'
76+
};
77+
var x = uniform( 100, sqrt( 2.0 ) / 2.0, sqrt( 2.0 ), opts );
7478

75-
var i;
76-
for ( i = 0; i < x.length; i++ ) {
77-
console.log( 'kernelLog1p(%d) = %d', x[ i ], kernelLog1p( x[ i ] ) );
78-
}
79+
logEachMap( 'kernelLog1p(%0.4f) = %0.4f', x, kernelLog1p );
7980
```
8081

8182
</section>

lib/node_modules/@stdlib/math/base/special/kernel-log1p/examples/index.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@
1818

1919
'use strict';
2020

21-
var linspace = require( '@stdlib/array/base/linspace' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var sqrt = require( '@stdlib/math/base/special/sqrt' );
2324
var kernelLog1p = require( './../lib' );
2425

25-
var x = linspace( sqrt( 2.0 ) / 2.0, sqrt( 2.0 ), 100 );
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 100, sqrt( 2.0 ) / 2.0, sqrt( 2.0 ), opts );
2630

27-
var i;
28-
for ( i = 0; i < x.length; i++ ) {
29-
console.log( 'kernelLog1p(%d) = %d', x[ i ], kernelLog1p( x[ i ] ) );
30-
}
31+
logEachMap( 'kernelLog1p(%0.4f) = %0.4f', x, kernelLog1p );

lib/node_modules/@stdlib/math/base/special/kernel-sin/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ v = kernelSin( NaN, NaN );
6464

6565
- For increased accuracy, the number for which the [sine][sine] should be evaluated can be supplied as a [double-double number][double-double-arithmetic] (i.e., a non-evaluated sum of two [double-precision floating-point numbers][ieee754] `x` and `y`).
6666

67-
- As components of a [double-double number][double-double-arithmetic], the two [double-precision floating-point numbers][ieee754] `x` and `y` must satisfy
67+
- As components of a [double-double number][double-double-arithmetic], the two [double-precision floating-point numbers][ieee754] `x` and `y` must satisfy
6868

6969
<!-- <equation class="equation" label="eq:double_double_inequality" align="center" raw="|y| \leq \frac{1}{2} \operatorname{ulp}(x)" alt="Inequality for the two components of a double-double number."> -->
7070

@@ -88,16 +88,17 @@ v = kernelSin( NaN, NaN );
8888
<!-- eslint no-undef: "error" -->
8989

9090
```javascript
91-
var linspace = require( '@stdlib/array/base/linspace' );
91+
var uniform = require( '@stdlib/random/array/uniform' );
92+
var logEachMap = require( '@stdlib/console/log-each-map' );
9293
var PI = require( '@stdlib/constants/float64/pi' );
9394
var kernelSin = require( '@stdlib/math/base/special/kernel-sin' );
9495

95-
var x = linspace( -PI/4.0, PI/4.0, 100 );
96+
var opts = {
97+
'dtype': 'float64'
98+
};
99+
var x = uniform( 100, -PI/4.0, PI/4.0, opts );
96100

97-
var i;
98-
for ( i = 0; i < x.length; i++ ) {
99-
console.log( 'sine(%d) = %d', x[ i ], kernelSin( x[ i ], 0.0 ) );
100-
}
101+
logEachMap( 'sine(%0.4f, %0.4f) = %0.4f', x, 0.0, kernelSin );
101102
```
102103

103104
</section>
@@ -179,7 +180,7 @@ double stdlib_base_kernel_sin( const double x, const double y );
179180
180181
int main( void ) {
181182
const double x[] = { -0.7853981633974483, -0.6108652381980153, -0.4363323129985824, -0.26179938779914946, -0.08726646259971649, 0.08726646259971649, 0.26179938779914935, 0.43633231299858233, 0.6108652381980153, 0.7853981633974483 };
182-
183+
183184
double out;
184185
int i;
185186
for ( i = 0; i < 10; i++ ) {

lib/node_modules/@stdlib/math/base/special/kernel-sin/examples/index.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@
1818

1919
'use strict';
2020

21-
var linspace = require( '@stdlib/array/base/linspace' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var PI = require( '@stdlib/constants/float64/pi' );
2324
var kernelSin = require( './../lib' );
2425

25-
var x = linspace( -PI/4.0, PI/4.0, 100 );
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 100, -PI/4.0, PI/4.0, opts );
2630

27-
var i;
28-
for ( i = 0; i < x.length; i++ ) {
29-
console.log( 'sine(%d) = %d', x[ i ], kernelSin( x[ i ], 0.0 ) );
30-
}
31+
logEachMap( 'sine(%0.4f, %0.4f) = %0.4f', x, 0.0, kernelSin );

lib/node_modules/@stdlib/math/base/special/kronecker-delta/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,16 @@ v = kroneckerDelta( NaN, NaN );
8383
<!-- eslint no-undef: "error" -->
8484

8585
```javascript
86-
var linspace = require( '@stdlib/array/base/linspace' );
86+
var uniform = require( '@stdlib/random/array/uniform' );
87+
var logEachMap = require( '@stdlib/console/log-each-map' );
8788
var kroneckerDelta = require( '@stdlib/math/base/special/kronecker-delta' );
8889

89-
var x = linspace( -1.0, 1.0, 101 );
90+
var opts = {
91+
'dtype': 'float64'
92+
};
93+
var x = uniform( 101, -1.0, 1.0, opts );
9094

91-
var i;
92-
for ( i = 0; i < x.length; i++ ) {
93-
console.log( 'kronecker(%d,%d) = %d', x[ i ], 0.0, kroneckerDelta( x[ i ], 0.0 ) );
94-
}
95+
logEachMap( 'kronecker(%0.4f,%0.4f) = %0.4f', x, 0.0, kroneckerDelta );
9596
```
9697

9798
</section>

lib/node_modules/@stdlib/math/base/special/kronecker-delta/examples/index.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@
1818

1919
'use strict';
2020

21-
var linspace = require( '@stdlib/array/base/linspace' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var kroneckerDelta = require( './../lib' );
2324

24-
var x = linspace( -1.0, 1.0, 101 );
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 101, -1.0, 1.0, opts );
2529

26-
var i;
27-
for ( i = 0; i < x.length; i++ ) {
28-
console.log( 'kronecker(%d,%d) = %d', x[ i ], 0.0, kroneckerDelta( x[ i ], 0.0 ) );
29-
}
30+
logEachMap( 'kronecker(%0.4f,%0.4f) = %0.4f', x, 0.0, kroneckerDelta );

lib/node_modules/@stdlib/math/base/special/kronecker-deltaf/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,16 @@ v = kroneckerDeltaf( NaN, NaN );
8383
<!-- eslint no-undef: "error" -->
8484

8585
```javascript
86-
var linspace = require( '@stdlib/array/base/linspace' );
86+
var uniform = require( '@stdlib/random/array/uniform' );
87+
var logEachMap = require( '@stdlib/console/log-each-map' );
8788
var kroneckerDeltaf = require( '@stdlib/math/base/special/kronecker-deltaf' );
8889

89-
var x = linspace( -1.0, 1.0, 101 );
90+
var opts = {
91+
'dtype': 'float32'
92+
};
93+
var x = uniform( 101, -1.0, 1.0, opts );
9094

91-
var i;
92-
for ( i = 0; i < x.length; i++ ) {
93-
console.log( 'kronecker(%d,%d) = %d', x[ i ], 0.0, kroneckerDeltaf( x[ i ], 0.0 ) );
94-
}
95+
logEachMap( 'kronecker(%0.4f,%0.4f) = %0.4f', x, 0.0, kroneckerDeltaf );
9596
```
9697

9798
</section>

lib/node_modules/@stdlib/math/base/special/kronecker-deltaf/examples/index.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@
1818

1919
'use strict';
2020

21-
var linspace = require( '@stdlib/array/base/linspace' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var kroneckerDeltaf = require( './../lib' );
2324

24-
var x = linspace( -1.0, 1.0, 101 );
25+
var opts = {
26+
'dtype': 'float32'
27+
};
28+
var x = uniform( 101, -1.0, 1.0, opts );
2529

26-
var i;
27-
for ( i = 0; i < x.length; i++ ) {
28-
console.log( 'kronecker(%d,%d) = %d', x[ i ], 0.0, kroneckerDeltaf( x[ i ], 0.0 ) );
29-
}
30+
logEachMap( 'kronecker(%0.4f,%0.4f) = %0.4f', x, 0.0, kroneckerDeltaf );

0 commit comments

Comments
 (0)