Skip to content

docs: replace manual for loop in examples #6587

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 3 commits into from
Apr 9, 2025
+46 −46
Merged

docs: replace manual for loop in examples #6587

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a31098
docs: replace manual for loop in examples
hrshya Apr 6, 2025
ab1b19a
fix: resolve lint issue
hrshya Apr 6, 2025
702c187
fix: resolve lint issue
hrshya Apr 6, 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
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/vercos/README.md
View file
Original file line number Diff line number Diff line change
@@ -77,16 +77,17 @@ v = vercos( -3.141592653589793/6.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 TWO_PI = require( '@stdlib/constants/float64/two-pi' );
var vercos = require( '@stdlib/math/base/special/vercos' );

var x = linspace( 0.0, TWO_PI, 100 );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, 0.0, TWO_PI, opts );

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

</section>
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/vercos/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -18,13 +18,14 @@

'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 TWO_PI = require( '@stdlib/constants/float64/two-pi' );
var vercos = require( './../lib' );

var x = linspace( 0.0, TWO_PI, 100 );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, 0.0, TWO_PI, opts );

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'vercos(%d) = %d', x[ i ], vercos( x[ i ] ) );
}
logEachMap( 'vercos(%0.4f) = %0.4f', x, vercos );
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/versin/README.md
View file
Original file line number Diff line number Diff line change
@@ -77,16 +77,17 @@ v = versin( -3.141592653589793/6.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 TWO_PI = require( '@stdlib/constants/float64/two-pi' );
var versin = require( '@stdlib/math/base/special/versin' );

var x = linspace( 0.0, TWO_PI, 100 );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, 0.0, TWO_PI, opts );

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

</section>
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/versin/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -18,13 +18,14 @@

'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 TWO_PI = require( '@stdlib/constants/float64/two-pi' );
var versin = require( './../lib' );

var x = linspace( 0.0, TWO_PI, 100 );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, 0.0, TWO_PI, opts );

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'versin(%d) = %d', x[ i ], versin( x[ i ] ) );
}
logEachMap( 'versin(%0.4f) = %0.4f', x, versin );
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/wrap/README.md
View file
Original file line number Diff line number Diff line change
@@ -106,20 +106,18 @@ var v = wrap( 3.14, 3.0, 3.0 );
<!-- 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 wrap = require( '@stdlib/math/base/special/wrap' );

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( 'wrap(%d,%d,%d) => %d', v, min, max, wrap( v, min, max ) );
}
logEachMap( 'wrap(%d,%d,%d) => %0.4f', v, min, max, wrap );
```

</section>
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/math/base/special/wrap/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 wrap = 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( 'wrap(%d,%d,%d) => %d', v, min, max, wrap( v, min, max ) );
}
logEachMap( 'wrap(%d,%d,%d) => %0.4f', v, min, max, wrap );