Skip to content

docs: replace manual for loop in examples #6182

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 5 commits into from
Mar 21, 2025
Merged

docs: replace manual for loop in examples #6182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9c9627d
docs: update examples to avoid explicit for loops
anandkaranubc Mar 18, 2025
5b48d69
docs: update examples to avoid explicit for loops
anandkaranubc Mar 19, 2025
ec1793a
docs: change %d to %f
anandkaranubc Mar 20, 2025
dd017a8
docs: fix use of %d
anandkaranubc Mar 21, 2025
1585b5e
docs: fix use of %f
anandkaranubc Mar 21, 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
14 changes: 6 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/abs2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,15 @@ v = abs2( 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 abs2 = require( '@stdlib/math/base/special/abs2' );

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

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

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

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

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

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 100.0 ) - 50.0;
console.log( 'abs2(%d) = %d', x, abs2( x ) );
}
logEachMap( 'abs2(%d) = %d', x, abs2 );
14 changes: 6 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/abs2f/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,15 @@ v = abs2f( 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 abs2f = require( '@stdlib/math/base/special/abs2f' );

var x;
var i;
var x = discreteUniform( 100, -50, 50, {
'dtype': 'float32'
});

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

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

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

var x;
var i;
var x = discreteUniform( 100, -50, 50, {
'dtype': 'float32'
});

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 100.0 ) - 50.0;
console.log( 'abs2f(%d) = %d', x, abs2f( x ) );
}
logEachMap( 'abs2f(%d) = %d', x, abs2f );
14 changes: 6 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/absf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,17 +83,15 @@ v = absf( 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 absf = require( '@stdlib/math/base/special/absf' );

var rand;
var i;
var x = discreteUniform( 100, -50, 50, {
'dtype': 'float32'
});

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

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

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

var rand;
var i;
var x = discreteUniform( 100, -50, 50, {
'dtype': 'float32'
});

for ( i = 0; i < 100; i++ ) {
rand = round( randu() * 100.0 ) - 50.0;
console.log( 'absf(%d) = %d', rand, absf( rand ) );
}
logEachMap( 'absf(%d) = %d', x, absf );
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/acos/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,15 @@ var v = acos( -3.14 );
<!-- eslint no-undef: "error" -->

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

var x = linspace( -1.0, 1.0, 100 );
var x = uniform( 100, -1.0, 1.0, {
'dtype': 'float64'
});

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

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

'use strict';

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

var x = linspace( -1.0, 1.0, 100 );
var x = uniform( 100, -1.0, 1.0, {
'dtype': 'float64'
});

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'acos(%d) = %d', x[ i ], acos( x[ i ] ) );
}
logEachMap( 'acos(%0.4f) = %0.4f', x, acos );
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/acosd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,15 @@ var v = acosd( -3.14 );
<!-- eslint no-undef: "error" -->

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

var x = linspace( -1.0, 1.0, 100 );
var x = uniform( 100, -1.0, 1.0, {
'dtype': 'float64'
});

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

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

'use strict';

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

var x = linspace( -1.0, 1.0, 100 );
var x = uniform( 100, -1.0, 1.0, {
'dtype': 'float64'
});

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'acosd(%d) = %d', x[ i ], acosd( x[ i ] ) );
}
logEachMap( 'acosd(%0.4f) = %0.4f', x, acosd );
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/acosdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,15 @@ var v = acosdf( -3.14 );
<!-- eslint no-undef: "error" -->

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

var x = linspace( -1.0, 1.0, 100 );
var x = uniform( 100, -1.0, 1.0, {
'dtype': 'float32'
});

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

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

'use strict';

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

var x = linspace( -1.0, 1.0, 100 );
var x = uniform( 100, -1.0, 1.0, {
'dtype': 'float32'
});

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'acosdf(%d) = %d', x[ i ], acosdf( x[ i ] ) );
}
logEachMap( 'acosdf(%0.4f) = %0.4f', x, acosdf );
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/acosf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,15 @@ var v = acosf( -3.14 );
<!-- eslint no-undef: "error" -->

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

var x = linspace( -1.0, 1.0, 100 );
var x = uniform( 100, -1.0, 1.0, {
'dtype': 'float32'
});

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

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

'use strict';

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

var x = linspace( -1.0, 1.0, 100 );
var x = uniform( 100, -1.0, 1.0, {
'dtype': 'float32'
});

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'acosf(%d) = %d', x[ i ], acosf( x[ i ] ) );
}
logEachMap( 'acosf(%0.4f) = %0.4f', x, acosf );
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/acosh/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ var v = acosh( 0.0 );
<!-- eslint no-undef: "error" -->

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

var x = linspace( 1.0, 5.0, 100 );
var x = uniform( 100, 1.0, 5.0, {
'dtype': 'float64'
});

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

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

'use strict';

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

var x = linspace( 1.0, 5.0, 100 );
var x = uniform( 100, 1.0, 5.0, {
'dtype': 'float64'
});

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'acosh( %d ) = %d', x[ i ], acosh( x[ i ] ) );
}
logEachMap( 'acosh(%0.4f) = %0.4f', x, acosh );
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/acot/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ v = acot( Infinity );
<!-- eslint no-undef: "error" -->

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

var x = linspace( -5.0, 5.0, 100 );
var x = uniform( 100, -5.0, 5.0, {
'dtype': 'float64'
});

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

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

'use strict';

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

var x = linspace( -5.0, 5.0, 100 );
var x = uniform( 100, -5.0, 5.0, {
'dtype': 'float64'
});

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'acot(%d) = %d', x[ i ], acot( x[ i ] ) );
}
logEachMap( 'acot(%0.4f) = %0.4f', x, acot );
Loading