All files main.js

100% Statements 82/82
100% Branches 9/9
100% Functions 1/1
100% Lines 82/82

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 831x 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 1013x 1013x 1013x 1013x 1013x 1006x 1013x 11x 11x 1013x 2x 2x 1000x 1013x 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
 
 
// MAIN //
 
/**
* Returns the mode of a log logistic distribution with scale parameter `alpha` and shape parameter `beta`.
*
* @param {PositiveNumber} alpha - scale parameter
* @param {PositiveNumber} beta - shape parameter
* @returns {NonNegativeNumber} mode
*
* @example
* var y = mode( 1.0, 2.0 );
* // returns ~0.577
*
* @example
* var y = mode( 4.0, 3.0 );
* // returns ~3.175
*
* @example
* var y = mode( 1.0, 1.0 );
* // returns 0.0
*
* @example
* var y = mode( NaN, 2.0 );
* // returns NaN
*
* @example
* var y = mode( 2.0, NaN );
* // returns NaN
*
* @example
* var y = mode( -1.0, 2.0 );
* // returns NaN
*
* @example
* var y = mode( 2.0, -1.0 );
* // returns NaN
*/
function mode( alpha, beta ) {
	if (
		isnan( alpha ) ||
		isnan( beta ) ||
		alpha <= 0.0 ||
		beta <= 0.0
	) {
		return NaN;
	}
	if ( beta <= 1.0 ) {
		return 0.0;
	}
	return alpha * pow( ( beta - 1.0 ) / ( beta + 1.0 ), 1.0 / beta );
}
 
 
// EXPORTS //
 
module.exports = mode;