All files main.js

100% Statements 84/84
100% Branches 5/5
100% Functions 1/1
100% Lines 84/84

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 851x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2008x 2008x 4x 4x 2004x 2008x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var log1pf = require( '@stdlib/math/base/special/log1pf' );
var f32 = require( '@stdlib/number/float64/base/to-float32' );
 
 
// VARIABLES //
 
var ZER0 = f32( 0.0 );
 
 
// MAIN //
 
/**
* Computes `x * ln(y+1)` so that the result is `0` if `x = 0` for single-precision floating-point numbers `x` and `y`.
*
* @param {number} x - input value
* @param {number} y - input value
* @returns {number} function value
*
* @example
* var out = xlog1pyf( 3.0, 2.0 );
* // returns ~3.296
*
* @example
* var out = xlog1pyf( 1.5, 5.9 );
* // returns ~2.897
*
* @example
* var out = xlog1pyf( 0.9, 1.0 );
* // returns ~0.624
*
* @example
* var out = xlog1pyf( 1.0, 0.0 );
* // returns 0.0
*
* @example
* var out = xlog1pyf( 0.0, -2.0 );
* // returns 0.0
*
* @example
* var out = xlog1pyf( 1.5, NaN );
* // returns NaN
*
* @example
* var out = xlog1pyf( 0.0, NaN );
* // returns NaN
*
* @example
* var out = xlog1pyf( NaN, 2.3 );
* // returns NaN
*/
function xlog1pyf( x, y ) {
	if ( x === ZER0 && !isnanf( y ) ) {
		return ZER0;
	}
	return f32( f32(x) * log1pf( y ) );
}
 
 
// EXPORTS //
 
module.exports = xlog1pyf;