Skip to content

docs: replace manual for loop in examples #6623

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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
+72 −82
Open

docs: replace manual for loop in examples #6623

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
a2126db
docs: replace manual for loop in examples
hrshya Apr 9, 2025
0471a08
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
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/floor10/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,18 +98,16 @@ v = floor10( 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 floor10 = require( '@stdlib/math/base/special/floor10' );

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 = floor10( x );
console.log( 'Value: %d. Rounded: %d.', x, v );
}
logEachMap( 'x: %0.4f. Rounded: %d.', x, floor10 );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/floor10/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 floor10 = 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 = floor10( x );
console.log( 'x: %d. Rounded: %d.', x, v );
}
logEachMap( 'x: %0.4f. Rounded: %d.', x, floor10 );
14 changes: 7 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/floorf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,16 @@ v = floorf( 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 floorf = require( '@stdlib/math/base/special/floorf' );

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

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

</section>
Expand Down
14 changes: 7 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/floorf/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 floorf = require( './../lib' );

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

for ( i = 0; i < 100; i++ ) {
x = (randu()*100.0) - 50.0;
console.log( 'floorf(%d) = %d', x, floorf( x ) );
}
logEachMap( 'floorf(%0.4f) = %d', x, floorf );
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/floorsd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,18 +65,16 @@ v = floorsd( 0.0313, 2, 2 );
<!-- 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 floorsd = require( '@stdlib/math/base/special/floorsd' );

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

for ( i = 0; i < 100; i++ ) {
x = (randu()*10000.0) - 5000.0;
y = floorsd( x, 5, 10 );
console.log( 'x: %d. Rounded: %d.', x, y );
}
logEachMap( 'x: %0.4f. y: %d. z: %d. Rounded: %0.4f.', x, 5, 10, floorsd );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/floorsd/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 floorsd = require( './../lib' );

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

for ( i = 0; i < 100; i++ ) {
x = (randu()*10000.0) - 5000.0;
y = floorsd( x, 5, 10 );
console.log( 'x: %d. Rounded: %d.', x, y );
}
logEachMap( 'x: %0.4f. y: %d. z: %d. Rounded: %0.4f.', x, 5, 10, floorsd );
18 changes: 8 additions & 10 deletions lib/node_modules/@stdlib/math/base/special/fmod/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,19 +83,17 @@ v = fmod( NaN, NaN );
<!-- eslint no-undef: "error" -->

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

var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 100, 0, 10, opts );
var y = discreteUniform( 100, -5, 5, opts );

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 10.0 );
y = round( randu() * 10.0 ) - 5.0;
console.log( '%d%%%d = %d', x, y, fmod( x, y ) );
}
logEachMap( '%d%%%d = %d', x, y, fmod );
```

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

'use strict';

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

var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 100, 0, 10, opts );
var y = discreteUniform( 100, -5, 5, opts );

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 10.0 );
y = round( randu() * 10.0 ) - 5.0;
console.log( '%d%%%d = %d', x, y, fmod( x, y ) );
}
logEachMap( '%d%%%d = %d', x, y, fmod );
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/fmodf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,16 @@ v = fmodf( NaN, NaN );

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

var x = discreteUniform( 10, 0.0, 100.0 );
var y = discreteUniform( 10, -50.0, 50.0 );
var i;
var opts = {
'dtype': 'float32'
};
var x = discreteUniform( 100, 0, 100, opts );
var y = discreteUniform( 100, -50, 50, opts );

for ( i = 0; i < 10; i++ ) {
console.log( '%f%%%f = %f', x[ i ], y[ i ], fmodf( x[ i ], y[ i ] ) );
}
logEachMap( '%d%%%d = %d', x, y, fmodf );
```

</section>
Expand Down
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/fmodf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@
'use strict';

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

var x = discreteUniform( 10, 0.0, 100.0 );
var y = discreteUniform( 10, -50.0, 50.0 );
var i;
var opts = {
'dtype': 'float32'
};
var x = discreteUniform( 100, 0, 100, opts );
var y = discreteUniform( 100, -50, 50, opts );

for ( i = 0; i < 10; i++ ) {
console.log( '%f%%%f = %f', x[ i ], y[ i ], fmodf( x[ i ], y[ i ] ) );
}
logEachMap( '%d%%%d = %d', x, y, fmodf );
Loading