@stdlib/math-base-napi-unary 0.0.7 → 0.0.9

package/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # unary
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
 > C APIs for registering a Node-API module exporting interfaces for invoking unary numerical functions.
 
@@ -108,16 +108,6 @@ console.log( headerDir );
 
 <!-- C usage documentation. -->
 
-<section class="installation">
-
-## Installation
-
-```bash
-npm install @stdlib/math-base-napi-unary
-```
-
-</section>
-
 <section class="usage">
 
 ### Usage
@@ -204,9 +194,169 @@ The function accepts the following arguments:
 void stdlib_math_base_napi_f_f( napi_env env, napi_callback_info info, float (*fcn)( float ) );
 ```
 
+#### stdlib_math_base_napi_z_z( env, info, fcn )
+
+Invokes a unary function accepting and returning double-precision complex floating-point numbers.
+
+```c
+#include "stdlib/complex/float64.h"
+#include <node_api.h>
+
+// ...
+
+static stdlib_complex128_t identity( const stdlib_complex128_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_z_z( 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] stdlib_complex128_t (*fcn)( stdlib_complex128_t )` unary function.
+
+```c
+void stdlib_math_base_napi_z_z( napi_env env, napi_callback_info info, stdlib_complex128_t (*fcn)( stdlib_complex128_t ) );
+```
+
+#### stdlib_math_base_napi_z_d( env, info, fcn )
+
+Invokes a unary function accepting a double-precision complex floating-point number and returning a double-precision floating-point number.
+
+```c
+#include "stdlib/complex/float64.h"
+#include <node_api.h>
+
+// ...
+
+static double fcn( const stdlib_complex128_t 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_z_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)( stdlib_complex128_t )` unary function.
+
+```c
+void stdlib_math_base_napi_z_d( napi_env env, napi_callback_info info, double (*fcn)( stdlib_complex128_t ) );
+```
+
+#### stdlib_math_base_napi_c_c( env, info, fcn )
+
+Invokes a unary function accepting and returning single-precision complex floating-point numbers.
+
+```c
+#include "stdlib/complex/float32.h"
+#include <node_api.h>
+
+// ...
+
+static stdlib_complex64_t identity( const stdlib_complex64_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_c_c( 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] stdlib_complex64_t (*fcn)( stdlib_complex64_t )` unary function.
+
+```c
+void stdlib_math_base_napi_c_c( napi_env env, napi_callback_info info, stdlib_complex64_t (*fcn)( stdlib_complex64_t ) );
+```
+
+#### stdlib_math_base_napi_c_f( env, info, fcn )
+
+Invokes a unary function accepting a single-precision complex floating-point number and returning a single-precision floating-point number.
+
+```c
+#include "stdlib/complex/float32.h"
+#include <node_api.h>
+
+// ...
+
+static float fcn( const stdlib_complex64_t 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_c_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)( stdlib_complex64_t )` unary function.
+
+```c
+void stdlib_math_base_napi_c_f( napi_env env, napi_callback_info info, float (*fcn)( stdlib_complex64_t ) );
+```
+
 #### stdlib_math_base_napi_i_i( env, info, fcn )
 
-Invokes a unary function accepting and returning 32-bit signed integers.
+Invokes a unary function accepting and returning signed 32-bit integers.
 
 ```c
 #include <node_api.h>
@@ -244,6 +394,46 @@ 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_i_d( env, info, fcn )
+
+Invokes a unary function accepting a signed 32-bit integer and returning a single-precision floating-point number.
+
+```c
+#include <node_api.h>
+#include <stdint.h>
+
+// ...
+
+static double scale( const int32_t x ) {
+    return x * 10.0;
+}
+
+// ...
+
+/**
+* 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_i_d( env, info, scale );
+}
+
+// ...
+```
+
+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 )` unary function.
+
+```c
+void stdlib_math_base_napi_i_i( napi_env env, napi_callback_info info, double (*fcn)( int32_t ) );
+```
+
 #### STDLIB_MATH_BASE_NAPI_MODULE_D_D( fcn )
 
 Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning double-precision floating-point numbers.
@@ -286,6 +476,116 @@ 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_Z_Z( fcn )
+
+Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning double-precision complex floating-point numbers.
+
+```c
+#include "stdlib/complex/float64.h"
+#include "stdlib/complex/reim.h"
+
+static stdlib_complex128_t scale( const stdlib_complex128_t x ) {
+    double re;
+    double im;
+
+    stdlib_reim( x, &re, &im );
+
+    re *= 10.0;
+    im *= 10.0;
+
+    return stdlib_complex128( re, im );
+}
+
+// ...
+
+// Register a Node-API module:
+STDLIB_MATH_BASE_NAPI_MODULE_Z_Z( scale );
+```
+
+The macro expects the following arguments:
+
+-   **fcn**: `stdlib_complex128_t (*fcn)( stdlib_complex128_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_MODULE_Z_D( fcn )
+
+Macro for registering a Node-API module exporting an interface for invoking a unary function accepting a double-precision complex floating-point number and returning a double-precision floating-point number.
+
+```c
+#include "stdlib/complex/float64.h"
+
+static double fcn( const stdlib_complex128_t x ) {
+    // ...
+}
+
+// ...
+
+// Register a Node-API module:
+STDLIB_MATH_BASE_NAPI_MODULE_Z_D( fcn );
+```
+
+The macro expects the following arguments:
+
+-   **fcn**: `double (*fcn)( stdlib_complex128_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_MODULE_C_C( fcn )
+
+Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning single-precision complex floating-point numbers.
+
+```c
+#include "stdlib/complex/float32.h"
+#include "stdlib/complex/reimf.h"
+
+static stdlib_complex64_t scale( const stdlib_complex64_t x ) {
+    float re;
+    float im;
+
+    stdlib_reimf( x, &re, &im );
+
+    re *= 10.0f;
+    im *= 10.0f;
+
+    return stdlib_complex64( re, im );
+}
+
+// ...
+
+// Register a Node-API module:
+STDLIB_MATH_BASE_NAPI_MODULE_C_C( scale );
+```
+
+The macro expects the following arguments:
+
+-   **fcn**: `stdlib_complex64_t (*fcn)( stdlib_complex64_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_MODULE_C_F( fcn )
+
+Macro for registering a Node-API module exporting an interface for invoking a unary function accepting a single-precision complex floating-point number and returning a single-precision floating-point number.
+
+```c
+#include "stdlib/complex/float32.h"
+
+static float fcn( const stdlib_complex64_t x ) {
+    // ...
+}
+
+// ...
+
+// Register a Node-API module:
+STDLIB_MATH_BASE_NAPI_MODULE_C_F( fcn );
+```
+
+The macro expects the following arguments:
+
+-   **fcn**: `float (*fcn)( stdlib_complex64_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_MODULE_I_I( fcn )
 
 Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning 32-bit signed integers.
@@ -309,6 +609,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_I_D( fcn )
+
+Macro for registering a Node-API module exporting an interface for invoking a unary function accepting a signed 32-bit integer and returning a double-precision floating-point number.
+
+```c
+#include <stdint.h>
+
+static double scale( const int32_t x ) {
+    return x * 10.0;
+}
+
+// ...
+
+// Register a Node-API module:
+STDLIB_MATH_BASE_NAPI_MODULE_I_D( scale );
+```
+
+The macro expects the following arguments:
+
+-   **fcn**: `double (*fcn)( int32_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.
+
 </section>
 
 <!-- /.usage -->
@@ -321,7 +644,7 @@ When used, this macro should be used **instead of** `NAPI_MODULE`. The macro inc
 
 -   The C-API functions expect that the callback `info` argument provides access to the following JavaScript arguments:
 
-    -   `x`: input value.
+    -   **x**: input value.
 
 </section>
 
@@ -347,6 +670,14 @@ When used, this macro should be used **instead of** `NAPI_MODULE`. The macro inc
 
 <!-- /.references -->
 
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 
@@ -373,7 +704,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -386,17 +717,21 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-napi-unary.svg
 [npm-url]: https://npmjs.org/package/@stdlib/math-base-napi-unary
 
-[test-image]: https://github.com/stdlib-js/math-base-napi-unary/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/math-base-napi-unary/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/math-base-napi-unary/actions/workflows/test.yml/badge.svg?branch=v0.0.9
+[test-url]: https://github.com/stdlib-js/math-base-napi-unary/actions/workflows/test.yml?query=branch:v0.0.9
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-napi-unary/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/math-base-napi-unary?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/math-base-napi-unary.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/math-base-napi-unary/main
 
+-->
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib