Skip to content

docs: replace manual for loop in examples #6622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 10, 2025
Merged

docs: replace manual for loop in examples #6622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9db1ead
docs: replace manual for loop in examples
hrshya Apr 9, 2025
629de3d
Apply suggestions from code review
kgryte Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/falling-factorial/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,18 @@ v = fallingFactorial( 3.0, -2 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/array/uniform' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var fallingFactorial = require( '@stdlib/math/base/special/falling-factorial' );

var x = randu( 100, -20.0, 20.0 );
var n = discreteUniform( 100, 0, 20 );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -20.0, 20.0, opts );
var n = discreteUniform( 100, 0, 20, opts );

var i;
for ( i = 0; i < 100; i++ ) {
console.log( 'fallingFactorial(%d,%d) = %d', x[ i ], n[ i ], fallingFactorial( x[ i ], n[ i ] ) );
}
logEachMap( 'fallingFactorial(%0.4f,%0.4f) = %d', x, n, fallingFactorial );
```

</section>
Expand Down
15 changes: 8 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/falling-factorial/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@

'use strict';

var randu = require( '@stdlib/random/array/uniform' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var fallingFactorial = require( './../lib' );

var x = randu( 100, -20.0, 20.0 );
var n = discreteUniform( 100, 0, 20 );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -20.0, 20.0, opts );
var n = discreteUniform( 100, 0, 20, opts );

var i;
for ( i = 0; i < 100; i++ ) {
console.log( 'fallingFactorial(%d,%d) = %d', x[ i ], n[ i ], fallingFactorial( x[ i ], n[ i ] ) );
}
logEachMap( 'fallingFactorial(%0.4f,%d) = %0.4f', x, n, fallingFactorial );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/flipsign/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,21 +75,18 @@ z = flipsign( 0.0, -1.0 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var flipsign = require( '@stdlib/math/base/special/flipsign' );

var x;
var y;
var z;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -50.0, 50.0, opts );
var y = uniform( 100, -5.0, 5.0, opts );

// Generate random numbers `x` and `y` and flip the sign of `x` only if `y` is negative...
for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
y = (randu()*10.0) - 5.0;
z = flipsign( x, y );
console.log( 'x: %d, y: %d => %d', x, y, z );
}
logEachMap( 'x: %0.4f, y: %0.4f => %0.4f', x, y, flipsign );
```

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/flipsign/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,15 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var flipsign = require( './../lib' );

var x;
var y;
var z;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -50.0, 50.0, opts );
var y = uniform( 100, -5.0, 5.0, opts );

// Generate random numbers `x` and `y` and flip the sign of `x` only if `y` is negative...
for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
y = (randu()*10.0) - 5.0;
z = flipsign( x, y );
console.log( 'x: %d, y: %d => %d', x, y, z );
}
logEachMap( 'x: %0.4f, y: %0.4f => %0.4f', x, y, flipsign );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/flipsignf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,21 +75,18 @@ z = flipsignf( 0.0, -1.0 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var flipsignf = require( '@stdlib/math/base/special/flipsignf' );

var x;
var y;
var z;
var i;
var opts = {
'dtype': 'float32'
};
var x = uniform( 100, -50.0, 50.0, opts );
var y = uniform( 100, -5.0, 5.0, opts );

// Generate random numbers `x` and `y` and flip the sign of `x` only if `y` is negative...
for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
y = (randu()*10.0) - 5.0;
z = flipsignf( x, y );
console.log( 'x: %d, y: %d => %d', x, y, z );
}
logEachMap( 'x: %0.4f, y: %0.4f => %0.4f', x, y, flipsignf );
```

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/flipsignf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,15 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var flipsignf = require( './../lib' );

var x;
var y;
var z;
var i;
var opts = {
'dtype': 'float32'
};
var x = uniform( 100, -50.0, 50.0, opts );
var y = uniform( 100, -5.0, 5.0, opts );

// Generate random numbers `x` and `y` and flip the sign of `x` only if `y` is negative...
for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
y = (randu()*10.0) - 5.0;
z = flipsignf( x, y );
console.log( 'x: %d, y: %d => %d', x, y, z );
}
logEachMap( 'x: %0.4f, y: %0.4f => %0.4f', x, y, flipsignf );
14 changes: 7 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/floor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,16 @@ v = floor( NaN );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var floor = require( '@stdlib/math/base/special/floor' );

var x;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -50.0, 50.0, opts );

for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
console.log( 'floor(%d) = %d', x, floor( x ) );
}
logEachMap( 'floor(%0.4f) = %d', x, floor );
```

</section>
Expand Down
14 changes: 7 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/floor/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var floor = require( './../lib' );

var x;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -50.0, 50.0, opts );

for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
console.log( 'floor(%d) = %d', x, floor( x ) );
}
logEachMap( 'floor(%0.4f) = %d', x, floor );
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/floor2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,18 +83,16 @@ v = floor2( NaN );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var floor2 = require( '@stdlib/math/base/special/floor2' );

var x;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -50.0, 50.0, opts );

for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
v = floor2( x );
console.log( 'Value: %d. Rounded: %d.', x, v );
}
logEachMap( 'x: %0.4f. Rounded: %d.', x, floor2 );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/floor2/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,13 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var floor2 = require( './../lib' );

var x;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -50.0, 50.0, opts );

for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
v = floor2( x );
console.log( 'x: %d. Rounded: %d.', x, v );
}
logEachMap( 'x: %0.4f. Rounded: %d.', x, floor2 );
Loading