@stdlib/math-base-napi-unary 0.0.4 → 0.0.8

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2021 The Stdlib Authors.
+Copyright (c) 2016-2022 The Stdlib Authors.

package/README.md

@@ -20,9 +20,9 @@ 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 an N-API module exporting interfaces for invoking unary numerical functions.
+> C APIs for registering a Node-API module exporting interfaces for invoking unary numerical functions.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -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
@@ -142,11 +132,11 @@ static double identity( const double x ) {
 // ...
 
 /**
-* Receives JavaScript callback invocation data via N-API.
+* Receives JavaScript callback invocation data.
 *
 * @param env    environment under which the function is invoked
 * @param info   callback data
-* @return       N-API value
+* @return       Node-API value
 */
 napi_value addon( napi_env env, napi_callback_info info ) {
     return stdlib_math_base_napi_d_d( env, info, identity );
@@ -181,11 +171,11 @@ static float identityf( const float x ) {
 // ...
 
 /**
-* Receives JavaScript callback invocation data via N-API.
+* Receives JavaScript callback invocation data.
 *
 * @param env    environment under which the function is invoked
 * @param info   callback data
-* @return       N-API value
+* @return       Node-API value
 */
 napi_value addon( napi_env env, napi_callback_info info ) {
     return stdlib_math_base_napi_f_f( env, info, identityf );
@@ -204,6 +194,166 @@ 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.
@@ -221,11 +371,11 @@ static int32_t identity( const int32_t x ) {
 // ...
 
 /**
-* Receives JavaScript callback invocation data via N-API.
+* Receives JavaScript callback invocation data.
 *
 * @param env    environment under which the function is invoked
 * @param info   callback data
-* @return       N-API value
+* @return       Node-API value
 */
 napi_value addon( napi_env env, napi_callback_info info ) {
     return stdlib_math_base_napi_i_i( env, info, identity );
@@ -246,7 +396,7 @@ void stdlib_math_base_napi_i_i( napi_env env, napi_callback_info info, int32_t (
 
 #### STDLIB_MATH_BASE_NAPI_MODULE_D_D( fcn )
 
-Macro for registering an N-API module exporting an interface for invoking a unary function accepting and returning double-precision floating-point numbers.
+Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning double-precision floating-point numbers.
 
 ```c
 static double scale( const double x ) {
@@ -255,7 +405,7 @@ static double scale( const double x ) {
 
 // ...
 
-// Register an N-API module:
+// Register a Node-API module:
 STDLIB_MATH_BASE_NAPI_MODULE_D_D( scale );
 ```
 
@@ -263,11 +413,11 @@ The macro expects the following arguments:
 
 -   **fcn**: `double (*fcn)( double )` unary function.
 
-When used, this macro should be used **instead of** `NAPI_MODULE`. The macro includes `NAPI_MODULE`, thus ensuring N-API module registration.
+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_F_F( fcn )
 
-Macro for registering an N-API module exporting an interface for invoking a unary function accepting and returning single-precision floating-point numbers.
+Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning single-precision floating-point numbers.
 
 ```c
 static float scale( const float x ) {
@@ -276,7 +426,7 @@ static float scale( const float x ) {
 
 // ...
 
-// Register an N-API module:
+// Register a Node-API module:
 STDLIB_MATH_BASE_NAPI_MODULE_F_F( scale );
 ```
 
@@ -284,11 +434,121 @@ The macro expects the following arguments:
 
 -   **fcn**: `float (*fcn)( float )` unary function.
 
-When used, this macro should be used **instead of** `NAPI_MODULE`. The macro includes `NAPI_MODULE`, thus ensuring N-API module registration.
+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 an N-API module exporting an interface for invoking a unary function accepting and returning 32-bit signed integers.
+Macro for registering a Node-API module exporting an interface for invoking a unary function accepting and returning 32-bit signed integers.
 
 ```c
 #include <stdint.h>
@@ -299,7 +559,7 @@ static int32_t scale( const int32_t x ) {
 
 // ...
 
-// Register an N-API module:
+// Register a Node-API module:
 STDLIB_MATH_BASE_NAPI_MODULE_I_I( scale );
 ```
 
@@ -307,7 +567,7 @@ The macro expects the following arguments:
 
 -   **fcn**: `int32_t (*fcn)( int32_t )` unary function.
 
-When used, this macro should be used **instead of** `NAPI_MODULE`. The macro includes `NAPI_MODULE`, thus ensuring N-API module registration.
+When used, this macro should be used **instead of** `NAPI_MODULE`. The macro includes `NAPI_MODULE`, thus ensuring Node-API module registration.
 
 </section>
 
@@ -321,7 +581,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 +607,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. -->
 
 
@@ -360,6 +628,10 @@ This package is part of [stdlib][stdlib], a standard library for JavaScript and
 
 For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
 
+#### Community
+
+[![Chat][chat-image]][chat-url]
+
 ---
 
 ## License
@@ -369,7 +641,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -388,9 +660,23 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [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
+<!--
+
+[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
 
+-->
+
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/math-base-napi-unary/tree/deno
+[umd-url]: https://github.com/stdlib-js/math-base-napi-unary/tree/umd
+[esm-url]: https://github.com/stdlib-js/math-base-napi-unary/tree/esm
+
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[chat-url]: https://gitter.im/stdlib-js/stdlib/
+
 [stdlib]: https://github.com/stdlib-js/stdlib
 
 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors