@stdlib/math-base-special-powm1

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!

powm1

Evaluate bˣ - 1.

When b is close to 1 and/or x is small, this implementation is more accurate than naively computing bˣ minus 1.

Installation

npm install @stdlib/math-base-special-powm1

Usage

var powm1 = require( '@stdlib/math-base-special-powm1' );

powm1( b, x )

Evaluates bˣ - 1.

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

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

#include "stdlib/math/base/special/powm1.h"

stdlib_base_powm1( base, exponent )

Evaluates bˣ - 1.

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.

double stdlib_base_powm1( const double base, const double exponent );

Examples

#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: exponential function.

---

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

---

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.3.0 (2024-07-28)

<section class="features">

Features

• 62e247d - add C implementation for math/base/special/powm1 (#2660)

</section> <!-- /.features --> <section class="commits">

Commits

<details>

• 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)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 3 people contributed to this release. Thank you to the following contributors:

• Athan Reines
• Gunj Joshi
• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.2.1">