Skip to content

feat: add macros for k_k and s_s #7860

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.

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
Aug 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
126 changes: 126 additions & 0 deletions lib/node_modules/@stdlib/math/base/napi/unary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,132 @@ The function accepts the following arguments:
void stdlib_math_base_napi_i_i( napi_env env, napi_callback_info info, int32_t (*fcn)( int32_t ) );
```

#### STDLIB_MATH_BASE_NAPI_MODULE_K_K( fcn )

Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning 16-bit signed integers.

```c
#include <stdint.h>

static int16_t scale( const int16_t x ) {
return x * 10;
}

// ...

// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_K_K( scale );
```

The macro expects the following arguments:

- **fcn**: `int16_t (*fcn)( int16_t )` unary 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_k_k( env, info, fcn )

Invokes a unary function accepting and returning signed 16-bit integers.

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

// ...

static int16_t identity( const int16_t x ) {
return x;
}

// ...

/**
* 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_k_k( env, info, identity );
}

// ...
```

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] int16_t (*fcn)( int16_t )` unary function.

```c
void stdlib_math_base_napi_k_k( napi_env env, napi_callback_info info, int16_t (*fcn)( int16_t ) );
```

#### STDLIB_MATH_BASE_NAPI_MODULE_S_S( fcn )

Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning 8-bit signed integers.

```c
#include <stdint.h>

static int8_t scale( const int8_t x ) {
return x * 10;
}

// ...

// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_S_S( scale );
```

The macro expects the following arguments:

- **fcn**: `int8_t (*fcn)( int8_t )` unary 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_s_s( env, info, fcn )

Invokes a unary function accepting and returning signed 8-bit integers.

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

// ...

static int8_t identity( const int8_t x ) {
return x;
}

// ...

/**
* 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_s_s( env, info, identity );
}

// ...
```

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] int8_t (*fcn)( int8_t )` unary function.

```c
void stdlib_math_base_napi_s_s( napi_env env, napi_callback_info info, int8_t (*fcn)( int8_t ) );
```

#### STDLIB_MATH_BASE_NAPI_MODULE_T_T( fcn )

Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning 16-bit unsigned integers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
#include "stdlib/math/base/napi/unary/i_d.h"
#include "stdlib/math/base/napi/unary/i_f.h"
#include "stdlib/math/base/napi/unary/i_i.h"
#include "stdlib/math/base/napi/unary/k_k.h"
#include "stdlib/math/base/napi/unary/s_s.h"
#include "stdlib/math/base/napi/unary/t_t.h"
#include "stdlib/math/base/napi/unary/u_u.h"
#include "stdlib/math/base/napi/unary/z_d.h"
Expand Down
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_UNARY_K_K_H
#define STDLIB_MATH_BASE_NAPI_UNARY_K_K_H

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

/**
* Macro for registering a Node-API module exporting an interface invoking a unary function accepting and returning 16-bit signed integers.
*
* @param fcn unary function
*
* @example
* #include <stdint.h>
*
* static int16_t scale( const int16_t x ) {
* return x * 10;
* }
*
* // ...
*
* // Register a Node-API module:
* STDLIB_MATH_BASE_NAPI_MODULE_K_K( scale );
*/
#define STDLIB_MATH_BASE_NAPI_MODULE_K_K( fcn ) \
static napi_value stdlib_math_base_napi_k_k_wrapper( \
napi_env env, \
napi_callback_info info \
) { \
return stdlib_math_base_napi_k_k( env, info, fcn ); \
}; \
static napi_value stdlib_math_base_napi_k_k_init( \
napi_env env, \
napi_value exports \
) { \
napi_value f; \
napi_status status = napi_create_function( \
env, \
"exports", \
NAPI_AUTO_LENGTH, \
stdlib_math_base_napi_k_k_wrapper, \
NULL, \
&f \
); \
assert( status == napi_ok ); \
return f; \
}; \
NAPI_MODULE( NODE_GYP_MODULE_NAME, stdlib_math_base_napi_k_k_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.
*/
#ifdef __cplusplus
extern "C" {
#endif

/**
* Invokes a unary function accepting and returning signed 16-bit integers.
*/
napi_value stdlib_math_base_napi_k_k( napi_env env, napi_callback_info info, int16_t (*fcn)( int16_t ) );

#ifdef __cplusplus
}
#endif

#endif // !STDLIB_MATH_BASE_NAPI_UNARY_K_K_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_UNARY_S_S_H
#define STDLIB_MATH_BASE_NAPI_UNARY_S_S_H

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

/**
* Macro for registering a Node-API module exporting an interface invoking a unary function accepting and returning 8-bit signed integers.
*
* @param fcn unary function
*
* @example
* #include <stdint.h>
*
* static int8_t scale( const int8_t x ) {
* return x * 10;
* }
*
* // ...
*
* // Register a Node-API module:
* STDLIB_MATH_BASE_NAPI_MODULE_S_S( scale );
*/
#define STDLIB_MATH_BASE_NAPI_MODULE_S_S( fcn ) \
static napi_value stdlib_math_base_napi_s_s_wrapper( \
napi_env env, \
napi_callback_info info \
) { \
return stdlib_math_base_napi_s_s( env, info, fcn ); \
}; \
static napi_value stdlib_math_base_napi_s_s_init( \
napi_env env, \
napi_value exports \
) { \
napi_value f; \
napi_status status = napi_create_function( \
env, \
"exports", \
NAPI_AUTO_LENGTH, \
stdlib_math_base_napi_s_s_wrapper, \
NULL, \
&f \
); \
assert( status == napi_ok ); \
return f; \
}; \
NAPI_MODULE( NODE_GYP_MODULE_NAME, stdlib_math_base_napi_s_s_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.
*/
#ifdef __cplusplus
extern "C" {
#endif

/**
* Invokes a unary function accepting and returning signed 8-bit integers.
*/
napi_value stdlib_math_base_napi_s_s( napi_env env, napi_callback_info info, int8_t (*fcn)( int8_t ) );

#ifdef __cplusplus
}
#endif

#endif // !STDLIB_MATH_BASE_NAPI_UNARY_S_S_H
2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/math/base/napi/unary/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
"./src/i_d.c",
"./src/i_f.c",
"./src/i_i.c",
"./src/k_k.c",
"./src/s_s.c",
"./src/t_t.c",
"./src/u_u.c",
"./src/z_d.c",
Expand Down
70 changes: 70 additions & 0 deletions lib/node_modules/@stdlib/math/base/napi/unary/src/k_k.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/**
* @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/unary/k_k.h"
#include <node_api.h>
#include <assert.h>
#include <stdint.h>

/**
* Invokes a unary function accepting and returning signed 16-bit integers.
*
* ## Notes
*
* - This function expects that the callback `info` argument provides access to the following JavaScript arguments:
*
* - `x`: input value.
*
* @param env environment under which the function is invoked
* @param info callback data
* @param fcn unary function
* @return function return value as a Node-API signed 32-bit integer
*/
napi_value stdlib_math_base_napi_k_k( napi_env env, napi_callback_info info, int16_t (*fcn)( int16_t ) ) {
napi_status status;

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

if ( argc < 1 ) {
status = napi_throw_error( env, NULL, "invalid invocation. Must provide a number." );
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. Must provide a number." );
assert( status == napi_ok );
return NULL;
}

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

napi_value v;
status = napi_create_int32( env, (int32_t)fcn( (int16_t)x ), &v );
assert( status == napi_ok );

return v;
}
Loading