All files / math/base/special/logitf/lib main.js

100% Statements 78/78
100% Branches 10/10
100% Functions 1/1
100% Lines 78/78

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 791x 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 1505x 1505x 1x 1x 1505x 2x 2x 1505x 1x 1x 1505x 1x 1x 1500x 1505x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 isProbabilityf = require( '@stdlib/math/base/assert/is-probabilityf' );
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' );
var PINF = require( '@stdlib/constants/float32/pinf' );
var NINF = require( '@stdlib/constants/float32/ninf' );
 
 
// MAIN //
 
/**
* Computes the logit function for a single-precision floating-point number.
*
* @param {Probability} p - input value
* @returns {number} function value
*
* @example
* var y = logitf( 0.2 );
* // returns ~-1.386
*
* @example
* var y = logitf( 0.9 );
* // returns ~2.197
*
* @example
* var y = logitf( -4.0 );
* // returns NaN
*
* @example
* var y = logitf( 1.5 );
* // returns NaN
*
* @example
* var y = logitf( NaN );
* // returns NaN
*/
function logitf( p ) {
	if ( isnanf( p ) ) {
		return p;
	}
	if ( !isProbabilityf( p ) ) {
		return NaN;
	}
	if ( p === 0.0 ) {
		return NINF;
	}
	if ( p === 1.0 ) {
		return PINF;
	}
	return lnf( float64ToFloat32( p / float64ToFloat32( 1.0-p ) ) );
}
 
 
// EXPORTS //
 
module.exports = logitf;