All files / math/base/special/heaviside/lib native.js

100% Statements 84/84
100% Branches 3/3
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 2011x 2011x 2011x 6x 6x 2011x 2011x 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 addon = require( './../src/addon.node' );
 
 
// MAIN //
 
/**
 * Create Continuity dictionary for heaviside function.
 *
 */
var CONTINUITY = {
	'half-maximum': 2,
	'left-continuous': 0,
	'right-continuous': 1
};
 
/**
* Evaluates the Heaviside function.
*
* @param {number} x - input value
* @param {string} [continuity] - continuity option
* @returns {number} function value
*
* @example
* var v = heaviside( 3.14, 'half-maximum' );
* // returns 1.0
*
* @example
* var v = heaviside( -3.14, 'half-maximum' );
* // returns 0.0
*
* @example
* var v = heaviside( 0.0, 'incorrect-continuity' );
* // returns NaN
*
* @example
* var v = heaviside( 0.0, 'half-maximum' );
* // returns 0.5
*
* @example
* var v = heaviside( 0.0, 'left-continuous' );
* // returns 0.0
*
* @example
* var v = heaviside( 0.0, 'right-continuous' );
* // returns 1.0
*
* @example
* var v = heaviside( NaN, 'half-maximum' );
* // returns NaN
*/
function heaviside( x, continuity ) {
	var contInt = -1;
	if ( continuity in CONTINUITY ) {
		contInt = CONTINUITY[continuity];
	}
	return addon( x, contInt );
}
 
 
// EXPORTS //
 
module.exports = heaviside;