time-to-botec

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

index.js (1035B)

      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 * Beta prime distribution mode.
     23 *
     24 * @module @stdlib/stats/base/dists/betaprime/mode
     25 *
     26 * @example
     27 * var mode = require( '@stdlib/stats/base/dists/betaprime/mode' );
     28 *
     29 * var v = mode( 1.0, 2.0 );
     30 * // returns 0.0
     31 *
     32 * v = mode( 4.0, 12.0 );
     33 * // returns ~0.231
     34 *
     35 * v = mode( 8.0, 2.0 );
     36 * // returns ~2.333
     37 */
     38 
     39 // MODULES //
     40 
     41 var mode = require( './mode.js' );
     42 
     43 
     44 // EXPORTS //
     45 
     46 module.exports = mode;