@stdlib/math-base-napi-ternary 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.
 
 # ternary
 
-[![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 ternary numerical functions.
+> C APIs for registering a Node-API module exporting interfaces for invoking ternary 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-ternary
-```
-
-</section>
-
 <section class="usage">
 
 ### Usage
@@ -142,11 +132,11 @@ static double add( const double x, const double y, const double z ) {
 // ...
 
 /**
-* 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_ddd_d( env, info, add );
@@ -181,11 +171,11 @@ static float addf( const float x, const float y, const float z ) {
 // ...
 
 /**
-* 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_fff_f( env, info, addf );
@@ -206,7 +196,7 @@ void stdlib_math_base_napi_fff_f( napi_env env, napi_callback_info info, float (
 
 #### STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( fcn )
 
-Macro for registering an N-API module exporting an interface for invoking a ternary function accepting and returning double-precision floating-point numbers.
+Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting and returning double-precision floating-point numbers.
 
 ```c
 static double add( const double x, const double y, const double z ) {
@@ -215,7 +205,7 @@ static double add( const double x, const double y, const double z ) {
 
 // ...
 
-// Register an N-API module:
+// Register a Node-API module:
 STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( add );
 ```
 
@@ -223,11 +213,11 @@ The macro expects the following arguments:
 
 -   **fcn**: `double (*fcn)( double, double, double )` ternary 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_FFF_F( fcn )
 
-Macro for registering an N-API module exporting an interface for invoking a ternary function accepting and returning single-precision floating-point numbers.
+Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting and returning single-precision floating-point numbers.
 
 ```c
 static float addf( const float x, const float y, const float z ) {
@@ -236,7 +226,7 @@ static float addf( const float x, const float y, const float z ) {
 
 // ...
 
-// Register an N-API module:
+// Register a Node-API module:
 STDLIB_MATH_BASE_NAPI_MODULE_FFF_F( addf );
 ```
 
@@ -244,7 +234,7 @@ The macro expects the following arguments:
 
 -   **fcn**: `float (*fcn)( float, float, float )` ternary 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>
 
@@ -286,6 +276,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. -->
 
 
@@ -299,6 +297,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
@@ -308,7 +310,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>
 
@@ -327,9 +329,23 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-napi-ternary/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/math-base-napi-ternary?branch=main
 
-[dependencies-image]: https://img.shields.io/david/stdlib-js/math-base-napi-ternary
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/math-base-napi-ternary.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/math-base-napi-ternary/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-ternary/tree/deno
+[umd-url]: https://github.com/stdlib-js/math-base-napi-ternary/tree/umd
+[esm-url]: https://github.com/stdlib-js/math-base-napi-ternary/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

package/include/stdlib/math/base/napi/ternary.h

@@ -23,7 +23,7 @@
 #include <assert.h>
 
 /**
-* Macro for registering an N-API module exporting an interface invoking a ternary function accepting and returning double-precision floating-point numbers.
+* Macro for registering a Node-API module exporting an interface invoking a ternary function accepting and returning double-precision floating-point numbers.
 *
 * @param fcn   ternary function
 *
@@ -34,7 +34,7 @@
 *
 * // ...
 *
-* // Register an N-API module:
+* // Register a Node-API module:
 * STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( add );
 */
 #define STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( fcn )                              \
@@ -63,7 +63,7 @@
 	NAPI_MODULE( NODE_GYP_MODULE_NAME, stdlib_math_base_napi_ddd_d_init )
 
 /**
-* Macro for registering an N-API module exporting an interface invoking a ternary function accepting and returning single-precision floating-point numbers.
+* Macro for registering a Node-API module exporting an interface invoking a ternary function accepting and returning single-precision floating-point numbers.
 *
 * @param fcn   ternary function
 *
@@ -74,7 +74,7 @@
 *
 * // ...
 *
-* // Register an N-API module:
+* // Register a Node-API module:
 * STDLIB_MATH_BASE_NAPI_MODULE_FFF_F( addf );
 */
 #define STDLIB_MATH_BASE_NAPI_MODULE_FFF_F( fcn )                              \

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/math-base-napi-ternary",
-  "version": "0.0.4",
-  "description": "C APIs for registering an N-API module exporting an interface for invoking a ternary numerical function.",
+  "version": "0.0.8",
+  "description": "C APIs for registering a Node-API module exporting an interface for invoking a ternary numerical function.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",
@@ -15,7 +15,7 @@
   ],
   "main": "./lib",
   "browser": "./lib/browser.js",
-  "gypfile": true,
+  "gypfile": false,
   "directories": {
     "benchmark": "./benchmark",
     "doc": "./docs",
@@ -32,7 +32,7 @@
     "examples": "make examples",
     "benchmark": "make benchmark"
   },
-  "homepage": "https://github.com/stdlib-js/stdlib",
+  "homepage": "https://stdlib.io",
   "repository": {
     "type": "git",
     "url": "git://github.com/stdlib-js/math-base-napi-ternary.git"
@@ -74,6 +74,7 @@
     "math",
     "napi",
     "n-api",
+    "node-api",
     "addon",
     "ternary",
     "map",

package/src/main.c

@@ -35,7 +35,7 @@
 * @param env    environment under which the function is invoked
 * @param info   callback data
 * @param fcn    ternary function
-* @return       function return value as an N-API double-precision floating-point number
+* @return       function return value as a Node-API double-precision floating-point number
 */
 napi_value stdlib_math_base_napi_ddd_d( napi_env env, napi_callback_info info, double (*fcn)( double, double, double ) ) {
 	napi_status status;
@@ -111,7 +111,7 @@ napi_value stdlib_math_base_napi_ddd_d( napi_env env, napi_callback_info info, d
 * @param env    environment under which the function is invoked
 * @param info   callback data
 * @param fcn    ternary function
-* @return       function return value as an N-API double-precision floating-point number
+* @return       function return value as a Node-API double-precision floating-point number
 */
 napi_value stdlib_math_base_napi_fff_f( napi_env env, napi_callback_info info, float (*fcn)( float, float, float ) ) {
 	napi_status status;

package/CHANGELOG.md

@@ -1,5 +0,0 @@
-# CHANGELOG
-
-> Package changelog.
-
-See [GitHub Releases](https://github.com/stdlib-js/math-base-napi-ternary/releases) for the changelog.

package/binding.gyp

@@ -1,170 +0,0 @@
-# @license Apache-2.0
-#
-# Copyright (c) 2020 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.
-
-# A `.gyp` file for building a Node.js native add-on.
-#
-# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md
-# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md
-{
-  # List of files to include in this file:
-  'includes': [
-    './include.gypi',
-  ],
-
-  # Define variables to be used throughout the configuration for all targets:
-  'variables': {
-    # Target name should match the add-on export name:
-    'addon_target_name%': 'addon',
-
-    # Set variables based on the host OS:
-    'conditions': [
-      [
-        'OS=="win"',
-        {
-          # Define the object file suffix:
-          'obj': 'obj',
-        },
-        {
-          # Define the object file suffix:
-          'obj': 'o',
-        }
-      ], # end condition (OS=="win")
-    ], # end conditions
-  }, # end variables
-
-  # Define compile targets:
-  'targets': [
-
-    # Target to generate an add-on:
-    {
-      # The target name should match the add-on export name:
-      'target_name': '<(addon_target_name)',
-
-      # Define dependencies:
-      'dependencies': [],
-
-      # Define directories which contain relevant include headers:
-      'include_dirs': [
-        # Local include directory:
-        '<@(include_dirs)',
-      ],
-
-      # List of source files:
-      'sources': [
-        '<@(src_files)',
-      ],
-
-      # Settings which should be applied when a target's object files are used as linker input:
-      'link_settings': {
-        # Define libraries:
-        'libraries': [
-          '<@(libraries)',
-        ],
-
-        # Define library directories:
-        'library_dirs': [
-          '<@(library_dirs)',
-        ],
-      },
-
-      # C/C++ compiler flags:
-      'cflags': [
-        # Enable commonly used warning options:
-        '-Wall',
-
-        # Aggressive optimization:
-        '-O3',
-      ],
-
-      # C specific compiler flags:
-      'cflags_c': [
-        # Specify the C standard to which a program is expected to conform:
-        '-std=c99',
-      ],
-
-      # C++ specific compiler flags:
-      'cflags_cpp': [
-        # Specify the C++ standard to which a program is expected to conform:
-        '-std=c++11',
-      ],
-
-      # Linker flags:
-      'ldflags': [],
-
-      # Apply conditions based on the host OS:
-      'conditions': [
-        [
-          'OS=="mac"',
-          {
-            # Linker flags:
-            'ldflags': [
-              '-undefined dynamic_lookup',
-              '-Wl,-no-pie',
-              '-Wl,-search_paths_first',
-            ],
-          },
-        ], # end condition (OS=="mac")
-        [
-          'OS!="win"',
-          {
-            # C/C++ flags:
-            'cflags': [
-              # Generate platform-independent code:
-              '-fPIC',
-            ],
-          },
-        ], # end condition (OS!="win")
-      ], # end conditions
-    }, # end target <(addon_target_name)
-
-    # Target to copy a generated add-on to a standard location:
-    {
-      'target_name': 'copy_addon',
-
-      # Declare that the output of this target is not linked:
-      'type': 'none',
-
-      # Define dependencies:
-      'dependencies': [
-        # Require that the add-on be generated before building this target:
-        '<(addon_target_name)',
-      ],
-
-      # Define a list of actions:
-      'actions': [
-        {
-          'action_name': 'copy_addon',
-          'message': 'Copying addon...',
-
-          # Explicitly list the inputs in the command-line invocation below:
-          'inputs': [],
-
-          # Declare the expected outputs:
-          'outputs': [
-            '<(addon_output_dir)/<(addon_target_name).node',
-          ],
-
-          # Define the command-line invocation:
-          'action': [
-            'cp',
-            '<(PRODUCT_DIR)/<(addon_target_name).node',
-            '<(addon_output_dir)/<(addon_target_name).node',
-          ],
-        },
-      ], # end actions
-    }, # end target copy_addon
-  ], # end targets
-}