time-to-botec

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

index.js (1207B)

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