Skip to content

refactor: update math/base/assert/is-odd to follow latest project conventions #4670

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 1 commit into from
Jan 19, 2025
Merged

refactor: update math/base/assert/is-odd to follow latest project conventions #4670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions lib/node_modules/@stdlib/math/base/assert/is-odd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,18 +85,20 @@ bool = isOdd( 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 isOdd = require( '@stdlib/math/base/assert/is-odd' );

var bool;
var len;
var x;
var i;

len = 100;
x = discreteUniform( len, 0, 1000 );

for ( i = 0; i < 100; i++ ) {
x = round( randu()*100.0 );
bool = isOdd( x );
console.log( '%d is %s', x, ( bool ) ? 'odd' : 'not odd' );
bool = isOdd( x[ i ] );
console.log( '%d is %s', x[ i ], ( bool ) ? 'odd' : 'not odd' );
}
```

Expand Down
10 changes: 6 additions & 4 deletions lib/node_modules/@stdlib/math/base/assert/is-odd/benchmark/benchmark.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var pkg = require( './../package.json' ).name;
var isOdd = require( './../lib' );
Expand All @@ -31,14 +30,17 @@ var isOdd = require( './../lib' );
// MAIN //

bench( pkg, function benchmark( b ) {
var len;
var x;
var y;
var i;

len = 100;
x = discreteUniform( len, 5.0e6, -5.0e6 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = round( (randu()*1.0e7) - 5.0e6 );
y = isOdd( x );
y = isOdd( x[ i % len ] );
if ( typeof y !== 'boolean' ) {
b.fail( 'should return a boolean' );
}
Expand Down
10 changes: 6 additions & 4 deletions lib/node_modules/@stdlib/math/base/assert/is-odd/benchmark/benchmark.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;
Expand All @@ -40,14 +39,17 @@ var opts = {
// MAIN //

bench( pkg+'::native', opts, function benchmark( b ) {
var len;
var x;
var y;
var i;

len = 100;
x = discreteUniform( len, 5.0e6, -5.0e6 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = round( (randu()*1.0e7) - 5.0e6 );
y = isOdd( x );
y = isOdd( x[ i % len ] );
if ( typeof y !== 'boolean' ) {
b.fail( 'should return a boolean' );
}
Expand Down
9 changes: 6 additions & 3 deletions lib/node_modules/@stdlib/math/base/assert/is-odd/benchmark/c/native/benchmark.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,18 @@ static double rand_double( void ) {
*/
static double benchmark( void ) {
double elapsed;
double x;
double x[ 100 ];
double t;
bool b;
int i;

for ( i = 0; i < 100; i++ ) {
x[ i ] = round( (rand_double()*200.0) - 100.0 );
}

t = tic();
for ( i = 0; i < ITERATIONS; i++ ) {
x = ( rand_double() * 200.0 ) - 100.0;
b = stdlib_base_is_odd( x );
b = stdlib_base_is_odd( x[ i % 100 ] );
if ( b != true && b != false ) {
printf( "should return either true or false\n" );
break;
Expand Down
12 changes: 7 additions & 5 deletions lib/node_modules/@stdlib/math/base/assert/is-odd/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,18 @@

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

var bool;
var len;
var x;
var i;

len = 100;
x = discreteUniform( len, 0, 1000 );

for ( i = 0; i < 100; i++ ) {
x = round( randu()*100.0 );
bool = isOdd( x );
console.log( '%d is %s', x, ( bool ) ? 'odd' : 'not odd' );
bool = isOdd( x[ i ] );
console.log( '%d is %s', x[ i ], ( bool ) ? 'odd' : 'not odd' );
}
41 changes: 40 additions & 1 deletion lib/node_modules/@stdlib/math/base/assert/is-odd/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"options": {},
"options": {
"task": "build"
},
"fields": [
{
"field": "src",
Expand All @@ -24,6 +26,43 @@
],
"confs": [
{
"task": "build",
"src": [
"./src/main.c"
],
"include": [
"./include"
],
"libraries": [
"-lm"
],
"libpath": [],
"dependencies": [
"@stdlib/math/base/assert/is-even",
"@stdlib/napi/export",
"@stdlib/napi/argv",
"@stdlib/napi/argv-double",
"@stdlib/napi/create-int32"
]
},
{
"task": "benchmark",
"src": [
"./src/main.c"
],
"include": [
"./include"
],
"libraries": [
"-lm"
],
"libpath": [],
"dependencies": [
"@stdlib/math/base/assert/is-even"
]
},
{
"task": "examples",
"src": [
"./src/main.c"
],
Expand Down
65 changes: 9 additions & 56 deletions lib/node_modules/@stdlib/math/base/assert/is-odd/src/addon.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@
*/

#include "stdlib/math/base/assert/is_odd.h"
#include "stdlib/napi/argv.h"
#include "stdlib/napi/argv_double.h"
#include "stdlib/napi/create_int32.h"
#include "stdlib/napi/export.h"
#include <node_api.h>
#include <stdint.h>
#include <assert.h>

/**
* Receives JavaScript callback invocation data.
Expand All @@ -29,60 +32,10 @@
* @return Node-API value
*/
static napi_value addon( napi_env env, napi_callback_info info ) {
napi_status status;

// Get callback arguments:
size_t argc = 1;
napi_value argv[ 1 ];
status = napi_get_cb_info( env, info, &argc, argv, NULL, NULL );
assert( status == napi_ok );

// Check whether we were provided the correct number of arguments:
if ( argc < 1 ) {
status = napi_throw_error( env, NULL, "invalid invocation. Insufficient arguments." );
assert( status == napi_ok );
return NULL;
}
if ( argc > 1 ) {
status = napi_throw_error( env, NULL, "invalid invocation. Too many arguments." );
assert( status == napi_ok );
return NULL;
}

napi_valuetype vtype0;
status = napi_typeof( env, argv[ 0 ], &vtype0 );
assert( status == napi_ok );
if ( vtype0 != napi_number ) {
status = napi_throw_type_error( env, NULL, "invalid argument. First argument must be a number." );
assert( status == napi_ok );
return NULL;
}

double x;
status = napi_get_value_double( env, argv[ 0 ], &x );
assert( status == napi_ok );

bool result = stdlib_base_is_odd( x );

napi_value v;
status = napi_create_int32( env, (int32_t)result, &v );
assert( status == napi_ok );

return v;
}

/**
* Initializes a Node-API module.
*
* @param env environment under which the function is invoked
* @param exports exports object
* @return main export
*/
static napi_value init( napi_env env, napi_value exports ) {
napi_value fcn;
napi_status status = napi_create_function( env, "exports", NAPI_AUTO_LENGTH, addon, NULL, &fcn );
assert( status == napi_ok );
return fcn;
STDLIB_NAPI_ARGV( env, info, argv, argc, 1 );
STDLIB_NAPI_ARGV_DOUBLE( env, x, argv, 0 );
STDLIB_NAPI_CREATE_INT32( env, (int32_t)stdlib_base_is_odd( x ), out );
return out;
}

NAPI_MODULE( NODE_GYP_MODULE_NAME, init )
STDLIB_NAPI_MODULE_EXPORT_FCN( addon )
16 changes: 8 additions & 8 deletions lib/node_modules/@stdlib/math/base/assert/is-odd/test/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ tape( 'the function returns `false` if provided an even number', function test(
x = round( randu()*1.0e6 ) - 5.0e5;
x *= 2; // always even
bool = isOdd( x );
t.equal( bool, false, 'returns false when provided '+x );
t.equal( bool, false, 'returns expected value when provided '+x );
}
t.end();
});
Expand All @@ -59,29 +59,29 @@ tape( 'the function returns `true` if provided an odd number', function test( t
x += 1;
}
bool = isOdd( x );
t.equal( bool, true, 'returns true when provided '+x );
t.equal( bool, true, 'returns expected value when provided '+x );
}
t.end();
});

tape( 'the function returns `false` if provided `+-0`', function test( t ) {
t.equal( isOdd( +0.0 ), false, 'returns false' );
t.equal( isOdd( -0.0 ), false, 'returns false' );
t.equal( isOdd( +0.0 ), false, 'returns expected value' );
t.equal( isOdd( -0.0 ), false, 'returns expected value' );
t.end();
});

tape( 'WARNING: the function returns `true` if provided `+infinity`', function test( t ) {
t.equal( isOdd( PINF ), true, 'returns true' );
t.equal( isOdd( PINF ), true, 'returns expected value' );
t.end();
});

tape( 'WARNING: the function returns `true` if provided `-infinity`', function test( t ) {
t.equal( isOdd( NINF ), true, 'returns true' );
t.equal( isOdd( NINF ), true, 'returns expected value' );
t.end();
});

tape( 'the function returns `false` if provided `NaN`', function test( t ) {
t.equal( isOdd( NaN ), false, 'returns false' );
t.equal( isOdd( 0.0/0.0 ), false, 'returns false' );
t.equal( isOdd( NaN ), false, 'returns expected value' );
t.equal( isOdd( 0.0/0.0 ), false, 'returns expected value' );
t.end();
});
16 changes: 8 additions & 8 deletions lib/node_modules/@stdlib/math/base/assert/is-odd/test/test.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ tape( 'the function returns `false` if provided an even number', opts, function
x = round( randu()*1.0e6 ) - 5.0e5;
x *= 2; // always even
bool = isOdd( x );
t.equal( bool, false, 'returns false when provided '+x );
t.equal( bool, false, 'returns expected value when provided '+x );
}
t.end();
});
Expand All @@ -68,29 +68,29 @@ tape( 'the function returns `true` if provided an odd number', opts, function te
x += 1;
}
bool = isOdd( x );
t.equal( bool, true, 'returns true when provided '+x );
t.equal( bool, true, 'returns expected value when provided '+x );
}
t.end();
});

tape( 'the function returns `false` if provided `+-0`', opts, function test( t ) {
t.equal( isOdd( +0.0 ), false, 'returns false' );
t.equal( isOdd( -0.0 ), false, 'returns false' );
t.equal( isOdd( +0.0 ), false, 'returns expected value' );
t.equal( isOdd( -0.0 ), false, 'returns expected value' );
t.end();
});

tape( 'WARNING: the function returns `true` if provided `+infinity`', opts, function test( t ) {
t.equal( isOdd( PINF ), true, 'returns true' );
t.equal( isOdd( PINF ), true, 'returns expected value' );
t.end();
});

tape( 'WARNING: the function returns `true` if provided `-infinity`', opts, function test( t ) {
t.equal( isOdd( NINF ), true, 'returns true' );
t.equal( isOdd( NINF ), true, 'returns expected value' );
t.end();
});

tape( 'the function returns `false` if provided `NaN`', opts, function test( t ) {
t.equal( isOdd( NaN ), false, 'returns false' );
t.equal( isOdd( 0.0/0.0 ), false, 'returns false' );
t.equal( isOdd( NaN ), false, 'returns expected value' );
t.equal( isOdd( 0.0/0.0 ), false, 'returns expected value' );
t.end();
});
Loading