time-to-botec

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

main.js (1504B)


      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 SQRT2 = require( '@stdlib/constants/float64/sqrt-two' );
     24 var pow = require( './../../../../base/special/pow' );
     25 var normhermitepoly = require( './../../../../base/tools/normhermitepoly' );
     26 
     27 
     28 // MAIN //
     29 
     30 /**
     31 * Evaluates a physicist's Hermite polynomial.
     32 *
     33 * @param {NonNegativeInteger} n - nonnegative polynomial degree
     34 * @param {number} x - evaluation point
     35 * @returns {number} function value
     36 *
     37 * @example
     38 * var v = hermitepoly( 1, 1.0 );
     39 * // returns 2.0
     40 *
     41 * @example
     42 * var v = hermitepoly( 1, 0.5 );
     43 * // returns 1.0
     44 *
     45 * @example
     46 * var v = hermitepoly( -1, 0.5 );
     47 * // returns NaN
     48 *
     49 * @example
     50 * var v = hermitepoly( 0, 0.5 );
     51 * // returns 1.0
     52 *
     53 * @example
     54 * var v = hermitepoly( 2, 0.5 );
     55 * // returns -1.0
     56 */
     57 function hermitepoly( n, x ) {
     58 	return pow( 2.0, 0.5*n ) * normhermitepoly( n, SQRT2*x );
     59 }
     60 
     61 
     62 // EXPORTS //
     63 
     64 module.exports = hermitepoly;