Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Dec 3, 2024
1 parent 2ce2a97 commit 2d43846
Show file tree
Hide file tree
Showing 4 changed files with 196 additions and 1 deletion.
25 changes: 24 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<section class="release" id="unreleased">

## Unreleased (2024-12-02)
## Unreleased (2024-12-03)

<section class="packages">

Expand Down Expand Up @@ -32,6 +32,28 @@

<!-- /.package -->

<section class="package" id="math-base-napi-unreleased">

#### [@stdlib/math/base/napi](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/napi)

<details>

<section class="features">

##### Features

- [`7d8ab5a`](https://github.com/stdlib-js/stdlib/commit/7d8ab5a148946f94121316cc1dc5d22936e7ea57) - add `ii_f` API in `math/base/napi/binary` [(#3315)](https://github.com/stdlib-js/stdlib/pull/3315)

</section>

<!-- /.features -->

</details>

</section>

<!-- /.package -->

<section class="package" id="math-base-ops-cdiv-unreleased">

#### [@stdlib/math/base/ops/cdiv](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/cdiv)
Expand Down Expand Up @@ -2618,6 +2640,7 @@ A total of 5 people contributed to this release. Thank you to the following cont

<details>

- [`7d8ab5a`](https://github.com/stdlib-js/stdlib/commit/7d8ab5a148946f94121316cc1dc5d22936e7ea57) - **feat:** add `ii_f` API in `math/base/napi/binary` [(#3315)](https://github.com/stdlib-js/stdlib/pull/3315) _(by Gunj Joshi)_
- [`c0d083d`](https://github.com/stdlib-js/stdlib/commit/c0d083d4329c439d9c002479740518584e5f5977) - **feat:** add `math/base/special/lcmf` _(by Aayush Khanna, stdlib-bot)_
- [`92c0d4e`](https://github.com/stdlib-js/stdlib/commit/92c0d4e65a8ffef2a2264ba906cfe8020c483b13) - **docs:** clean-up and use C floats when appropriate _(by Philipp Burckhardt)_
- [`d24969e`](https://github.com/stdlib-js/stdlib/commit/d24969e35be1cfbff2e0d62d740c451e476ee444) - **chore:** update package meta data [(#3303)](https://github.com/stdlib-js/stdlib/pull/3303) _(by stdlib-bot, Athan Reines)_
Expand Down
63 changes: 63 additions & 0 deletions base/napi/binary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -595,6 +595,46 @@ The function accepts the following arguments:
void stdlib_math_base_napi_ll_d( napi_env env, napi_callback_info info, double (*fcn)( int64_t, int64_t ) );
```
#### stdlib_math_base_napi_ii_f( env, info, fcn )
Invokes a binary function accepting signed 32-bit integers and returning a single-precision floating-point number.
```c
#include <node_api.h>
#include <stdint.h>
// ...
static float fcn( const int32_t x, const int32_t y ) {
// ...
}
// ...
/**
* Receives JavaScript callback invocation data.
*
* @param env environment under which the function is invoked
* @param info callback data
* @return Node-API value
*/
napi_value addon( napi_env env, napi_callback_info info ) {
return stdlib_math_base_napi_ii_f( env, info, fcn );
}
// ...
```

The function accepts the following arguments:

- **env**: `[in] napi_env` environment under which the function is invoked.
- **info**: `[in] napi_callback_info` callback data.
- **fcn**: `[in] float (*fcn)( int32_t, int32_t )` binary function.

```c
void stdlib_math_base_napi_ii_f( napi_env env, napi_callback_info info, float (*fcn)( int32_t, int32_t ) );
```
#### STDLIB_MATH_BASE_NAPI_MODULE_DD_D( fcn )
Macro for registering a Node-API module exporting an interface for invoking a binary function accepting and returning double-precision floating-point numbers.
Expand Down Expand Up @@ -964,6 +1004,29 @@ The macro expects the following arguments:

When used, this macro should be used **instead of** `NAPI_MODULE`. The macro includes `NAPI_MODULE`, thus ensuring Node-API module registration.

#### STDLIB_MATH_BASE_NAPI_MODULE_II_F( fcn )

Macro for registering a Node-API module exporting an interface for invoking a binary function accepting signed 32-bit integers and returning a single-precision floating-point number.

```c
#include <stdint.h>

static float fcn( const int32_t x, const int32_t y ) {
// ...
}

// ...

// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_II_F( fcn );
```
The macro expects the following arguments:
- **fcn**: `float (*fcn)( int32_t, int32_t )` binary function.
When used, this macro should be used **instead of** `NAPI_MODULE`. The macro includes `NAPI_MODULE`, thus ensuring Node-API module registration.
</section>
<!-- /.usage -->
Expand Down
47 changes: 47 additions & 0 deletions base/napi/binary/include/stdlib/math/base/napi/binary.h
Original file line number Diff line number Diff line change
Expand Up @@ -616,6 +616,48 @@
}; \
NAPI_MODULE( NODE_GYP_MODULE_NAME, stdlib_math_base_napi_ll_d_init )

/**
* Macro for registering a Node-API module exporting an interface invoking a binary function accepting signed 32-bit integers and returning a single-precision floating-point number.
*
* @param fcn binary function
*
* @example
* #include <stdint.h>
*
* static float fcn( const int_32 x, const int_32 y ) {
* // ...
* }
*
* // ...
*
* // Register a Node-API module:
* STDLIB_MATH_BASE_NAPI_MODULE_II_F( fcn );
*/
#define STDLIB_MATH_BASE_NAPI_MODULE_II_F( fcn ) \
static napi_value stdlib_math_base_napi_ii_f_wrapper( \
napi_env env, \
napi_callback_info info \
) { \
return stdlib_math_base_napi_ii_f( env, info, fcn ); \
}; \
static napi_value stdlib_math_base_napi_ii_f_init( \
napi_env env, \
napi_value exports \
) { \
napi_value fcn; \
napi_status status = napi_create_function( \
env, \
"exports", \
NAPI_AUTO_LENGTH, \
stdlib_math_base_napi_ii_f_wrapper, \
NULL, \
&fcn \
); \
assert( status == napi_ok ); \
return fcn; \
}; \
NAPI_MODULE( NODE_GYP_MODULE_NAME, stdlib_math_base_napi_ii_f_init )

/*
* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
*/
Expand Down Expand Up @@ -688,6 +730,11 @@ napi_value stdlib_math_base_napi_cf_c( napi_env env, napi_callback_info info, st
*/
napi_value stdlib_math_base_napi_ll_d( napi_env env, napi_callback_info info, double (*fcn)( int64_t, int64_t ) );

/**
* Invokes a binary function accepting signed 32-bit integers and returning a single-precision floating-point number.
*/
napi_value stdlib_math_base_napi_ii_f( napi_env env, napi_callback_info info, float (*fcn)( int32_t, int32_t ) );

#ifdef __cplusplus
}
#endif
Expand Down
62 changes: 62 additions & 0 deletions base/napi/binary/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -1247,3 +1247,65 @@ napi_value stdlib_math_base_napi_ll_d( napi_env env, napi_callback_info info, do

return v;
}

/**
* Invokes a binary function accepting signed 32-bit integers and returning a single-precision floating-point number.
*
* ## Notes
*
* - This function expects that the callback `info` argument provides access to the following JavaScript arguments:
*
* - `x`: input value.
* - `y`: input value.
*
* @param env environment under which the function is invoked
* @param info callback data
* @param fcn binary function
* @return function return value as a Node-API single-precision floating-point number
*/
napi_value stdlib_math_base_napi_ii_f( napi_env env, napi_callback_info info, float (*fcn)( int32_t, int32_t ) ) {
napi_status status;

size_t argc = 2;
napi_value argv[ 2 ];
status = napi_get_cb_info( env, info, &argc, argv, NULL, NULL );
assert( status == napi_ok );

if ( argc < 2 ) {
status = napi_throw_error( env, NULL, "invalid invocation. Must provide two numbers." );
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;
}

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

int32_t x;
status = napi_get_value_int32( env, argv[ 0 ], &x );
assert( status == napi_ok );

int32_t y;
status = napi_get_value_int32( env, argv[ 1 ], &y );
assert( status == napi_ok );

napi_value v;
status = napi_create_double( env, (double)fcn( x, y ), &v );
assert( status == napi_ok );

return v;
}

0 comments on commit 2d43846

Please sign in to comment.