index.js (1089B)
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 the logit function. 23 * 24 * @module @stdlib/math/base/special/logit 25 * 26 * @example 27 * var logit = require( '@stdlib/math/base/special/logit' ); 28 * 29 * var y = logit( 0.2 ); 30 * // returns ~-1.386 31 * 32 * y = logit( 0.9 ); 33 * // returns ~2.197 34 * 35 * y = logit( -4.0 ); 36 * // returns NaN 37 * 38 * y = logit( 1.5 ); 39 * // returns NaN 40 * 41 * y = logit( NaN ); 42 * // returns NaN 43 */ 44 45 // MODULES // 46 47 var logit = require( './logit.js' ); 48 49 50 // EXPORTS // 51 52 module.exports = logit;