All files / stats/base/ztest/two-sample/results/struct-factory/lib main.js

100% Statements 99/99
100% Branches 2/2
100% Functions 1/1
100% Lines 99/99

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 1001x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var struct = require( '@stdlib/dstructs/struct' );
 
 
// MAIN //
 
/**
* Returns a new struct constructor tailored to a specified floating-point data type.
*
* @param {string} dtype - floating-point data type
* @returns {Function} struct constructor
*
* @example
* var Struct = factory( 'float64' );
* // returns <Function>
*
* var s = new Struct();
* // returns <Struct>
*/
function factory( dtype ) {
	var schema = [
		{
			'name': 'rejected',
			'description': 'boolean indicating whether the null hypothesis was rejected',
			'type': 'bool',
			'castingMode': 'none'
		},
		{
			'name': 'alternative',
			'description': 'alternative hypothesis',
			'type': 'int8',
			'castingMode': 'none'
		},
		{
			'name': 'alpha',
			'description': 'significance level',
			'type': dtype,
			'castingMode': 'mostly-safe'
		},
		{
			'name': 'pValue',
			'description': 'p-value',
			'type': dtype,
			'castingMode': 'mostly-safe'
		},
		{
			'name': 'statistic',
			'description': 'test statistic',
			'type': dtype,
			'castingMode': 'mostly-safe'
		},
		{
			'name': 'ci',
			'description': 'confidence interval',
			'type': dtype,
			'length': 2,
			'castingMode': 'mostly-safe'
		},
		{
			'name': 'nullValue',
			'description': 'null value',
			'type': dtype,
			'castingMode': 'mostly-safe'
		},
		{
			'name': 'sd',
			'description': 'standard error of the mean',
			'type': dtype,
			'castingMode': 'mostly-safe'
		}
	];
	return struct( schema );
}
 
 
// EXPORTS //
 
module.exports = factory;