index.js (1170B)
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 z-Test. 23 * 24 * @module @stdlib/stats/ztest 25 * 26 * @example 27 * var ztest = require( '@stdlib/stats/ztest' ); 28 * var normal = require( '@stdlib/random/base/normal' ).factory; 29 * 30 * var rnorm; 31 * var out; 32 * var i; 33 * var x; 34 * var y; 35 * 36 * rnorm = normal( 1.0, 2.0, { 37 * 'seed': 786 38 * }); 39 * 40 * // One-sample z-test: 41 * x = new Array( 300 ); 42 * for ( i = 0; i < x.length; i++ ) { 43 * x[ i ] = rnorm(); 44 * } 45 * out = ztest( x, 2.0 ); 46 */ 47 48 // MODULES // 49 50 var ztest = require( './main.js' ); 51 52 53 // EXPORTS // 54 55 module.exports = ztest;