Skip to content

Commit

Permalink
feat: add III_D macro in math/base/napi/ternary
Browse files Browse the repository at this point in the history
PR-URL: stdlib-js#4855
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]>
  • Loading branch information
2 people authored and Vinit-Pandit committed Feb 4, 2025
1 parent fa90bfe commit ae16cfe
Show file tree
Hide file tree
Showing 5 changed files with 247 additions and 0 deletions.
63 changes: 63 additions & 0 deletions lib/node_modules/@stdlib/math/base/napi/ternary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,69 @@ The function accepts the following arguments:
void stdlib_math_base_napi_iid_d( napi_env env, napi_callback_info info, double (*fcn)( int32_t, int32_t, double ) );
```
#### STDLIB_MATH_BASE_NAPI_MODULE_III_D( fcn )
Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting three signed 32-bit integers and returning a double-precision floating-point number.
```c
#include <stdint.h>
static double fcn( const int32_t x, const int32_t y, const int32_t z ) {
// ...
}
// ...
// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_III_D( fcn );
```

The macro expects the following arguments:

- **fcn**: `double (*fcn)( int32_t, int32_t, int32_t )` ternary function.

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_iii_d( env, info, fcn )

Invokes a ternary function accepting three signed 32-bit integers and returning a double-precision floating-point number.

```c
#include <node_api.h>
#include <stdint.h>

// ...

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

// ...

/**
* 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_iii_d( 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] double (*fcn)( int32_t, int32_t, int32_t )` ternary function.
```c
void stdlib_math_base_napi_iii_d( napi_env env, napi_callback_info info, double (*fcn)( int32_t, int32_t, int32_t ) );
```

#### STDLIB_MATH_BASE_NAPI_MODULE_ZZZ_Z( fcn )

Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting and returning double-precision complex floating-point numbers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
#include "stdlib/math/base/napi/ternary/dii_d.h"
#include "stdlib/math/base/napi/ternary/fff_f.h"
#include "stdlib/math/base/napi/ternary/iid_d.h"
#include "stdlib/math/base/napi/ternary/iii_d.h"
#include "stdlib/math/base/napi/ternary/zzz_z.h"

#endif // !STDLIB_MATH_BASE_NAPI_TERNARY_H
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#ifndef STDLIB_MATH_BASE_NAPI_TERNARY_III_D_H
#define STDLIB_MATH_BASE_NAPI_TERNARY_III_D_H

#include <node_api.h>
#include <assert.h>
#include <stdint.h>

/**
* Macro for registering a Node-API module exporting an interface invoking a ternary function accepting three signed 32-bit integers and returning a double-precision floating-point number.
*
* @param fcn ternary function
*
* @example
* #include <stdint.h>
*
* static double fcn( const int_32 x, const int_32 y, const int_32 z ) {
* // ...
* }
*
* // ...
*
* // Register a Node-API module:
* STDLIB_MATH_BASE_NAPI_MODULE_III_D( fcn );
*/
#define STDLIB_MATH_BASE_NAPI_MODULE_III_D( fcn ) \
static napi_value stdlib_math_base_napi_iii_d_wrapper( \
napi_env env, \
napi_callback_info info \
) { \
return stdlib_math_base_napi_iii_d( env, info, fcn ); \
}; \
static napi_value stdlib_math_base_napi_iii_d_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_iii_d_wrapper, \
NULL, \
&fcn \
); \
assert( status == napi_ok ); \
return fcn; \
}; \
NAPI_MODULE( NODE_GYP_MODULE_NAME, stdlib_math_base_napi_iii_d_init )

/*
* If C++, prevent name mangling so that the compiler emits a ternary file having undecorated names, thus mirroring the behavior of a C compiler.
*/
#ifdef __cplusplus
extern "C" {
#endif

/**
* Invokes a ternary function accepting three signed 32-bit integers and returning a double-precision floating-point number.
*/
napi_value stdlib_math_base_napi_iii_d( napi_env env, napi_callback_info info, double (*fcn)( int32_t, int32_t, int32_t ) );

#ifdef __cplusplus
}
#endif

#endif // !STDLIB_MATH_BASE_NAPI_TERNARY_III_D_H
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"./src/dii_d.c",
"./src/fff_f.c",
"./src/iid_d.c",
"./src/iii_d.c",
"./src/zzz_z.c"
],
"include": [
Expand Down
98 changes: 98 additions & 0 deletions lib/node_modules/@stdlib/math/base/napi/ternary/src/iii_d.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#include "stdlib/math/base/napi/ternary/iii_d.h"
#include <node_api.h>
#include <stdint.h>
#include <assert.h>

/**
* Invokes a ternary function accepting three signed 32-bit integers and returning a double-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.
* - `z`: input value.
*
* @param env environment under which the function is invoked
* @param info callback data
* @param fcn ternary function
* @return function return value as a Node-API double-precision floating-point number
*/
napi_value stdlib_math_base_napi_iii_d( napi_env env, napi_callback_info info, double (*fcn)( int32_t, int32_t, int32_t ) ) {
napi_status status;

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

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

napi_valuetype vtype2;
status = napi_typeof( env, argv[ 2 ], &vtype2 );
assert( status == napi_ok );
if ( vtype2 != napi_number ) {
status = napi_throw_type_error( env, NULL, "invalid argument. Third 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 );

int32_t z;
status = napi_get_value_int32( env, argv[ 2 ], &z );
assert( status == napi_ok );

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

return v;
}

0 comments on commit ae16cfe

Please sign in to comment.