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 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | 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 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 1x 1x 1x 25x 25x 25x 25x 25x 10x 10x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 95x 95x 95x 95x 95x 95x 95x 42x 42x 20x 20x 42x 11x 11x 11x 11x 53x 95x 48x 25x 61x 61x 48x 14x 13x 13x 13x 13x 23x 9x 9x 48x 44x 44x 44x 95x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 2x 1x 1x 1x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 1x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 7x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 10x 10x 15x 15x 15x 15x 15x 15x 15x 15x 5x 5x 25x 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.
*/
/* eslint-disable no-invalid-this, no-restricted-syntax */
'use strict';
// MODULES //
var isArrayBuffer = require( '@stdlib/assert/is-arraybuffer' );
var isObject = require( '@stdlib/assert/is-object' );
var hasProp = require( '@stdlib/assert/has-property' );
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var setReadWriteAccessor = require( '@stdlib/utils/define-nonenumerable-read-write-accessor' );
var propertyDescriptor = require( '@stdlib/utils/property-descriptor' );
var contains = require( '@stdlib/array/base/assert/contains' ).factory;
var join = require( '@stdlib/array/base/join' );
var objectAssign = require( '@stdlib/object/assign' );
var inherit = require( '@stdlib/utils/inherit' );
var resolveStr = require( '@stdlib/stats/base/ztest/alternative-resolve-str' );
var resolveEnum = require( '@stdlib/stats/base/ztest/alternative-resolve-enum' );
var structFactory = require( '@stdlib/stats/base/ztest/two-sample/results/struct-factory' );
var res2json = require( '@stdlib/stats/base/ztest/two-sample/results/to-json' );
var res2str = require( '@stdlib/stats/base/ztest/two-sample/results/to-string' );
var format = require( '@stdlib/string/format' );
// VARIABLES //
var DTYPES = [
'float64',
'float32'
];
var isDataType = contains( DTYPES );
// MAIN //
/**
* Returns a constructor for creating a two-sample Z-test results object.
*
* @param {string} dtype - storage data type for floating-point values
* @throws {TypeError} first argument must be a supported data type
* @returns {Function} constructor
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var Results = factory( 'float64' );
*
* var results = new Results();
* // returns <Results>
*
* results.alternative = 'two-sided';
* results.alpha = 0.05;
* results.nullValue = 0.0;
* results.pValue = 0.3374;
* results.statistic = 0.9592;
* results.sd = 0.4535;
* results.ci = new Float64Array( [ -0.0316, 0.0923 ] );
* results.rejected = false;
*
* var str = results.toString();
* // returns <string>
*/
function factory( dtype ) {
var alternativeDescriptor;
var Struct;
if ( !isDataType( dtype ) ) {
throw new TypeError( format( 'invalid argument. First argument must be one of the following: "%s". Value: `%s`.', join( DTYPES, ', ' ), dtype ) );
}
// Create a struct constructor:
Struct = structFactory( dtype );
// Cache a reference to a property descriptor on the parent prototype so that we can intercept the return value:
alternativeDescriptor = propertyDescriptor( Struct.prototype, 'alternative' );
/**
* Returns a two-sample Z-test results object.
*
* @private
* @constructor
* @param {(ArrayBuffer|Object)} [arg] - underlying byte buffer or a data object
* @param {NonNegativeInteger} [byteOffset] - byte offset
* @param {NonNegativeInteger} [byteLength] - maximum byte length
* @throws {TypeError} first argument must be an ArrayBuffer or a data object
* @returns {Results} results object
*/
function Results( arg, byteOffset, byteLength ) {
var nargs;
var args;
var v;
var i;
nargs = arguments.length;
if ( !( this instanceof Results ) ) {
if ( nargs === 0 ) {
return new Results();
}
if ( nargs === 1 ) {
return new Results( arg );
}
if ( nargs === 2 ) {
return new Results( arg, byteOffset );
}
return new Results( arg, byteOffset, byteLength );
}
args = [];
if ( nargs > 0 ) {
if ( isArrayBuffer( arg ) ) {
for ( i = 0; i < nargs; i++ ) {
args.push( arguments[ i ] );
}
} else if ( isObject( arg ) ) {
if ( hasProp( arg, 'alternative' ) ) {
args.push( objectAssign( {}, arg ) );
v = resolveEnum( args[ 0 ].alternative );
args[ 0 ].alternative = ( v === null ) ? NaN : v;
}
} else {
throw new TypeError( format( 'invalid argument. First argument must be an ArrayBuffer or a data object. Value: `%s`.', arg ) );
}
}
// Call the parent constructor...
Struct.apply( this, args );
return this;
}
/*
* Inherit from the parent constructor.
*/
inherit( Results, Struct );
/**
* Test name.
*
* @private
* @name method
* @memberof Results.prototype
* @type {string}
* @default 'Two-sample Z-test'
*/
setReadOnly( Results.prototype, 'method', 'Two-sample Z-test' );
/**
* Alternative hypothesis.
*
* @private
* @name alternative
* @memberof Results.prototype
* @type {string}
*/
setReadWriteAccessor( Results.prototype, 'alternative', getAlternative, setAlternative );
/**
* Serializes a results object as a string.
*
* ## Notes
*
* - Example output:
*
* ```text
*
* Two-sample Z-test
*
* Alternative hypothesis: True mean is less than 1.0
*
* pValue: 0.0406
* statistic: 9.9901
* 95% confidence interval: [9.7821, 10.4451]
*
* Test Decision: Reject null in favor of alternative at 5% significance level
*
* ```
*
* @private
* @name toString
* @memberof Results.prototype
* @type {Function}
* @param {Options} [opts] - options object
* @param {PositiveInteger} [opts.digits=4] - number of digits after the decimal point
* @param {boolean} [opts.decision=true] - boolean indicating whether to show the test decision
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @returns {string} serialized results
*/
setReadOnly( Results.prototype, 'toString', function toString( opts ) {
if ( arguments.length ) {
return res2str( this, opts );
}
return res2str( this );
});
/**
* Serializes a results object as a JSON object.
*
* ## Notes
*
* - `JSON.stringify()` implicitly calls this method when stringifying a `Results` instance.
*
* @private
* @name toJSON
* @memberof Results.prototype
* @type {Function}
* @returns {Object} serialized object
*/
setReadOnly( Results.prototype, 'toJSON', function toJSON() {
return res2json( this );
});
/**
* Returns a DataView of a results object.
*
* @private
* @name toDataView
* @memberof Results.prototype
* @type {Function}
* @returns {DataView} DataView
*/
setReadOnly( Results.prototype, 'toDataView', function toDataView() {
return Struct.viewOf( this );
});
return Results;
/**
* Returns the alternative hypothesis.
*
* @private
* @returns {string} alternative hypothesis
*/
function getAlternative() {
return resolveStr( alternativeDescriptor.get.call( this ) );
}
/**
* Sets the alternative hypothesis.
*
* @private
* @param {string} value - alternative hypothesis
*/
function setAlternative( value ) {
alternativeDescriptor.set.call( this, resolveEnum( value ) );
}
}
// EXPORTS //
module.exports = factory;
|