Return a constructor for creating a two-sample Z-test results object.
npm install @stdlib/stats-base-ztest-two-sample-results-factoryWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create a new constructor for creating a two-sample Z-test results object.
``bash`
npm install @stdlib/stats-base-ztest-two-sample-results-factory
`javascript`
var resultsFactory = require( '@stdlib/stats-base-ztest-two-sample-results-factory' );
#### resultsFactory( dtype )
Returns a new constructor for creating a two-sample Z-test results object.
`javascript
var Results = resultsFactory( 'float64' );
// returns
var r = new Results();
// returns
`
The function supports the following parameters:
- dtype: floating-point data type for storing floating-point results. Must be either 'float64' or 'float32'.
- A results object is a [struct][@stdlib/dstructs/struct] providing a fixed-width composite data structure for storing two-sample Z-test results and providing an ABI-stable data layout for JavaScript-C interoperation.
`javascript
var Float64Array = require( '@stdlib/array-float64' );
var Float32Array = require( '@stdlib/array-float32' );
var resultsFactory = require( '@stdlib/stats-base-ztest-two-sample-results-factory' );
var Results = resultsFactory( 'float64' );
var results = new Results({
'rejected': true,
'alpha': 0.05,
'pValue': 0.0132,
'statistic': 2.4773,
'nullValue': 0.0,
'xmean': 3.7561,
'ymean': 3.0129,
'ci': new Float64Array( [ 0.1552, 1.3311 ] ),
'alternative': 'two-sided'
});
var str = results.toString({
'format': 'linear'
});
console.log( str );
Results = resultsFactory( 'float32' );
results = new Results({
'rejected': true,
'alpha': 0.05,
'pValue': 0.0132,
'statistic': 2.4773,
'nullValue': 0.0,
'xmean': 3.7561,
'ymean': 3.0129,
'ci': new Float32Array( [ 0.1552, 1.3311 ] ),
'alternative': 'two-sided'
});
str = results.toString({
'format': 'linear'
});
console.log( str );
`
*
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-ztest-two-sample-results-factory.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-ztest-two-sample-results-factory
[test-image]: https://github.com/stdlib-js/stats-base-ztest-two-sample-results-factory/actions/workflows/test.yml/badge.svg?branch=v0.0.1
[test-url]: https://github.com/stdlib-js/stats-base-ztest-two-sample-results-factory/actions/workflows/test.yml?query=branch:v0.0.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-ztest-two-sample-results-factory/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-ztest-two-sample-results-factory?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/stats-base-ztest-two-sample-results-factory/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-ztest-two-sample-results-factory/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-ztest-two-sample-results-factory/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-ztest-two-sample-results-factory/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-ztest-two-sample-results-factory/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-ztest-two-sample-results-factory/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-ztest-two-sample-results-factory/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-ztest-two-sample-results-factory/main/LICENSE
[@stdlib/dstructs/struct]: https://www.npmjs.com/package/@stdlib/dstructs-struct