main.js (1686B)
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 computeFresnel = require( './fresnel.js' ); 24 25 26 // MAIN // 27 28 /** 29 * Computes the Fresnel integrals S(x) and C(x). 30 * 31 * @param {(Array|TypedArray|Object)} [out] - destination array 32 * @param {number} x - input value 33 * @returns {(Array|TypedArray|Object)} S(x) and C(x) 34 * 35 * @example 36 * var v = fresnel( 0.0 ); 37 * // returns [ 0.0, 0.0 ] 38 * 39 * @example 40 * var v = fresnel( 1.0 ); 41 * // returns [ ~0.438, ~0.780 ] 42 * 43 * @example 44 * var v = fresnel( Infinity ); 45 * // returns [ ~0.5, ~0.5 ] 46 * 47 * @example 48 * var v = fresnel( -Infinity ); 49 * // returns [ ~-0.5, ~-0.5 ] 50 * 51 * @example 52 * var v = fresnel( NaN ); 53 * // returns [ NaN, NaN ] 54 * 55 * @example 56 * var Float64Array = require( '@stdlib/array/float64' ); 57 * 58 * var out = new Float64Array( 2 ); 59 * 60 * var v = fresnel( out, 0.0 ); 61 * // return <Float64Array>[ ~0.0, ~0.0 ] 62 * 63 * var bool = ( v === out ); 64 * // returns true 65 */ 66 function fresnel( out, x ) { 67 if ( arguments.length === 1 ) { 68 return computeFresnel( new Array( 2 ), out ); 69 } 70 return computeFresnel( out, x ); 71 } 72 73 74 // EXPORTS // 75 76 module.exports = fresnel;