Create a zero-filled ndarray having a specified shape and data type.
npm install @stdlib/ndarray-zerosWe 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 zero-filled [ndarray][@stdlib/ndarray/ctor] having a specified shape and [data type][@stdlib/ndarray/dtypes].
``bash`
npm install @stdlib/ndarray-zeros
`javascript`
var zeros = require( '@stdlib/ndarray-zeros' );
#### zeros( shape\[, options] )
Creates a zero-filled [ndarray][@stdlib/ndarray/ctor] having a specified shape and [data type][@stdlib/ndarray/dtypes].
`javascript
var arr = zeros( [ 2, 2 ] );
// returns
var sh = arr.shape;
// returns [ 2, 2 ]
var dt = arr.dtype;
// returns 'float64'
`
The specified output [ndarray][@stdlib/ndarray/ctor] shape may be either an array-like object or an integer value.
`javascript
var arr = zeros( 2 );
// returns
var sh = arr.shape;
// returns [ 2 ]
var dt = arr.dtype;
// returns 'float64'
`
The function accepts the following options:
- dtype: underlying [data type][@stdlib/ndarray/dtypes]. Must be a numeric [data type][@stdlib/ndarray/dtypes] or "generic". Default: 'float64'.'row-major'
- order: specifies whether an [ndarray][@stdlib/ndarray/ctor] is (C-style) or 'column-major' (Fortran-style). Default: 'row-major'.ndarray
- mode: specifies how to handle indices which exceed array dimensions (see [][@stdlib/ndarray/ctor]). Default: 'throw'.ndarray
- submode: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions (see [][@stdlib/ndarray/ctor]). If provided fewer modes than dimensions, the constructor recycles modes using modulo arithmetic. Default: [ options.mode ].boolean
- readonly: indicating whether an array should be read-only. Default: false.
By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [float64][@stdlib/ndarray/dtypes] data type. To specify an alternative [data type][@stdlib/ndarray/dtypes], provide a dtype option.
`javascript
var arr = zeros( [ 2, 2 ], {
'dtype': 'float32'
});
// returns
var sh = arr.shape;
// returns [ 2, 2 ]
var dt = arr.dtype;
// returns 'float32'
`
`javascript
var dtypes = require( '@stdlib/ndarray-dtypes' );
var zeros = require( '@stdlib/ndarray-zeros' );
// Get a list of data types:
var dt = dtypes( 'numeric' );
// Generate zero-filled arrays...
var arr;
var i;
for ( i = 0; i < dt.length; i++ ) {
arr = zeros( [ 2, 2 ], {
'dtype': dt[ i ]
});
console.log( arr.data );
}
`
*
- [@stdlib/ndarray-empty][@stdlib/ndarray/empty]: create an uninitialized ndarray having a specified shape and data type.
- [@stdlib/ndarray-zeros-like][@stdlib/ndarray/zeros-like]: create a zero-filled ndarray having the same shape and data type as a provided ndarray.
*
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/ndarray-zeros.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-zeros
[test-image]: https://github.com/stdlib-js/ndarray-zeros/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/ndarray-zeros/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-zeros/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-zeros?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/ndarray-zeros/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-zeros/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-zeros/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-zeros/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-zeros/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-zeros/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-zeros/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-zeros/main/LICENSE
[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor
[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray-dtypes
[@stdlib/ndarray/empty]: https://www.npmjs.com/package/@stdlib/ndarray-empty
[@stdlib/ndarray/zeros-like]: https://www.npmjs.com/package/@stdlib/ndarray-zeros-like