time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

main.js (1551B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MODULES //
     22 
     23 var fcn = require( './sici.js' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Computes the sine and cosine integrals.
     30 *
     31 * @param {(Array|TypedArray|Object)} [out] - output array
     32 * @param {number} x - input value
     33 * @returns {(Array|TypedArray|Object)} output array
     34 *
     35 * @example
     36 * var v = sici( 3.0 );
     37 * // returns [ ~1.849, ~0.12 ]
     38 *
     39 * @example
     40 * var Float64Array = require( '@stdlib/array/float64' );
     41 *
     42 * var out = new Float64Array( 2 );
     43 *
     44 * var v = sici( out, 3.0 );
     45 * // returns <Float64Array>[ ~1.849, ~0.12 ]
     46 *
     47 * var bool = ( v === out );
     48 * // returns true
     49 *
     50 * @example
     51 * var v = sici( 0.0 );
     52 * // returns [ 0.0, -Infinity  ]
     53 *
     54 * @example
     55 * var v = sici( -9.0 );
     56 * // returns [ ~-1.665, ~0.055 ]
     57 *
     58 * @example
     59 * var v = sici( NaN );
     60 * // returns [ NaN, NaN ]
     61 */
     62 function sici( out, x ) {
     63 	if ( arguments.length === 1 ) {
     64 		return fcn( [ 0.0, 0.0 ], out );
     65 	}
     66 	return fcn( out, x );
     67 }
     68 
     69 
     70 // EXPORTS //
     71 
     72 module.exports = sici;