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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
|
/**
* @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.
*
*
* ## Notice
*
* The following copyright, license, and long comment were part of the original implementation available as part of [FreeBSD]{@link https://svnweb.freebsd.org/base/release/9.3.0/lib/msun/src/s_sin.c}. The implementation follows the original, but has been modified for JavaScript.
*
* ```text
* Copyright (C) 1993 by Sun Microsystems, Inc. All rights reserved.
*
* Developed at SunPro, a Sun Microsystems, Inc. business.
* Permission to use, copy, modify, and distribute this
* software is freely granted, provided that this notice
* is preserved.
* ```
*/
'use strict';
// MODULES //
var getHighWord = require( '@stdlib/number/float64/base/get-high-word' );
var kernelCos = require( './../../../../base/special/kernel-cos' );
var kernelSin = require( './../../../../base/special/kernel-sin' );
var rempio2 = require( './../../../../base/special/rempio2' );
// VARIABLES //
// Absolute value mask: 0x7fffffff = 2147483647 => 01111111111111111111111111111111
var ABS_MASK = 0x7fffffff|0; // asm type annotation
// Exponent mask: 0x7ff00000 = 2146435072 => 01111111111100000000000000000000
var EXPONENT_MASK = 0x7ff00000|0; // asm type annotation
// High word for PI/4: 0x3fe921fb = 1072243195 => 00111111111010010010000111111011
var PIO4_HIGH_WORD = 0x3fe921fb|0; // asm type annotation
// 2^-26 = 1.4901161193847656e-8 => 0011111001010000000000000000000000000000000000000000000000000000 => high word => 00111110010100000000000000000000 => 0x3e500000 = 1045430272
var SMALL_HIGH_WORD = 0x3e500000|0; // asm type annotation
// Array for storing remainder elements:
var Y = [ 0.0, 0.0 ]; // WARNING: not thread safe
// MAIN //
/**
* Computes the sine of a number.
*
* ## Method
*
* - Let \\(S\\), \\(C\\), and \\(T\\) denote the \\(\sin\\), \\(\cos\\), and \\(\tan\\), respectively, on \\(\[-\pi/4, +\pi/4\]\\).
*
* - Reduce the argument \\(x\\) to \\(y1+y2 = x-k\pi/2\\) in \\(\[-\pi/4, +\pi/4\]\\), and let \\(n = k \mod 4\\).
*
* - We have
*
* | n | sin(x) | cos(x) | tan(x) |
* | - | ------ | ------ | ------ |
* | 0 | S | C | T |
* | 1 | C | -S | -1/T |
* | 2 | -S | -C | T |
* | 3 | -C | S | -1/T |
*
*
* @param {number} x - input value (in radians)
* @returns {number} sine
*
* @example
* var v = sin( 0.0 );
* // returns ~0.0
*
* @example
* var v = sin( 3.141592653589793/2.0 );
* // returns ~1.0
*
* @example
* var v = sin( -3.141592653589793/6.0 );
* // returns ~-0.5
*
* @example
* var v = sin( NaN );
* // returns NaN
*/
function sin( x ) {
var ix;
var n;
ix = getHighWord( x );
ix &= ABS_MASK;
// Case: |x| ~< π/4
if ( ix <= PIO4_HIGH_WORD ) {
// Case: |x| ~< 2^-26
if ( ix < SMALL_HIGH_WORD ) {
return x;
}
return kernelSin( x, 0.0 );
}
// Case: x is NaN or infinity
if ( ix >= EXPONENT_MASK ) {
return NaN;
}
// Argument reduction...
n = rempio2( x, Y );
switch ( n & 3 ) {
case 0:
return kernelSin( Y[ 0 ], Y[ 1 ] );
case 1:
return kernelCos( Y[ 0 ], Y[ 1 ] );
case 2:
return -kernelSin( Y[ 0 ], Y[ 1 ] );
default:
return -kernelCos( Y[ 0 ], Y[ 1 ] );
}
}
// EXPORTS //
module.exports = sin;
|