All files main.js

100% Statements 80/80
100% Branches 6/6
100% Functions 1/1
100% Lines 80/80

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 811x 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 1004x 1004x 1004x 1004x 1002x 1004x 4x 4x 1000x 1000x 1004x 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 ln = require( '@stdlib/math/base/special/ln' );
var LN2 = require( '@stdlib/constants/float64/ln-two' );
 
 
// MAIN //
 
/**
* Returns the differential entropy of an Anglit distribution with location parameter `mu` and scale parameter `sigma`.
*
* @param {number} mu - location parameter
* @param {number} sigma - scale parameter
* @returns {number} entropy
*
* @example
* var h = entropy( 0.0, 1.0 );
* // returns ~0.307
*
* @example
* var h = entropy( 0.0, 2.0 );
* // returns ~1.000
*
* @example
* var h = entropy( 1.0, 1.0 );
* // returns ~0.307
*
* @example
* var h = entropy( 0.0, 0.5 );
* // returns ~-0.386
*
* @example
* var h = entropy( NaN, 1.0 );
* // returns NaN
*
* @example
* var h = entropy( 0.0, NaN );
* // returns NaN
*
* @example
* var h = entropy( 0.0, -1.0 );
* // returns NaN
*/
function entropy( mu, sigma ) {
	if (
		isnan( mu ) ||
		isnan( sigma ) ||
		sigma <= 0.0
	) {
		return NaN;
	}
 
	return 1.0 - LN2 + ln( sigma );
}
 
 
// EXPORTS //
 
module.exports = entropy;