npm package: @stdlib/stats-strided-sztest
Description: Compute a one-sample Z-test for a single-precision floating-point strided array.
Author: The Stdlib Authors
Latest version: 0.1.1

<!--

@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.

-->

<!-- lint disable max-heading-length -->


<details>
  <summary>
    About stdlib...
  </summary>
  <p>We 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.</p>
  <p>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.</p>
  <p>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.</p>
  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
</details>

# sztest

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->

> Compute a one-sample Z-test for a single-precision floating-point strided array.

<section class="intro">

A Z-test commonly refers to a one-sample location test which compares the mean of a set of measurements `X` to a given constant when the standard deviation is known. A Z-test supports testing three different null hypotheses `H0`:

-   `H0: μ ≥ μ0` versus the alternative hypothesis `H1: μ < μ0`.
-   `H0: μ ≤ μ0` versus the alternative hypothesis `H1: μ > μ0`.
-   `H0: μ = μ0` versus the alternative hypothesis `H1: μ ≠ μ0`.

</section>

<!-- /.intro -->

<section class="installation">

## Installation

```bash
npm install @stdlib/stats-strided-sztest
```

</section>

<section class="usage">

## Usage

```javascript
var sztest = require( '@stdlib/stats-strided-sztest' );
```

#### sztest( N, alternative, alpha, mu, sigma, x, strideX, out )

Computes a one-sample Z-test for a single-precision floating-point strided array.

```javascript
var Results = require( '@stdlib/stats-base-ztest-one-sample-results-float32' );
var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 4.0, 4.0, 6.0, 6.0, 5.0 ] );

var results = new Results();
var out = sztest( x.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, results );
// returns {...}

var bool = ( out === results );
// returns true
```

The function has the following parameters:

-   **N**: number of indexed elements.
-   **alternative**: [alternative hypothesis][@stdlib/stats/base/ztest/alternatives].
-   **alpha**: significance level.
-   **mu**: mean value under the null hypothesis.
-   **sigma**: known standard deviation.
-   **x**: input [`Float32Array`][@stdlib/array/float32].
-   **strideX**: stride length for `x`.
-   **out**: output [results object][@stdlib/stats/base/ztest/one-sample/results/float32].

The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to perform a one-sample Z-test over every other element in `x`,

<!-- eslint-disable max-len -->

```javascript
var Results = require( '@stdlib/stats-base-ztest-one-sample-results-float32' );
var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 4.0, 0.0, 4.0, 0.0, 6.0, 0.0, 6.0, 0.0, 5.0, 0.0 ] );

var results = new Results();
var out = sztest( 5, 'two-sided', 0.05, 0.0, 1.0, x, 2, results );
// returns {...}

var bool = ( out === results );
// returns true
```

Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.

<!-- eslint-disable stdlib/capitalized-comments -->

```javascript
var Results = require( '@stdlib/stats-base-ztest-one-sample-results-float32' );
var Float32Array = require( '@stdlib/array-float32' );

var x0 = new Float32Array( [ 0.0, 4.0, 4.0, 6.0, 6.0, 5.0 ] );
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var results = new Results();
var out = sztest( x1.length, 'two-sided', 0.05, 0.0, 1.0, x1, 1, results );
// returns {...}

var bool = ( out === results );
// returns true
```

#### sztest.ndarray( N, alternative, alpha, mu, sigma, x, strideX, offsetX, out )

Computes a one-sample Z-test for a single-precision floating-point strided array using alternative indexing semantics.

```javascript
var Results = require( '@stdlib/stats-base-ztest-one-sample-results-float32' );
var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 4.0, 4.0, 6.0, 6.0, 5.0 ] );

var results = new Results();
var out = sztest.ndarray( x.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, 0, results );
// returns {...}

var bool = ( out === results );
// returns true
```

The function has the following additional parameters:

-   **offsetX**: starting index for `x`.

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to perform a one-sample Z-test over every other element in `x` starting from the second element

```javascript
var Results = require( '@stdlib/stats-base-ztest-one-sample-results-float32' );
var Float32Array = require( '@stdlib/array-float32' );

var x = new Float32Array( [ 0.0, 4.0, 0.0, 4.0, 0.0, 6.0, 0.0, 6.0, 0.0, 5.0 ] );

var results = new Results();
var out = sztest.ndarray( 5, 'two-sided', 0.05, 0.0, 1.0, x, 2, 1, results );
// returns {...}

var bool = ( out === results );
// returns true
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

-   As a general rule of thumb, a Z-test is most reliable when `N >= 50`. For smaller sample sizes or when the standard deviation is unknown, prefer a t-test.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var Results = require( '@stdlib/stats-base-ztest-one-sample-results-float32' );
var normal = require( '@stdlib/random-array-normal' );
var sztest = require( '@stdlib/stats-strided-sztest' );

var x = normal( 1000, 0.0, 1.0, {
    'dtype': 'float32'
});

var results = new Results();
var out = sztest( x.length, 'two-sided', 0.05, 0.0, 1.0, x, 1, results );
// returns {...}

console.log( out.toString() );
```

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/stats/strided/sztest.h"
```

#### stdlib_strided_sztest( N, alternative, alpha, mu, sigma, \*X, strideX, \*results )

Computes a one-sample Z-test for a single-precision floating-point strided array.

```c
#include "stdlib/stats/base/ztest/one-sample/results/float32.h"
#include "stdlib/stats/base/ztest/alternatives.h"

struct stdlib_stats_ztest_one_sample_float32_results results = {
    .rejected = false,
    .alpha = 0.0f,
    .alternative = STDLIB_STATS_ZTEST_TWO_SIDED,
    .pValue = 0.0f,
    .statistic = 0.0f,
    .ci = { 0.0f, 0.0f },
    .nullValue = 0.0f,
    .sd = 0.0f
};

