index.js (1288B)
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 a one-parameter Box-Cox transformation of `1+x`. 23 * 24 * @module @stdlib/math/base/special/boxcox1p 25 * 26 * @example 27 * var boxcox1p = require( '@stdlib/math/base/special/boxcox1p' ); 28 * 29 * var v = boxcox1p( 1.0, 2.5 ); 30 * // returns ~1.8627 31 * 32 * v = boxcox1p( 4.0, 2.5 ); 33 * // returns ~21.9607 34 * 35 * v = boxcox1p( 10.0, 2.5 ); 36 * // returns ~160.1246 37 * 38 * v = boxcox1p( 2.0, 0.0 ); 39 * // returns ~1.0986 40 * 41 * v = boxcox1p( -1.0, 2.5 ); 42 * // returns -0.4 43 * 44 * v = boxcox1p( 0.0, -1.0 ); 45 * // returns 0.0 46 * 47 * v = boxcox1p( -1.0, -1.0 ); 48 * // returns -Infinity 49 */ 50 51 // MODULES // 52 53 var boxcox1p = require( './main.js' ); 54 55 56 // EXPORTS // 57 58 module.exports = boxcox1p;