All files main.js

100% Statements 74/74
100% Branches 2/2
100% Functions 1/1
100% Lines 74/74

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 751x 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 32003x 32003x 32003x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2018 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 abs2 = require( '@stdlib/math/base/special/abs2' );
var sin = require( '@stdlib/math/base/special/sin' );
 
 
// MAIN //
 
/**
* Computes the versed sine.
*
* ## Method
*
* Evaluating the textbook formula
*
* ```tex
* \operatorname{versin}(x) = 1 - \cos(x)
* ```
*
* loses significant digits when \\(\cos(x)\\) is close to one (i.e., for `x` near multiples of 2π, including small `x`). Accordingly, we use the equivalent half-angle identity
*
* ```tex
* \operatorname{versin}(x) = 2 \sin^2\left(\tfrac{x}{2}\right)
* ```
*
* which does not suffer from cancellation.
*
* @param {number} x - input value (in radians)
* @returns {number} versed sine
*
* @example
* var v = versin( 0.0 );
* // returns 0.0
*
* @example
* var v = versin( 3.141592653589793/2.0 );
* // returns ~1.0
*
* @example
* var v = versin( -3.141592653589793/6.0 );
* // returns ~0.13397
*
* @example
* var v = versin( NaN );
* // returns NaN
*/
function versin( x ) {
	return 2.0 * abs2( sin( x / 2.0 ) );
}
 
 
// EXPORTS //
 
module.exports = versin;