Giter Club home page Giter Club logo

math-base-napi-quinary's Introduction

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

quinary

NPM version Build Status Coverage Status

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

Installation

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

Usage

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

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-quinary' );

console.log( headerDir );
// => <string>

C APIs

Usage

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

stdlib_math_base_napi_ddddd_d( env, info, fcn )

Invokes a quinary 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, const double w, const double u ) {
    return x + y + z + w + u;
}

// ...

/**
* 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_ddddd_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, double, double ) quinary function.
void stdlib_math_base_napi_ddddd_d( napi_env env, napi_callback_info info, double (*fcn)( double, double, double, double, double ) );

stdlib_math_base_napi_fffff_f( env, info, fcn )

Invokes a quinary 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, const float w, const float u ) {
    return x + y + z + w + u;
}

// ...

/**
* 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_fffff_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, float, float ) quinary function.
void stdlib_math_base_napi_fffff_f( napi_env env, napi_callback_info info, float (*fcn)( float, float, float, float, float ) );

STDLIB_MATH_BASE_NAPI_MODULE_DDDDD_D( fcn )

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

static double add( const double x, const double y, const double z, const double w, const double u ) {
    return x + y + z + w + u;
}

// ...

// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_DDDDD_D( add );

The macro expects the following arguments:

  • fcn: double (*fcn)( double, double, double, double, double ) quinary 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_FFFFF_F( fcn )

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

static float addf( const float x, const float y, const float z, const float w, const float u ) {
    return x + y + z + w + u;
}

// ...

// Register a Node-API module:
STDLIB_MATH_BASE_NAPI_MODULE_FFFFF_F( addf );

The macro expects the following arguments:

  • fcn: float (*fcn)( float, float, float, float, float ) quinary 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.
    • w: input value.
    • u: 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-2024. The Stdlib Authors.

math-base-napi-quinary's People

Contributors

stdlib-bot avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.