Skip to content

docs: replace manual for loop in examples #6496

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 2, 2025
Merged

docs: replace manual for loop in examples #6496

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
b6b3bd6
docs: replace manual for loop in examples
hrshya Apr 1, 2025
8ccb12c
removes trailing spaces
hrshya Apr 1, 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
15 changes: 7 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/sqrt/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 = sqrt( -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 sqrt = require( '@stdlib/math/base/special/sqrt' );

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( 'sqrt(%d) = %d', x, sqrt( x ) );
}
logEachMap( 'sqrt(%d) = %0.4f', x, sqrt );
```

</section>
Expand Down
15 changes: 7 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/sqrt/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 sqrt = 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( 'sqrt(%d) = %d', x, sqrt( x ) );
}
logEachMap( 'sqrt(%d) = %0.4f', x, sqrt );
19 changes: 9 additions & 10 deletions lib/node_modules/@stdlib/math/base/special/sqrt1pm1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ var sqrt1pm1 = require( '@stdlib/math/base/special/sqrt1pm1' );

#### sqrt1pm1( x )

Computes `sqrt( 1 + x ) - 1` more accurately for small `x`.
Computes `sqrt( 1 + x ) - 1` more accurately for small `x`.

```javascript
var v = sqrt1pm1( 3.0 );
Expand Down Expand Up @@ -65,17 +65,16 @@ v = sqrt1pm1( 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 sqrt1pm1 = require( '@stdlib/math/base/special/sqrt1pm1' );

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( 'sqrt(1+%d) - 1 = %d', x, sqrt1pm1( x ) );
}
logEachMap( 'sqrt(1+%d) - 1 = %0.4f', x, sqrt1pm1 );
```

</section>
Expand Down Expand Up @@ -110,7 +109,7 @@ for ( i = 0; i < 100; i++ ) {

#### stdlib_base_sqrt1pm1( x )

Computes `sqrt( 1 + x ) - 1` more accurately for small `x`.
Computes `sqrt( 1 + x ) - 1` more accurately for small `x`.

```c
double out = stdlib_base_sqrt1pm1( 3.0 );
Expand Down
15 changes: 7 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/sqrt1pm1/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 sqrt1pm1 = 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( 'sqrt(1+%d) - 1 = %d', x, sqrt1pm1( x ) );
}
logEachMap( 'sqrt(1+%d) - 1 = %0.4f', x, sqrt1pm1 );
15 changes: 7 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/sqrtf/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 = sqrtf( -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 sqrtf = require( '@stdlib/math/base/special/sqrtf' );

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

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

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

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

for ( i = 0; i < 100; i++ ) {
x = round( randu() * 100.0 );
console.log( 'sqrt(%d) = %d', x, sqrtf( x ) );
}
logEachMap( 'sqrt(%d) = %0.4f', x, sqrtf );
14 changes: 7 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/sqrtpi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,16 @@ var v = sqrtpi( -4.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 sqrtpi = require( '@stdlib/math/base/special/sqrtpi' );

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

for ( i = 0; i < 100; i++ ) {
x = discreteUniform( 0, 100 );
console.log( 'sqrtpi(%d) = %d', x, sqrtpi( x ) );
}
logEachMap( 'sqrtpi(%d) = %0.4f', x, sqrtpi );
```

</section>
Expand Down
14 changes: 7 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/sqrtpi/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 discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var sqrtpi = require( './../lib' );

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

for ( i = 0; i < 100; i++ ) {
x = discreteUniform( 0, 100 );
console.log( 'sqrtpi(%d) = %d', x, sqrtpi( x ) );
}
logEachMap( 'sqrtpi(%d) = %0.4f', x, sqrtpi );
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/sqrtpif/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,16 @@ var v = sqrtpif( -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 sqrtpif = require( '@stdlib/math/base/special/sqrtpif' );

var x = randu( 100, 0.0, 100.0 );
var opts = {
'dtype': 'float32'
};
var x = discreteUniform( 100, 0, 100, opts );

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

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

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

var x = randu( 100, 0.0, 100.0 );
var opts = {
'dtype': 'float32'
};
var x = discreteUniform( 100, 0, 100, opts );

var i;
for ( i = 0; i < 100; i++ ) {
console.log( 'sqrtpif(%d) = %d', x[ i ], sqrtpif( x[ i ] ) );
}
logEachMap( 'sqrtpif(%d) = %0.4f', x, sqrtpif );
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/trigamma/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,18 +97,16 @@ var v = trigamma( 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 trigamma = require( '@stdlib/math/base/special/trigamma' );

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

for ( i = 0; i < 10; i++ ) {
x = (randu()*100.0) - 50.0;
v = trigamma( x );
console.log( 'x: %d, ψ^(1)(x): %d', x, v );
}
logEachMap( 'x: %0.4f, ψ^(1)(x): %0.4f', x, trigamma );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/trigamma/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 trigamma = 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 = trigamma( x );
console.log( 'x: %d, ψ^(1)(x): %d', x, v );
}
logEachMap( 'x: %0.4f, ψ^(1)(x): %0.4f', x, trigamma );