index.js (1435B)
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-sample Student's t-Test. 23 * 24 * @module @stdlib/stats/ttest 25 * 26 * @example 27 * var normal = require( '@stdlib/random/base/normal' ).factory; 28 * var Float64Array = require( '@stdlib/array/float64' ); 29 * var ttest = require( '@stdlib/stats/ttest' ); 30 * 31 * var rnorm; 32 * var out; 33 * var i; 34 * var x; 35 * var y; 36 * 37 * rnorm = normal( 1.0, 2.0, { 38 * 'seed': 786 39 * }); 40 * 41 * // One-sample t-test: 42 * x = new Float64Array( 100 ); 43 * for ( i = 0; i < x.length; i++ ) { 44 * x[ i ] = rnorm(); 45 * } 46 * out = ttest( x ); 47 * 48 * // Paired t-test: 49 * x = new Float64Array( 100 ); 50 * y = new Float64Array( 100 ); 51 * for ( i = 0; i < x.length; i++ ) { 52 * x[ i ] = rnorm(); 53 * y[ i ] = rnorm(); 54 * } 55 * out = ttest( x, y ); 56 */ 57 58 // MODULES // 59 60 var ttest = require( './main.js' ); 61 62 63 // EXPORTS // 64 65 module.exports = ttest;