Skip to content

Commit 4e5bf6f

Browse files
gunjjoshikgryte
andauthored
docs: update examples
PR-URL: #2875 Ref: ff629c7#r146363058 Ref: ff629c7#r146363086 Ref: ff629c7#r146363121 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>
1 parent f13d569 commit 4e5bf6f

File tree

8 files changed

+34
-30
lines changed

8 files changed

+34
-30
lines changed

lib/node_modules/@stdlib/math/base/special/maxabsf/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ var maxabsf = require( '@stdlib/math/base/special/maxabsf' );
4545
Returns the maximum absolute single-precision floating-point number.
4646

4747
```javascript
48-
var v = maxabsf( -4.2, 3.14 );
49-
// returns ~4.2
48+
var v = maxabsf( -4.0, 3.0 );
49+
// returns 4.0
5050

5151
v = maxabsf( +0.0, -0.0 );
5252
// returns +0.0
@@ -83,19 +83,21 @@ v = maxabsf( NaN, 3.14 );
8383
<!-- eslint no-undef: "error" -->
8484

8585
```javascript
86-
var randu = require( '@stdlib/random/base/randu' );
86+
var randu = require( '@stdlib/random/array/uniform' );
8787
var maxabsf = require( '@stdlib/math/base/special/maxabsf' );
8888

89-
var x;
90-
var y;
89+
var opts = {
90+
'dtype': 'float32'
91+
};
92+
93+
var x = randu( 100, -500.0, 500.0, opts );
94+
var y = randu( 100, -500.0, 500.0, opts );
95+
9196
var v;
9297
var i;
93-
9498
for ( i = 0; i < 100; i++ ) {
95-
x = ( randu() * 1000.0 ) - 500.0;
96-
y = ( randu() * 1000.0 ) - 500.0;
97-
v = maxabsf( x, y );
98-
console.log( 'maxabsf(%d,%d) = %d', x, y, v );
99+
v = maxabsf( x[ i ], y[ i ] );
100+
console.log( 'maxabsf(%d,%d) = %d', x[ i ], y[ i ], v );
99101
}
100102
```
101103

@@ -178,7 +180,7 @@ int main( void ) {
178180
float y;
179181
float v;
180182
int i;
181-
183+
182184
for ( i = 0; i < 100; i++ ) {
183185
x = ( ( (float)rand() / (float)RAND_MAX ) * 1000.0f ) - 500.0f;
184186
y = ( ( (float)rand() / (float)RAND_MAX ) * 1000.0f ) - 500.0f;

lib/node_modules/@stdlib/math/base/special/maxabsf/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919

2020
Examples
2121
--------
22-
> var v = {{alias}}( 3.14, -4.2 )
23-
~4.2
22+
> var v = {{alias}}( -4.0, 3.0 )
23+
4.0
2424
> v = {{alias}}( 3.14, NaN )
2525
NaN
2626
> v = {{alias}}( +0.0, -0.0 )

lib/node_modules/@stdlib/math/base/special/maxabsf/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
* @returns maximum absolute value
2727
*
2828
* @example
29-
* var v = maxabsf( 3.14, -4.2 );
30-
* // returns 4.2
29+
* var v = maxabsf( -4.0, 3.0 );
30+
* // returns 4.0
3131
*
3232
* @example
3333
* var v = maxabsf( 3.14, NaN );

lib/node_modules/@stdlib/math/base/special/maxabsf/examples/index.js

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,19 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var randu = require( '@stdlib/random/array/uniform' );
2222
var maxabsf = require( './../lib' );
2323

24-
var x;
25-
var y;
24+
var opts = {
25+
'dtype': 'float32'
26+
};
27+
28+
var x = randu( 100, -500.0, 500.0, opts );
29+
var y = randu( 100, -500.0, 500.0, opts );
30+
2631
var v;
2732
var i;
28-
2933
for ( i = 0; i < 100; i++ ) {
30-
x = ( randu() * 1000.0 ) - 500.0;
31-
y = ( randu() * 1000.0 ) - 500.0;
32-
v = maxabsf( x, y );
33-
console.log( 'maxabsf(%d,%d) = %d', x, y, v );
34+
v = maxabsf( x[ i ], y[ i ] );
35+
console.log( 'maxabsf(%d,%d) = %d', x[ i ], y[ i ], v );
3436
}

lib/node_modules/@stdlib/math/base/special/maxabsf/lib/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
* @example
2727
* var maxabsf = require( '@stdlib/math/base/special/maxabsf' );
2828
*
29-
* var v = maxabsf( 3.14, -4.2 );
30-
* // returns ~4.2
29+
* var v = maxabsf( -4.0, 3.0 );
30+
* // returns 4.0
3131
*
3232
* v = maxabsf( 3.14, NaN );
3333
* // returns NaN

lib/node_modules/@stdlib/math/base/special/maxabsf/lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
3535
* @returns {number} maximum absolute value
3636
*
3737
* @example
38-
* var v = maxabsf( 3.14, -4.2 );
39-
* // returns ~4.2
38+
* var v = maxabsf( -4.0, 3.0 );
39+
* // returns 4.0
4040
*
4141
* @example
4242
* var v = maxabsf( 3.14, NaN );

lib/node_modules/@stdlib/math/base/special/maxabsf/lib/native.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ var addon = require( './../src/addon.node' );
3434
* @returns {number} maximum absolute value
3535
*
3636
* @example
37-
* var v = maxabsf( -4.2, 3.14 );
38-
* // returns ~4.2
37+
* var v = maxabsf( -4.0, 3.0 );
38+
* // returns 4.0
3939
*
4040
* @example
4141
* var v = maxabsf( 0.0, -0.0 );

lib/node_modules/@stdlib/math/base/special/maxabsf/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
*
3030
* @example
3131
* float v = stdlib_base_maxabsf( 3.14f, -4.2f );
32-
* // returns ~4.2f
32+
* // returns 4.2f
3333
*
3434
* @example
3535
* float v = stdlib_base_maxabsf( 0.0f, -0.0f );

0 commit comments

Comments
 (0)