Skip to content

docs: update examples in math/base/special/minabsf #2873

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
Sep 6, 2024
Merged

docs: update examples in math/base/special/minabsf #2873

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5b3060
refactor: use random/array/uniform in examples, style fixes in math/b…
gunjjoshi Sep 6, 2024
3c71a02
Apply suggestions from code review
kgryte Sep 6, 2024
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
21 changes: 13 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/minabsf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ var minabsf = require( '@stdlib/math/base/special/minabsf' );
Returns the minimum absolute single-precision floating-point number.

```javascript
var v = minabsf( -4.2, 3.14 );
// returns ~3.14
var v = minabsf( -4.0, 3.0 );
// returns 3.0

v = minabsf( +0.0, -0.0 );
// returns +0.0
Expand Down Expand Up @@ -83,19 +83,24 @@ v = minabsf( NaN, 3.14 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var randu = require( '@stdlib/random/array/uniform' );
var minabsf = require( '@stdlib/math/base/special/minabsf' );

var opts = {
'dtype': 'float32'
};

var x;
var y;
var v;
var i;

x = randu( 100, -500.0, 500.0, opts );
y = randu( 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 = minabsf( x, y );
console.log( 'minabsf(%d,%d) = %d', x, y, v );
v = minabsf( x[ i ], y[ i ] );
console.log( 'minabsf(%d,%d) = %d', x[ i ], y[ i ], v );
}
```

Expand Down Expand Up @@ -178,7 +183,7 @@ int main( void ) {
float y;
float v;
int i;

for ( i = 0; i < 100; i++ ) {
x = ( ( (float)rand() / (float)RAND_MAX ) * 1000.0f ) - 500.0f;
y = ( ( (float)rand() / (float)RAND_MAX ) * 1000.0f ) - 500.0f;
Expand Down
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/math/base/special/minabsf/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

{{alias}}( x, y )
Returns the minimum absolute absolute single-precision
floating-point number.
Returns the minimum absolute single-precision floating-point
number.

If any argument is `NaN`, the function returns `NaN`.

Expand All @@ -20,8 +20,8 @@

Examples
--------
> var v = {{alias}}( 3.14, -4.2 )
~3.14
> var v = {{alias}}( -4.0, 3.0 )
3.0
> v = {{alias}}( 3.14, NaN )
NaN
> v = {{alias}}( +0.0, -0.0 )
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/minabsf/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
* @returns minimum absolute value
*
* @example
* var v = minabsf( -3.14, 4.2 );
* // returns ~3.14
* var v = minabsf( -4.0, 3.0 );
* // returns 3.0
*
* @example
* var v = minabsf( 3.14, NaN );
Expand Down
15 changes: 10 additions & 5 deletions lib/node_modules/@stdlib/math/base/special/minabsf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,22 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var randu = require( '@stdlib/random/array/uniform' );
var minabsf = require( './../lib' );

var opts = {
'dtype': 'float32'
};

var x;
var y;
var v;
var i;

x = randu( 100, -500.0, 500.0, opts );
y = randu( 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 = minabsf( x, y );
console.log( 'minabsf(%d,%d) = %d', x, y, v );
v = minabsf( x[ i ], y[ i ] );
console.log( 'minabsf(%d,%d) = %d', x[ i ], y[ i ], v );
}
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/minabsf/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
* @example
* var minabsf = require( '@stdlib/math/base/special/minabsf' );
*
* var v = minabsf( -3.14, 4.2 );
* // returns ~3.14
* var v = minabsf( -4.0, 3.0 );
* // returns 3.0
*
* v = min( 3.14, NaN );
* // returns NaN
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/minabsf/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
* @returns {number} minimum absolute value
*
* @example
* var v = minabsf( -3.14, 4.2 );
* // returns ~3.14
* var v = minabsf( -4.0, 3.0 );
* // returns 3.0
*
* @example
* var v = minabsf( 3.14, NaN );
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/minabsf/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ var addon = require( './../src/addon.node' );
* @returns {number} minimum absolute value
*
* @example
* var v = minabsf( -4.2, 3.14 );
* // returns ~3.14
* var v = minabsf( -4.0, 3.0 );
* // returns 3.0
*
* @example
* var v = minabsf( 0.0, -0.0 );
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/minabsf/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
*
* @example
* float v = stdlib_base_minabsf( 3.14f, -4.2f );
* // returns ~3.14f
* // returns 3.14f
*
* @example
* float v = stdlib_base_minabsf( 0.0f, -0.0f );
Expand Down
Loading