Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/math-base-special-fast
Standard library fast math special functions.
https://github.com/stdlib-js/math-base-special-fast
fast fastmath javascript lib library math mathematics node node-js nodejs standard stdlib
Last synced: about 1 month ago
JSON representation
Standard library fast math special functions.
- Host: GitHub
- URL: https://github.com/stdlib-js/math-base-special-fast
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T17:00:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T10:06:35.000Z (about 2 months ago)
- Last Synced: 2024-11-15T16:33:55.336Z (about 1 month ago)
- Topics: fast, fastmath, javascript, lib, library, math, mathematics, node, node-js, nodejs, standard, stdlib
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 947 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# Special Functions
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Fast math special functions.
## Installation
```bash
npm install @stdlib/math-base-special-fast
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var fmath = require( '@stdlib/math-base-special-fast' );
```
#### fmath
Namespace containing "fast" math special functions.
```javascript
var fcns = fmath;
// returns {...}
```
- [`abs( x )`][@stdlib/math/base/special/fast/abs]: compute an absolute value.
- [`acosh( x )`][@stdlib/math/base/special/fast/acosh]: compute the hyperbolic arccosine of a number.
- [`ampbm( x, y )`][@stdlib/math/base/special/fast/alpha-max-plus-beta-min]: compute the hypotenuse using the alpha max plus beta min algorithm.
- [`asinh( x )`][@stdlib/math/base/special/fast/asinh]: compute the hyperbolic arcsine of a number.
- [`atanh( x )`][@stdlib/math/base/special/fast/atanh]: compute the hyperbolic arctangent of a number.
- [`hypot( x, y )`][@stdlib/math/base/special/fast/hypot]: compute the hypotenuse.
- [`max( x, y )`][@stdlib/math/base/special/fast/max]: return the maximum value.
- [`min( x, y )`][@stdlib/math/base/special/fast/min]: return the minimum value.
- [`powint( base, exponent )`][@stdlib/math/base/special/fast/pow-int]: exponential function.
- [`log2Uint32( x )`][@stdlib/math/base/special/fast/uint32-log2]: compute an integer binary logarithm.
- [`sqrtUint32( x )`][@stdlib/math/base/special/fast/uint32-sqrt]: compute an integer square root.
## Notes
- Implementations **may** violate strict IEEE semantics.
- Implementations **may** assume arguments and results are **not** `NaN`.
- Implementations **may** assume arguments are **neither** positive or negative `infinity`.
- Implementations **may** ignore the sign of zero.
## Examples
```javascript
var objectKeys = require( '@stdlib/utils-keys' );
var fmath = require( '@stdlib/math-base-special-fast' );
console.log( objectKeys( fmath ) );
```
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-fast.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-fast
[test-image]: https://github.com/stdlib-js/math-base-special-fast/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/math-base-special-fast/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-fast/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-fast?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[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-special-fast/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-fast/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-fast/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-fast/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-fast/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-fast/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-fast/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-fast/main/LICENSE
[@stdlib/math/base/special/fast/abs]: https://github.com/stdlib-js/math-base-special-fast-abs
[@stdlib/math/base/special/fast/acosh]: https://github.com/stdlib-js/math-base-special-fast-acosh
[@stdlib/math/base/special/fast/alpha-max-plus-beta-min]: https://github.com/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min
[@stdlib/math/base/special/fast/asinh]: https://github.com/stdlib-js/math-base-special-fast-asinh
[@stdlib/math/base/special/fast/atanh]: https://github.com/stdlib-js/math-base-special-fast-atanh
[@stdlib/math/base/special/fast/hypot]: https://github.com/stdlib-js/math-base-special-fast-hypot
[@stdlib/math/base/special/fast/max]: https://github.com/stdlib-js/math-base-special-fast-max
[@stdlib/math/base/special/fast/min]: https://github.com/stdlib-js/math-base-special-fast-min
[@stdlib/math/base/special/fast/pow-int]: https://github.com/stdlib-js/math-base-special-fast-pow-int
[@stdlib/math/base/special/fast/uint32-log2]: https://github.com/stdlib-js/math-base-special-fast-uint32-log2
[@stdlib/math/base/special/fast/uint32-sqrt]: https://github.com/stdlib-js/math-base-special-fast-uint32-sqrt