Package Exports

@stdlib/math-base-special-xlog1py

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/math-base-special-xlog1py) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

xlog1py

$NPM version$ $Build Status$ $Coverage Status$ $dependencies$

Compute x * ln(y+1) so that the result is 0 if x = 0.

Installation

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

Usage

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

xlog1py( x, y )

Computes x * ln(y+1) so that the result is 0 if x = 0.

var out = xlog1py( 3.0, 2.0 );
// returns ~3.296

out = xlog1py( 1.5, 5.9 );
// returns ~2.897

out = xlog1py( 0.9, 1.0 );
// returns ~0.624

out = xlog1py( 1.0, 0.0 );
// returns 0.0

out = xlog1py( 0.0, -2.0 );
// returns 0.0

out = xlog1py( 1.5, NaN );
// returns NaN

out = xlog1py( 0.0, NaN );
// returns NaN

out = xlog1py( NaN, 2.3 );
// returns NaN

Examples

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

var x;
var y;
var i;

for ( i = 0; i < 100; i++ ) {
    x = randu();
    if ( x < 0.5 ) {
        x = 0.0;
    }
    y = ( randu() * 20.0 ) - 5.0;
    console.log( 'xlog1py(%d, %d) = %d', x, y, xlog1py( x, y ) );
}

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.

License

See LICENSE.

@stdlib/math-base-special-xlog1py