Skip to content

README.md

Latest commit

 

History

History
217 lines (136 loc) · 5 KB

README.md

File metadata and controls

217 lines (136 loc) · 5 KB

xlog1pyf

Compute x * ln(y+1) so that the result is 0 if x = 0 for single-precision floating-point numbers.

Usage

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

xlog1pyf( x, y )

Computes x * ln(y+1) so that the result is 0 if x = 0 for single-precision floating-point numbers x and y.

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

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

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

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

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

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

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

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

Examples

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

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( 'xlog1pyf(%d, %d) = %d', x, y, xlog1pyf( x, y ) );
}

C APIs

Usage

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

stdlib_base_xlog1pyf( x, y )

Computes x * ln(y+1) so that the result is 0 if x = 0 for single-precision floating-point numbers x and y.

float v = stdlib_base_xlog1pyf( 3.0f, 2.0f );
// returns ~3.296f

The function accepts the following arguments:

  • x: [in] float input value.
  • y: [in] float input value.
float stdlib_base_xlog1pyf( const float x, const float y );

Examples

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

int main( void ) {
    float out;
    float x;
    float y;
    int i;

    for ( i = 0; i < 100; i++ ) {
        x = ( (float)rand() / (float)RAND_MAX ) * 100.0f;
        y = ( (float)rand() / (float)RAND_MAX ) * 5.0f;
        out = stdlib_base_xlog1pyf( x, y );
        printf( "xlog1pyf(%f, %f) = %f\n", x, y, out );
    }
}

See Also