index.js (1335B)
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 Fibonacci polynomial. 23 * 24 * @module @stdlib/math/base/tools/fibpoly 25 * 26 * @example 27 * var fibpoly = require( '@stdlib/math/base/tools/fibpoly' ); 28 * 29 * var v = fibpoly( 5, 1.0 ); 30 * // returns 5.0 31 * 32 * @example 33 * var factory = require( '@stdlib/math/base/tools/fibpoly' ).factory; 34 * 35 * var fibpolyval = factory( 5 ); 36 * 37 * var v = fibpolyval( 1.0 ); 38 * // returns 5.0 39 * 40 * v = fibpolyval( 2.0 ); 41 * // returns 29.0 42 */ 43 44 // MODULES // 45 46 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 47 var fibpoly = require( './main.js' ); 48 var factory = require( './factory.js' ); 49 50 51 // MAIN // 52 53 setReadOnly( fibpoly, 'factory', factory ); 54 55 56 // EXPORTS // 57 58 module.exports = fibpoly;