Skip to content

docs: replace manual for loop in examples #6472

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
kgryte merged 1 commit into from
Apr 1, 2025
Merged

docs: replace manual for loop in examples #6472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 7 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/log10/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,17 +90,16 @@ var v = log10( -4.0 );
<!-- 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 log10 = require( '@stdlib/math/base/special/log10' );

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

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 100.0 );
console.log( 'log10(%d) = %d', x, log10( x ) );
}
logEachMap( 'log10(%0.4f) = %0.4f', x, log10 );
Copy link
Member

@Planeshifter Planeshifter Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stdlib-bot This should become

logEachMap( 'log10(%d) = %0.4f', x, log10 );

since we don't want to display decimal points for integers.

```

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

'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 log10 = require( './../lib' );

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

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 100.0 );
console.log( 'log10(%d) = %d', x, log10( x ) );
}
logEachMap( 'log10(%0.4f) = %0.4f', x, log10 );
Copy link
Member

@Planeshifter Planeshifter Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stdlib-bot This should become

logEachMap( 'log10(%d) = %0.4f', x, log10 );

since we don't want to display decimal points for integers.

15 changes: 7 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/log2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,17 +87,16 @@ var v = log2( -4.0 );
<!-- 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 log2 = require( '@stdlib/math/base/special/log2' );

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

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 100.0 );
console.log( 'log2(%d) = %d', x, log2( x ) );
}
logEachMap( 'log2(%0.4f) = %0.4f', x, log2 );
Copy link
Member

@Planeshifter Planeshifter Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stdlib-bot This should become

logEachMap( 'log2(%d) = %0.4f', x, log2 );

since we don't want to display decimal points for integers.

```

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

'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 log2 = require( './../lib' );

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

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 100.0 );
console.log( 'log2(%d) = %d', x, log2( x ) );
}
logEachMap( 'log2(%0.4f) = %0.4f', x, log2 );
Copy link
Member

@Planeshifter Planeshifter Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stdlib-bot This should become

logEachMap( 'log2(%d) = %0.4f', x, log2 );

since we don't want to display decimal points for integers.

13 changes: 5 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/logf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,20 +66,17 @@ v = logf( 2.0, -4.0 );
<!-- eslint no-undef: "error" -->

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

var opts = {
'dtype': 'float32'
};
var x = discreteUniform( 100, 0, 100, opts );
var b = discreteUniform( 100, 0, 5, opts );

var x = randu( 100, 0, 100, opts );
var b = randu( 100, 0, 5, opts );

var i;
for ( i = 0; i < 100; i++ ) {
console.log( 'logf( %d, %d ) = %d', x[ i ], b[ i ], logf( x[ i ], b[ i ] ) );
}
logEachMap( 'logf( %0.4f, %0.4f ) = %0.4f', x, b, logf );
Copy link
Member

@Planeshifter Planeshifter Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stdlib-bot This should become

logEachMap( 'logf( %d, %d ) = %0.4f', x, b, logf );

since we don't want to display decimal points for integers.

```

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

'use strict';

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

var opts = {
'dtype': 'float32'
};
var x = discreteUniform( 100, 0, 100, opts );
var b = discreteUniform( 100, 0, 5, opts );

var x = randu( 100, 0, 100, opts );
var b = randu( 100, 0, 5, opts );

var i;
for ( i = 0; i < 100; i++ ) {
console.log( 'logf( %d, %d ) = %d', x[ i ], b[ i ], logf( x[ i ], b[ i ] ) );
}
logEachMap( 'logf( %0.4f, %0.4f ) = %0.4f', x, b, logf );
Copy link
Member

@Planeshifter Planeshifter Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stdlib-bot This should become

logEachMap( 'logf( %d, %d ) = %0.4f', x, b, logf );

since we don't want to display decimal points for integers.

14 changes: 7 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/logit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,16 +86,16 @@ v = logit( -0.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 logit = require( '@stdlib/math/base/special/logit' );

var p;
var i;
var opts = {
'dtype': 'float64'
};
var p = uniform( 100, 0.0, 1.0, opts );

for ( i = 0; i < 100; i++ ) {
p = randu();
console.log( 'logit(%d) = %d', p, logit( p ) );
}
logEachMap( 'logit(%0.4f) = %0.4f', p, logit );
```

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

var p;
var i;
var opts = {
'dtype': 'float64'
};
var p = uniform( 100, 0.0, 1.0, opts );

for ( i = 0; i < 100; i++ ) {
p = randu();
console.log( 'logit(%d) = %d', p, logit( p ) );
}
logEachMap( 'logit(%0.4f) = %0.4f', p, logit );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/maxabs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,17 @@ v = maxabs( NaN, 3.14 );
<!-- 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 maxabs = require( '@stdlib/math/base/special/maxabs' );

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

for ( i = 0; i < 100; i++ ) {
x = ( randu()*1000.0 ) - 500.0;
y = ( randu()*1000.0 ) - 500.0;
v = maxabs( x, y );
console.log( 'maxabs(%d,%d) = %d', x, y, v );
}
logEachMap( 'maxabs(%0.4f,%0.4f) = %0.4f', x, y, maxabs );
```

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

'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 maxabs = require( './../lib' );

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

for ( i = 0; i < 100; i++ ) {
x = ( randu()*1000.0 ) - 500.0;
y = ( randu()*1000.0 ) - 500.0;
v = maxabs( x, y );
console.log( 'maxabs(%d,%d) = %d', x, y, v );
}
logEachMap( 'maxabs(%0.4f,%0.4f) = %0.4f', x, y, maxabs );
15 changes: 5 additions & 10 deletions lib/node_modules/@stdlib/math/base/special/maxabsf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,22 +83,17 @@ v = maxabsf( NaN, 3.14 );
<!-- 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 maxabsf = require( '@stdlib/math/base/special/maxabsf' );

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

var x = randu( 100, -500.0, 500.0, opts );
var y = randu( 100, -500.0, 500.0, opts );

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

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

'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 maxabsf = require( './../lib' );

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

var x = randu( 100, -500.0, 500.0, opts );
var y = randu( 100, -500.0, 500.0, opts );

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