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

0.2.2 • Public • Published
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!

expm1rel

NPM version Build Status Coverage Status

Compute the relative error exponential.

The relative error exponential is defined as

Equation for the relative error exponential.

Installation

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

Usage

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

expm1rel( x )

Computes the relative error exponential.

var v = expm1rel( 0.0 );
// returns 1.0

v = expm1rel( 1.0 );
// returns ~1.718

v = expm1rel( -1.0 );
// returns ~0.632

v = expm1rel( NaN );
// returns NaN

Notes

  • When x is near zero, exp(x)-1 can suffer catastrophic cancellation (i.e., a significant loss in precision). expm1rel avoids such a loss in precision.

Examples

var randu = require( '@stdlib/random-base-randu' );
var expm1rel = require( '@stdlib/math-base-special-expm1rel' );

var x;
var y;
var a;
var i;

for ( i = 0; i < 100; i++ ) {
    x = (randu()*100.0) - 50.0;
    a = x.toFixed( 3 );
    y = expm1rel( x );
    console.log( '(e^%d - 1)/%d = %d', a, a, y );
}

C APIs

Usage

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

stdlib_base_exmp1rel( x )

Computes the relative error exponential.

double out = stdlib_base_expm1rel( 0.0 );
// returns 1.0

out = stdlib_base_expm1rel( 1.0 );
// returns ~1.718

The function accepts the following arguments:

  • x: [in] double input value.
double stdlib_base_expm1rel( const double x );

Examples

#include "stdlib/math/base/special/expm1rel.h"
#include <stdlib.h>
#include <stdio.h>

int main( void ) {
    double x;
    double v;
    int i;
    
    for ( i = 0; i < 100; i++ ) {
        x = ( ( (double)rand() / (double)RAND_MAX ) * 100.0 ) - 50.0;
        v = stdlib_base_expm1rel( x );
        printf( "(e^%lf - 1)/%lf = %lf\n", x, x, v );
    }
}

See Also


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.

Package Sidebar

Install

npm i @stdlib/math-base-special-expm1rel

Homepage

stdlib.io

Weekly Downloads

51

Version

0.2.2

License

Apache-2.0

Unpacked Size

39.9 kB

Total Files

17

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser