Noisy Pterodactyl Melodies

    @stdlib/math-base-napi-ternary
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.8 • Public • Published

    ternary

    NPM version Build Status Coverage Status

    C APIs for registering a Node-API module exporting interfaces for invoking ternary numerical functions.

    Installation

    npm install @stdlib/math-base-napi-ternary

    Usage

    var headerDir = require( '@stdlib/math-base-napi-ternary' );

    headerDir

    Absolute file path for the directory containing header files for C APIs.

    var dir = headerDir;
    // returns <string>

    Examples

    var headerDir = require( '@stdlib/math-base-napi-ternary' );
    
    console.log( headerDir );
    // => <string>

    C APIs

    Usage

    #include "stdlib/math/base/napi/ternary.h"

    stdlib_math_base_napi_ddd_d( env, info, fcn )

    Invokes a ternary function accepting and returning double-precision floating-point numbers.

    #include <node_api.h>
    
    // ...
    
    static double add( const double x, const double y, const double z ) {
        return x + y + 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_ddd_d( env, info, add );
    }
    
    // ...

    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)( double, double, double ) ternary function.
    void stdlib_math_base_napi_ddd_d( napi_env env, napi_callback_info info, double (*fcn)( double, double, double ) );

    stdlib_math_base_napi_fff_f( env, info, fcn )

    Invokes a ternary function accepting and returning single-precision floating-point numbers.

    #include <node_api.h>
    
    // ...
    
    static float addf( const float x, const float y, const float z ) {
        return x + y + 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_fff_f( env, info, addf );
    }
    
    // ...

    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)( float, float, float ) ternary function.
    void stdlib_math_base_napi_fff_f( napi_env env, napi_callback_info info, float (*fcn)( float, float, float ) );

    STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( fcn )

    Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting and returning double-precision floating-point numbers.

    static double add( const double x, const double y, const double z ) {
        return x + y + z;
    }
    
    // ...
    
    // Register a Node-API module:
    STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( add );

    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 Node-API module registration.

    STDLIB_MATH_BASE_NAPI_MODULE_FFF_F( fcn )

    Macro for registering a Node-API module exporting an interface for invoking a ternary function accepting and returning single-precision floating-point numbers.

    static float addf( const float x, const float y, const float z ) {
        return x + y + z;
    }
    
    // ...
    
    // Register a Node-API module:
    STDLIB_MATH_BASE_NAPI_MODULE_FFF_F( addf );

    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 Node-API module registration.

    Notes

    • The C-API functions expect that the callback info argument provides access to the following JavaScript arguments:

      • x: input value.
      • y: input value.
      • z: input value.

    Notice

    This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

    For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/math-base-napi-ternary

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    84

    Version

    0.0.8

    License

    Apache-2.0

    Unpacked Size

    55.2 kB

    Total Files

    15

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser