time-to-botec

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

index.js (1420B)

      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 /**
     22 * Compute the Fresnel integrals S(x) and C(x).
     23 *
     24 * @module @stdlib/math/base/special/fresnel
     25 *
     26 * @example
     27 * var fresnel = require( '@stdlib/math/base/special/fresnel' );
     28 *
     29 * var v = fresnel( 0.0 );
     30 * // returns [ 0.0, 0.0 ]
     31 *
     32 * v = fresnel( 1.0 );
     33 * // returns [ ~0.438, ~0.780 ]
     34 *
     35 * v = fresnel( Infinity );
     36 * // returns [ ~0.5, ~0.5 ]
     37 *
     38 * v = fresnel( -Infinity );
     39 * // returns [ ~-0.5, ~-0.5 ]
     40 *
     41 * v = fresnel( NaN );
     42 * // returns [ NaN, NaN ]
     43 *
     44 * @example
     45 * var fresnel = require( '@stdlib/math/base/special/fresnel' );
     46 *
     47 * var out = new Float64Array( 2 );
     48 *
     49 * var v = fresnel( out, 0.0 );
     50 * // return <Float64Array>[ ~0.0, ~0.0 ]
     51 *
     52 * var bool = ( v === out );
     53 * // returns true
     54 */
     55 
     56 // MODULES //
     57 
     58 var fresnel = require( './main.js' );
     59 
     60 
     61 // EXPORTS //
     62 
     63 module.exports = fresnel;