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

0.2.3 • 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!

log1p

NPM version Build Status Coverage Status

Evaluate the natural logarithm of 1+x.

Installation

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

Usage

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

log1p( x )

Evaluates the natural logarithm of 1+x.

var v = log1p( 4.0 );
// returns ~1.609

v = log1p( -1.0 );
// returns -Infinity

v = log1p( Infinity );
// returns Infinity

v = log1p( 0.0 );
// returns 0.0

v = log1p( -0.0 );
// returns -0.0

v = log1p( NaN );
// returns NaN

For x < -1, the function returns NaN, as the natural logarithm is not defined for negative numbers.

var v = log1p( -2.0 );
// returns NaN

Examples

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

var x;
var i;

for ( i = 0; i < 100; i++ ) {
    x = round( randu() * 100.0 );
    console.log( log1p( x ) );
}

C APIs

Usage

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

stdlib_base_log1p( x )

Evaluates the natural logarithm of 1+x.

double out = stdlib_base_log1p( 4.0 );
// returns ~1.609

out = stdlib_base_log1p( -1.0 );
// returns -Infinity

The function accepts the following arguments:

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

Examples

#include "stdlib/math/base/special/log1p.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;
        v = stdlib_base_log1p( x );
        printf( "log1p(%lf) = %lf\n", 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


Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

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

Homepage

stdlib.io

Weekly Downloads

20,654

Version

0.2.3

License

Apache-2.0

Unpacked Size

66.4 kB

Total Files

17

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser