time-to-botec

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

index.js (1227B)


      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 binomial coefficient.
     23 *
     24 * @module @stdlib/math/base/special/binomcoef
     25 *
     26 * @example
     27 * var binomcoef = require( '@stdlib/math/base/special/binomcoef' );
     28 *
     29 * var v = binomcoef( 8, 2 );
     30 * // returns 28
     31 *
     32 * v = binomcoef( 0, 0 );
     33 * // returns 1
     34 *
     35 * v = binomcoef( -4, 2 );
     36 * // returns 10
     37 *
     38 * v = binomcoef( 5, 3 );
     39 * // returns 10
     40 *
     41 * v = binomcoef( NaN, 3 );
     42 * // returns NaN
     43 *
     44 * v = binomcoef( 5, NaN );
     45 * // returns NaN
     46 *
     47 * v = binomcoef( NaN, NaN );
     48 * // returns NaN
     49 */
     50 
     51 // MODULES //
     52 
     53 var binomcoef = require( './binomcoef.js' );
     54 
     55 
     56 // EXPORTS //
     57 
     58 module.exports = binomcoef;