const float x[] = { 4.0f, 4.0f, 6.0f, 6.0f, 5.0f };

stdlib_strided_sztest( 5, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05f, 0.0f, 1.0f, x, 1, &results );
```

The function accepts the following arguments:

-   **N**: `[in] CBLAS_INT` number of indexed elements.
-   **alternative**: `[in] enum STDLIB_STATS_ZTEST_ALTERNATIVE` [alternative hypothesis][@stdlib/stats/base/ztest/alternatives].
-   **alpha**: `[in] float` significance level.
-   **mu**: `[in] float` value of the mean under the null hypothesis.
-   **sigma** `[in] float` known standard deviation.
-   **X**: `[in] float*` input array.
-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
-   **results**: `[out] struct stdlib_stats_ztest_one_sample_results_float32*` output [results object][@stdlib/stats/base/ztest/one-sample/results/float32].

```c
void stdlib_strided_sztest( const CBLAS_INT N, const enum STDLIB_STATS_ZTEST_ALTERNATIVE alternative, const float alpha, const float mu, const float sigma, const float *X, const CBLAS_INT strideX, struct stdlib_stats_ztest_one_sample_float32_results *results );
```

#### stdlib_strided_sztest_ndarray( N, alternative, alpha, mu, sigma, \*X, strideX, offsetX, \*results )

Computes a one-sample Z-test for a single-precision floating-point strided array using alternative indexing semantics.

```c
#include "stdlib/stats/base/ztest/one-sample/results/float32.h"
#include "stdlib/stats/base/ztest/alternatives.h"

struct stdlib_stats_ztest_one_sample_float32_results results = {
    .rejected = false,
    .alpha = 0.0f,
    .alternative = STDLIB_STATS_ZTEST_TWO_SIDED,
    .pValue = 0.0f,
    .statistic = 0.0f,
    .ci = { 0.0f, 0.0f },
    .nullValue = 0.0f,
    .sd = 0.0f
};

const float x[] = { 4.0f, 4.0f, 6.0f, 6.0f, 5.0f };

stdlib_strided_sztest_ndarray( 5, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05f, 0.0f, 1.0f, x, 1, 0, &results );
```

The function accepts the following arguments:

-   **N**: `[in] CBLAS_INT` number of indexed elements.
-   **alternative**: `[in] enum STDLIB_STATS_ZTEST_ALTERNATIVE` [alternative hypothesis][@stdlib/stats/base/ztest/alternatives].
-   **alpha**: `[in] float` significance level.
-   **mu**: `[in] float` value of the mean under the null hypothesis.
-   **sigma** `[in] float` known standard deviation.
-   **X**: `[in] float*` input array.
-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
-   **results**: `[out] struct stdlib_stats_ztest_one_sample_results_float32*` output [results object][@stdlib/stats/base/ztest/one-sample/results/float32].

```c
void stdlib_strided_sztest_ndarray( const CBLAS_INT N, const enum STDLIB_STATS_ZTEST_ALTERNATIVE alternative, const float alpha, const float mu, const float sigma, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, struct stdlib_stats_ztest_one_sample_float32_results *results );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/stats/strided/sztest.h"
#include "stdlib/stats/base/ztest/one-sample/results/float32.h"
#include "stdlib/stats/base/ztest/alternatives.h"
#include <stdbool.h>
#include <stdio.h>

int main( void ) {
    // Create a strided array:
    const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };

    // Specify the number of elements:
    const int N = 4;

    // Specify the stride length:
    const int strideX = 2;

    // Initialize a results object:
    struct stdlib_stats_ztest_one_sample_float32_results results = {
        .rejected = false,
        .alpha = 0.0f,
        .alternative = STDLIB_STATS_ZTEST_TWO_SIDED,
        .pValue = 0.0f,
        .statistic = 0.0f,
        .ci = { 0.0f, 0.0f },
        .nullValue = 0.0f,
        .sd = 0.0f
    };

    // Compute a Z-test:
    stdlib_strided_sztest( N, STDLIB_STATS_ZTEST_TWO_SIDED, 0.05f, 5.0f, 3.0f, x, strideX, &results );

    // Print the result:
    printf( "Statistic: %f\n", results.statistic );
    printf( "Null hypothesis was %s\n", ( results.rejected ) ? "rejected" : "not rejected" );
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->


<section class="main-repo" >

* * *

## Notice

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]

---

## License

See [LICENSE][stdlib-license].


## Copyright

Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].

</section>

<!-- /.stdlib -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-strided-sztest.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-strided-sztest

[test-image]: https://github.com/stdlib-js/stats-strided-sztest/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/stats-strided-sztest/actions/workflows/test.yml?query=branch:v0.1.1

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-strided-sztest/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-strided-sztest?branch=main

<!--

[dependencies-image]: https://img.shields.io/david/stdlib-js/stats-strided-sztest.svg
[dependencies-url]: https://david-dm.org/stdlib-js/stats-strided-sztest/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-strided-sztest/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-strided-sztest/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-strided-sztest/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-strided-sztest/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-strided-sztest/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-strided-sztest/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-strided-sztest/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-strided-sztest/main/LICENSE

[@stdlib/array/float32]: https://www.npmjs.com/package/@stdlib/array-float32

[@stdlib/stats/base/ztest/alternatives]: https://www.npmjs.com/package/@stdlib/stats-base-ztest-alternatives

[@stdlib/stats/base/ztest/one-sample/results/float32]: https://www.npmjs.com/package/@stdlib/stats-base-ztest-one-sample-results-float32

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

</section>

<!-- /.links -->