Détail du package

@stdlib/math-base-special-powm1

stdlib-js213.9kApache-2.0 AND BSL-1.00.3.1

Evaluate bˣ - 1.

stdlib, stdmath, mathematics, math

readme

<summary> About stdlib... </summary>

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!

powm1

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

Evaluate bˣ - 1.

Exponential function minus one
When b is close to 1 and/or x is small, this implementation is more accurate than naively computing minus 1.
## Installation bash npm install @stdlib/math-base-special-powm1
## Usage javascript var powm1 = require( '@stdlib/math-base-special-powm1' ); #### powm1( b, x ) Evaluates bˣ - 1. javascript var y = powm1( 2.0, 3.0 ); // returns 7.0 y = powm1( 4.0, 0.5 ); // returns 1.0 y = powm1( 0.0, 100.0 ); // returns -1.0 y = powm1( 100.0, 0.0 ); // returns 0.0 y = powm1( 0.0, 0.0 ); // returns 0.0 y = powm1( 3.141592653589793, 5.0 ); // returns ~305.0197 y = powm1( NaN, 3.0 ); // returns NaN y = powm1( 5.0, NaN ); // returns NaN
## Examples javascript var randu = require( '@stdlib/random-base-randu' ); var round = require( '@stdlib/math-base-special-round' ); var powm1 = require( '@stdlib/math-base-special-powm1' ); var b; var x; var y; var i; for ( i = 0; i < 100; i++ ) { b = round( randu()*10.0 ); x = round( randu()*10.0 ) - 5.0; y = powm1( b, x ); console.log( '%d^%d - 1 = %d', b, x, y ); }

## C APIs
### Usage c #include "stdlib/math/base/special/powm1.h" #### stdlib_base_powm1( base, exponent ) Evaluates bˣ - 1. c double out = stdlib_base_powm1( 3.141592653589793, 5.0 ); // returns ~305.0197 out = stdlib_base_powm1( 4.0, 0.5 ); // returns 1.0 The function accepts the following arguments: - base: [in] double base. - exponent: [in] double exponent. c double stdlib_base_powm1( const double base, const double exponent );
### Examples c #include "stdlib/math/base/special/powm1.h" #include <stdlib.h> #include <stdio.h> int main( void ) { double out; double b; double x; int i; for ( i = 0; i < 100; i++ ) { b = ( ( (double)rand() / (double)RAND_MAX ) * 10.0 ); x = ( ( (double)rand() / (double)RAND_MAX ) * 10.0 ) - 5.0; out = stdlib_base_powm1( b, x ); printf( "powm1(%lf, %lf) = %lf\n", b, x, out ); } }

* ## See Also - [@stdlib/math-base/special/pow][@stdlib/math/base/special/pow]: exponential function.
* ## 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] --- ## Copyright Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-powm1.svg [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-powm1 [test-image]: https://github.com/stdlib-js/math-base-special-powm1/actions/workflows/test.yml/badge.svg?branch=v0.3.1 [test-url]: https://github.com/stdlib-js/math-base-special-powm1/actions/workflows/test.yml?query=branch:v0.3.1 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-powm1/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-powm1?branch=v0.3.1 [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-powm1/tree/deno [deno-readme]: https://github.com/stdlib-js/math-base-special-powm1/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/math-base-special-powm1/tree/umd [umd-readme]: https://github.com/stdlib-js/math-base-special-powm1/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/math-base-special-powm1/tree/esm [esm-readme]: https://github.com/stdlib-js/math-base-special-powm1/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/math-base-special-powm1/blob/main/branches.md [@stdlib/math/base/special/pow]: https://www.npmjs.com/package/@stdlib/math-base-special-pow

changelog

CHANGELOG

Package changelog.

## Unreleased (2024-07-29)
### Commits
- 4d208c9 - test: add missing tests (#2701) (by Gunj Joshi) - a2ad2e1 - chore: update package meta data (#2696) (by stdlib-bot, Philipp Burckhardt)
### Contributors A total of 2 people contributed to this release. Thank you to the following contributors: - Gunj Joshi - Philipp Burckhardt

## 0.3.0 (2024-07-28)
### Features - 62e247d - add C implementation for math/base/special/powm1 (#2660)
### Commits
- 62e247d - feat: add C implementation for math/base/special/powm1 (#2660) (by Gunj Joshi) - 3e05048 - docs: remove comment (by Athan Reines) - 9ed7d0e - chore: add missing trailing newlines (by Philipp Burckhardt)
### Contributors A total of 3 people contributed to this release. Thank you to the following contributors: - Athan Reines - Gunj Joshi - Philipp Burckhardt

## 0.2.1 (2024-02-24) No changes reported for this release.
## 0.2.0 (2024-02-14) No changes reported for this release.
## 0.1.0 (2023-09-24)
### Features - 58832ee - update minimum TypeScript version
### BREAKING CHANGES - 58832ee: update minimum TypeScript version - 58832ee: update minimum TypeScript version to 4.1 - To migrate, users should upgrade their TypeScript version to at least version 4.1.
### Commits
- 58832ee - feat: update minimum TypeScript version (by Philipp Burckhardt) - b734544 - refactor: use strictEqual checks (by Philipp Burckhardt) - c5da1f9 - docs: render equations via math code blocks (by Philipp Burckhardt)
### Contributors A total of 1 person contributed to this release. Thank you to this contributor: - Philipp Burckhardt

## 0.0.6 (2022-02-16) No changes reported for this release.
## 0.0.5 (2021-08-23) No changes reported for this release.
## 0.0.4 (2021-07-07) No changes reported for this release.
## 0.0.3 (2021-06-27) No changes reported for this release.
## 0.0.2 (2021-06-16) No changes reported for this release.
## 0.0.1 (2021-06-15) No changes reported for this release.