time-to-botec

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

index.js (1521B)

      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 * Evaluate a physicist's Hermite polynomial.
     23 *
     24 * @module @stdlib/math/base/tools/hermitepoly
     25 *
     26 * @example
     27 * var hermitepoly = require( '@stdlib/math/base/tools/hermitepoly' );
     28 *
     29 * var v = hermitepoly( 1, 1.0 );
     30 * // returns 2.0
     31 *
     32 * v = hermitepoly( 1, 0.5 );
     33 * // returns 0.5
     34 *
     35 * v = hermitepoly( -1, 0.5 );
     36 * // returns NaN
     37 *
     38 * v = hermitepoly( 0, 0.5 );
     39 * // returns 1.0
     40 *
     41 * v = hermitepoly( 2, 0.5 );
     42 * // returns -1.0
     43 *
     44 * @example
     45 * var factory = require( '@stdlib/math/base/tools/hermitepoly' ).factory;
     46 *
     47 * var polyval = factory( 2 );
     48 *
     49 * var v = polyval( 0.5 );
     50 * // returns -1.0
     51 */
     52 
     53 // MODULES //
     54 
     55 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     56 var hermitepoly = require( './main.js' );
     57 var factory = require( './factory.js' );
     58 
     59 
     60 // MAIN //
     61 
     62 setReadOnly( hermitepoly, 'factory', factory );
     63 
     64 
     65 // EXPORTS //
     66 
     67 module.exports = hermitepoly;