All files / xlogyf/lib main.js

92% Statements 69/75
100% Branches 1/1
0% Functions 0/1
92% Lines 69/75

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 761x 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  
/**
* @license Apache-2.0
*
* Copyright (c) 2024 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 lnf = require( '@stdlib/math/base/special/lnf' );
var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
 
 
// MAIN //
 
/**
* Computes `x * ln(y)` 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 = xlogyf( 3.0, 2.0 );
* // returns ~2.079
*
* @example
* var out = xlogyf( 1.5, 5.9 );
* // returns ~2.662
*
* @example
* var out = xlogyf( 0.9, 1.0 );
* // returns 0.0
*
* @example
* var out = xlogyf( 0.0, -2.0 );
* // returns 0.0
*
* @example
* var out = xlogyf( 1.5, NaN );
* // returns NaN
*
* @example
* var out = xlogyf( 0.0, NaN );
* // returns NaN
*
* @example
* var out = xlogyf( NaN, 2.3 );
* // returns NaN
*/
function xlogyf( x, y ) {
	if ( x === 0.0 && !isnanf( y ) ) {
		return 0.0;
	}
	return float64ToFloat32( float64ToFloat32( x ) * lnf( float64ToFloat32( y ) ) );
}
 
 
// EXPORTS //
 
module.exports = xlogyf;