Skip to content

docs: replace manual for loop in examples #6608

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 9, 2025
+78 −98
Merged

docs: replace manual for loop in examples #6608

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0977cf9
docs: replace manual for loop in examples
hrshya Apr 8, 2025
41dfd53
Apply suggestions from code review
kgryte Apr 9, 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/ceil10/README.md
View file
Original file line number Diff line number Diff line change
@@ -98,18 +98,16 @@ v = ceil10( 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 ceil10 = require( '@stdlib/math/base/special/ceil10' );

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

</section>
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/ceil10/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -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 ceil10 = 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 = ceil10( x );
console.log( 'x: %d. Rounded: %d.', x, v );
}
logEachMap( 'x: %0.4f. Rounded: %0.4f.', x, ceil10 );
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/ceil2/README.md
View file
Original file line number Diff line number Diff line change
@@ -83,18 +83,16 @@ v = ceil2( 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 ceil2 = require( '@stdlib/math/base/special/ceil2' );

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

</section>
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/ceil2/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -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 ceil2 = 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 = ceil2( x );
console.log( 'x: %d. Rounded: %d.', x, v );
}
logEachMap( 'x: %0.4f. Rounded: %0.4f.', x, ceil2 );
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/ceilsd/README.md
View file
Original file line number Diff line number Diff line change
@@ -65,18 +65,16 @@ v = ceilsd( 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 ceilsd = require( '@stdlib/math/base/special/ceilsd' );

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

for ( i = 0; i < 100; i++ ) {
x = (randu()*10000.0) - 5000.0;
y = ceilsd( 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, ceilsd );
```

</section>
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/ceilsd/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -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 ceilsd = require( './../lib' );

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

for ( i = 0; i < 100; i++ ) {
x = (randu()*10000.0) - 5000.0;
y = ceilsd( 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, ceilsd );
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/clamp/README.md
View file
Original file line number Diff line number Diff line change
@@ -95,20 +95,18 @@ v = clamp( 3.14, 0.0, NaN );
<!-- eslint no-undef: "error" -->

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

var min;
var max;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var min = discreteUniform( 100, 0, 10, opts );
var max = discreteUniform( 100, 5, 15, opts );
var v = discreteUniform( 100, -20, 20, opts );

for ( i = 0; i < 100; i++ ) {
min = discreteUniform( 0.0, 10.0 );
max = discreteUniform( 5.0, 15.0 );
v = discreteUniform( -20.0, 20.0 );
console.log( 'clamp(%d,%d,%d) => %d', v, min, max, clamp( v, min, max ) );
}
logEachMap( 'clamp(%d,%d,%d) => %d', v, min, max, clamp );
```

</section>
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/clamp/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -18,17 +18,15 @@

'use strict';

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

var min;
var max;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var min = discreteUniform( 100, 0, 10, opts );
var max = discreteUniform( 100, 5, 15, opts );
var v = discreteUniform( 100, -20, 20, opts );

for ( i = 0; i < 100; i++ ) {
min = discreteUniform( 0.0, 10.0 );
max = discreteUniform( 5.0, 15.0 );
v = discreteUniform( -20.0, 20.0 );
console.log( 'clamp(%d,%d,%d) => %d', v, min, max, clamp( v, min, max ) );
}
logEachMap( 'clamp(%d,%d,%d) => %d', v, min, max, clamp );
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/clampf/README.md
View file
Original file line number Diff line number Diff line change
@@ -95,20 +95,18 @@ v = clampf( 3.14, 0.0, NaN );
<!-- eslint no-undef: "error" -->

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

var min;
var max;
var v;
var i;
var opts = {
'dtype': 'float32'
};
var min = discreteUniform( 100, 0, 10, opts );
var max = discreteUniform( 100, 5, 15, opts );
var v = discreteUniform( 100, -20, 20, opts );

for ( i = 0; i < 100; i++ ) {
min = discreteUniform( 0.0, 10.0 );
max = discreteUniform( 5.0, 15.0 );
v = discreteUniform( -20.0, 20.0 );
console.log( 'clampf(%d,%d,%d) => %d', v, min, max, clampf( v, min, max ) );
}
logEachMap( 'clampf(%d,%d,%d) => %d', v, min, max, clampf );
```

</section>
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/clampf/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -18,17 +18,15 @@

'use strict';

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

var min;
var max;
var v;
var i;
var opts = {
'dtype': 'float32'
};
var min = discreteUniform( 100, 0, 10, opts );
var max = discreteUniform( 100, 5, 15, opts );
var v = discreteUniform( 100, -20, 20, opts );

for ( i = 0; i < 100; i++ ) {
min = discreteUniform( 0.0, 10.0 );
max = discreteUniform( 5.0, 15.0 );
v = discreteUniform( -20.0, 20.0 );
console.log( 'clampf(%d,%d,%d) => %d', v, min, max, clampf( v, min, max ) );
}
logEachMap( 'clampf(%d,%d,%d) => %d', v, min, max, clampf );