Nocturnal Programmer's Machine

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

    0.0.5 • Public • Published

    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.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

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

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    1

    Version

    0.0.5

    License

    Apache-2.0

    Unpacked Size

    36.5 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser